ScheduleService 3-5
For more information about in-session methods, see Section 1.2, About In-Session
Methods.
Signature String deliveryServiceInSessionString 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 downloadDocumentDataString 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 downloadDocumentDataInSessionString jobInstanceID, String
bipSessionToken;
Table 3–8 Parameters for deliveryServiceInSession Method
Parameter Description
DeliveryRequest deliveryRequest The DeliveryRequest object. See Section 2.3.21,
DeliveryRequest. 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–9 Parameters for downloadDocumentData Method
Parameter Description
String jobOutputID The ID assigned to the output. The jobOutputID is a string
of integers. String userID
Specifies the BI Publisher user name. String password
Specifies the password for the user name.
Table 3–10 Parameters for downloadDocumentDataInSession 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.
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
