SUBMIT JOB - USAP Command

Owned by Stonebranch (Deactivated)
Jan 31, 2024

Description

The SUBMIT JOB command defines a new SAP job.

Command Line Syntax

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


-sub {filename/ddname | -jobname jobname [-jobid jobid]}
    [-target_jobname jobname]
    [-model_status option]
    [-resolve_multi_model option]
    [-start 
        [-immediate]
        [-targetserver server]
        [-target_variant job step,variant name;job step,variant name;...]
        [-wait 
            [-poll seconds] 
            [-joblog {yes|no}]
            [-spoollist {yes|no}]
            [-rawspool {yes|no}]
            [-purge]
            [-waitchild {yes|no}]
            [-max_child_depth depth]
            [-joblogchild {yes|no}|error}]
            [-spoollistchild {yes|no}]
            [-purgechild {yes|no}]
        ]
    ]

Command Argument

The SUBMIT JOB command can be expressed as either:

  • -U (Short form)
  • -sub (Long form)

The SUBMIT JOB command argument, filename/ddname, specifies the name of the file that contains the job definition.

See Universal Connector for SAP Job Definition Files for additional information on the job definition file.

Configuration Options

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

Configuration
Option Name

Command Line
Long Form

Description

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.

MAX_CHILD_DEPTH

-max_child_depth

Controls the maximum relationship depth that will be monitored by USAP.

MODEL_STATUS

-model_status

For operations that work with model jobs without providing a job ID to explicitly target a specific job on the SAP system, restricts the model job candidates to the specified job status.

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.

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.

START

-start

Starts the newly defined job.

TARGET_JOB_NAME

-target_jobname

Name to give the newly created job.

TARGET_VARIANT

-target_variant

One or more replacement variants for ABAP program job steps in an SAP job.

WAIT

-wait

Wait for the SAP job to complete processing.

WAIT_FOR_CHILD_JOBS

-waitchild

Controls the monitoring of child jobs.