3 ScheduleService

3.1 cancelSchedule() Method

Use the cancelSchedule() method to cancel a currently running scheduled job.

Signature

boolean cancelSchedule(String jobInstanceID, String userID, String password);

3.2 cancelScheduleInSession() Method

Cancels the schedule associated with the bipSessionToken string for a given user.

For more information about in-session methods, see Section 1.2, "About In-Session Methods."

Signature

String cancelScheduleInSession(String jobInstanceID, String bipSessionToken);

3.3 deleteJobHistory() Method

Use the deleteJobHistory() method to perform a "soft" delete the historical information about a report job, as opposed to the purgeJobHistory() method, which performs a "hard" (permanent) deletion. The deleteJobHistory() method must precede the purgeJobHistory() method.

boolean deleteJobHistory(String instanceJobID, String userID, String password);

Signature

3.4 deleteJobHistoryInSession() Method

Deletes the job history associated with the bipSessionToken string for a given user.

For more information about in-session methods, see Section 1.2, "About In-Session Methods."

Signature

boolean deleteJobHistoryInSession(String jobInstanceID, String bipSessionToken);

3.5 deleteSchedule() Method

Use the deleteSchedule() method to delete a scheduled job from the scheduler queue.

Signature

boolean deleteSchedule(String jobInstanceID, String userID, String password);

3.6 deleteScheduleInSession() Method

Deletes the schedule associated with the bipSessionToken string for a given user.

For more information about in-session methods, see Section 1.2, "About In-Session Methods."

Signature

boolean deleteScheduleInSession(String jobInstanceID, String bipSessionToken);

3.7 deliveryService() Method

Use the deliveryService() method to deliver a document from source to destination through the specified delivery channel.

Signature

String deliveryService(DeliveryRequest deliveryRequest, String userID, String password);

3.8 deliveryServiceInSession() Method

Delivers a document associated with the deliveryRequest and bipSessionToken string for a given user.

For more information about in-session methods, see Section 1.2, "About In-Session Methods."

Signature

String deliveryServiceInSession(String jobInstanceID, String bipSessionToken);

3.9 downloadDocumentData() Method

Saves a report document into the local temporary directory of the BI Publisher server, and returns the fileID of the user for later downloads. This implementation is for performance concern in case that report data size is significant.

Signature

String downloadDocumentData(String JobOutputID, String userID, String password);

3.10 downloadDocumentDataInSession() Method

Downloads the document report associated with the jobInstanceID and bipSessionToken string for a given user.

For more information about in-session methods, see Section 1.2, "About In-Session Methods."

Signature

String downloadDocumentDataInSession(String jobInstanceID, String bipSessionToken);

3.11 downloadXMLData() Method

Returns XML data used to generate a report document. It returns raw data in XML format.

Signature

downloadXMLData(String jobInstanceID, String userID, String password);

3.12 downloadXMLDataInSession() Method

Downloads the XML data for a document report associated with the bipSessionToken string for a given user.

For more information about in-session methods, see Section 1.2, "About In-Session Methods."

Signature

String downloadXMLDataInSession(String jobInstanceID, String bipSessionToken);

3.13 getAllScheduledReport() Method

Use the getAllScheduledReportInfo() method to return information about all scheduled report jobs that match filter criteria passed through the JobFilterProperties object.

Signature

JobInfosList getAllScheduledReportInfo(JobFilterProperties filter, int beginIdx, String userID, String password);

3.14 getAllScheduledReportHistory() Method

Use the getAllScheduledReportHistory() method to return information about all scheduled report histories that match filter criteria passed through the JobFilterProperties object.

Signature

JobInfosList getAllScheduledReportHistory(JobFilterProperties filter, int beginIdx, String userID, String password);

3.15 getAllScheduledReportHistoryInSession() Method

Use the getAllScheduledReportHistoryInSession() method to return information about all scheduled report histories that match filter criteria passed through the JobFilterProperties object and that are based on the bipSessionToken string for a given user.

For more information about in-session methods, see Section 1.2, "About In-Session Methods."

Signature

