Enterprise Resource Planning Jobs

The following topics describe job attributes that work with Enterprise Resource Planning (ERP) platforms and services:

Oracle E-Business Suite Job

The following table describes the Oracle E-Business Suite job parameters.

Attribute

Description

Connection Profile

Determines the authorization credentials that are used to connect Control-M to Oracle E-Business Suite.

Rules:

  • Characters: 1−30

  • Case Sensitive: Yes

  • Invalid Characters: Blank spaces

Variable Name: %%-OAP-INSTANCE

For more information about creating a local connection profile for this job, see Creating a connection profile.

User Name

Defines an authorized Oracle E-Business Suite user who has at least one responsibility.

Rule:

  • Characters: 1−100

Variable Name: %%OAP-USERNAME

Responsibility

Determines the authorization to access data and execute programs or requests, or both, as follows:

  • Security Group: Indicates the Security group associated with the Responsibility name.

    Variable Name: %%OAP-SECURITY_GROUPNAME

  • Application: Indicates the Application short name associated with the Responsibility name.

    Variable Name: %%OAP-RESPAPP

Submit

Determines whether the request is a Request Set or Single Request, as follows:

  • Request Set: Enables you to submit a predefined set of requests.

    Variable Name: %%OAP-SETPROG-P<n>-PROGDESP

  • Single Request: Enables you to submit an individual request.

    Variable Name: %%OAP-TASKTYPE

More Options

Click to open the More Options attributes.

Post Process Actions: Output Handling

 

Append Request Log to Job Output

Determines whether the Control-M for Oracle E-Business Suite request log is copied to the Control-M Job output.

Default: Selected

Variable Name: %%OAP-DISPLAY_LOGFILE

Append Request Output to Job Output

Determines whether the Control-M for Oracle E Business Suite request output is copied to the Control-M Job output.

Default: Not Selected

Variable Name: %%OAP-DISPLAY_OUTPUT

Post Process Actions: Completion Status

 

Complete Successfully even if OEBS Warning Occurred

Determines whether the job completes even when Control-M for Oracle E-Business Suite request ends with a Warning status.

Default: Not selected

Variable Name: %%OAP-CONVERT_WARNING2OK

Monitor all Child Requests (Wait Child)

Determines whether to track the status of child jobs. If not selected, only the status of the parent job is tracked.

Default: Selected

Variable Name: %%OAP_WAITCHILD

Job Completion Status will Depend on Child Requests Status

Determines whether the ending status of the job is set according to the worst completion status of all the child requests. If not selected, the job status is determined by the ending status of the parent job.

Default: Not selected

Variable Name: %%OAP-SUBSTATUS

Profiles

Defines the profile internal Name and Value.

Name and Value Rules:

  • Characters: 1−214
  • Case Sensitive: Yes

Variable Names:

  • Profile name Single Request: %%OAP-PROFILES-P<n>-USER_NAME

  • Profile name Request Set: %%OAP-PROFILES-P<n>NAME

  • Profile value: %%OAP-PROFILES-P<n>VALUE

Increment Date Parameters each Run

Determines whether the date parameters of the job increase on each execution, starting from the First Run Date.

Variable Name: %%-OAP-INCREMENT_DATE

Single Request Attributes

The following table describes the Single Request job parameters.

Attribute

Description

Use Menu Function

Determines whether to restrict application functionality to authorized users.

Variable Name: %%OAP-USE_MENU_FUNCTION

Program Name

Defines the concurrent program name that causes the Oracle E-Business Suite server to generate a list in real time that satisfies relevant criteria.

Rules:

  • Characters: 1−30
  • Case: Uppercase only.
  • Invalid Characters: Blank spaces.

Variable Names:

  • Single Request: %%OAP-PROGNAME

  • Request Set: %%OAP-SETPROG-P<n>-PROGDESP

Operating Unit

Determines the Operating Unit field.

Rules:

  • Characters: 1−100
  • Case Sensitive: Yes
  • Invalid Characters: Blank spaces.

Variable Names:

  • Single Request: %%OAP-OPERATING_UNIT

  • Request Set: %%OAP-SETPROG-P<n>-OPERATING_UNIT

Parameters

Determines the parameter values for the specified concurrent program.

Variable Names:

  • Single Request:

    • %%OAP-PARMS-P<n>NAME

    • %%OAP-PARMS-P<n>VALUE

  • Request Set:

    • %%OAP-SETPROG-P<n>-PARMS-P<n>-NAME

    • %%OAP-SETPROG-P<n>-PARMS-P<n>-VALUE

Parameter Validation

Determines whether parameter values are validated.

Variable Name: %%OAP-PARAM_VALIDATION

Language

Defines the Job output language.

Variable Name: %%OAP-LANGUAGE

Description

Defines the text description of a request.

Rules:

  • Characters: 1−214
  • Case Sensitive: Yes

Variable Name: %%OAP-DESCRIPTION

Upon Completion

Defines various tasks performed after completion of the job.

Layout

Determines the template options for your job.

Variable Names:

  • Template name

    • Single Request: %%OAP-LOUT-P<n>-NAME

    • Request Set: %%OAP-SETPROG-P<n>-LOUT-P<n>-NAME

  • Language

    • Single Request: %%OAP-LOUT-P<n>-LANG

    • Request Set: %%OAP-SETPROG-P<n>-LOUT-P<n>-LANG

  • Type

    • Single Request: %%OAP-LOUT-P<n>-TYPE

    • Request Set: %%OAP-SETPROG-P<n>-LOUT-P<n>-TYPE

Notify

Defines the workflow role names that Control-M notifies, in a text string.

Print to

Determines print output options.

Variable Names:

  • Single Request: %%OAP-PRINTERS-P<n>NAME

  • Request Set: %%OAP-SETPROG-P<n>PRINTERNAME

Delivery Options

 

Request Set Attributes

The following table describes the Request Set job parameters.

Attribute

Description

Use Menu Function

Determines whether to restrict application functionality to authorized users.

Variable Name: %%OAP-USE_MENU_FUNCTION

Request Set

