START JOB - USAP Command
Description
The START JOB command starts a currently defined SAP job.
The following figure illustrates the command line syntax of the START JOB command, using the command line, long form of its configuration options.
-start -jobname jobname [-jobid jobid]
[-immediate]
[-targetserver server]
[-resolve_multi_model option]
[-wait
[-poll seconds]
[-joblog {yes|no}]
[-spoollist {yes|no}]
[-rawspool {yes|no}]
[-purge]
[-waitchild {yes|no}]
[-joblogchild {yes|no}]
[-spoollistchild {yes|no}]
[-purgechild {yes|no}]
[-terminatedec exitcode]
[-finishedec exitcode]
]
[-bdcwait [-bdcjobnameptrn pattern]
[-bdcjobidptrn pattern]
[-bdcqidptrn pattern]
[-qtobecreatedec exitcode]
[-qunprocessedec exitcode]
[-qinbackgroundec exitcode]
[-qfinishedec exitcode]
[-qerrorec exitcode]
]
The following table describes all START JOB configuration options and provides the command line, long form of each option illustrated in the START JOB command line syntax, above.
Configuration | Command Line | Description |
|---|---|---|
-bdcwait | Causes USAP to perform batch input monitoring for the job being started. | |
-finishedec | USAP exit code for the SAP job finished status. | |
-terminatedec | USAP exit code for the SAP job terminated status. | |
-qinbackgroundec | USAP exit code for the SAP queue state 'S' (in background). | |
-qtobecreatedec | USAP exit code for the SAP queue state 'C' (to be created). | |
-qerrorec | USAP exit code for the SAP queue state 'E' (error). | |
-qfinishedec | USAP exit code for the SAP queue state 'F' (finished). | |
-qunprocessedec | USAP exit code for the SAP queue state ' ' (unprocessed). | |
-immediate | Causes the job to be started immediately. | |
-jobid | Job ID of an existing SAP job to use as a model for the new job definition. | |
-joblogchild | Controls the printing of job logs for child jobs. | |
-jobname | Name of an existing SAP job to use as a model for the new job definition. | |
-bdcjobidptrn | Locates the header record and determines the offset of the job ID in the RSBDCSUB batch input processing report. | |
-bdcjobnameptrn | Locates the header record and determines the offset of the job name in the RSBDCSUB batch input processing report. | |
-purgechild | Controls the purging of child jobs. | |
-purge | Purge job that has completed processing from SAP system. | |
-bdcqidptrn | Locates the header record and determines the offset of the queue ID in the RSBDCSUB batch input processing report. | |
-rawspool | Specification for whether the SAP spool lists will be returned from the SAP system in raw or plain format. | |
-resolve_multi_model | For operations that work with model jobs without providing a job ID to explicitly target a specific job on the SAP system, controls the behavior when multiple candidate jobs are found. | |
-joblog | Specification for whether or not the job's joblog is returned. | |
-spoollist | Specification for whether or not the spoollists of all job steps are returned. | |
-spoollistchild | Controls the printing of spoollists for child jobs. | |
-targetserver | Server on which the job will run. | |
-poll | Length of time to wait between job status calls to the SAP system. | |
-wait | Wait for the SAP job to complete processing. | |
-waitchild | Controls the monitoring of child jobs. |