DISPLAY STATUS - USAP Command

Description

The DISPLAY STATUS command displays the current status for an SAP job. The status is printed to standard output and the exit code of usap indicates the status. See Universal Connector for SAP Exit Codes for a complete list of job status exit codes.

Command Line Syntax

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

-display status -jobname jobname -jobid jobid
    [-activeec exitcode]
    [-readyec exitcode]
    [-scheduledec exitcode]
    [-releasedec exitcode]
    [-terminatedec exitcode]
    [-finishedec exitcode]

Command Argument

The DISPLAY STATUS command can be expressed as either:

  • -D (Short form)
  • -display (Long form)

The DISPLAY STATUS command argument, status, requests a job status.

The status is printed to standard output and the exit code of USAP indicates the status. See Section 2.5 Exit Codes for a complete list of job status exit codes.

Configuration Options

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

Configuration
Option Name

Command Line
Long Form

Description

EXIT_JOB_ACTIVE

-activeec

USAP exit code for the SAP job active status.

EXIT_JOB_FINISHED

-finishedec

USAP exit code for the SAP job finished status.

EXIT_JOB_READY

-readyec

USAP exit code for the SAP job ready status.

EXIT_JOB_RELEASED

-releasedec

USAP exit code for the SAP job released status.

EXIT_JOB_SCHEDULED

-scheduledec

USAP exit code for the SAP job scheduled status.

EXIT_JOB_TERMINATED

-terminatedec

USAP exit code for the SAP job terminated status.

JOB_ID

-jobid

Job ID of an existing SAP job to use as a model for the new job definition.

JOB_NAME

-jobname

Name of an existing SAP job to use as a model for the new job definition.

Exit Codes

If the DISPLAY STATUS command is specified, Universal Connector will map the current status of the job to the user-definable job exit code parameters.

The following table illustrates this mapping; Universal Connector default values are listed in parentheses.

Process Chain Current Status in SAP

Exit Code

'X' - Aborted

pcaborted_exit_code (8)

'R' - Red

pcred_exit_code (4)

'A' - Active

pcactive_exit_code (10)

'G' - Green

pcgreen_exit_code (0)

Error in Universal Connector processing
(see All Other Command Exit Codes)

> 200

InfoPackage Current Status in SAP

Exit Code

'Y' - Yellow (Active)

ipyellow_exit_code (10)

'R' - Red

ipred_exit_code (4)

'G' - Green

ipgreen_exit_code (0)

Error in Universal Connector processing
(see All Other Command Exit Codes)

> 200