Determines the concurrent programs in the request set as follows:

  • Program Display Name: Indicates the Program long name associated with the concurrent program.

    Variable Names:

    • Single Request: %%OAP-PROGDESP

    • Request Set: %%OAP-SETDESP

  • Program Name: Indicates the Program short name associated with the concurrent program.

    Variable Names:

    • Single Request: %%OAP-PROGNAME

    • Request Set: %%OAP-SETNAME

  • Application Name: Indicates the Application short name associated with the concurrent program.

    Variable Name: %%OAP-APPNAME

  • Application Display Name: Indicates the Application long name associated with the concurrent program.

    Variable Name: %%OAP-APPDESP

Parameter Validation

Determines whether parameter values are validated.

Variable Name: %%OAP-PARAM_VALIDATION

Programs

 

Stage

 

Program Name

Defines the concurrent program name that causes the Oracle E-Business Suite server to generate a list in real time that satisfies relevant criteria.

Rules:

  • Characters: 1−30
  • Case: Uppercase only
  • Invalid Characters: Blank spaces.

Variable Names:

  • Single Request: %%OAP-PROGNAME

  • Request Set: %%OAP-SETPROG-P<n>-PROGDESP

Operating Unit

Defines the Operating Unit field.

Rules:

  • Characters: 1−100
  • Case Sensitive: Yes
  • Invalid Characters: Blank spaces.

Variable Names:

  • Single Request: %%OAP-OPERATING_UNIT

  • Request Set: %%OAP-SETPROG-P<n>-OPERATING_UNIT

Parameters

Defines the Values and Descriptions for the parameters of the concurrent program.

Variable Names:

  • Single Request:

    • %%OAP-PARMS-P<n>NAME

    • %%OAP-PARMS-P<n>VALUE

  • Request Set:

    • %%OAP-SETPROG-P<n>-PARMS-P<n>-NAME

    • %%OAP-SETPROG-P<n>-PARMS-P<n>-VALUE

Parameter Validation

Determines whether parameter values are validated.

Variable Name: %%OAP-PARAM_VALIDATION

Language

Defines the Job output language.

Variable Name: %%OAP-LANGUAGE

Upon Completion

Defines various tasks performed after completion of the job.

Layout

Determines the template options for your job.

Variable Names:

  • Template name

    • Single Request: %%OAP-LOUT-P<n>-NAME

    • Request Set: %%OAP-SETPROG-P<n>-LOUT-P<n>-NAME

  • Language

    • Single Request: %%OAP-LOUT-P<n>-LANG

    • Request Set: %%OAP-SETPROG-P<n>-LOUT-P<n>-LANG

  • Type

    • Single Request: %%OAP-LOUT-P<n>-TYPE

    • Request Set: %%OAP-SETPROG-P<n>-LOUT-P<n>-TYPE

Notify

Defines the workflow role names that Control-M notifies, in a text string.

Variable Names:

  • Single Request: %%OAP-NOTIFCATIONS-Nn-NAME

  • Request Set: %%OAP-SETPROG-P<n>-NOTIFY-N001-DISP_NAME

Print to

Determines print output options.

Variable Names:

  • Single Request: %%OAP-PRINTERS-P<n>NAME

  • Request Set: %%OAP-SETPROG-P<n>PRINTERNAME

Delivery Options

Determines the email delivery options.

Variable Names:

  • From

    • Single Request: %%OAP-DE_OP_EMAIL_FROM

    • Request Set: %%OAP-SETPROG-P<n>-DE_OP_EMAIL_FROM

  • Subject

    • Single Request: %%OAP-DE_OP_EMAIL_SUBJECT

    • Request Set: %%OAP-SETPROG-P<n>-DE_OP_EMAIL_SUBJECT

  • To

    • Single Request: %%OAP-DE_OP_EMAIL-P<n>-TO

    • Request Set: %%OAP-SETPROG-P<n>-DE_OP_EMAIL-P<n>-TO

  • CC

    • Single Request: %%OAP-DE_OP_EMAIL-P<n>-CC

    • Request Set: %%OAP-SETPROG-P<n>-DE_OP_EMAIL-P<n>-CC

  • For Language

    • Single Request: %%OAP-DE_OP_EMAIL-P<n>-LANG

    • Request Set: %%OAP-SETPROG-P<n>-DE_OP_EMAIL-P<n>-LANG

PeopleSoft Job

Control-M for PeopleSoft is an Oracle-based application that enables you to develop, test, and run large-data batch processes, as well as execute common human resources tasks, such as approving promotions, viewing pay slips, or editing employee information.

The following table describes the PeopleSoft job parameters.

Attribute

Description

Connection Profile

Determines the authorization credentials that are used to connect Control-M to PeopleSoft.

Rules:

  • Characters: 1−50
  • Case Sensitive: Yes
  • Valid Characters: Blank spaces, the numbers 09, the letters AZ, _ (underscores), - (hyphens), and . (periods).

Variable Name: %%PS8-CON_PROFILE

For more information about creating a local connection profile for this job, see Creating a connection profile.

Email Subject

Defines an email message subject line that is sent by the Job.

Rule

  • Characters: 1−50

Variable Name: %%PS8-EMAIL_SUBJECT

Email Text

Defines the message text displayed in the body of an email message.

Rule:

  • Characters: Up to 250

Variable Name: %%PS8-EMAIL_TEXT

Email Web Report

Determines whether to attach the web report to the email sent at the completion of this Job. This parameter is set only when the Type parameter for the request is Web.

Variable Name: %%PS8-EMAIL_WEB_REPORT

Email with Log

Determines whether to attach the log file to the email sent at the completion of this Job.

Variable Name: %%PS8-EMAIL_ATTACH_LOG

Format

Defines the output format for all job processes

Variable Name: %%PS8-OUTDESTFORMAT

Process Name (I)

Defines the name of the scheduled process.

Rules:

  • Characters: 1−12
  • Case: Uppercase only.
  • Invalid Characters: Blank spaces.

Variable Name: %%PS8-PRCSNAME

Process Name (II)

Defines the name of the scheduled Job.

