getScheduledReportDeliveryInfoInSession Method getScheduledReportOutputInfo Method

3-12 Developers Guide for Oracle Business Intelligence Publisher

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 getScheduledReportOutputInfoInSessionString 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[] getXMLDataString JobInstanceID, String userID, String password; Table 3–25 Parameters for getScheduledReportOutputInfo Method Parameter Description String jobInstanceID The ID of the job for which to return job information. String userID Specifies the BI Publisher user name. String password Specifies the password for the user name. Table 3–26 Parameters for getScheduledReportOutputInfoInSession Method Parameter Description String jobInstanceID The ID of the job for which to return job information. 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–27 Parameters for getXMLData Method Parameter Description String JobInstanceID The ID assigned to the instance of the job that generated the output. The JobInstanceID is a string of integers. String userID Specifies the BI Publisher user name. String password Specifies the password for the user name. 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.