Schedule Samples

In this section:

 

This section provides sample Java applications that show how to create and manipulate ReportCaster schedules using the API. As with all of the samples, it uses the ReportCaster authentication and context information contained in samples.properties. These sample Java applications are presented as examples for learning purposes and are not provided as production quality applications.


Top of page

x
S01_Add_Library.java

This sample creates a default schedule instance (a run once, email, WebFOCUS server procedure) and modifies it to distribute to the library. It accepts four arguments: the Job Description, the name of the FEX on the reporting server, the execution ID for access to the reporting server, and the password for access to the reporting server.

Usage: java S01_Add_Library <scheduleDescription> <fexFileName> <execId> <execPassword>


Top of page

x
S02_Add_Email.java

This sample creates a default schedule instance of a WebFOCUS Procedure through email. It accepts five arguments: the Job Description, the name of the FEX on the reporting server, the execution ID for access to the reporting server, the password for access to the reporting server, and a single email address for distribution.

Usage: java S02_Add_Email <scheduleDescription> <fexFileName> <execId> <execPassword> <emailAddress>


Top of page

x
S03_Add_StandardReport.java

This sample creates a default schedule and modifies it to distribute a Managed Reporting Standard Report to the library. It also queries the FEX in Managed Reporting for parameter values and shows how to submit these values into the schedule. It accepts five arguments: the Job Description, the Folder HREF in Managed Reporting that contains the FEX, the HREF representing the name of the FEX that is stored in Managed Reporting, the execution ID for access to the reporting server, and the password for access to the reporting server.

Usage: java S03_Add_StandardReport <scheduleDescription> <folderHREF> <procedureHREF> <execId> <execPassword>


Top of page

x
S04_Add_AmperParameter.java

This sample creates a schedule that distributes a Managed Reporting Standard Report to the library. It queries the FEX in Managed Reporting for parameter values and then shows how to use the optionValue class to obtain an acceptable range of input values for the parameters. It accepts five arguments: the Job Description, the Folder HREF in Managed Reporting that contains the FEX, the HREF representing the name of the FEX that is stored in Managed Reporting, the execution ID for access to the reporting server, and the password for access to the reporting server.

Usage: java S04_Add_AmperParameter <scheduleDescription> <folderHREF> <procedureHREF> <execId> <execPassword>


Top of page

x
S05_Add_TimeInfo.java

This sample creates a default schedule (a run once, email, WebFOCUS server procedure) and changes it to distribute library and run every minute. It accepts four arguments: the Job Description, the name of the FEX on the reporting server, the execution ID for access to the reporting server, and the password for access to the reporting server.

Usage: java S05_Add_TimeInfo <scheduleDescription> <fexFileName> <execId> <execPassword>


Top of page

x
S06_Add_Notification.java

This sample creates a default schedule (a run once, email, WebFOCUS server procedure) and changes it to distribute library. It then turns on full and brief notification for all distributions. It accepts five arguments: the Job Description, the name of the FEX on the reporting server, the execution ID for access to the reporting server, the password for access to the reporting server, and the email address that will be used for both the full and brief notification.

Usage: java S06_Add_Notification <scheduleDescription> <fexFileName> <execId> <execPassword> <notificationAddress>


Top of page

x
S07_Add_Alert.java

This sample creates a default schedule and modifies it to distribute a Managed Reporting Standard Report to the library, run in minute intervals, and schedule it as an alert. It accepts five arguments: the Job Description, the Folder HREF in Managed Reporting that contains the FEX, the HREF representing the name of the FEX that is stored in MR, the execution ID for access to the reporting server, and the password for access to the reporting server.

Usage: java S07_Add_Alert <scheduleDescription> <folderHREF> <procedureHREF> <execId> <execPassword>


Top of page

x
S10_Get_ScheduleList.java

This sample displays a list of schedules owned by the designated owner to standard out. It accepts one argument: the owner of the schedules.

Usage: java S10_Get_ScheduleList <owner>


Top of page

x
S11_Get_OwnerList.java

This sample returns a list of all of the owners of schedules in the repository to standard out.

Usage: java S11_Get_OwnerList


Top of page

x
S21_Run.java

This sample runs a specified schedule. It accepts two arguments: the owner of the schedule and the Job Description.

Usage: java S21_Run <owner> <scheduleDescription>


Top of page

x
S31_Delete.java

This sample deletes a specified schedule. It accepts two arguments: the owner of the schedule and the Job Description.

Usage: java S31_Delete <owner> <scheduleDescription>


Top of page

x
S31_Update.java

This sample accepts an owner and a Job Description and updates the frequency information in the specified schedule. This application can be modified to accept multiple parameters for update, or to update different fields or values. It accepts two arguments: the owner of the schedule and Job Description.

Usage: java S31_Update <owner> <scheduleDescription>


WebFOCUS