Rules:

  • Characters: 1−12
  • Case: Uppercase only.
  • Invalid Characters: Blank spaces.

Variable Name: %%PS8-PRCSTYPE

Process Type

Defines the type of process for the process or Job definition.

Rules:

  • Characters: 1−30
  • Case Sensitive: Yes

Variable Name: %%PS8-PRCSTYPE

Rerun from Step

Defines when a Job re-executes from a specific process number, which has previously failed

Variable Name: %%PS8-FAILEDSTEP

Run Control ID

Defines run control attributes, which are associated with a process or Job.

Rules:

  • Characters: 1−30
  • Case Sensitive: Yes

Variable Name: %%PS8-RUNCONTROLID

Server Name

Defines the name of the PeopleSoft server used to execute the process or Job.

Rules:

  • Characters: 1−8
  • Case Sensitive: Yes
  • Invalid Characters: Blank spaces.

Variable Name: %%PS8-SERVERNAME

Type

Defines the output destination type of a process or a Job

Variable Name: %%PS8-OUTDESTTYPE

User ID

Defines the PeopleSoft user ID name used for the process or Job.

Rules:

  • Characters: 1−30
  • Case Sensitive: Yes
  • Invalid Characters: Blank spaces.

Variable Name: %%PS8-USERID

Userdef1-20

Refers to user defined parameters that are available for the PeopleSoft process or Jobs.

Rule:

Characters: 1−214

Variable Name: %%PS8-USERDEF1-20

Append to Output

Define to include the PeopleSoft process in the Control-M Job output.

SAP Business Warehouse Job

The SAP Business Warehouse job lets you execute predefined SAP Process Chains or SAP Info Packages and monitor their completion status. This job connects to the SAP Application Server or SAP Message Server, according to the Connection Profile settings.

The following table describes the SAP Business Warehouse job parameters.

Attribute

Process Type

Description

Connection Profile

N/A

Determines the authorization credentials that are used to connect Control-M to SAP Business Warehouse.

Rules:

  • Characters: 1−30

  • Case Sensitive: Yes

  • Invalid Characters: Blank spaces.

Process Type

N/A

Determines one of the following tasks that the job performs:

  • Process Chain

  • Info Package

Variable Name: %%SAPR3-JOB_MODE

ID

Process Chain

Defines a unique BW-generated ID of a Process Chain.

Rule:

  • Characters: 1−30

Variable Name: %%SAPR3-ProcessChain_ID

Description

  • Process Chain

  • Info Package

Defines a description of a Process Chain or Info Package.

Rule:

Characters: 1−60

Variable Names:

  • %%SAPR3-ProcessChain_Desc

  • %%SAPR3-InfoPackage_Desc

Rerun Options (on job failure)

Process Chain

Determines how the Process Chain re-executes if the job fails, as follows:

  • Restart from Point of Failure: Re-executes the job from its point of failure.

  • Rerun from Start: Re-executes the job from the start of the job.

More Options

Process Chain

Click to open the More options attributes.

Enable Periodic Job

Process Chain

Determines whether the first execution of the Process Chain prepares for the next execution.

This is useful for re-executions when large Process Chains are scheduled.

Consider Only the Overall Chain Status

Process Chain

Determines whether to consider the status of the overall Process Chain.

Retrieve Log

Process Chain

Determines whether to add the Process Chain logs to the job outputClosed A tab in the job properties pane of the Monitoring domain where the job output appears that indicates whether a job ended OK, and is used, for example, with jobs that check file location..

Detect Spawned Job

Process Chain

Determines whether to detect and monitor jobs that were spawned by the current SAP job.

Detect and Create By

Process Chain

Determines the properties of the detected job for one of the following jobs definitions:

  • Parent [current] Job Definition

  • A Specific Job Definition

Job Name

Process Chain

Detected spawned jobs of the current job are extracted to Control-M with identical properties to the specified job.

Start Spawned Job

Process Chain

Determines whether to start any spawned job with a Scheduled status.

Job Ends Only after All Child Jobs Complete on SAP

Process Chain

Determines whether a job completes its execution only after all child jobs complete.

Job Completion Status Depends on Child Job Status

Process Chain

Determines whether to wait for all child jobs to complete.

The parent job does not end OK if any child job fails.

Tech. Name

Info Package

Defines a unique BW-generated Info Package ID.

Rule:

  • Characters: 1−30

Variable Name: %%SAPR3-InfoPackage_TechName

Background Job Name

Info Package

Defines the Info Package background job name.

Rule:

  • Characters: 1−25

Variable Name: %%SAPR3-BACKJOBNAME

SAP Data Archiving Job

An SAP Data Archiving job enables you to manage, schedule, and monitor individual archiving jobs, automate all phases of data archiving, and schedule archiving jobs according to business requirements and available resources.

The following table describes the SAP Data Archiving job parameters.

Attribute

Action

Description

Connection Profile

N/A

Determines the authorization credentials that are used to connect Control-M to SAP Data Archiving.

Rules:

  • Characters: 1−30
  • Case: Uppercase only
  • Case Sensitive: Yes
  • Invalid Characters: Spaces

Action

N/A

Determines which of the following tasks the job performs:

  • Write job

  • Detect delete job

  • Detect store job

SAP Job Name

  • Write job

  • Detect delete job

  • Detect store job

Defines the name of the job to be monitored or submitted.

Rule:

  • Characters: 1−32

Variable Name: %%SAPR3-DETECT_CHILD_JOBNAME

Related Variable: %%SAPR3-GROUP-ORDID

Archiving Object

  • Write job

  • Detect delete job

Defines name of the archiving object.

Rules:

  • Characters: 1−10
  • Case: Uppercase only
  • Invalid Characters: Spaces

Variable Name: %%SAPR3-DA_ARC_OBJ

Variant

Write job

Defines the variant parameters. Click , to the right of the field, to see the attributes.

User

Write job

Determines the user.

Language

Write job

Defines the Job output language.

Variable Name: %%OAP-LANGUAGE

Variant Name

Write job

Defines the variant for the specified ABAP program or archiving object.