JobInfosList getAllScheduledReportHistoryInSession(JobFilterProperties filter, int beginIdx, String bipSessionToken);

3.16 getAllScheduledReportInSession() Method

Use the getAllScheduledReportInSession() method to return information about all scheduled reports that match filter criteria passed through the JobFilterProperties object and that are based on the bipSessionToken string for a given user.

For more information about in-session methods, see Section 1.2, "About In-Session Methods."

Signature

JobInfosList getAllScheduledReportInSession(JobFilterProperties filter, int beginIdx, String bipSessionToken);

3.17 getDeliveryServiceDefinition() Method

Use the getDeliveryServiceDefinition() method to get the delivery service definition for a given userID and password. See deliveryService() Method.

Signature

DeliveryServiceDefinition getDeliveryServiceDefinition(String userID, String password);

3.18 getDeliveryServiceDefinitionInSession() Method

Use the getDeliveryServiceDefinitionInSession() method to get the delivery service definition based on the bipSessionToken of a given user. See deliveryService() Method.

For more information about in-session methods, see Section 1.2, "About In-Session Methods."

Signature

DeliveryServiceDefinition getDeliveryServiceDefinitionInSession(String bipSessionToken);

3.19 getDocumentData() Method

Use the getDocumentData() method to return the document generated by a BI Publisher scheduled job. You can use the JobOutputID returned from the scheduleReport() method to retrieve the generated report document.

Note, the getDocumentData() method returns the byte[] of a report document, while the downloadDocumentData() Method saves the report document onto BI Publisher server as a local file. The latter method returns the file ID, enabling the user to download the report document later through the Delivery Service. This is for performance concerns in cases where a report document size is quite large.

Signature

byte[] getDocumentData(String JobOutputID, String userID, String password);

3.20 getDocumentDataInSession() Method

Returns the byte[] of a report document based on the jobOutputID and bipSessionToken of a given user.

For more information about in-session methods, see Section 1.2, "About In-Session Methods."

Signature

byte[] getDocumentDataInSession(String jobOutputID, String bipSessionToken);

3.21 getScheduledJobInfo() Method

Use the getScheduledJobInfo() method to return a JobDetail object that provides the details about a submitted job, including report parameters and other properties. This method retrieves all information stored in the database for a given jobInstanceID, userID, and password.

Signature

JobInfo getScheduledJobInfo(int jobInstanceID, String userID, String password);

3.22 getScheduledJobInfoInSession() Method

Returns a JobDetail object that provides the details for the job that's associated with a given jobInstanceID and the bipSessionToken of a given user.

For more information about in-session methods, see Section 1.2, "About In-Session Methods."

Signature

JobDetail getScheduledJobInfoInSession(String jobInstanceID, String bipSessionToken);

3.23 getScheduledReportDeliveryInfo() Method

Use the getScheduledReportdeliveryInfo() method to retrieve information about the delivery of a scheduled job output. For each scheduled Job, it could have multiple outputIDs. For each outputID, there could be multiple delivery info. See Section 2.3.35, "JobOutputDeliverysList."

Signature

JobOutputDeliverysList getScheduledReportDeliveryInfo(String jobOutputID, String userID, String password);

3.24 getScheduledReportDeliveryInfoInSession() Method

Returns a JobOutputDeliverysList object that provides the details for a given jobOutputID and the bipSessionToken of a given user.

For more information about in-session methods, see Section 1.2, "About In-Session Methods."

Signature

JobOutputDeliverysList getScheduledReportDeliveryInfoInSession(String jobOutputID, String bipSessionToken);

3.25 getScheduledReportOutputInfo() Method

Use the getScheduledReportOutputInfo() method to return information about a specific scheduled report output.

Signature

JobOutputsList getScheduledReportOutputInfo(String jobInstanceID, String userID, String password);

3.26 getScheduledReportOutputInfoInSession() Method

Use the getScheduledReportOutputInfo() method to return information about a specific scheduled report output based on its jobInstanceID and the bipSessionToken of a given user.

For more information about in-session methods, see Section 1.2, "About In-Session Methods."

Signature

JobOutputsList getScheduledReportOutputInfoInSession(String jobInstanceID, String bipTokenSession);

