...
Property | UI Field Name | Description | Specifications | Required |
|---|
| Anchor |
|---|
| asynchronous - COMMAND |
|---|
| asynchronous - COMMAND |
|---|
|
asynchronous | Asynchronous | If executionOption is In Process; Specification for whether the command runs synchronously or asynchronously. If executionOption is Out Of Process, asynchronous will be ignored.
| Boolean; Valid values: true/false. Default is false.
| N |
| Anchor |
|---|
| executionOption - COMMAND |
|---|
| executionOption - COMMAND |
|---|
|
executionOption
| Execution Option | Specification for whether the command runs out-of-process execution or in-process execution. | Valid values: - As String = Out Of Process, As Value = 0
- As String = In Process, As Value = 1
Default is Out Of Process. | N |
| Anchor |
|---|
| fields - COMMAND |
|---|
| fields - COMMAND |
|---|
|
fields
| Dependent Fields | Universal Template fields (if any) that are required by the command. The values of those fields are included in the command request. | | Code Block |
|---|
| language | xml |
|---|
| linenumbers | true |
|---|
| <fields>
<field>Integer Field 1</field>
<field>Boolean Field 1</field>
<field>Text Field 1</field>
<field>Large Text Field 1</field>
<field>Choice Field 1</field>
<field>Credential Field 6</field>
<field>Script Field 1</field>
<field>Array Field 1</field>
<field>Float Field 2</field>
</fields> |
| Code Block |
|---|
| language | xml |
|---|
| linenumbers | true |
|---|
| "fields": [
"Integer Field 1",
"Boolean Field 1",
"Text Field 1",
"Large Text Field 1",
"Choice Field 1",
"Credential Field 6",
"Script Field 1",
"Array Field 1",
"Float Field 2"
] |
Valid values for field: As String = Integer Field [1-10] Boolean Field [1-10] Text Field [1-20] Large Text Field [1-2] Choice Field [1-15] Credential Field [1-6] Script Field [1-2] Array Field [1-4] Float Field [1-4]
| N |
| Anchor |
|---|
| label - COMMAND |
|---|
| label - COMMAND |
|---|
|
label
| Label | User-friendly display name for the command, to be displayed within the client. |
| Y |
| Anchor |
|---|
| name - COMMAND |
|---|
| name - COMMAND |
|---|
|
name
| Name | Unique name of this command, adhering to the same naming convention as a Universal Template field name. |
| Y |
| Anchor |
|---|
| statuses - COMMAND |
|---|
| statuses - COMMAND |
|---|
|
statuses
| Supported Status(es) | Task instance status(es) that the dynamic command should be enabled for. | | Code Block |
|---|
| language | xml |
|---|
| linenumbers | true |
|---|
| <statuses>
<status>Defined</status>
<status>Waiting</status>
</statuses> |
| Code Block |
|---|
| language | xml |
|---|
| linenumbers | true |
|---|
| "statuses": [
"Defined",
"Waiting"
] |
Valid values for status: As String = Defined, As Value = 0 As String = Waiting, As Value = 10 As String = Time Wait, As Value = 15 As String = Held, As Value = 20 As String = Exclusive Requested, As Value = 22 As String = Exclusive Wait, As Value = 23 As String = Resource Requested, As Value = 25 As String = Resource Wait, As Value = 30 As String = Execution Wait, As Value = 33 As String = Undeliverable, As Value = 35 As String = Queued, As Value = 40 As String = Submitted, As Value = 43 As String = Action Required, As Value = 60 As String = Started, As Value = 70 As String = Running, As Value = 80 As String = Running/Problems, As Value = 81 As String = Cancel Pending, As Value = 99 As String = In Doubt, As Value = 110 As String = Start Failure, As Value = 120 As String = Confirmation Required, As Value = 125 As String = Cancelled, As Value = 130 As String = Failed, As Value = 140 As String = Skipped, As Value = 180 As String = Finished, As Value = 190 As String = Success, As Value = 200
| Y |
| Anchor |
|---|
| sysId - COMMAND |
|---|
| sysId - COMMAND |
|---|
|
sysId | n/a | sys_id used within the Controller to identify this Universal Template Field. | Persisted only if retainSysIds is set to true. | N |
| Anchor |
|---|
| timeout - COMMAND |
|---|
| timeout - COMMAND |
|---|
|
timeout
| Timeout (Seconds) | Optional command timeout, in seconds, if the command requires longer than the System-level default of 60 seconds. |
| N |
| Anchor |
|---|
| Universal Event Template Properties |
|---|
| Universal Event Template Properties |
|---|
|
Universal Event Template PropertiesThe excludeRelated and retainSysIds properties are specified as attributes in the <eventTemplate> element of XML web services.
Property | UI Field Name | Description | Specifications | Required |
|---|
| Anchor |
|---|
| UET - attributesPolicy |
|---|
| UET - attributesPolicy |
|---|
|
attributesPolicy
| Unmapped Attributes Policy | Defines how unmapped/unknown attributes that are in the published event are handled. | Valid values: As String = Prohibit Universal Event, As Value = 1 As String = Include Attributes, As Value = 2 As String = Exclude Attributes, As Value = 3
Default is Prohibit Universal Event (1). | N |
| Anchor |
|---|
| UET - attributes |
|---|
| UET - attributes |
|---|
|
attributes
| Attributes | Zero or more attributes, specifying their Name, Label, and Type. | | Expand |
|---|
| | Code Block |
|---|
| <attributes>
<attribute>
<label>attribute_label1</label>
<name>attribute_name1</name>
<type>Text</type>
</attribute>
<attribute>
<label>attribute_label2</label>
<name>attribute_name2</name>
<type>Integer</type>
</attribute>
</attributes> |
|
| Expand |
|---|
| | Code Block |
|---|
| "attributes": [
{
"label": "attribute_label1",
"name": "attribute_name1",
"type": "Text"
},
{
"label": "attribute_label2",
"name": "attribute_name2",
"type": "Integer"
}
] |
|
| N |
| Anchor |
|---|
| UET - description |
|---|
| UET - description |
|---|
|
description
| Description | Description of the Universal Event. |
| N |
| Label | User-friendly display name for the event, to be displayed within the client. | The Label must be unique. | Y |
| Name | Unique event name, adhering to the same naming convention as a Universal Template field name. |
| Y |
| Time To Live | Default value for Time to live; how long, in minutes, the Universal Event data is valid. | non-negative Integer | N |
| n/a | sys_id used within the Controller to identify this record. | Persisted only if retainSysIds is set to true. | N |
| Anchor |
|---|
| Universal Event Template - Attribute Properties |
|---|
| Universal Event Template - Attribute Properties |
|---|
|
Universal Event Template - Attribute PropertiesProperty | UI Field Name | Description | Specifications | Required |
|---|
| Label | User-friendly display name for the attribute, to be displayed within the client. | Attribute Label must be unique. | Y |
| Name | Unique attribute name, adhering to the same naming convention as a Universal Template field name. |
| Y |
| Type | Attribute type. | Valid values: As String = Text, As Value = 1 As String = Integer, As Value = 2 As String = Boolean, As Value = 3 As String = Float, As Value = 4
| Y |
| Anchor |
|---|
| Restore Default Universal Template Icon |
|---|
| Restore Default Universal Template Icon |
|---|
|
Restore Default Universal Template Icon
...
