| | | | | |
|---|
chainDesc
| Chain Description | If sapDisplayCommand equals Process Chains (19); Displays the list of processes contained within the specified process chain. | | N | |
chainId
| Chain ID | If commandGroup is one of the following; ID of the process chain to run: Run Process Chain Start Process Chain Wait Process Chain Interrupt Process Chain Display and sapDisplayCommand is Process Chains (19), Process Chain (20), Process Chain Log (21), Process Chain Start Condition (22), or Process Chain Status (23)
| | Y | |
commandGroup
| Command Group | Universal Connector command group. | Valid values: As String = Run, As Value = 1 As String = Submit, As Value = 2 As String = Modify, As Value = 3 As String = Start, As Value = 4 As String = Wait, As Value = 5 As String = Abort, As Value = 6 As String = Purge Job, As Value = 7 As String = Raise Event, As Value = 8 As String = Display, As Value = 9 As String = Generate Variant Definition, As Value = 10 As String = Generate Job Definition, As Value = 11 As String = Create CM Profile, As Value = 12 As String = Set CM Criteria, As Value = 13 As String = Activate CM Profile, As Value = 14 As String = Deactivate CM Profile, As Value = 15 As String = Delete CM Profile, As Value = 16 As String = Purge Variant, As Value = 17 As String = Run Process Chain, As Value = 18 As String = Start Process Chain, As Value = 19 As String = Wait Process Chain, As Value = 20 As String = Interrupt Process Chain, As Value = 21 As String = Run InfoPackage, As Value = 22 As String = Start InfoPackage, As Value = 23 As String = Wait InfoPackage, As Value = 24
Default is Run (1). | N | |
commandOptions | SAP Command Options | Any additional command options supported by Universal Connector. | | N | |
dataSource | Data Source | If sapDisplayCommand is InfoPackages(24); SAP InfoPackage data source. | | N | |
defFile | Definition File | For Run, Submit, and Modify commandGroups if repositoryOrFilesys is File System; Path and file name of the file. | | Y | |
definitionOrModel | Definition or Model | If commandGroup is Run(1); Specification for how the new SAP job will be created, based either on a USAP Definition File or an SAP Model Job. | Valid values: As String = USAP Definition File, As Value = 1 As String = SAP Model Job, As Value = 2
Default is USAP Definition File (1). | N | |
definitionOrModelJobVar | Definition or Model | If commandGroup is Submit(1); Name of a variable that will be resolved at run time to the name of the Definition or Model to use. | Valid values: As String = USAP Definition File, As Value = 1 As String = SAP Model Job, As Value = 2 As String = SAP Model Variant, As Value = 3
Default is USAP Definition File (1). | N | |
dispAbapName | SAP ABAP Program Name | If definitionOrModelJobVar is SAP Model Variant; Name of an ABAP program in an SAP system to which the model variant belongs. | | Y | |
dispSapEventId | SAP Event | If sapDisplayCommand is Event History(16); ID of the Event. | | Y | |
dispSapEventParm | SAP Event Parameter | If sapDisplayCommand is Event History(16); Optional parameter value for the event. | | N | |
dispVariant | SAP Variant Name | Pre-existing SAP variant name to use as the model variant. | | N | |
environment
| Environment Variables | List of environment variables needed by the program to run: <environment>
<variable>
<name>env1</name>
<value>test1</value>
</variable>
<variable>
<name>env2</name>
<value>test2</value>
</variable>
</environment>
| | N | |
exitCodeOutput
| Output File | If outputType = FILE (3); Path and file name of the output file that should be scanned for the text in exitCodeText. | | N | |
exitCodeProcessing
| Exit Code Processing | Specification for how the Controller should determine whether the executed command failed or completed successfully. | Valid values: As String = Success Exitcode Range, As Value = 1 As String = Failure Exitcode Range, As Value = 2 As String = Success Output Contains, As Value = 3 As String = Failure Output Contains, As Value = 4 As String = Step Conditions, As Value = 5
Default is Success Exitcode Range (1). | N | |
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 | |
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 | |
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 | |
infoPackage
| InfoPackage | If commandGroup is one of the following; Name of the InfoPackage: | | Y | |
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 | |
infoSource
| InfoSource | If sapDisplayCommand equals InfoPackages (24); SAP InfoSource. | | N | |
jobId
| SAP Job ID | Job ID of the SAP job. | Variables are supported. | N | |
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 | |
jobName
| SAP Job Name | Job name of the SAP job. | Variables are supported. | N | |
jobStatus
| Status | If sapDisplayCommand equals InfoPackages(24); Current status for an SAP job. | | N | |
logId
| 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 | |
outputFailureOnly
| 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 | |
outputReturnFile
| 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 | |
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 | |
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 | |
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 | |
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: As String = NONE, As Value = 1 As String = STDOUT, As Value = 2 As String = STDERR, As Value = 3 As String = FILE, As Value = 4 As String = OUTERR, As Value = 6
Default is NONE (1).
Note If outputReturnType is not NONE (1), the web service will fail with Start Failure if outputProhibited is true for the specified agent. | N | |
outputType
| Output Type | If exitCodeProcessing = Success Output Contains (3) or Failure Output Contains (4); Type of output. | Valid values: As String = STDOUT, As Value = 1 As String = STDERR, As Value = 2 As String = FILE, As Value = 3
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 | |
purge
| Delete SAP Job on Completion |