Job types

Host

Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host. Optionally, you can define a host group instead of a host machine.

NOTE : If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.

RunAs

Identifies the operating system user that will run the job.

PreCommand

(Optional) A command to execute before the job is executed.

PostCommand

(Optional) A command to execute after the job is executed.

Host

Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host. Optionally, you can define a host group instead of a host machine. See Control-M in a nutshell.

NOTE : If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.

RunAs

Identifies the operating systems user that will run the job.

FileName together with FilePath

Indicates the location of the script. 

NOTE: Due to JSON character escaping, each backslash in a Windows file system path must be doubled. For example, "c:\\tmp\\scripts".

PreCommand

(Optional) A command to execute before the job is executed.

PostCommand

(Optional) A command to execute after the job is executed.

Script

Full content of the script, up to 64 kilobytes.

Host

Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host. Optionally, you can define a host group instead of a host machine. See Control-M in a nutshell.

NOTE : If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.

RunAs

Identifies the operating systems user that will run the job.

FileName

Name of a script file. This property is used for the following purposes:

• The file extension provides an indication of how to interpret the script. If this is the only purpose of this property, the file does not have to exist.
• If you specify an alternative script override using the OverridePath job property, the FileName property indicates the name of the alternative script file.

PreCommand

(Optional) A command to execute before the job is executed.

PostCommand

(Optional) A command to execute after the job is executed.

Host

Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host.
In addition, Control-M File Transfer plugin version 8.0.00 or later must be installed.

ConnectionProfileSrc

The connection profile to use as the source

ConnectionProfileDest

The connection profile to use as the destination

ConnectionProfileDualEndpoint

If you need to use a dual-endpoint connection profile that you have set up, specify the name of the dual-endpoint connection profile instead of ConnectionProfileSrc and ConnectionProfileDest.

A dual-endpoint connection profile can be used for FTP, SFTP, and Local filesystem transfers. For more information about dual-endpoint connection profiles, see ConnectionProfile:FileTransfer:DualEndPoint.

NumberOfRetries

Number of connection attempts after a connection failure

Range of values: 0–99 or "Default" (to inherit the default)

Default: 5 attempts

S3BucketName

For file transfers between a local filesystem and an Amazon S3 or S3-compatible storage service: The name of the S3 bucket

S3BucketNameSrc

For file transfers between two Amazon S3 or S3-compatible storage services: The name of the S3 bucket at the source

S3BucketNameDest

For file transfers between two Amazon S3 or S3-compatible storage services: The name of the S3 bucket at the destination

FileTransfers

A list of file transfers to perform during job execution, each with the following properties:

   Src

Full path to the source file

   Dest

Full path to the destination file

   TransferType

(Optional) FTP transfer mode, either Ascii (for a text file) or Binary (non-textual data file).

Ascii mode handles the conversion of line endings within the file, while Binary mode creates a byte-for-byte identical copy of the transferred file.

Default: "Binary"

   TransferOption

   As2Subject

Optional for AS2 file transfer: A text to use to override the subject of the AS2 message.

   As2Message

Optional for AS2 file transfer: A text to use to override the content type in the AS2 message.

PreCommandSrc

PreCommandDest

PostCommandSrc

PostCommandDest

Defines commands that occur before and after job execution.
Each command can run only one action at a time.

FileWatcherOptions

Additional options for watching the transferred file using the File Watcher utility:

    MinDetectedSizeInBytes

Defines the minimum number of bytes transferred before checking if the file size is static

    TimeLimitPolicy/
    TimeLimitValue

Defines the time limit to watch a file:
TimeLimitPolicy options:”WaitUntil”, "MinutesToWait"

TimeLimitValue: If TimeLimitPolicy: WaitUntil, the TimeLimitValue is the specific time to wait, for example 04:22 would be 4:22 AM.
If TimeLimitPolicy: MinutesToWait, the TimeLimitValue is the number of minutes to wait.

    MinFileAge

Defines the minimum number of years, months, days, hours, and/or minutes that must have passed since the watched file was last modified

Valid values: 9999Y9999M9999d9999h9999Min

For example: 2y3d7h

    MaxFileAge

Defines the maximum number of years, months, days, hours, and/or minutes that can pass since the watched file was last modified

Valid values: 9999Y9999M9999d9999h9999Min

For example: 2y3d7h

    AssignFileNameToVariable

Defines the variable name that contains the detected file name

    TransferAllMatchingFiles

Whether to transfer all matching files (value of true) or only the first matching file (value of false) after waiting until the watching criteria is met.

Valid values: true | false
Default value: false

Path

