Description

The WAIT for JOB command allows USAP to reconnect to a started job and monitor it through completion.

Command Line Syntax

The following figure illustrates the command line syntax of the WAIT for JOB command, using the command line, long form of its configuration options.

-wait-jobname jobname -jobid jobid 
    [-job_stat_check option]
    [-job_stat_check_interval seconds]
    [-joblog {yes|no}] 
    [-applog {yes|no}]
    [-printapprc {yes|no}]
    [-useapprc {yes|no}]
    [-server_stop_conditions codes]
    [-spoollist {yes|no}]
    [-rawspool {yes|no}]
    [-spool_codepage codepage]
    [-spool_recv_buffer size]
    [-transtab translation_table]
    [-terminatedec exitcode]
    [-finishedec exitcode] 
    [-poll seconds]
    [-purge]
    [-syslog {yes|no} 
        [-syslogpre seconds] 
        [-syslogpost seconds] 
    ]
    [-waitchild {yes|no}]
    [-max_child_depth depth]
    [-joblogchild {yes|no|error}]
    [-spoollistchild {yes|no}]
    [-purgechild {yes|no}]
    [-max_log_size size]
    [-max_spool_size size]
    [-maxspoolsizeexceededec exitcode] 
    [-first_page page]
    [-last_page page]

Configuration Options

The following table describes all WAIT for JOB configuration options and provides the command line, long form of each option illustrated in the WAIT for JOB command line syntax, above.

Configuration Option Name	Command Line Long Form	Description
WAIT	-wait	Causes USAP to wait for the SAP job to complete processing.
ENABLE_JOB_STATUS_CHECK	-job_stat_check	Specification to enable or disable calls to SAP function module BAPI_XBP_JOB_STATUS_CHECK, which are used to synchronize the actual job status with the R/3 stored status.
EXIT_JOB_FINISHED	-finishedec	USAP exit code for the SAP job finished status.
EXIT_JOB_TERMINATED	-terminatedec	USAP exit code for the SAP job terminated status.
EXIT_MAX_SPOOL_SIZE_EXCEEDED	-maxspoolsizeexceededec	Minimum exit code that will be set if an attempt is made to return a spool list that exceeds the maximum size for job logs as specified by the MAX_SPOOL_LIST_SIZE USAP configuration option.
FIRST_PAGE	-first_page	Starting page from which a spool list will be returned.
LAST_PAGE	-last_page	Last page of a spool list to be returned.
JOB_ID	-jobid	Job ID of an existing SAP job to use as a model for the new job definition.
JOB_LOG_CHILD	-joblogchild	Controls the printing of job logs for child jobs.
JOB_NAME	-jobname	Name of an existing SAP job to use as a model for the new job definition.
MAX_CHILD_DEPTH	-max_child_depth	Controls the maximum relationship depth that will be monitored by USAP.
MAX_JOB_LOG_SIZE	-max_log_size	Maximum size for job logs.
MAX_SPOOL_LIST_SIZE	-max_spool_size	Maximum size for spool lists.
PURGE_CHILD_JOBS	-purgechild	Controls the purging of child jobs.
PURGE_JOB	-purge	Purge job that has completed processing from SAP system.
RAW_SPOOL	-rawspool	Specification for whether the SAP spool lists will be returned from the SAP system in raw or plain format.
RETURN_APPLICATION_LOG	-applog	Specification for whether or not the job's application log is returned.
RETURN_APPLICATION_RC	-printapprc	Specification for whether or not the job's application return codes are returned.
RETURN_JOB_LOG	-joblog	Specification for whether or not the job's joblog is returned.
RETURN_SPOOL_LIST	-spoollist	Specification for whether or not the spoollists of all job steps are returned.
SERVER_STOP_CONDITIONS	-server_stop_conditions	Exit code(s) of the executing Universal Connector process that should trigger the locally running Universal Broker to cancel the corresponding SAP job.
SPOOL_CODEPAGE	-spool_codepage	Codepage used for transferring spool lists from SAP system.
SPOOL_LIST_CHILD	-spoollistchild	Controls the printing of spoollists for child jobs.
SPOOL_RECEIVE_BUFFER	-spool_recv_buffer	Size of the blocks (number of pages) used when transferring spool lists.
STATUS_CHECK_INTERVAL	-job_stat_check_interval	Length of time that can elapse, without a change in job status, before a call will be made to synchronize the actual job status with the SAP stored status.
SYSLOG	-syslog	Specification for whether or not a syslog report is generated on standard error if the job does not complete successfully.
SYSLOG_POST_TIME	-syslogpost	Length of time to add to the job end time when calculating the to time for the syslog report.
SYSLOG_PRE_TIME	-syslogpre	Length of time to subtract from the job release time when calculating the from time for the syslog report.
TRANSLATION_TABLE	-transtab	Spoollist translation table file to use for formatting returned spoollists.
USAP_POLL	-poll	Length of time to wait between job status calls to the SAP system.
USE_APPLICATION_RC	-useapprc	Specification for whether or not the job's application return codes are used to determine the exit code of the USAP job.
WAIT_FOR_CHILD_JOBS	-waitchild	Controls the monitoring of child jobs.

Universal Agent 7.7.x

WAIT for JOB - USAP Command

Description

Command Line Syntax

Configuration Options