Functions and CALL Routines

DQSRVJOBSTATUS Function

Returns the status of a job that was submitted to a DataFlux Integration Server.

Valid in:

DATA step, PROC SQL, and SCL

Syntax
Arguments
Details
Example
See Also

Syntax

DQSRVJOBSTATUS(interval, job-ID,time-out<,host><,port> )

Arguments

interval

is the repeat period for the return of status information, within the limit that is imposed by the time-out argument.

job-ID

identifies the job that was submitted to a DataFlux Integration Server. The identifier is previously set by a function such as DQSRVARCHJOB or DQSRVPROFJOBFILE.

time-out

is a time in seconds that determines when status information is returned from the host. Valid values are defined as follows:

-1	returns status information about when the job is finished. Return values are 0 (job completed successfully) or 1 (job failed). This value invalidates the interval argument.
0	returns status information immediately. Return values are 0 (job completed successfully), 1 (job failed), or 2 (job running). This value invalidates the interval argument.
greater-than-zero	specifies a time limit for the interval argument. If the job is still running after the time-out value, another value is returned only when the job is finished.

host

identifies the host of the DataFlux Integration Server. If this value is not specified, then localhost is used

port

identifies the port through which the local host communicates with the DataFlux Integration Server. If this value is not specified, or if the value is 0 or a negative number, then the default port number 21036 is used.

Details

Use the DQSRVJOBSTATUS function to return job status information instantly, periodically, or at the completion of the job. With an interval of 20 and a time-out of 60, DQSRVJOBSTATUS returns status information up to four times. After 60 seconds, the last return value is provided at the completion of the job.

Return values are 0 (job completed successfully), 1 (job failed), or 2 (job running).

Example

The following example returns a status number for a job that ran or is running on a DataFlux Integration Server. The job identifier was returned by the function that ran the job. Status information is returned in 20 seconds or less, depending on the termination of the job. Job status is checked every 5 seconds.

status= dqsrvJobStatus(jobid,'archServer1', 5001, 20, 5);