getScheduledReportOutputInfoInSession Method getXMLData Method

ScheduleService 3-13

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[] getXMLDataInSessionString 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 purgeJobHistoryString 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 purgeJobHistoryInSessionString instanceJobID, String bipSessionToken; Table 3–28 Parameters for getXMLDataInSession Method Parameter Description String jobInstanceID The ID assigned to the job instance. The jobInstanceID is a string of integers. String bipSessionToken The proprietary token string generated for the user by the BI Publisher server. With the bipSessionToken string, the user no longer needs to provide user credentials. The BI Publisher server can validate this token string and restore the BI Publisher server session to perform needed operation. Table 3–29 Parameters for purgeJobHistory Method Parameter Description String instanceJobID The ID assigned to the instance of the job that generated the output. The instanceJobID is a string of integers. String userID Specifies the BI Publisher user name. String password Specifies the password for the user name. 3-14 Developers Guide for Oracle Business Intelligence Publisher

3.31 resendScheduledReport Method

Use the resendScheduledReport method to resend a previously-defined scheduled report. The resend action is respective to the outputJobID. Theres no need to define any delivery channels options, as the previously-defined delivery parameters are used to perform the resend action. Signature boolean resendScheduledReportString 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 resendScheduledReportInSessionString outputJobID, String bipSessionToken;

3.33 resumeSchedule Method

Use the resumeSchedule method to resume a schedule job that has been suspended. Table 3–30 Parameters for purgeJobHistoryInSession Method Parameter Description String instanceJobID The ID assigned to the job instance. The instanceJobID is a string of integers. String bipSessionToken The proprietary token string generated for the user by the BI Publisher server. With the bipSessionToken string, the user no longer needs to provide user credentials. The BI Publisher server can validate this token string and restore the BI Publisher server session to perform needed operation. Table 3–31 Parameters for resendScheduledReport Method Parameter Description String outputJobID The ID of the scheduled job to resend. String userID Specifies the BI Publisher user name. String password Specifies the password for the user name. Table 3–32 Parameters for resendScheduledReportInSession Method Parameter Description String outputJobID The ID of the scheduled job to resend. String bipSessionToken The proprietary token string generated for the user by the BI Publisher server. With the bipSessionToken string, the user no longer needs to provide user credentials. The BI Publisher server can validate this token string and restore the BI Publisher server session to perform needed operation.