Rules:

  • Characters: 1−10
  • Case: Uppercase only

Variant Values

Write job

Determines the variant value for the specified ABAP program or archiving object.

Variable Names:

  • %%SAPR3-STEP-S<xx>-VAR-P<yyy>-MODIFY

    Valid Values:

    • X: Variant parameter value is modified on the next job execution.

    • N: Variant parameter value is not modified on the next job execution.

  • %%SAPR3-STEP-S<yy>-VAR-P<xxx>-TYPE

    Valid Values:

    • Simple

    • Range

    • Selection

  • %%SAPR3-STEP-S<yy>-VAR-P<xxx>-VALUE

    • Specifies the value of the variant parameter

    • Only available when %%SAPR3-STEP-S<yy>-VAR-P<xxx>-TYPE is set to Simple or Selection

  • %%SAPR3-STEP-S<yy>-VAR-P<xxx>-LOW

    • Specifies the low value of the variant parameter

    • Only available when %%SAPR3-STEP-S<yy>-VAR-P<xxx>-TYPE is set to Range

  • %%SAPR3-STEP-S<yy>-VAR-P<xxx>-HIGH

    • Specifies the high value of the variant parameter

    • Only available when %%SAPR3-STEP-S<yy>-VAR-P<xxx>-TYPE is set to Range

  • %%SAPR3-STEP-S<yy>-VAR-P<xxx>-OPTION

    • Only available when %%SAPR3-STEP-S<yy>-VAR-P<xxx>-TYPE is set to Range or Selection

    Valid Values:

    • When %%SAPR3-STEP-S<yy>-VAR-P<xxx>-TYPE is set to Range:

      • BT: Interval

      • NB: Outside range

    • When %%SAPR3-STEP-S<yy>-VAR-P<xxx>-TYPE is set to Selection:

      • EQ: Single value

      • NE: Not equal to

      • GT: Greater than

      • LT: Less than

      • GE: Greater than or equal to

      • LE: Less than or equal to

      • CP: Include pattern

      • NP: Exclude pattern

  • %%SAPR3-STEP-S<yy>-VAR-P<xxx>-SIGN

    • Only available when %%SAPR3-STEP-S<yy>-VAR-P<xxx>-TYPE is set to Range or Selection

    Valid Values:

    • I: Include

    • E: Exclude

Advanced

Write job

Click to open the Advanced attributes.

Output Device

Write job

Determines which printer to use.

Rules:

  • Characters: 1−4

  • Case: Uppercase only
  • Invalid Characters: Spaces

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_DEST

Copies

Write job

Determines the number of copies to print.

Rules

  • Characters: 1−3

  • Valid Values: 001–255

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_COPIES

Print / Archive Mode

Write job

Determines one of the following spool printing options:

  • Archive: Prints the spool to an archive.

  • Print: Prints the spool to the output device.

  • Print & Archive: Prints the spool to the output device and to an archive.

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_ARCHMODE

Time of Print

Write job

Determines when the job prints, as follows:

  • Print out immediately

  • Print later

  • Send to SAP spooler

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_IMMED

Print Expiration

Write job

Determines the number of days until a print job expires.

Rules:

  • Number of days: 1−8
  • Do Not Delete: Last option

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_EXPIRATION

New Spool Request

Write job

Determines whether to request a new spool.

Variable Name: %%SAPR3-STEP-S<nn>-NEW_LIST_ID

Delete after Print

Write job

Determines whether to delete the report after printing.

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_RELEASE

Layout

Write job

Determines the print layout format. Click , to the right of the field, to see available options.

Rules:

  • Characters: 1−16
  • Case: Uppercase only
  • Invalid Characters: Spaces

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_LAYOUT

Rows

Write job

Determines the maximum number of rows per page, as follows:

  • Use ABAP program default: Uses the program default.

  • Custom rows number: Determines the maximum number of rows.

    Rule: A number between 1 and 90

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_NUMLINES

Columns

Write job

Determines the maximum number of characters in an output line, as follows:

  • Use ABAP program default: Uses the program default.

  • Custom columns number: Determines the maximum number of columns.

    Rule: A number between 1 and 255

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_NUMCOLUMNS

Recipient

Write job

Defines the recipient name of the job output.

Rules:

  • Characters: 1−12
  • Case Sensitive: Yes

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_RECIPIENT

Department

Write job

Defines the spool department.

Rules:

  • Characters: 1−12
  • Case Sensitive: Yes

Variable Name: %%SAPR3-STEP-S<nn>-DEPT

SAP Cover Page

Write job

Determines whether to print the SAP cover page, as follows:

  • Default setting

  • Print

  • Do not print

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_BANNER

OS Cover Sheet

Write job

Determines whether to print the OS cover sheet, as follows:

  • Default setting

  • Print

  • Do not print

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_HOST_BANNER

Selection Cover Page

Write job

Determines whether each selection has a cover page.

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_BANNER_PAGE

Name

Write job

Defines the spool list name.

Rules:

  • Characters: 1−12
  • Case: Uppercase only

Variable Name: %%SAPR3-STEP-S<nn>-LIST_NAME

Titles

Write job

Defines the spool list titles.

Rules:

  • Characters: 1−68
  • Case Sensitive: Yes

Variable Name: %%SAPR3-STEP-S<nn>-LIST_TEXT

Authorization

Write job

Defines the user with print authorization.

Rules:

  • Characters: 1−12
  • Case Sensitive: Yes

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_AUTH

Check Sessions

Write job

Determines whether to check for an incomplete archiving session for a specific archiving object.

An incomplete archiving session is one for which not all Delete Jobs ended successfully.

Variable Name: %%SAPR3-DA_CHECK_SESSIONS

Check Variants

Write job

Determines whether to check for a Write Job that exists with the specific variant for the archiving object defined for this job.

Variable Name: %%SAPR3-DA_CHECK_VARIANT

Target Server

  • Write job

  • Detect delete job

  • Detect store job

Defines which application server the external program executes on.

Rules:

  • Characters: 1-20
    The (full) format must be used: hostname_SYSID_sysnumber
  • Case: Uppercase only
  • Case Sensitive: Yes
  • Invalid Characters: Spaces

