getAllScheduledReportInSession Method getDeliveryServiceDefinition Method

ScheduleService 3-9

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 getDeliveryServiceDefinitionInSessionString 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[] getDocumentDataString 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[] getDocumentDataInSessionString jobOutputID, String bipSessionToken; Table 3–18 Parameters for getDeliveryServiceDefinitionInSession Method Parameter Description 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–19 Parameters for getDocumentData Method Parameter Description String JobOutputID Job output assigned to the output. The output ID is a string of integers. String userID Specifies the BI Publisher user name. String password Specifies the password for the user name. 3-10 Developers Guide for Oracle Business Intelligence Publisher

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 getScheduledJobInfoint 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 getScheduledJobInfoInSessionString jobInstanceID, String bipSessionToken; Table 3–20 Parameters for getDocumentDataInSession Method Parameter Description String jobOutputID The ID assigned to the output. The jobOutputID 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–21 Parameters for getScheduledJobInfo Method Parameter Description int 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–22 Parameters for getScheduledJobInfoInSession 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.