ScheduleService 3-15
Signature boolean resumeScheduleString jobInstanceID, String userID, String password;
3.34 resumeScheduleInSession Method
Resumes a scheduled job that was previously suspended 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 boolean resumeScheduleInSessionString outputJobID, String bipSessionToken;
3.35 scheduleReport Method
Use the scheduleReport method to schedule the reports that are in the BI Publisher catalog. You can submit and run the reports immediately or create a job to schedule
the reports to run. When you schedule reports you can also deliver reports to any of delivery types that are set up in your BI Publisher Enterprise Server instance. The
method will return a jobID of the scheduled job.
Signature String scheduleReportScheduleRequest scheduleRequest, String userID, String
password;
Table 3–33 Parameters for resumeSchedule Method
Parameter Description
String jobInstanceID The ID assigned to the instance of the job to be resumed.
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–34 Parameters for resumeScheduleInSession Method
Parameter Description
String jobInstanceID The ID assigned to the instance of the job to be resumed.
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–35 Parameters for scheduleReport Method
Parameter Description
ScheduleRequest scheduleRequest
Specifies a ScheduleRequest object for the report that you want to run. See
Section 2.3.48, ScheduleRequest. String userID
Specifies the BI Publisher user name. String password
Specifies the password for the user name.
3-16 Developers Guide for Oracle Business Intelligence Publisher
3.36 scheduleReportInSession Method
Schedules a report based on the schedule request, delivery channel, and bipSessionToken of a given user.
For more information about in-session methods, see Section 1.2, About In-Session
Methods.
Signature String scheduleReportInSessionScheduleRequest scheduleRequest, DeliveryChannel
deliveryChannel, String bipSessionToken;
3.37 suspendSchedule Method
Use the suspendSchedule method to suspend a schedule job.
Signature boolean suspendscheduleString jobInstanceID, String userID, String password;
3.38 suspendScheduleInSession Method
Suspends a scheduled report based on its associated jobInstanceID and the bipSessionToken of a given user.
For more information about in-session methods, see Section 1.2, About In-Session
Methods.
Signature boolean suspendScheduleInSessionString jobInstanceID, String bipSessionToken;
Table 3–36 Parameters for scheduleReportInSession Method
Parameter Description
ScheduleRequest scheduleRequest
Specifies a ScheduleRequest object for the report that you want to run. See
Section 2.3.48, ScheduleRequest. .
DeliveryChannel deliveryChannel
Specifies the delivery channels through which the report will be delivered. See
Section 2.3.20, DeliveryChannels. 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–37 Parameters for suspendSchedule Method
Parameter Description
String jobInstanceID The ID assigned to the instance of the job to be suspended.
The jobInstanceID is a string of integers. String userID
Specifies the BI Publisher user name. String password
Specifies the password for the user name.