Variable Name: %%SAPR3-TARGET_SERVER

Related Variable: %%SAPR3-SERVER_OR_GROUP_TYPE

Job Class

Write job

Determines the job submission priority (in SAP) using one of the following options:

  • A - High Priority

  • B - Medium Priority

  • C - Low Priority

Start Condition

  • Write job

  • Detect delete job

  • Detect store job

Determines when the job should execute, as follows:

  • ASAP

  • Immediate

Detect Spawned Job

Write job

Determines whether to detect and monitor jobs that were spawned by the current SAP job.

Detect and Create By

Write job

Determines the properties of the detected job for one of the following job definitions:

  • Parent [current] Job definition

  • A specific Job definition

Job Name

Write job

Defines the template for new created detected SAP type jobs.

The selected job must exist in the same folder as the current job.

Rule:

  • Characters: 1−32

Variable Name: %%SAPR3-DETECT_CHILD_JOBNAME

Related Variable: %%SAPR3-GROUP-ORDID

Copy Spool File To

  • Write job

  • Detect delete job

  • Detect store job

Defines the name and path of the file the spool should be copied to.

Rules:

  • Characters: 1-214
  • Case Sensitive: Yes
  • Invalid Characters: Spaces

Variable Name: %%SAPR3-SPOOL

Session Number

  • Detect delete job

  • Detect store job

Defines the archiving session number in SAP.

Rule:

  • Digits: 6

Variable Name: %%SAPR3-DA_SESSION_NUMBER

SAP R/3 Job

An SAP R/3 job lets you create and execute a new SAP job, copy an existing job, execute a predefined job, monitor a scheduled job, execute a batch input session, activate or deactivate an SAP profile, and trigger or watch for an SAP event. This job connects to the SAP Application Server or SAP Message Server, depending on the Connection Profile settings.

The following table describes the SAP R/3 job parameters.

Attribute

Action

Description

Connection Profile

N/A

Determines the authorization credentials that are used to connect Control-M to SAP R/3.

Rules:

  • Characters: 1−30

  • Case Sensitive: Yes

  • Invalid Characters: Spaces

Variable Name: %%SAPR3-ACCOUNT

Action

N/A

Determines one of the following tasks that the job performs:

  • Create a New Job: Creates and execute a new SAP job.

  • Copy an Existing Job: Copies an existing SAP job for multiple executions of identical jobs.

  • Run a Predefined SAP Job: Executes a job that was previously defined in the SAP server.

  • Monitor a Scheduled SAP job: Monitors a job that is scheduled to execute on the SAP server.

  • Run Batch Input Session: Executes a batch input session.

  • Activate/Deactivate SAP Profile: Activates or deactivates an event or Interception SAP profile.

  • Trigger an SAP Event: Causes a specific SAP background event to occur.

  • Watch for an SAP Event: Executes a job that waits for an event to occur on the SAP server.

Variable Name: %%SAPR3-JOB_MODE

Related Variable: %%SAPR3-DA_JOB_TYPE

SAP Job Name

  • Create a New Job

  • Copy an Existing Job

  • Run a Predefined SAP Job

  • Monitor a Scheduled SAP Job

Defines the name of the job to be created, copied, executed, or monitored.

Rule:

  • Characters: 1−32

You can find the SAP job name by clicking to the right of the field when you copy, execute, or monitor the job. In the dialog box, you can filter for the following attributes.

  • User Name

  • Job Status

  • Job Name

Execution Target

  • Create a New Job

  • Copy an Existing Job

  • Run a Predefined SAP Job

Determines one of the following execution targets the job executes on:

  • Server

  • Group

Rules:

  • Characters: 1−20

  • Case Sensitive: Yes

  • Invalid Characters: Spaces

Name

  • Create a New Job

  • Copy an Existing Job

  • Run a Predefined SAP Job

Defines the name of the execution target.

Job Class

Create a New Job

Determines one of the following job submission priorities in SAP:

  • A - High Priority

  • B - Medium Priority

  • C - Low Priority

Start Condition

  • Create a New Job

  • Copy an Existing Job

Determines when the job should execute, as follows:

  • ASAP

  • Intermediate

  • After Event

Steps

Create a New Job

Defines the type and number of job steps the new SAP job performs.

You can add and define each step by clicking the to the right side of the field.

Rules:

  • Steps: 1−99

Program Type

Create a New Job

Determines one of the following step program types:

Rerun from Point of Failure

  • Create a New Job

  • Copy an Existing Job

  • Run a Predefined SAP Job

  • Monitor a Scheduled SAP Job

Determines whether an SAP R/3 job re-executes from its point of failure.

If this is not selected, the next field—Rerun from Step—must be defined.

Rerun from Step

  • Create a New Job

  • Copy an Existing Job

  • Run a Predefined SAP Job

  • Monitor a Scheduled SAP Job

Determines which step to re-execute the SAP R/3 job from when Rerun from Point of Failure is not selected.

Rule:

  • Steps:1−99

More Options

  • Create a New Job

  • Copy an Existing Job

  • Run a Predefined SAP Job

  • Monitor a Scheduled SAP Job

Click to open the More Options attributes.

Spool

  • Create a New Job

  • Copy an Existing Job

  • Run a Predefined SAP Job

Determines one of the following actions for the SAP job spool:

After selecting one of the above copy options, you have the option to save the spool in PDF format.

File

  • Create a New Job

  • Copy an Existing Job

  • Run a Predefined SAP Job

Defines the file name for the copied SAP job spool when Copy to File is selected in the Spool attribute, above.

Save spool in PDF Format

  • Create a New Job

  • Copy an Existing Job

  • Run a Predefined SAP Job

Determines whether the SAP job spool is copied to a PDF file.

Job Log

  • Create a New Job

  • Copy an Existing Job

  • Run a Predefined SAP Job

Determines one of the following actions for the SAP job log:

File

  • Create a New Job

  • Copy an Existing Job

  • Run a Predefined SAP Job

