downloadDocumentData Method downloadDocumentDataInSession Method

3-6 Developers Guide for Oracle Business Intelligence Publisher

3.11 downloadXMLData Method

Returns XML data used to generate a report document. It returns raw data in XML format. Signature downloadXMLDataString 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 downloadXMLDataInSessionString 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. 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–11 Parameters for downloadXMLData Method Parameter Description String jobInstanceID The ID assigned to the XML data. The jobInstanceID is a string of integers. String userID Specifies the BI Publisher user name. String password Specifies the password for the user name. Table 3–12 Parameters for downloadXMLDataInSession 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 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–10 Cont. Parameters for downloadDocumentDataInSession Method Parameter Description ScheduleService 3-7 Signature JobInfosList getAllScheduledReportInfoJobFilterProperties 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 getAllScheduledReportHistoryJobFilterProperties 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 getAllScheduledReportHistoryInSessionJobFilterProperties filter, int beginIdx, String bipSessionToken; Table 3–13 Parameters for getAllScheduledReport Method Parameter Description JobFilterProperties filter The JobFilterProperties object specifies the specific criteria for the report jobs you want to return information about. See Section 2.3.30, JobFilterProperties. int beginIdx The starting point of the index default is 1. String userID Specifies the BI Publisher user name. String password Specifies the password for the user name. Table 3–14 Parameters for getAllScheduledReportHistory Method Parameter Description JobFilterProperties filter The JobFilterProperties object specifies the specific criteria for the report jobs you want to return information about. See Section 2.3.30, JobFilterProperties. int beginIdx The starting point of the index default is 1. String userID Specifies the BI Publisher user name. String password Specifies the password for the user name.