Path of the file to be detected by the File Watcher

You can include wildcards in the path — * for any number of characters, and ? for any single character.

SearchInterval

Interval (in seconds) between successive attempts to detect the creation/deletion of a file

TimeLimit

Maximum time (in minutes) to run the process without detecting the file at its minimum size (for Job:FileWatcher:Create) or detecting its deletion (for Job:FileWatcher:Delete). If the file is not detected/deleted in this specified time frame, the process terminates with an error return code.

Default: 0 (no time limit)

StartTime

The time at which to start watching the file

The format is yyyymmddHHMM. For example, 201805041535 means that the File Watcher will start watching the file on May 4, 2018 at 3:35 PM.
Alternatively, to specify a time on the current date, use the HHMM format.

StopTime

The time at which to stop watching the file.

Format: yyyymmddHHMM or HHMM (for the current date)

MinimumSize

Minimum file size to monitor for, when watching a created file

Follow the specified number with the unit: B for bytes, KB for kilobytes, MB for megabyes, or GB for gigabytes.

If the file name (specified by the Path parameter) contains wildcards, minimum file size is monitored only if you set the Wildcard parameter to true.

Wildcard

Whether to monitor minimum file size of a created file if the file name (specified by the Path parameter) contains wildcards

Values: true | false
Default: false

MinimalAge

(Optional) The minimum number of years, months, days, hours, and/or minutes that must have passed since the created file was last modified. 

For example: 2Y10M3D5H means that 2years, 10 months, 3 days, and 5 hours must pass before the file will be watched. 2H10Min means that 2 hours and 10 minutes must pass before the file will be watched.

MaximalAge

(Optional) The maximum number of years, months, days, hours, and/or minutes that can pass since the created file was last modified.

For example: 2Y10M3D5H means that after 2years, 10 months, 3 days, and 5 hours have passed, the file will no longer be watched. 2H10Min means that after 2 hours and 10 minutes have passed, the file will no longer be watched.

Host

Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host, as well as Control-M Databases plugin version 9.0.00 or later.

Optionally, you can define a host group instead of a host machine.  See Control-M in a nutshell.

NOTE: If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.

Query

The embedded SQL query that you want to run.

The SQL query can contain auto edit variables. During job run, these variables are replaced by the values that you specify in Variables parameter (next row).

For long queries, you can specify delimiters using \\n (new line) and \\t (tab).

Variables

Variables are pairs of name and value. Every name that appears in the embedded script will be replaced by its value pair.