Defines the text file name for the copied SAP job log when Copy to File is selected in the Job Log attribute, above.

Job Completion Status ill Depend on Application Status

  • Create a New Job

  • Copy an Existing Job

  • Run a Predefined SAP Job

Determines whether the completion of the job depends on the SAP application status.

Detect Spawned Job

  • Create a New Job

  • Copy an Existing Job

  • Run a Predefined SAP Job

  • Monitor a Scheduled SAP Job

Determines whether to detect and monitor jobs that were spawned by the current SAP job.

Detect and Create By

  • Create a New Job

  • Copy an Existing Job

  • Run a Predefined SAP Job

  • Monitor a Scheduled SAP Job

Determines which of the following templates are used to create spawned jobs:

  • Parent [Current] Job Definition: Uses the current job as the template.
  • A specific Job Definition: Uses the job defined in the next field—Job Name—as the template.

Job Name

  • Create a New Job

  • Copy an Existing Job

  • Run a Predefined SAP Job

  • Monitor a Scheduled SAP Job

Defines the job whose properties must be identical to the properties of the detected spawned jobs of the current job.

Variable Name: %%JOBNAME

Start Spawned Job

  • Create a New Job

  • Copy an Existing Job

  • Run a Predefined SAP Job

  • Monitor a Scheduled SAP Job

Determines whether to check the status of each spawned job and to start any spawned jobs that have a Scheduled status.

Job Ends Only after All Child Kobs Complete on SAP

  • Create a New Job

  • Copy an Existing Job

  • Run a Predefined SAP Job

  • Monitor a Scheduled SAP Job

Determines whether a job completes its execution only after all child jobs complete.

Job Completion Status Depends on Child Job Status

  • Create a New Job

  • Copy an Existing Job

  • Run a Predefined SAP Job

  • Monitor a Scheduled SAP Job

Determines whether to wait for all child jobs to complete.

The parent job does not end OK if any child job fails.

Recipient Type

Create a New Job

Determines one of the following recipient types for the print job:

  • External address

  • Shared distribution list

  • Private distribution list

  • Fax number

  • Telex number

  • Internet address

  • X.400 address

  • Remote mail address

Variable Name: %%SAPR3_RECIP_TYPE

Related Variables:

  • %%SAPR3_RECIPIENT

  • %%SAPR3_RECIP_COPY

  • %%SAPR3_RECIP_BLIND_COPY

  • %%SAPR3_RECIP_EXPRESS

  • %%SAPR3_RECIP_NO_FORWARDING

You can use either %%SAPR3_RECIP_COPY or %%SAPR3_RECIP_BLIND_COPY at any one time.

Recipient Name

Create a New Job

Defines the recipient of the print job.

Rule

  • Characters: 1−214

Variable Name: %%SAPR3_RECIPIENT

Related Variables:

  • %%SAPR3_RECIP_TYPE

  • %%SAPR3_RECIP_COPY

  • %%SAPR3_RECIP_BLIND_COPY

  • %%SAPR3_RECIP_EXPRESS

  • %%SAPR3_RECIP_NO_FORWARDING

General Attributes

Create a New Job

Determines one of the following attributes for the spool list recipient delivery:

  • No Copy

  • Copy

  • Blind Copy

Express

Create a New Job

Determines whether the delivery is made immediately.

Forwarding

Create a New Job

Determines whether the delivery is forwarded.

Job Count

  • Copy an Existing Job

  • Run a Predefined SAP Job

  • Monitor a Scheduled SAP Job

Determines one of the following unique SAP jobs:

  • First Scheduled

  • Last scheduled

  • First

    This selection is only available in the Copy an Existing Job action.

  • Last

    This selection is only available in the Copy an Existing Job action.

  • Specific Job

    This selection is only available in the Monitor a Scheduled SAP Job action.

Count

  • Copy an Existing Job

  • Run a Predefined SAP Job

  • Monitor a Scheduled SAP Job

Defines the unique SAP job ID number when Specific Job is selected in the Job Count attribute.

New Job Name

Copy an Existing Job

Defines the name of the newly created job.

Start Condition

  • Copy an Existing Job

  • Run a Predefined SAP Job

Determines when the job should execute, as follows:

  • ASAP

  • Intermediate

  • After Event

    Selecting After Event displays two attributes, Event and Parameter, described below.

Event (ID)

  • Copy an Existing Job

  • Trigger an SAP event

  • Watch for an SAP Event

Determines which event the job should execute after, or which event should be triggered or watched for.

Parameter

  • Copy an Existing Job

  • Trigger an SAP event

  • Watch for an SAP Event

Defines the event parameter.

View Job Steps

  • Copy an Existing Job

  • Run a Predefined SAP Job

Defines a read-only field that displays the job steps to be performed as part of a SAP job.

View SAP Job Documentation

  • Copy an Existing Job

  • Run a Predefined SAP Job

Retrieves SAP job documentation from the Solution Manager.

Target Server

Run Batch Input Session

Defines the application server where the external program executes.

Rules:

  • Characters: 1-20
    The full format must be used: hostname_SYSID_sysnumber
  • Case: Uppercase only
  • Case Sensitive: Yes
  • Invalid Characters: Spaces

Variable Name: %%SAPR3-TARGET_SERVER

Related Variable: %%SAPR3-SERVER_OR_GROUP_TYPE

Type

Run Batch Input Session

Determines which of the following batch input types execute:

  • Session

  • Pattern

Session Name

Run Batch Input Session

Defines the batch input session name when Session is selected in the Type attribute, above.

Rule:

  • Characters: 1−12

Variable Name: %%SAPR3-JOBNAME

QID

Run Batch Input Session

Defines the batch input session Queue Identification (QID) number when Session is selected in the Type attribute, above.

Rules:

Digits: 20

Variable Name: %%SAPR3-QID

Pattern Name

Run Batch Input Session

Defines a filter for one or more sessions that you can execute for batch input mode when Use Batch Input Pattern is selected.

Rules:

The following wildcards are used:

  • ? means any single character.
  • * means any character.

Variable Name: %%SAPR3- BI_PATTERN_NAME

