Immediately Running a Scheduled Job Using the DSTRUNNOW Servlet

The DSTRUNNOW servlet is a direct HTML call that runs a scheduled job immediately, regardless of its status (active or inactive) in the ReportCaster Repository. The job runs as soon as a WebFOCUS Reporting Server agent is available .

With this servlet you can pass values to the scheduled job you are running. The values are assigned to the appropriate variables in the scheduled job and used at run time. For syntax and examples about passing values to a scheduled job, see Passing Values to a Scheduled Job Using DSTSCHED, making sure to substitute DSTRUNNOW for every instance of DSTSCHED.

Note: To run the scheduled job with an execution ID other than the execution ID stored within the schedule information in the ReportCaster tables, append a colon and the alternate execution ID to schedule owner in the IBIB_user parameter in the URL query.

Reference: DSTRUNNOW Requirements

The Distribution List used for the job must already exist.
The schedule information for the job must already exist. A ReportCaster Administrator can determine a schedule ID for a job by running the report from the ReportCaster Console. Both administrators and users can determine a schedule ID from the Log File icon on the ReportCaster toolbar.
The call must be made from a secure environment. This means that the user must log on to your application with a valid Execution ID and password, which is then written to a WebFOCUS cookie and accessed by the API. The user ID for the server in the cookie must match the user ID stored in the ReportCaster Repository for the target job schedule.
To run a job belonging to another user, supply their user ID for the IBIB_user parameter.
If there are multiple schedules for a report request (job), you must supply the parameter IBIB_scheduleid.
If there is one schedule for a job, you may supply either IBIB_scheduleid or IBIB_jobdesc.

Top of page

Example: Specifying a Relative Address Using DSTRUNNOW

<FORM ACTION="/context_root/servlet/DSTRUNNOW">

where:

context_root: Is the configurable context root for the ReportCaster Web application in your Application Server configuration. By default, this is /ibi_apps.

Top of page

Example: Specifying an Alternate Execution ID Using DSTRUNNOW

To specify an execution ID other than the execution ID stored with the schedule information in the ReportCaster tables, append a colon and the alternate execution ID to the schedule owner in the IBIB_user parameter. For example, in the first request, the default execution ID runs the scheduled job:

http://hostname/context_root/servlet/DSTRUNNOW?IBIB_user=admin...

In the following request, execid is specified as the execution ID:

http://hostname/context_root/servlet/DSTRUNNOW?IBIB_user=admin:execid...

DSTRUNNOW Parameters

In this section:

The following parameters may be used in an HTML calling form to generate the query string passed to the DSTRUNNOW servlet.

Top of page

IBIB_jobdesc Parameter for DSTRUNNOW

Description	Unique, user-supplied description for the scheduled job.
Required?	Yes, if the job was scheduled to run once and IBIB_scheduleid is not supplied.
Size in bytes	90
Valid Values	Existing description used for the schedule created by the ReportCaster API.
Default	None

Top of page

IBIB_parm Parameter for DSTRUNNOW

Description	Values passed to the scheduled job. The values are assigned to variables in the scheduled job and used at run time. For more information on specifying a parameter string, see Passing Values to a Scheduled Job Using DSTSCHED.
Required?	No
Size in bytes	75
Valid Values	Must fit on an 80-byte line, which includes all punctuation.
Default	None

Top of page

IBIB_priority Parameter for DSTRUNNOW

Description	Priority level for the job scheduled to run.
Required?	No
Size in bytes	1
Valid Values	1 = Highest priority. 2 = Class 2 priority. 3 = Class 3 priority. 4 = Class 4 priority. 5 = Lowest priority.
Default	3

Top of page

IBIB_scheduleid Parameter for DSTRUNNOW

Description	Unique, API-generated key that identifies the scheduled job.
Required?	Yes, if there are multiple schedules for a job. If the job was scheduled to run once, either this parameter or IBIB_jobdesc is required.
Size in bytes	12
Valid Values	Existing schedule ID generated by the ReportCaster API.
Default	None

Top of page

IBIB_tcpiplevel Parameter for DSTRUNNOW

Description	Method ReportCaster uses for securing sockets from TCP/IP, based on a specific SAS/C library.
Required?	Yes, if the WebFOCUS Reporting Server runs on OS/390.
Size in bytes	1
Valid Values	1 = Resolves special connectivity problems. 0 = Specifies no special connectivity problems.
Default	0

Top of page

IBIB_user Parameter for DSTRUNNOW

Description	User ID of the owner of the scheduled job. Optionally, an execution ID can also be supplied.
Required?	No. If you do not supply a value, DSTRUNNOW uses the user ID from the WebFOCUS cookie and execution ID stored with the schedule information in the ReportCaster tables. If you do supply an owner value, it will override the user ID from the WebFOCUS cookie and ReportCaster tables. This feature enables a logged on user (whose ID is stored in the cookie) to run a job owned by another user. In addition, if an execution ID is also supplied, it will override the execution ID stored with the schedule if the specified execution ID meets the Servlet security requirements.
Size in bytes	48 (Windows and UNIX)8 (OS/390)
Valid Values	Single quotation marks, ampersands, and spaces are not allowed.
Default	User ID from the WebFOCUS cookie.