The maximum length of a variable name is 38 alphanumeric characters and it is case-sensitive.
The variable name cannot begin with a number and must not contain blank spaces or any of the following special characters:
< > [ ] { } ( ) = ; ` ~ | : ? . + - * / & ^ # @ ! , " '

Autocommit

(Optional) Commits statements to the database that completes successfully

Default: N

OutputExecutionLog

(Optional) Shows the execution log in the job output

Default: Y

OutputSQLOutput

(Optional) Shows the SQL sysout in the job output

Default: N

SQLOutputFormat

(Optional) Defines the output format as either Text, XML, CSV, or HTML

Default: Text

Host

Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host, as well as Control-M Databases plugin version 9.0.00 or later.

Optionally, you can define a host group instead of a host machine.  See Control-M in a nutshell.

NOTE: If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.

Parameters

Parameters are pairs of name and value. Every name that appears in the SQL script will be replaced by its value pair.

Host

Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host, as well as Control-M Databases plugin version 9.0.00 or later.

Optionally, you can define a host group instead of a host machine.  See Control-M in a nutshell.

NOTE: If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.

StoredProcedure

Name of stored procedure that the job runs

Parameters

A comma-separated list of values and variables for all parameters in the procedure, in the order of their appearance in the procedure.

The value that you specify for any specific parameter in the procedure depends on the type of parameter:

• For an In parameter, specify an input value.
• For an Out parameter, specify an output variable.
• For an In/Out parameter, specify a pair of input value + output variable, enclosed in brackets: [value,variable]

In the example above, three parameters are listed, in the following order: [In,Out,Inout]

ReturnValue

A variable for the Return parameter (if the procedure contains such a parameter)

Schema

The database schema where the stored procedure resides

Package

(Oracle only) Name of a package in the database where the stored procedure resides

The default is "*", that is, any package in the database.

ConnectionProfile

Name of a connection profile that contains the details of the connection to the database

Host

Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host, as well as Control-M Databases plugin version 9.0.00 or later.

Optionally, you can define a host group instead of a host machine.  See Control-M in a nutshell.

NOTE: If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.

JobName

The name of the job defined in the SQL server

Category

The category of the job, as defined in the SQL server

Host

Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host, as well as Control-M Databases plugin version 9.0.00 or later.

Optionally, you can define a host group instead of a host machine.  See Control-M in a nutshell.

NOTE: If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.

PackageSource

The source of the SSIS package, one of the following:

• SQL Server — Package stored on an MSSQL database.
• File System — Package stored on the Control-M/Agent's local file system.
• SSIS Package Store — Package stored on a file system that is managed by an SSIS service.
• SSIS Catalog — Package stored on a file system that is managed by an SSIS Catalog service.

PackageName

The name of the SSIS package.

CatalogEnv

If PackageSource is 'SSIS Catalog': The name of the environment on which to run the package.

Use this optional parameter if you want to run the package on a different environment from the one that you are currently using.

ConfigFiles

(Optional) Names of configuration files that contain specific data that you want to apply to the SSIS package

Properties

(Optional) Pairs of names and values for properties defined in the SSIS package.

Each property name is replaced by its defined value during SSIS package execution.

ConnectionProfile

See ConnectionProfile:Hadoop

Host

Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host. Optionally, you can define a host group instead of a host machine. See Control-M in a nutshell.

NOTE : If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.

PreCommands and PostCommands

Allows you to define HDFS commands to perform before and after running the job. For example, you can use them for preparation and cleanup.

FailJobOnCommandFailure

This parameter is used to ignore failure in the pre- or post- commands.

The default for PreCommands is true , that is, the job will fail if any pre-command fails.

The default for PostCommands is false, that is, the job will complete successfully even if any post-command fails.

ConnectionProfile

See ConnectionProfile:Hadoop

Host

Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host. Optionally, you can define a host group instead of a host machine. See Control-M in a nutshell.

NOTE : If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.

PreCommands and PostCommands

Allows you to define HDFS commands to perform before and after running the job. For example, you can use them for preparation and cleanup.

FailJobOnCommandFailure

This parameter is used to ignore failure in the pre- or post- commands.

The default for PreCommands is true , that is, the job will fail if any pre-command fails.

The default for PostCommands is false, that is, the job will complete successfully even if any post-command fails.

ConnectionProfile

See ConnectionProfile:Hadoop

Host

Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host. Optionally, you can define a host group instead of a host machine. See Control-M in a nutshell.

NOTE : If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.

PreCommands and PostCommands

Allows you to define HDFS commands to perform before and after running the job. For example, you can use them for preparation and cleanup.

FailJobOnCommandFailure

This parameter is used to ignore failure in the pre- or post- commands.

The default for PreCommands is true , that is, the job will fail if any pre-command fails.

The default for PostCommands is false, that is, the job will complete successfully even if any post-command fails.

ConnectionProfile

See Sqoop ConnectionProfile:Hadoop 

Host

Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host. Optionally, you can define a host group instead of a host machine. See Control-M in a nutshell.

NOTE : If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.

PreCommands and PostCommands

Allows you to define HDFS commands to perform before and after running the job. For example, you can use them for preparation and cleanup.

FailJobOnCommandFailure

This parameter is used to ignore failure in the pre- or post- commands.

The default for PreCommands is true , that is, the job will fail if any pre-command fails.

The default for PostCommands is false, that is, the job will complete successfully even if any post-command fails.

SqoopOptions

These are passed as the specific sqoop tool args

SqoopArchives

Indicates the location of the Hadoop archives.

SqoopFiles

Indicates the location of the Sqoop files.

ConnectionProfile

See Hive ConnectionProfile:Hadoop

Host

Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host. Optionally, you can define a host group instead of a host machine. See Control-M in a nutshell.

NOTE : If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.

PreCommands and PostCommands

Allows you to define HDFS commands to perform before and after running the job. For example, you can use them for preparation and cleanup.

FailJobOnCommandFailure

This parameter is used to ignore failure in the pre- or post- commands.

The default for PreCommands is true , that is, the job will fail if any pre-command fails.

The default for PostCommands is false, that is, the job will complete successfully even if any post-command fails.

HiveSciptParameters

Passed to beeline as --hivevar “name”=”value”.

HiveProperties

Passed to beeline as --hiveconf “key”=”value”.

HiveArchives

Passed to beeline as --hiveconf mapred.cache.archives=”value”.

HiveFiles

Passed to beeline as --hiveconf mapred.cache.files=”value”.

ConnectionProfile

See ConnectionProfile:Hadoop

Host

Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host. Optionally, you can define a host group instead of a host machine.  See Control-M in a nutshell.

NOTE : If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.

ConnectionProfile

See ConnectionProfile:Hadoop

Host

Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host. Optionally, you can define a host group instead of a host machine. See Control-M in a nutshell.

NOTE : If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.

ConnectionProfile

See ConnectionProfile:Hadoop

Host

Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host. Optionally, you can define a host group instead of a host machine. See Control-M in a nutshell.

NOTE : If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.

HdfsFilePath

Specifies the full path of the file being watched.

MinDetecedSize

Defines the minimum file size in bytes to meet the criteria and finish the job as OK. If the file arrives, but the size is not met, the job continues to watch the file.

MaxWaitTime

Defines the maximum number of minutes to wait for the file to meet the watching criteria. If criteria are not met (file did not arrive, or minimum size was not reached) the job fails after this maximum number of minutes.

ConnectionProfile

See ConnectionProfile:Hadoop

Host

Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host. Optionally, you can define a host group instead of a host machine. See Control-M in a nutshell.

NOTE : If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.

JobPropertiesFile

The path to the job properties file.

PreCommands and PostCommands

Allows you to define HDFS commands to perform before and after running the job. For example, you can use them for preparation and cleanup.

FailJobOnCommandFailure

This parameter is used to ignore failure in the pre- or post- commands.

The default for PreCommands is true , that is, the job will fail if any pre-command fails.

The default for PostCommands is false , that is, the job will complete successfully even if any post-command fails.

OozieOptions

Set or override values for given job property.

ConnectionProfile

See ConnectionProfile:Hadoop  

Host

Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host. Optionally, you can define a host group instead of a host machine. See Control-M in a nutshell.

NOTE : If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.

PreCommands and PostCommands

Allows you to define HDFS commands to perform before and after running the job. For example, you can use them for preparation and cleanup.

FailJobOnCommandFailure

This parameter is used to ignore failure in the pre- or post- commands.

The default for PreCommands is true , that is, the job will fail if any pre-command fails.

The default for PostCommands is false, that is, the job will complete successfully even if any post-command fails.

ConnectionProfile

See ConnectionProfile:Hadoop

Host

Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host. Optionally, you can define a host group instead of a host machine. See Control-M in a nutshell.

NOTE : If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.

PreCommands and PostCommands

Allows you to define HDFS commands to perform before and after running the job. For example, you can use them for preparation and cleanup.

FailJobOnCommandFailure

This parameter is used to ignore failure in the pre- or post- commands.

The default for PreCommands is true , that is, the job will fail if any pre-command fails.

The default for PostCommands is false, that is, the job will complete successfully even if any post-command fails.

GeneralOptions

Additional Hadoop command options passed to the hadoop-streaming.jar, including generic options and streaming options.

ConnectionProfile

See ConnectionProfile:Hadoop

Host

Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host. Optionally, you can define a host group instead of a host machine. See Control-M in a nutshell.

NOTE : If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.

FullFilePath

The full path to the input file used as the Tajo command source

Parameters

Optional parameters for the script, expressed as name:value pairs

PreCommands and PostCommands

Allows you to define HDFS commands to perform before and after running the job. For example, you can use them for preparation and cleanup.

FailJobOnCommandFailure

This parameter is used to ignore failure in the pre- or post- commands.

The default for PreCommands is true , that is, the job will fail if any pre-command fails.

The default for PostCommands is false, that is, the job will complete successfully even if any post-command fails.

ConnectionProfile

See ConnectionProfile:Hadoop

Host

Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host. Optionally, you can define a host group instead of a host machine. See Control-M in a nutshell.

NOTE : If this parameter is left blank, the job is submitted for execution on the Control-M Scheduling Server host.

OpenQuery

An ad-hoc query to the Apache Tajo warehouse system

PreCommands and PostCommands

Allows you to define HDFS commands to perform before and after running the job. For example, you can use them for preparation and cleanup.

FailJobOnCommandFailure

This parameter is used to ignore failure in the pre- or post- commands.

The default for PreCommands is true , that is, the job will fail if any pre-command fails.

The default for PostCommands is false, that is, the job will complete successfully even if any post-command fails.

ConnectionProfile

Name of the SAP connection profile to use for the connection

SapJobName

Name of SAP job to be monitored or submitted

Exec

Type of execution target where the SAP job will run, one of the following:

• Server — an SAP application server (the default)

• Group — an SAP group

Target

The name of the SAP application server or SAP group (depending on the value specified in the previous parameter)

JobClass

Job submission priority in SAP, one of the following options:

• A — high priority 
• B — medium priority
• C — low priority

StartCondition

Specifies when the job should run, one of the following:

• ASAP — Job runs as soon as a background work process is available for it in SAP (the default). If the job cannot start immediately, it is transformed in SAP into a time-based job.
• Immediate — Job runs immediately. If there are no work processes available to run it, the job fails.
• AfterEvent — Job waits for an event that you specify (in the next two parameters) to be triggered.

AfterEvent

The name of the SAP event that the job waits for (if you set StartCondition to AfterEvent)

AfterEventParameters

Parameters in the SAP event to watch for.

Use space characters to separate multiple parameters.

RerunFromPointOfFailure

Whether to rerun the SAP R/3 job from its point of failure, either true of false (the default)

Note: If RerunFromPointOfFailure is set to false, use the CopyFromStep parameter to set a specific step from which to rerun.

CopyFromStep

The number of a specific step in the SAP R/3 job from which to rerun

The default is step 1 (that is, the beginning of the job).

Note: If RerunFromPointOfFailure is set to true, the CopyFromStep parameter is ignored.

Steps

An object that groups together the definitions of SAP R/3 job steps

StepType

The type of program to execute in this step, one of the following options:

• ABAP (the default)
• ExternalCommand
• ExternalProgram

ProgramName

The name of the program or command

UserName

The authorized owner of the step

Description

A textual description or comment for the step

Further parameters for each individual step depend on the type of program that is executed in the step. These parameters are listed in separate tables:

• Parameters for ABAP program
• Parameters for External Command or External Program

PostJobAction

This object groups together several parameters that control post-job actions for the SAP R/3 job.

Spool

How to manage spool output, one of the following options:

• DoNotCopy (the default)
• CopyToOutput
• CopyToFile

SpoolFile

The file to which to copy the job's spool output (if Spool is set to CopyToFile)

SpoolSaveToPDF

Whether to save the job's spool output in PDF format (if Spool is set to CopyToFile)

JobLog

How to manage job log output, one of the following options:

• DoNotCopy
• CopyToOutput (the default)
• CopyToFile

JobLogFile

The file to which to copy the job's log output (if JobLog is set to CopyToFile)

JobCompletionStatusWillDependOnApplicationStatus

Whether job completion status depends on SAP application status, either true or false (the default)

DetectSpawnedJob

This object groups together several parameters that you specify if you want to detect and monitor jobs that are spawned by the current SAP job

DetectAndCreate

How to determine the properties of detected spawned jobs:

• CurrentJobDefinition — Properties of detected spawned jobs are identical to the current (parent) job properties (the default)
• SpecificJobDefinition — Properties of detected spawned jobs are derived from a different job that you specify

JobName

Name of an SAP-type job to use for setting properties in spawned jobs of the current job (if DetectAndCreate is set to SpecificJobDefinition)

Note: The specified job must exist in the same folder as the current job, and the connection profile should be the same. BMC recommends that it should have the same Application and Sub Application values.

StartSpawnedJob

Whether to start spawned jobs that have a status of Scheduled (either true or false, where false is the default)

JobEndInControlMOnlyAftreChildJobsCompleteOnSap

Whether to allow the job to end in Control-M only after all child jobs complete in the SAP environment (either true or false, where false is the default)

JobCompletionStatusDependsOnChildJobsStatus

Whether Control-M should wait for all child jobs to complete (either true or false, where false is the default)

When set to true, the parent job does not end OK if any child job fails.

This parameter is relevant only if JobEndInControlMOnlyAftreChildJobsCompleteOnSap is set to true.

SpoolListRecipient

This object groups together several parameters that define recipients of Print jobs

RecipientType

Type of recipient of the print job, one of the following:

• ExternalAddress
• SapUserName (the default)
• SharedDistributionList
• PrivateDistributionList
• FaxNumber
• TelexNumber
• InternetAddress
• X400Address
• RemoteMailAddress

RecipientName

Recipient of the print job (of the type defined by the previous parameter)

RecipientCopy

Whether this recipient is a copied (CC) recipient, either true or false (the default)

RecipientBlindCopy

Whether this recipient is a blind copied (BCC) recipient, either true or false (the default)

RecipientExpress

For a CC or BCC recipient: Whether to send in express mode, either true or false (the default)

ReciptNoForwarding

For a CC or BCC recipient: Whether to set the recipient to "No Forwarding", either true or false (the default)

Language

SAP internal one-character language code for the ABAP step

For example, German is D and Serbian (using the Latin alphabet) is d.

For the full list of available language codes, see SAP Knowledge Base Article 2633548.

VariantName

The name of a variant for the specified ABAP program or Archiving Object

VariantDescription

A textual description or comment for the variant

VariantParameters

This object groups together the variables defined in the variant. For each variable, you can set the following parameters:

• Name — name of the variable
• Modify — whether to modify the variable value when the job executes, either true (the default) or false
• Type — type of variable, one of the following: Simple (the default), Selection, Range
• Value — value to set for a Simple variable or a Selection variable
• Low — lowest value in a Range variable
• High — highest value in a Range variable
• Option — operator to use in a range or selection
  For a Range: either BT (between) or NB (not between)
  For a Selection: one of the following:
  • 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
• Sign — whether to include or exclude the Range or Selection — either I (the default) or E

TemporaryVariantParameters

This object groups together the variables defined in a temporary variant.

For each variable, you can set the same parameters listed above, except for Modify (which is not supported by a temporary variant).

OutputDevice

The logical name of the designated printer

NumberOfCopies

Number of copies to be printed

The default is 1.

PrintArchiveMode

Whether the spool of the step is printed to an output device, to the archive, or both.

Choose from the following available values:

• Print (the default)
• Archive
• PrintAndArchive

TimeToPrint

When to print the job output, one of the following options:

• PrintLater
• PrintImmediately
• SendToSAPSpooler (the default)

PrintExpiration

Number of days until a print job expires

Valid values are single-digit numbers:

• 1–8 days
• 9 — no expiration

The default is 8 days.

NewSpoolRequest

Whether to request a new spool, either true (the default) or false

DeleteAfterPrint

Whether to delete the report after printing, either true or false (the default)

OutputLayout

Print layout format

OutputNumberRows

(Mandatory) Maximum number of rows per page

Valid values:

• Any integer between 1 and 90
• -1 — use ABAP program default (the default)

OutputNumberColumns

(Mandatory) Maximum number of characters in an output line

Valid values:

• Any integer between 1 and 255
• -1 — use ABAP program default (the default)

CoverRecipient

Name of the recipient of the job output on the cover sheet

The name can be up to 12 characters.

CoverDepartment

Name of the spool department on the cover sheet

The department name can be up to 12 characters.

CoverPage

Type of cover page for output, one of the following options:

• DefaultSetting — use the default setting from SAP (the default)
• Print — print the cover page
• DoNotPrint — do not print the cover page

CoverSheet

Type of cover sheet for output, one of the following options:

• DefaultSetting — use the default setting from SAP (the default)
• Print — print the cover page
• DoNotPrint — do not print the cover page

CoverPrintPage

Whether to use a cover page, either true or false

The default is false.

SpoolListName

Name of the spool list

The name can be up to 12 characters.

SpoolListTitles

The spool list titles

SpoolAuthorization

Name of a user with print authorization

The name can be up to 12 characters.

ArchiveId

SAP ArchiveLink Storage system ID

Values are two carachters long. The default is ZZ.

Note that Archive parameters are relevant only when you set PrintArchiveMode to Archive or PrintAndArchive.

ArchiveText

Free text description of the archive location, up to 40 characters

ArchiveObjectType

Archive object type

Valid values are up to 10 characters.

ArchiveDocumentType

Archive object document type

Valid values are up to 10 characters.

ArchiveInformationField

Archive information

Values can be 1–3 characters.

TargetHost

Host computer on which the program or command runs

OperatingSystem

Operating system on which the external command runs

The default is ANYOS.

WaitExternalTermination

Whether SAP waits for the external program or external command to end before starting the next step, or before exiting.

Values are either true (the default) or false.

LogExternalOutput

Whether SAP logs external output in the joblog

Values are either true (the default) or false.

LogExternalErrors

Whether SAP logs external errors in the joblog

Values are either true (the default) or false.

ActiveTrace

Whether SAP activates traces for the external program or external command

Values are either true or false (the default).

ConnectionProfile

Name of the SAP connection profile to use for the connection

SapJobName

Name of SAP job to copy

Exec

Type of execution target where the SAP job will run, one of the following:

• Server — an SAP application server (the default)

• Group — an SAP group

Target

The name of the SAP application server or SAP group (depending on the value specified in the previous parameter)

JobCount

How to define a unique ID number for the SAP job, one of the following options:

• FirstScheduled (the default)
• LastScheduled
• First
• Last
• SpecificJob

If you specify SpecificJob, you must provide the next parameter.

JobCountSpecificName

A unique SAP job ID number for a specific job (that is, for when JobCount is set to SpecificJob)

NewJobName

Name of the newly created job

StartCondition

Specifies when the job should run, one of the following:

• ASAP — Job runs as soon as a background work process is available for it in SAP (the default). If the job cannot start immediately, it is transformed in SAP into a time-based job.
• Immediate — Job runs immediately. If there are no work processes available to run it, the job fails.
• AfterEvent — Job waits for an event that you specify (in the next two parameters) to be triggered.

AfterEvent

The name of the SAP event that the job waits for (if you set StartCondition to AfterEvent)

AfterEventParameters

Parameters in the SAP event to watch for.

Use space characters to separate multiple parameters.

RerunFromPointOfFailure

Whether to rerun the SAP R/3 job from its point of failure, either true of false (the default)

Note: If RerunFromPointOfFailure is set to false, use the CopyFromStep parameter to set a specific step from which to rerun.

CopyFromStep

The number of a specific step in the SAP R/3 job from which to rerun or copy

The default is step 1 (that is, the beginning of the job).

Note: If RerunFromPointOfFailure is set to true, the CopyFromStep parameter is ignored.

PostJobAction

This object groups together several parameters that control post-job actions for the SAP R/3 job.

Spool

How to manage spool output, one of the following options:

• DoNotCopy (the default)
• CopyToOutput
• CopyToFile

SpoolFile

The file to which to copy the job's spool output (if Spool is set to CopyToFile)

SpoolSaveToPDF

Whether to save the job's spool output in PDF format (if Spool is set to CopyToFile)

JobLog

How to manage job log output, one of the following options:

• DoNotCopy
• CopyToOutput (the default)
• CopyToFile

JobLogFile

The file to which to copy the job's log output (if JobLog is set to CopyToFile)

JobCompletionStatusWillDependOnApplicationStatus

Whether job completion status depends on SAP application status, either true or false (the default)

DetectSpawnedJob

This object groups together several parameters that you specify if you want to detect and monitor jobs that are spawned by the current SAP job

DetectAndCreate

How to determine the properties of detected spawned jobs:

• CurrentJobDefinition — Properties of detected spawned jobs are identical to the current (parent) job properties (the default)
• SpecificJobDefinition — Properties of detected spawned jobs are derived from a different job that you specify

JobName

Name of an SAP-type job to use for setting properties in spawned jobs of the current job (if DetectAndCreate is set to SpecificJobDefinition)

Note: The specified job must exist in the same folder as the current job, and the connection profile should be the same. BMC recommends that it should have the same Application and Sub Application values.

StartSpawnedJob

Whether to start spawned jobs that have a status of Scheduled (either true or false, where false is the default)

JobEndInControlMOnlyAftreChildJobsCompleteOnSap

Whether to allow the job to end in Control-M only after all child jobs complete in the SAP environment (either true or false, where false is the default)

JobCompletionStatusDependsOnChildJobsStatus

Whether Control-M should wait for all child jobs to complete (either true or false, where false is the default)

When set to true, the parent job does not end OK if any child job fails.

This parameter is relevant only if JobEndInControlMOnlyAftreChildJobsCompleteOnSap is set to true.

ConnectionProfile

Name of the PeopleSoft connection profil e to use for the connection

User

A PeopleSoft user ID that exists in the PeopleSoft Environment

ControlId

Run Control ID for access to run controls at runtime

ServerName

The name of the server on which to run the PeopleSoft job or process

ProcessType

A PeopleSoft process type that the user is authorized to perform

ProcessName

The name of the PeopleSoft process to run

AppendToOutput

Whether to include PeopleSoft job output in the Control-M job output, either true or false

The default is false.

BindVariables

Values of up to 20 USERDEF variables for sharing data between Control-M and the PeopleSoft job or process

ConnectionProfile

Name of the Informatica connection profile to use for the connection

RepositoryFolder

The Repository folder that contains the workflow that you want to run

Workflow

The workflow that you want to run in Control-M for Informatica

InstanceName

(Optional) The specific instance of the workflow that you want to run

OsProfile

(Optional) The operating system profile in Informatica

WorkflowExecutionMode

The mode for executing the workflow, one of the following:

• RunWholeWorkflow — run the whole workflow
• StartFromTask — start running the workflow from a specific task, as specified by the StartFromTask parameter
• RunSingleTask — run a single task in the workflow, as specified by the RunSingleTask parameter

  StartFromTask

The task from which to start running the workflow

This parameter is required only if you set WorkflowExecutionMode to StartFromTask.

  RunSingleTask

The workflow task that you want to run

This parameter is required only if you set WorkflowExecutionMode to RunSingleTask.

Depth

The number of levels within the workflow task hierarchy for the selection of workflow tasks

Default: 10 levels

EnableOutput

Whether to include the workflow events log in the job output (either true or false)

Default: true

EnableErrorDetails

Whether to include a detailed error log for a workflow that failed (either true or false)

Default: true

WorkflowRestartMode

The operation to execute when the workflow is in a suspended satus, one of the following:

• Recover — recover the suspended workflow
• ForceRestart — force a restart of the suspended workflow
• ForceRestartFromSpecificTask — force a restart of the suspended workflow from a specific task, as specified by the RestartFromTask parameter

  RestartFromTask

The task from which to restart a suspended workflow

This parameter is required only if you set WorkflowRestartMode to ForceRestartFromSpecificTask

WorkflowParametersFile

(Optional) The path and name of the workflow parameters file

This enables you to use the same workflow for different actions.

StateMachine

The State Machine to use

ExecutionName

A name for the execution

Input

The Step Function input in JSON format

Escape all special characters.

AppendLog

Whether to add the log to the job’s output, either true (the default) or false

JobName

The name of the batch job

JobDefinition

The job definition to use

JobDefinitionRevision

The job definition revision

JobQueue

The queue to which the job is submitted

AWSJobType

The type of job, either Array or Single

ArraySize

(For a job of type Array) The size of the array (that is, the number of items in the array)

Valid values: 2–10000

DependsOn

Parameters that determine a job dependency

    DependencyType

(For a job of type Array) Type of dependency, one of the following values:

• Standard
• Sequential
• N-to-N

   JobDependsOn

The JobID upon which the Batch job depends

This parameter is mandatory for a Standard or N-to-N dependency, and optional for a Sequential dependency.

Command

A command to send to the container that overrides the default command from the Docker image or the job definition

Memory

The number of megabytes of memory reserved for the job

Minimum value: 4 megabytes

vCPUs

The number of vCPUs to reserve for the container

JobAttempts

The number of retry attempts

Valid values: 1–10

ExecutionTimeout

The timeout duration in seconds

AppendLog

Whether to add the log to the job’s output, either true (the default) or false

LogicAppName

The name of the Azure Logic App

RequestBody

(Optional) The JSON for the expected payload

AppendLog

(Optional) Whether to add the log to the job’s output, either true (the default) or false

JobId

The ID of the batch job

CommandLine

A command line that the batch job runs

AppendLog

(Optional) Whether to add the log to the job’s output, either true (the default) or false

Wallclock

(Optional) Maximum limit for the job's run time

If you do not include this parameter, the default is unlimited run time.

Use this parameter to set a custom time limit. Include the following next-level parameters:

• Time — number (of the specified time unit), 0 or higher
• Unit — time unit, one of the following: Seconds, Minutes, Hours, Days

MaxTries

(Optional) The number of times to retry running a failed task

If you do not include this parameter, the default is none (no retries).

Use this parameter to choose between the following options:

• Unlimited number of retries. For this option, include the following next-level parameter:
  "Option": "Unlimited"
• Custom number of retries, 1 or higher. For this option, include the following next-level parameters:
  • "Count": number
  • "Option": "Custom"

Retention

(Optional) File retention period for the batch job

If you do not include this parameter, the default is an unlimited retention period.

Use this parameter to set a custom time limit for retention. Include the following next-level parameters:

• Time — number (of the specified time unit), 0 or higher
• Unit — time unit, one of the following: Seconds, Minutes, Hours, Days

ServiceName

A logical name, from a user or business perspective, for the critical service. BMC recommends that the service name be unique.

Names can contain up to 64 alphanumeric characters.

ServicePriority

The priority level of this service, from a user or business perspective.

Values range from 1 (highest priority) to 5 (lowest priority).

Default: 3

CreatedBy

The Control‑M/EM user who defined the job.

RunAs

The operating system user that will run the job.

JobRunsDeviationsTolerance

Extent of tolerated deviation from the average completion time for a job in the service, expressed as a number of standard deviations based on percentile ranges.

If the run time falls within the tolerance set, it is considered on time, otherwise it has run too long or ended too early.

Select one of the following values:

• 2 — 95.5% (highest confidence in the completion time)
• 3 — 99.73%
• 4 — 99.99% (lowest confidence)

Note: The JobRunsDeviationsTolerance parameter and the AverageRunTimeTolerance parameter are mutually exclusive. Specify only one of these two parameters.

AverageRunTimeTolerance

CompleteBy

CompleteIn

ServiceActions

Defines automatic interventions (actions, such as rerunning a job or extending the service due time) in response to specific occurrences (If statements, such as a job finished too quickly or a service finished late).

For more information, see Service Actions.