3.27 getXMLData() Method

Use the getXMLData() method to return, in XML format, the data document generated by a BI Publisher scheduled job. You can use the JobOutputID returned from the scheduleReport() method to retrieve the generated XML document.

Note, the getXMLData() method returns the byte[] of a report document, while the downloadXMLData() Method saves the XML data on the BI Publisher server as a local file. The latter method returns the file ID, enabling the user to download the XML-based document later through the Delivery Service. This is for performance concerns in cases where a report document size is quite large.

Signature

byte[] getXMLData(String JobInstanceID, String userID, String password);

3.28 getXMLDataInSession() Method

Returns the byte[] of XML data based on the jobInstanceID and bipSessionToken of a given user.

For more information about in-session methods, see Section 1.2, "About In-Session Methods."

Signature

byte[] getXMLDataInSession(String jobInstanceID, String bipSessionToken);

3.29 purgeJobHistory() Method

Use the purgeHistory() method to perform a "hard" delete of the historical information about a report job. That is, to permanently purge the information from the database.

You must precede the purgeJobHistory() method with the deleteJobHistory() method, otherwise the following SOAP fault is thrown:

purgeJobHistory failed due to job is not deleted. You have to delete JobHistory first prior to purge.

Signature

boolean purgeJobHistory(String instanceJobID, String userID, String password);

3.30 purgeJobHistoryInSession() Method

Permanently purges the job history from the database for the given instanceJobID and bipSessionToken of the given user. This action must be preceded by a deleteJobHistoryInSession.

For more information about in-session methods, see Section 1.2, "About In-Session Methods."

Signature

boolean purgeJobHistoryInSession(String instanceJobID, String bipSessionToken);

3.31 resendScheduledReport() Method

Use the resendScheduledReport() method to resend a previously-defined scheduled report. The resend action is respective to the outputJobID. There's no need to define any delivery channels options, as the previously-defined delivery parameters are used to perform the resend action.

Signature

boolean resendScheduledReport(String outputJobID, String userID, String password);

3.32 resendScheduledReportInSession() Method

Resends a previously-defined scheduled report based on its associated outputJobID and the bipSessionToken of a given user.

For more information about in-session methods, see Section 1.2, "About In-Session Methods."

Signature

boolean resendScheduledReportInSession(String outputJobID, String bipSessionToken);

3.33 resumeSchedule() Method

Use the resumeSchedule() method to resume a schedule job that has been suspended.

Signature

boolean resumeSchedule(String jobInstanceID, String userID, String password);

3.34 resumeScheduleInSession() Method

Resumes a scheduled job that was previously suspended based on its jobInstanceID and the bipSessionToken of a given user.

For more information about in-session methods, see Section 1.2, "About In-Session Methods."

Signature

boolean resumeScheduleInSession(String outputJobID, String bipSessionToken);

3.35 scheduleReport() Method

Use the scheduleReport() method to schedule the reports that are in the BI Publisher catalog. You can submit and run the reports immediately or create a job to schedule the reports to run. When you schedule reports you can also deliver reports to any of delivery types that are set up in your BI Publisher Enterprise Server instance. The method will return a jobID of the scheduled job.

Signature

String scheduleReport(ScheduleRequest scheduleRequest, String userID, String password);

3.36 scheduleReportInSession() Method

Schedules a report based on the schedule request, delivery channel, and bipSessionToken of a given user.

For more information about in-session methods, see Section 1.2, "About In-Session Methods."

Signature

String scheduleReportInSession(ScheduleRequest scheduleRequest, DeliveryChannel deliveryChannel, String bipSessionToken);

3.37 suspendSchedule() Method

Use the suspendSchedule() method to suspend a schedule job.

Signature

boolean suspendschedule(String jobInstanceID, String userID, String password);

3.38 suspendScheduleInSession() Method

Suspends a scheduled report based on its associated jobInstanceID and the bipSessionToken of a given user.

For more information about in-session methods, see Section 1.2, "About In-Session Methods."

Signature

boolean suspendScheduleInSession(String jobInstanceID, String bipSessionToken);