Profile Type

Activate/Deactivate SAP profile

Determines one of the following profile types:

  • Interception

  • Event History

Selecting either of the above profile types lets you choose one of the following options:

  • Activate

    Selecting Activate displays two attributes—Profile ID and Profile description—described below.

  • Deactivate

Profile ID

Activate/Deactivate SAP profile

Defines the profile ID.

Profile Description

Activate/Deactivate SAP profile

Defines the text description of a profile ID.

Time Limit

Watch for an SAP Event

Determines one of the following time periods that a job waits for an event to occur on the SAP server:

  • No limit: The job waits indefinitely.

  • Stop after: The job waits for a set period of time.

    Rules:

    • Hours: 0−99

    • Minutes: 0−59

  • Stop at: The job waits for a set time and number of days.

    Rules:

    • Time: Any hour and minute in a 24-hour period.

    • In (days): 0−30

Send Alert on Timeout

Watch for an SAP Event

Determines whether an alert should be sent when the job reaches its set time limit.

Alert Severity

Watch for an SAP Event

Determines one of the following severity levels for the timeout alert:

  • Regular

  • Urgent

  • Very urgent

Event ID

Watch for an SAP Event

Defines the event ID variable for a detected event.

Event Parameter

Watch for an SAP Event

Defines the event parameter variable for a detected event.

ABAP Attributes

The following table describes the ABAP step parameters.

Attribute

Description

ABAP Program

Defines the name of the ABAP program.

ABAP is a language used within the SAP system.

Rules:

  • Characters: 1−40

  • Case: Uppercase only

  • Invalid Characters: Special characters

Variable Name: %%SAPR3-STEP-S<nn>-PROGRAM

User

Defines the authorized step owner.

Rules:

  • Characters: 1−12

  • Case: Uppercase only

  • Invalid Characters: Spaces

Variable Name: %%SAPR3-STEP-S<nn>-OWNER

Language

Determines the language of the ABAP step.

Rules:

  • Characters (alphanumeric): 1

    D for German

    d for Serbo-Croatian

  • Case Sensitive: Yes

  • Invalid Characters: Spaces and special characters

Variable Name: %%SAPR3-STEP-S<nn>-LANGU

Variant Type

Determines one of the following variant types used in the ABAP program:

  • Variant: Specify a preexisting variant that you select in the next attribute—Variant name.

  • Temporary Variant: Specify temporary variant values for the specified ABAP program.

Variant Name

Defines the variant for the specified ABAP program or archiving object.

Rules:

  • Characters: 1−14

  • Case: Uppercase only

Variable Name: %%SAPR3-STEP-S<nn>-VAR-NAME

Variant Values

Determines the variant value for the specified ABAP program or archiving object.

Variable Names:

  • %%SAPR3-STEP-S<xx>-VAR-P<yyy>-MODIFY

    Valid Values:

    • X: Variant parameter value is modified on the next job execution.

    • N: Variant parameter value is not modified on the next job execution.

  • %%SAPR3-STEP-S<yy>-VAR-P<xxx>-TYPE

    Valid Values:

    • Simple

    • Range

    • Selection

  • %%SAPR3-STEP-S<yy>-VAR-P<xxx>-VALUE

    • Specifies the value of the variant parameter.

    • Only available when %%SAPR3-STEP-S<yy>-VAR-P<xxx>-TYPE is set to Simple or Selection.

  • %%SAPR3-STEP-S<yy>-VAR-P<xxx>-LOW

    • Specifies the low value of the variant parameter.

    • Only available when %%SAPR3-STEP-S<yy>-VAR-P<xxx>-TYPE is set to Range.

  • %%SAPR3-STEP-S<yy>-VAR-P<xxx>-HIGH

    • Specifies the high value of the variant parameter.

    • Only available when %%SAPR3-STEP-S<yy>-VAR-P<xxx>-TYPE is set to Range.

  • %%SAPR3-STEP-S<yy>-VAR-P<xxx>-OPTION

    • Only available when %%SAPR3-STEP-S<yy>-VAR-P<xxx>-TYPE is set to Range or Selection.

    Valid Values:

    • When %%SAPR3-STEP-S<yy>-VAR-P<xxx>-TYPE is set to Range:

      • BT: Interval

      • NB: Outside range

    • When %%SAPR3-STEP-S<yy>-VAR-P<xxx>-TYPE is set to Selection:

      • EQ: Single value

      • NE: Not equal to

      • GT: Greater than

      • LT: Less than

      • GE: Greater than or equal to

      • LE: Less than or equal to

      • CP: Include pattern

      • NP: Exclude pattern

  • %%SAPR3-STEP-S<yy>-VAR-P<xxx>-SIGN

    • Only available when %%SAPR3-STEP-S<yy>-VAR-P<xxx>-TYPE is set to Range or Selection.

    Valid Values:

    • I: Include

    • E: Exclude

Comments

Defines a free text description of the ABAP step program.

Advanced

Click to open the Advanced attributes.

Output Device

Determines which printer to use.

Rules:

  • Characters: 1−4

  • Case: Uppercase only

  • Invalid Characters: Spaces

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_DEST

Copies

Determines the number of copies to print.

Rule: A 3-digit number between 001 and 255

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_COPIES

Print / Archive Mode

Determines one of the following spool printing options:

  • Archive: Prints the spool to an archive.
  • Print: Prints the spool to the output device.

  • Print & Archive: Prints the spool to the output device and to an archive.

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_ARCHMODE

Time of Print

Determines when to print the job output, as follows:

  • Print out immediately

  • Print later

  • Send to SAP spooler

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_IMMED

Print Expiration

Determines the number of days until a print job expires.

Rules:

  • Number of Days: 1−8
  • Do Not Delete: Last option

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_EXPIRATION

New Spool Request

Determines whether to request a new spool.

Variable Name: %%SAPR3-STEP-S<nn>-NEW_LIST_ID

Delete after Print

Determines whether to delete the report after printing.

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_RELEASE

Layout

Determines the print layout format. Click , to the right of the field, to see available options.

