BDCWAIT - USAP Command

Description

The BDCWAIT command allows USAP to reconnect to a started batch input processing job and monitor it, and all its generated session processing jobs, through completion.

Command Line Syntax

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

-bdcwait-jobname jobname -jobid jobid 
    [-poll seconds] 
    [-job_stat_check option]
    [-job_stat_check_interval seconds]
    [-joblog {yes|no}] 
    [-applog {yes|no}]
    [-printapprc {yes|no}]
    [-useapprc {yes|no}]
    [-transtab translation_table]
    [-purge] 
    [-purge_bdc_map {yes|no}]
    [-syslog {yes|no} 
        [-syslogpre seconds] 
        [-syslogpost seconds] 
    [-terminatedec exitcode]
    [-finishedec exitcode] 
    [-maxspoolsizeexceededec exitcode] 
    [-qtobecreatedec exitcode]
    [-qunprocessedec exitcode]
    [-qinbackgroundec exitcode]
    [-qfinishedec exitcode]
    [-qerrorec exitcode]
    [-bdcjobnameptrn pattern]
    [-bdcjobidptrn pattern]
    [-bdcqidptrn pattern]


Configuration Options

The following table describes all BDCWAIT configuration options and provides the command line, long form of each option illustrated in the BDCWAIT 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.

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.

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

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.

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_BDC_MAP

-purge_bdc_map

Specification for whether or not to delete BDC Batch input session queues that have been processed successfully.

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.

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.

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.