START JOB - USAP Command

Description

The START JOB command starts a currently defined SAP job.

Command Line Syntax

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]
    ]

Configuration Options

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
Option Name

Command Line
Long Form

Description

BATCH_MONITOR

-bdcwait

Causes USAP to perform batch input monitoring for the job being started.

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_QUEUE_BACKGROUND

-qinbackgroundec

USAP exit code for the SAP queue state 'S' (in background).

EXIT_QUEUE_CREATED

-qtobecreatedec

USAP exit code for the SAP queue state 'C' (to be created).

EXIT_QUEUE_ERROR

-qerrorec

USAP exit code for the SAP queue state 'E' (error).

EXIT_QUEUE_FINISHED

-qfinishedec

USAP exit code for the SAP queue state 'F' (finished).

EXIT_QUEUE_UNPROCESSED

-qunprocessedec

USAP exit code for the SAP queue state ' ' (unprocessed).

IMMEDIATE_JOB

-immediate

Causes the job to be started immediately.

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.

JOB_ID_PATTERN

-bdcjobidptrn

Locates the header record and determines the offset of the job ID in the RSBDCSUB batch input processing report.

JOB_NAME_PATTERN

-bdcjobnameptrn

Locates the header record and determines the offset of the job name in the RSBDCSUB batch input processing report.

PURGE_CHILD_JOBS

-purgechild

Controls the purging of child jobs.

PURGE_JOB

-purge

Purge job that has completed processing from SAP system.

QUEUE_ID_PATTERN

-bdcqidptrn

Locates the header record and determines the offset of the queue ID in the RSBDCSUB batch input processing report.

RAW_SPOOL

-rawspool

Specification for whether the SAP spool lists will be returned from the SAP system in raw or plain format.

RESOLVE_MULTI_ MODEL

-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.

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.

SPOOL_LIST_CHILD

-spoollistchild

Controls the printing of spoollists for child jobs.

TARGET_SERVER

-targetserver

Server on which the job will run.

USAP_POLL

-poll

Length of time to wait between job status calls to the SAP system.

WAIT

-wait

Wait for the SAP job to complete processing.

WAIT_FOR_CHILD_JOBS

-waitchild

Controls the monitoring of child jobs.