Rules:

  • Characters: 1−16
  • Case: Uppercase only
  • Invalid Characters: Spaces

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_LAYOUT

Rows

Determines the maximum number of rows per page, as follows:

  • Use ABAP Program Default: Uses the program default.

  • Custom Rows Number: Determines the maximum number of rows.

    Rule: A number between 1 and 90

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_NUMLINES

Columns

Determines the maximum number of characters in an output line, as follows:

  • Use ABAP Program Default: Uses the program default.

  • Custom Columns Number: Determines the maximum number of columns.

    Rule: A number between 1 and 255

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_NUMCOLUMNS

Recipient

Defines the recipient name of the job output.

Rules:

  • Characters: 1−12
  • Case Sensitive: Yes

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_RECIPIENT

Department

Defines the spool department.

Rules:

  • Characters: 1−12
  • Case Sensitive: Yes

Variable Name: %%SAPR3-STEP-S<nn>-DEPT

SAP Cover Page

Determines whether to print the SAP cover page, as follows:

  • Default setting

  • Print

  • Do not print

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_BANNER

OS Cover Sheet

Determines whether to print the OS cover sheet, as follows:

  • Default setting

  • Print

  • Do not print

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_HOST_BANNER

Selection Cover Page

Determines whether each selection has a cover page.

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_BANNER_PAGE

Name

Defines the spool list name.

Rules:

  • Characters: 1−12
  • Case: Uppercase only

Variable Name: %%SAPR3-STEP-S<nn>-LIST_NAME

Titles

Defines the spool list titles.

Rules:

  • Characters: 1−68
  • Case Sensitive: Yes

Variable Name: %%SAPR3-STEP-S<nn>-LIST_TEXT

Authorization

Defines the user with print authorization.

Rules:

  • Characters: 1−12
  • Case Sensitive: Yes

Variable Name: %%SAPR3-STEP-S<nn>-PRINT_AUTH

Archive ID

Defines the SAP ArchiveLink Storage system ID.

Rules:

  • Characters: 2

  • Case Sensitive: Yes

  • Invalid Characters: Spaces between text.

    Trailing blank spaces are permitted.

Variable Name: %%SAPR3-STEP-S<nn>-ARCH_ID

Information Field

Defines the archive information.

Rules:

  • Characters: 1−3
  • Case Sensitive: Yes

Variable Name: %%SAPR3-STEP-S<nn>-ARCHIVE_INFO

Object Type

Defines the archive object type.

Rules:

  • Characters: 1−10
  • Case Sensitive: Yes

Variable Name: %%SAPR3-STEP-S<nn>-ARCHIVE_SAPOBJECT

Document Type

Defines an archive object document type.

Rules:

  • Characters: 1−10
  • Case Sensitive: Yes

Variable Name: %%SAPR3-STEP-S<nn>-ARCHIVE_OBJECT

Archive Text

Defines a free text description of the archive location.

Rules:

  • Characters: 1−40
  • Case Sensitive: Yes
  • Invalid Characters: Spaces

Variable Name: %%SAPR3-STEP-S<nn>-ARCH_TEXT

External Program Attributes

The following table describes the External program step parameters.

Attribute

Description

Name

Defines the name of the external program.

Rules:

  • Characters: 1−128
  • Case Sensitive: Yes

Variable Name: %%SAPR3-STEP-S<nn>-PROGRAM

User

Defines the authorized step owner.

Rules:

  • Characters, uppercase only: 1−12

  • Invalid Characters: Spaces

Parameters

Defines the parameters for the external program.

Rules:

  • Characters: 1−214
  • Case Sensitive: Yes

Variable Name: %%SAPR3-STEP-S<nn>-VAR-NAME

Target server

Defines the server where the external program executes.

Rules:

  • Characters: 1−32
  • Case Sensitive: Yes
  • Invalid Characters: Spaces

Variable Name: %%SAPR3-STEP-S<nn>-TARGET_HOST

Job Waiting for External Termination

Determines whether SAP waits for the external program to end before starting the next step or exiting.

Variable Name: %%SAPR3-STEP-S<nn>-WAIT_FOR_TERM

Log External Output to Job Log

Determines whether SAP logs external output in the job log.

Variable Name: %%SAPR3-STEP-S<nn>-LOG_STDOUT

Log External Errors in Job Log

Determines whether SAP logs external errors in the job log.

Variable Name: %%SAPR3-STEP-S<nn>-LOG_STDERR

Active Trace

Determines whether SAP activates traces.

Variable Name: %%SAPR3-STEP-S<nn>-ACTIVATE_TRACE

Comments

Defines a free text description of the external program.

External Command Attributes

The following table describes the External command step parameters.

Attribute

Description

Name

Defines the name of the external command.

Rules:

  • Characters: 1−128
  • Case Sensitive: Yes

User

Defines the authorized step owner.

Rules:

  • Characters: 1−12

  • Case: Uppercase only
  • Invalid Characters: Spaces

Parameters

Defines the parameters for the external command.

Rules:

  • Characters: 1−214
  • Case Sensitive: Yes

Target Server

Defines the server where the external command executes.

Rules:

  • Characters: 1−20
  • Case Sensitive: Yes
  • Invalid Characters: Spaces

Operating System

Defines the operating system.

Rules:

  • Characters: 1−10
  • Case Sensitive: Yes

Variable Name: %%SAPR3-STEP-S<nn>-OPERSYS

Job Waiting for External Termination

Determines whether SAP waits for the external command to end before starting the next step or exiting.

Variable Name: %%SAPR3-STEP-S<nn>-WAIT_FOR_TERM

Log External Output to Job Log

Determines whether SAP logs external output in the job log.

Variable Name: %%SAPR3-STEP-S<nn>-LOG_STDOUT

Log External Errors in Job Log

Determines whether SAP logs external errors in the job log.

Variable Name: %%SAPR3-STEP-S<nn>-LOG_STDERR

Active Trace

Determines whether SAP activates traces.

Variable Name: %%SAPR3-STEP-S<nn>-ACTIVATE_TRACE

Comments

Defines a free text description of the external program.