...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
chainDesc | Chain Description | If |
| N |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
chainId | Chain ID | If
|
| Y |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commandGroup | Command Group | Universal Connector command group. | Valid values: | N |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | commandOptions - SAP | commandOptions - SAP | SAP Command Options | Any additional command options supported by Universal Connector. |
| N |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | dataSource - SAP | dataSource - SAP | Data Source | If |
| N |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | defFile - SAP | defFile - SAP | Definition File | For Run, Submit, and Modify |
| Y |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | definitionOrModel - SAP | definitionOrModel - SAP | Definition or Model | If | N |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | definitionOrModelJobVar - SAP | definitionOrModelJobVar - SAP | Definition or Model | If | N |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | dispAbapName - SAP | dispAbapName - SAP | SAP ABAP Program Name | If |
| Y |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | dispSapEventId - SAP | dispSapEventId - SAP | SAP Event | If |
| Y |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | dispSapEventParm - SAP | dispSapEventParm - SAP | SAP Event Parameter | If |
| N |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | dispVariant - SAP | dispVariant - SAP | SAP Variant Name | Pre-existing SAP variant name to use as the model variant. |
| N |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | environment - SAP | environment - SAP | Environment Variables | List of environment variables needed by the program to run: Panel |
| N |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commandOptions | SAP Command Options | Any additional command options supported by Universal Connector. |
| N |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
exitCodeOutput dataSource | Output File Data Source | If |
| N |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
defFile | Definition File | For Run, Submit, and Modify |
| N Y |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
exitCodeProcessing | Exit Code Processing | Specification for how the Controller should determine whether the executed command failed or completed successfully | Definition or Model | If | Valid values: Default is Success Exitcode Range (1). | N |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | exitCodes - SAP | exitCodes - SAP | Exit Codes | If | Format: Numeric. Use commas to list a series of exit codes; use hyphens to specify a range. Example: 1,5, 22-30. | Y |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | exitCodeText - SAP | exitCodeText - SAP | Scan Output For | If | The Controller will process this field as a regular expression. | Y |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | immediate- SAP | immediate- SAP | Start Immediately | If | Boolean; Valid values: true/false. Default is false
Default is USAP Definition File (1). | N |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
definitionOrModelJobVar | Definition or Model | If | Valid values:
Default is USAP Definition File (1). | N |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
infoPackage InfoPackage dispAbapName | SAP ABAP Program Name | If sapDisplayCommand equals InfoPackages (24)an ABAP program in an SAP system to which the model variant belongs. |
| Y |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
infoPackageJobname InfoPackage Job Name dispSapEventId | SAP Event | If
|
| Y |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
infoSource dispSapEventParm | InfoSource SAP Event Parameter | If |
| N |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
jobId dispVariant | SAP Job ID | Job ID of the SAP job. | Variables are supported. Variant Name | Pre-existing SAP variant name to use as the model variant. |
| N |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
jobLog | Print Job Log | If | Boolean; Valid values: true/false. Default is false. | N |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | jobName - SAP | jobName - SAP | SAP Job Name | Job name of the SAP job. | Variables are supported. | N |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | jobStatus - SAP | jobStatus - SAP | Status | If |
| N |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | logId - SAP | logId - SAP | Log ID | If
|
| Y |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | outputFailureOnly - SAP | outputFailureOnly - SAP | Failure Only | If | Boolean; Valid values: true/false. Default is false. | Environment Variables | List of environment variables needed by the program to run:
|
| N |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
outputReturnFile exitCodeOutput | Output File | If |
| Y N |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
outputReturnNline | Number of Lines | If | Integer; Default is the value of the Retrieve Output Default Maximum Lines Universal Controller system property. | N |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | outputReturnSline - SAP | outputReturnSline - SAP | Starting Line | If | Integer; Default is 1. | N |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | outputReturnText - SAP | outputReturnText - SAP | Scan Text | If | The Controller will process this field as a regular expression. | N |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | outputReturnType - SAP | outputReturnType - SAP | Automatic Output Retrieval | Specification for whether you want the Controller to automatically retrieve any output from the job and attach it to the task instance record. |
Note | ||
---|---|---|
| ||
If |
N
outputType
Output Type
If exitCodeProcessing
= Success Output Contains (3) or Failure Output Contains (4); Type of output.
Valid values:
Default is STDOUT (1).
Y
pcRestart
Restart
If commandGroup
equals Start Process Chain (18); Specification for whether or not to restart failed and cancelled processes (R or X) in the specified process chain instance.
Boolean. Valid values: true/false. Default is false.
N
printAppLog
Print Application Log
If commandGroup
is Run (1) or Wait (5), or wait
is true; Specification for whether or not the job's application log, if one was generated, is returned.
Boolean. Valid values: true/false. Default is false.
N
printAppRc
Print Application RC
If commandGroup
is Run (1) or Wait (5) or wait
is true; Specification for whether or not the job's application return codes, if they were set, are returned.
Boolean. Valid values: true/false. Default is false.
N
Anchor
purge
Delete SAP Job on Completion exitCodeProcessing
Exit Code Processing
Specification for how the Controller should determine whether the executed command failed or completed successfully.
Valid values:
Html bobswift |
---|
<ul>
<li> As String = Success Exitcode Range, As Value = 1
<li> As String = Failure Exitcode Range, As Value = 2
<li> As String = Success Output Contains, As Value = 3
<li> As String = Failure Output Contains, As Value = 4
<li> As String = Step Conditions, As Value = 5
</ul> |
Default is Success Exitcode Range (1).
N
Anchor | ||||
---|---|---|---|---|
|
exitCodes
Exit Codes
If exitCodeProcessing
= Success Exitcode Range (1) or Failure Exitcode Range (2); Range of exit codes.
Format: Numeric. Use commas to list a series of exit codes; use hyphens to specify a range. Example: 1,5, 22-30.
Y
Anchor | ||||
---|---|---|---|---|
|
exitCodeText
Scan Output For
If exitCodeProcessing
= Success Output Contains (3) or Failure Output Contains (4); text for which the Controller should scan the output file.
The Controller will process this field as a regular expression.
Y
Anchor | ||||
---|---|---|---|---|
|
immediate
Start Immediately
If commandGroup
is Run(1) or Start(4), or start
is true; Causes the job to fail if SAP resources are not available to start the job immediately (for example, a background work process). Otherwise, the job will wait for SAP resources to become available.
Boolean; Valid values: true/false. Default is false.
N
Anchor | ||||
---|---|---|---|---|
|
infoPackage
InfoPackage
If commandGroup
is one of the following; Name of the InfoPackage:
- Run InfoPackage (22)
- Start InfoPackage(23)
- Display(9) and
sapDisplayCommand
equals InfoPackages (24).
Y
Anchor | ||||
---|---|---|---|---|
|
infoPackageJobname
InfoPackage Job Name
If commandGroup
is one of the following; Name of the SAP batch job that processes the InfoPackage request:
- Run InfoPackage (22)
- Start InfoPackage (23)
Y
Anchor | ||||
---|---|---|---|---|
|
infoSource
InfoSource
If sapDisplayCommand
equals InfoPackages (24); SAP InfoSource.
N
Anchor | ||||
---|---|---|---|---|
|
jobId
SAP Job ID
Job ID of the SAP job.
Variables are supported.
N
Anchor | ||||
---|---|---|---|---|
|
jobLog
Print Job Log
If commandGroup
is Wait (5) or wait
is true; Specification for whether or not the job's joblog is returned.
Boolean. ; Valid values: true/false. Default is false.
N
Anchor | ||||
---|---|---|---|---|
|
repositoryOrFilesys
Script or File System
Specification for whether the USAP definition file exists in the file system of the machine where the Agent is running or in Scripts.
Valid values:
Default is Script (1)jobName
SAP Job Name
Job name of the SAP job.
Variables are supported.
N
Anchor | ||||
---|---|---|---|---|
|
requestId
jobStatus
Request ID Status
If commandGroup
is Wait InfoPackage(24) or Display(9) and sapDisplayCommand
is InfoPackages Status (25); Request ID of the InfoPackage that is to be monitored sapDisplayCommand
equals InfoPackages(24); Current status for an SAP job.
Y N
Anchor | ||||
---|---|---|---|---|
|
retryIndefinitely
logId
Retry Indefinitely
Specification for whether or not the Controller should continue trying indefinitely to run this task.
Boolean; Valid values: true/false. Default is false. This value overrides any value placed in retryMaximum
.
N Log ID
If commandGroup
is one of the following; Log ID for process chain instance to be restarted:
- Start Process Chain and
pcRestart
is true. - Wait Process Chain.
- Display (9) and
sapDisplayCommand
is Process Chain (20), Process Chain Log (21), or Process Chain Status (23).
Y
Anchor | ||||
---|---|---|---|---|
|
retryInterval
Retry Interval]
Number of seconds between each retry.
Integer; Default is 60outputFailureOnly
Failure Only
If outputReturnType
= STDOUT (2), STDERR (3), FILE (4), or OUTERR (6), and waitForOutput
is false; Indication for whether output should be retrieved on task failure only.
Boolean; Valid values: true/false. Default is false.
N
Anchor | ||||
---|---|---|---|---|
|
retryMaximum
outputReturnFile
Maximum Retries
Maximum number of times that the Controller should retry this task after it has started and gone to a failed state.
Integer; Default is 0.
N Output File
If outputReturnType
is FILE (4); Path and file name containing the output that you want automatically retrieved and attached to the task instance.
Y
Anchor | ||||
---|---|---|---|---|
|
retrySuppressFailure
Suppress Intermediate Failures
Specification for whether or not the following will be suppressed until all scheduled retry attempts have been made:
- All Actions (Abort, Email Notification, Set Variable, SNMP Notification, and System Operation) to be made against the task instance.
- Workflow conditional path processing; any Successors waiting on a failure path will not be released.
- Task Monitors will not be notified of the Failed status. Also, any Task Monitor task that has a Time Scope in the past will disqualify any matching task instance in the past with a Failed status if the task instance is scheduled for automatic retry and for which Suppress Intermediate Failures has been enabled.
- Any Workflow containing the Failed task instance will not transition to the Running/Problems status.
Boolean; Valid values: true/false. Default is false. outputReturnNline
Number of Lines
If outputReturnType
is STDOUT (2), STDERR (3), FILE (4), or OUTERR (6); Allows you to limit the retrieved data to the number of lines specified.
Integer; Default is the value of the Retrieve Output Default Maximum Lines Universal Controller system property.
N
Anchor | ||||
---|---|---|---|---|
|
outputReturnSline
Starting Line
If outputReturnType
is STDOUT (2), STDERR (3), FILE (4), or OUTERR (6); Allows you to instruct the Controller to retrieve data beginning at this line.
Integer; Default is 1.
N
Anchor | ||||
---|---|---|---|---|
|
runtimeDir
Runtime Directory
Directory from which the application should be executed. Variables are supported.
N
sapCmProfileId
SAP Criteria Manager Profile ID
If commandGroup
is Set CM Profile, Activate CM Profile, or Delete CM Profile; ID of the profile.
Y outputReturnText
Scan Text
If outputReturnType
is STDOUT (2), STDERR (3), FILE (4), or OUTERR (6); Instructs the Controller to scan the data for the text specified and retrieve only that.
The Controller will process this field as a regular expression.
N
sapCmXmlFile
SAP Criteria Manager XML File
If commandGroup
is Create CM Profile or Set CM Profile, and repositoryOrFilesys
is File System; Name of the file that contains the Criteria Manager information.
Y
sapCommandMask
SAP Command Mask
Name of a command or a mask used to select SAP external commands that match the mask.
N
sapConnection
SAP Connection
Name of the SAP connection.
The SAP connection specifies information about the SAP server.
Y
(unless {{sap
ConnectionVar}}
is specified)
sapConnectionVar
sapConnectionVar
SAP Connection Variable
Name of a variable that will be resolved at run time to the name of the SAP Connection to use.
Y
(unless {{sap
Connection}}
is specified)
sapConnection
sapCred
SAP Credentials
Login credentials that the Controller will use to access the SAP system.
The credentials are stored in the Universal Controller credentials table; see Credentials.
Y
(unless sapCredVar
is specified)
sapCredVar
sapCredVar
SAP Credentials Variable
Name of a variable that will be resolved at run time to the name of the SAP Credentials to use.
Y
(unless sapCred
is specified)
sapCred
sapDispConfirmEvents
Confirm Returned Events
If sapDisplayCommand
is Event History(16); Specification for whether or not the status of returned events should be changed in the SAP system.
N
sapDispEventSelectState
Event Select State
Event status of the events which should be read.
Valid values:
Default is New (1).
N
sapDisplayCommand
Display Command
Displays the specified data, which is written to standard output.
Valid values:
Anchor | ||||
---|---|---|---|---|
|
sapCmProfileType
SAP Criteria Manager Profile Type
If commandGroup
is Set CM Profile, Activate CM Profile, Deactivate CM Profile, or Delete CM Profile; Type of profile. For the default criteria types provided by SAP, the values are:
- EVTHIS - Identifies a criteria type for event history.
- EVHIRO - Identifies a criteria type for the reorganization of raised events.
- INTERC - Identifies a criteria type for job interception.
Y
outputReturnType
Automatic Output Retrieval
Specification for whether you want the Controller to automatically retrieve any output from the job and attach it to the task instance record.
Valid values:
Html bobswift |
---|
<ul>
<li> As String = NONE, As Value = 1
<li> As String = STDOUT, As Value = 2
<li> As String = STDERR, As Value = 3
<li> As String = FILE, As Value = 4
<li> As String = OUTERR, As Value = 6
</ul> |
Default is NONE (1).
Note | ||
---|---|---|
| ||
If |
N
Anchor | ||||
---|---|---|---|---|
|
outputType
Output Type
If exitCodeProcessing
= Success Output Contains (3) or Failure Output Contains (4); Type of output.
Valid values:
Html bobswift |
---|
<ul>
<li> As String = STDOUT, As Value = 1
<li> As String = STDERR, As Value = 2
<li> As String = FILE, As Value = 3
</ul> |
Default is STDOUT (1).
Y
Anchor | ||||
---|---|---|---|---|
|
pcRestart
Restart
If commandGroup
equals Start Process Chain (18); Specification for whether or not to restart failed and cancelled processes (R or X) in the specified process chain instance.
Boolean. Valid values: true/false. Default is false.
N
Anchor | ||||
---|---|---|---|---|
|
printAppLog
Print Application Log
If commandGroup
is Run (1) or Wait (5), or wait
is true; Specification for whether or not the job's application log, if one was generated, is returned.
Boolean. Valid values: true/false. Default is false.
N
Anchor | ||||
---|---|---|---|---|
|
printAppRc
Print Application RC
If commandGroup
is Run (1) or Wait (5) or wait
is true; Specification for whether or not the job's application return codes, if they were set, are returned.
Boolean. Valid values: true/false. Default is false.
N
Anchor | ||||
---|---|---|---|---|
|
purge
Delete SAP Job on Completion
If commandGroup
is Wait(5) or wait
is true;
Boolean. Valid values: true/false. Default is false.
N
Anchor | ||||
---|---|---|---|---|
|
repositoryOrFilesys
Script or File System
Specification for whether the USAP definition file exists in the file system of the machine where the Agent is running or in Scripts.
Valid values:
Html bobswift |
---|
<ul>
<li> As String = Script, As Value = 1
<li> As String = File System, As Value = 2
</ul> |
Default is Script (1).
N
Anchor | ||||
---|---|---|---|---|
|
requestId
Request ID
If commandGroup
is Wait InfoPackage(24) or Display(9) and sapDisplayCommand
is InfoPackages Status (25); Request ID of the InfoPackage that is to be monitored.
Y
Anchor | ||||
---|---|---|---|---|
|
retryIndefinitely
Retry Indefinitely
Specification for whether or not the Controller should continue trying indefinitely to run this task.
Boolean; Valid values: true/false. Default is false. This value overrides any value placed in retryMaximum
.
N
Anchor | ||||
---|---|---|---|---|
|
retryInterval
Retry Interval]
Number of seconds between each retry.
Integer; Default is 60.
N
Anchor | ||||
---|---|---|---|---|
|
retryMaximum
Maximum Retries
Maximum number of times that the Controller should retry this task after it has started and gone to a failed state.
Integer; Default is 0.
N
Anchor | ||||
---|---|---|---|---|
|
retrySuppressFailure
Suppress Intermediate Failures
Specification for whether or not the following will be suppressed until all scheduled retry attempts have been made:
- All Actions (Abort, Email Notification, Set Variable, SNMP Notification, and System Operation) to be made against the task instance.
- Workflow conditional path processing; any Successors waiting on a failure path will not be released.
- Task Monitors will not be notified of the Failed status. Also, any Task Monitor task that has a Time Scope in the past will disqualify any matching task instance in the past with a Failed status if the task instance is scheduled for automatic retry and for which Suppress Intermediate Failures has been enabled.
- Any Workflow containing the Failed task instance will not transition to the Running/Problems status.
Boolean; Valid values: true/false. Default is false.
N
Anchor | ||||
---|---|---|---|---|
|
runtimeDir
Runtime Directory
Directory from which the application should be executed. Variables are supported.
N
Anchor | ||||
---|---|---|---|---|
|
sapCmProfileId
SAP Criteria Manager Profile ID
If commandGroup
is Set CM Profile, Activate CM Profile, or Delete CM Profile; ID of the profile.
Y
Anchor | ||||
---|---|---|---|---|
|
sapCmProfileType
SAP Criteria Manager Profile Type
If commandGroup
is Set CM Profile, Activate CM Profile, Deactivate CM Profile, or Delete CM Profile; Type of profile. For the default criteria types provided by SAP, the values are:
- EVTHIS - Identifies a criteria type for event history.
- EVHIRO - Identifies a criteria type for the reorganization of raised events.
- INTERC - Identifies a criteria type for job interception.
Y
Anchor | ||||
---|---|---|---|---|
|
sapCmXmlFile
SAP Criteria Manager XML File
If commandGroup
is Create CM Profile or Set CM Profile, and repositoryOrFilesys
is File System; Name of the file that contains the Criteria Manager information.
Y
Anchor | ||||
---|---|---|---|---|
|
sapCommandMask
SAP Command Mask
Name of a command or a mask used to select SAP external commands that match the mask.
N
Anchor | ||||
---|---|---|---|---|
|
sapConnection
SAP Connection
Name of the SAP connection.
The SAP connection specifies information about the SAP server.
Y
(unless {{sap
ConnectionVar}}
is specified)
sapConnectionVar
Anchor | ||||
---|---|---|---|---|
|
sapConnectionVar
SAP Connection Variable
Name of a variable that will be resolved at run time to the name of the SAP Connection to use.
Y
(unless {{sap
Connection}}
is specified)
sapConnection
Anchor | ||||
---|---|---|---|---|
|
sapCred
SAP Credentials
Login credentials that the Controller will use to access the SAP system.
The credentials are stored in the Universal Controller credentials table; see Credentials.
Y
(unless sapCredVar
is specified)
sapCredVar
Anchor | ||||
---|---|---|---|---|
|
sapCredVar
SAP Credentials Variable
Name of a variable that will be resolved at run time to the name of the SAP Credentials to use.
Y
(unless sapCred
is specified)
sapCred
Anchor | ||||
---|---|---|---|---|
|
sapDispConfirmEvents
Confirm Returned Events
If sapDisplayCommand
is Event History(16); Specification for whether or not the status of returned events should be changed in the SAP system.
N
Anchor | ||||
---|---|---|---|---|
|
sapDispEventSelectState
Event Select State
Event status of the events which should be read.
Valid values:
Html bobswift |
---|
<ul>
<li> As String = New, As Value = 1
<li> As String = Confirmed, As Value = 2
<li> As String = All, As Value = 3
</ul> |
Default is New (1).
N
Anchor | ||||
---|---|---|---|---|
|
sapDisplayCommand
Display Command
Displays the specified data, which is written to standard output.
Valid values:
Html bobswift |
---|
<ul>
<li> As String = Job Log, As Value = 1
<li> As String = Spool List, As Value = 2
<li> As String = Status, As Value = 3
<li> As String = Variants, As Value = 4
<li> As String = Variant, As Value = 5
<li> As String = Job Definition, As Value = 6
<li> As String = Select, As Value = 7
<li> As String = System Log, As Value = 8
<li> As String = Intercept Table, As Value = 9
<li> As String = Intercepted Jobs, As Value = 10
<li> As String = Reports, As Value = 11
<li> As String = Commands, As Value = 12
<li> As String = Output Devices, As Value = 13
<li> As String = Print Formats, As Value = 14
<li> As String = Selection Screen, As Value = 15
<li> As String = Event History, As Value = 16
<li> As String = Criteria Manager Profiles, As Value = 17
<li> As String = Criteria Manager Criteria, As Value = 18
<li> As String = Process Chains, As Value = 19
<li> As String = Process Chain, As Value = 20
<li> As String = Process Chain Log, As Value = 21
<li> As String = Process Chain Start Condition, As Value = 22
<li> As String = Process Chain Status, As Value = 23
<li> As String = InfoPackages, As Value = 24
<li> As String = InfoPackages Status, As Value = 25
</ul> |
Default Value: Log (1)
N
Anchor | ||||
---|---|---|---|---|
|
sapEventId
SAP Event
If commandGroup
is Raise Event (8); Name of the event.
Y
Anchor | ||||
---|---|---|---|---|
|
sapEventParm
SAP Event Parameter
If commandGroup
equals Raise Event(8); Optional parameter value for the event.
N
Anchor | ||||
---|---|---|---|---|
|
sapFromDate
From Date
If sapDisplayCommand
is Select (7) or System Log (8); Earliest date to use for job selection or syslog request.
N
Anchor | ||||
---|---|---|---|---|
|
sapLang
SAP Language
SAP logon language used when executing the SAP task.
Valid values:
- Any valid 1-character SAP language identifier.
- Any valid 2-character ISO language identifier.
- (no value). SAP will use the default language set up for the user. If there is no such default, the default is EN (English).
Anchor | ||||
---|---|---|---|---|
|
sapPrinterName
SAP Printer Name
If sapDisplayCommand
is Print Formats (14); Name of the SAP printer.
Y
Anchor | ||||
---|---|---|---|---|
|
sapToDate
To Date
If sapDisplayCommand
is Select(7) or System Log (8); Latest date to use for job selection or syslog request.
N
Anchor | ||||
---|---|---|---|---|
|
script
Script
If repositoryOrFilesys
is Script; Name of an SAP Definition script in the Controller database.
Y
Anchor | ||||
---|---|---|---|---|
|
sourceSystem
Source System
If sapDisplayCommand
equals InfoPackages (24); SAP InfoPackage source system.
N
Anchor | ||||
---|---|---|---|---|
|
spoollist
Print Spooled Output
If commandGroup
is Wait(5) or wait
is true; Specification for whether or not the spoollists of all job steps are returned.
Boolean; Valid values: true/false. Default is false.
N
Anchor | ||||
---|---|---|---|---|
|
start
Start
Specification for whether or not the newly-defined SAP job should be started.
Boolean; Valid values: true/false. Default is false.
N
Anchor | ||||
---|---|---|---|---|
|
stepNum
SAP Job Step Number
If sapDisplayCommand
is Spool List; Step number of the SAP job step.
Y
Anchor | ||||
---|---|---|---|---|
|
targetJobName
Target Job Name
If commandGroup
equals Run or Submit and definitionOrModel
is SAP Model Job (2); Name of the new SAP job being created.
If you do not include targetJobName
, the Controller uses the same name as the SAP Model Job.
N
Anchor | ||||
---|---|---|---|---|
|
targetServer
SAP Target Server
If commandGroup
is Run (1) or Start (4), or start
is true; Name of an SAP instance at which a background job should be run.
The name has the following format:
Panel | ||
---|---|---|
|
Where host name is the name of the server computer on which the instance is running, as specified in the system profile parameter SAPLOCALHOST. For example:
Panel | ||
---|---|---|
|
N
Anchor | ||||
---|---|---|---|---|
|
targetVariantName
Target Variant Name
If commandGroup
is Submit and definitionOrModelJobVar
is SAP Model Variant (3); One or more replacement variants for ABAP program job steps in an SAP job.
Y
Anchor | ||||
---|---|---|---|---|
|
useAppRc
Use Application RC
If commandGroup
is Run (1) or Wait(5), or wait
is true; Specification for whether or not the SAP job's application return codes will be used to determine the return code for the Universal Controller task.
Boolean; Valid values: true/false. Default is false.
N
Anchor | ||||
---|---|---|---|---|
|
wait
Wait
Specification for whether or not the Controller should wait for the SAP process chain to complete processing.
Boolean; Valid values: true/false. Default is false.
N
Anchor | ||||
---|---|---|---|---|
|
waitForOutput
Wait For Output
If outputReturnType
= STDOUT (2), STDERR (3), FILE (4), or OUTERR (6), and outputFailureOnly
is false; Specification for whether or not the task should wait for the requested output before completing.
Boolean; Valid values: true/false. Default is false.
N