ScheduleService 3-3
3.3 deleteJobHistory Method
Use the deleteJobHistory method to perform a soft delete the historical information about a report job, as opposed to the purgeJobHistory method, which performs a
hard permanent deletion. The deleteJobHistory method must precede the purgeJobHistory method.
boolean deleteJobHistoryString instanceJobID, String userID, String password;
Signature
3.4 deleteJobHistoryInSession Method
Deletes the job history 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 boolean deleteJobHistoryInSessionString jobInstanceID, String bipSessionToken;
3.5 deleteSchedule Method
Use the deleteSchedule method to delete a scheduled job from the scheduler queue.
Table 3–2 Parameters for cancelScheduleInSession 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–3 Parameters for deleteJobHistory 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.
Table 3–4 Parameters for deleteJobHistoryInSession 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.
3-4 Developers Guide for Oracle Business Intelligence Publisher
Signature boolean deleteScheduleString jobInstanceID, String userID, String password;
3.6 deleteScheduleInSession Method
Deletes the schedule 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 boolean deleteScheduleInSessionString jobInstanceID, String bipSessionToken;
3.7 deliveryService Method
Use the deliveryService method to deliver a document from source to destination through the specified delivery channel.
Signature String deliveryServiceDeliveryRequest deliveryRequest, String userID, String
password;
3.8 deliveryServiceInSession Method
Delivers a document associated with the deliveryRequest and bipSessionToken string for a given user.
Table 3–5 Parameters for deleteSchedule Method
Parameter Description
String jobInstanceID The ID assigned to the instance of the job to be deleted. 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–6 Parameters for deleteScheduleInSession 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–7 Parameters for deliveryService Method
Parameter Description
DeliveryRequest deliveryRequest The DeliveryRequest object. See Section 2.3.21,
DeliveryRequest. String userID
Specifies the BI Publisher user name. String password
Specifies the password for the user name.