Parameter metadata
Parameter metadata embedded in an automation script is used to define the inputs and outputs required by the implementation.
When an automation script is associated with an action launch point, parameter mappings are specified in the launch point variables, and facilitate the development of re-usable actions, that can be configured for use in different object contexts (for example, workorders, tickets)
Three types of information are defined in the metadata:
- Description - Provides a general description of how the action implementation works. This information is rendered on the Action application.
- Input Parameters - Defines the characteristics of each input parameter used by the action implementation
- Output Parameters - Defines the characteristics of each output parameter
The following are supported for each input parameter:
Attribute | Description |
---|---|
Name | Name of the input parameter. This is a required parameter. |
Description | Provides a description of the input parameter. This is an optional parameter. |
DefaultRelationship | Provides a default value for the relationship portion of the parameter mapping. This value will be used to automatically populate the Relationship field in the Parameters table when the metadata is imported into an action. This is an optional parameter. The user may choose to modify the value in the action UI 'Relationship' field. If an override value is specified, this parameter will be ignored. |
DefaultAttribute | Provides a default value for the attribute portion of the parameter mapping. This value will be used to automatically populate the Attribute field in the Parameters table when the metadata is imported into an action. This is an optional parameter. The user may choose to modify the value in the action UI 'Attribute' field. If an override value is specified, this parameter will be ignored. |
Type | Defines how the data is being accessed (using
the appropriate 'get' method). Three data access methods are supported.
When a parameter mapping is defined, Type is used to validate that
the parameter mapping is properly referencing a MBO Set, a single
attribute value or an array of attribute values. If Type is not specified
then the default will be set to 'Attribute'. In order to call 'get'
methods that return arrays, the Type must be set to AttributeArray.
The following three values are supported:
Note: This value will be used to populate the 'Method Type' field
in the Parameters table when the metadata is imported into an action.
|
AttributeType | Defines the expected data type of the returned
attribute (applicable when Type is Attribute or AttributeArray).
AttributeType is used to validate that the provided mapping references
an attribute of the required type. This value is used to populate
the 'Attribute Data Type' field in the Parameters table when the metadata
is imported into an action. Valid AttributeType specifications mirror
the data types supported by Tivoli's process automation engine:
Note: This is an optional parameter. However, it is
required if the Type is specified as 'Attribute' or 'AttributeArray'
If specified, it will be enforced at validation time when the action
is saved. For example, if the metadata specifies AttributeType="ALN",
and the maxtype of the attribute specified in the data mapping attribute
field of the mapping table is "INTEGER", then an exception will be
thrown and an error displayed when the action is saved.
|
MBOType | Defines the type of MBO that should be defined
in the last position in the Relationship field in the parameter mapping.
For example, if MBOType="CI", then the following data mappings would
be considered to be valid, or invalid:
Note: This is an optional parameter. However, if specified,
it will be enforced at validation time when the action is saved. For
example, if the metadata specfies MBOType="CI", and the Relationship
field is MULTIASSETLOCCI.CI.ASSET, then an exception is thrown and
an error displays when the action is saved.
|
The following are supported for each output parameter:
Attribute | Description |
---|---|
Name | Name of the output parameter. This is a required parameter. |
Description | Provides a description of the output parameter. This is an optional parameter. |
DefaultRelationship | Provides a default value for the relationship portion of the parameter mapping. This value will be used to automatically populate the Relationship field in the Parameters table when the metadata is imported into an action. This is an optional parameter. The user may choose to modify the value in the action UI 'Relationship' field. |
DefaultAttribute | Provides a default value for the attribute portion of the parameter mapping. This value will be used to automatically populate the Attribute field in the Parameters table when the metadata is imported into an action. This is an optional parameter. |
AttributeType | Defines the AttributeType is the expected data
type of the attribute value to be set. For output parameters, only
Type=Attribute is supported (setting arrays or MBO sets are not supported).
AttributeType is used to validate that the provided parameter mapping
references an attribute of the required type. This value is used to
populate the 'Attribute Data Type' field in the Parameters table when
the metadata is imported into an action. Valid AttributeTypes mirror
the data types supported by the Tivoli's process automation engine:
Note: This is a required parameter. This value is used to populate
the 'Attribute Data Type' field in the Parameters table when the metadata
is imported into an action.
|
MBOType | Defines the type of MBO Set that should be defined
in the last position in the Relationship field in the parameter mapping.
For example, if MBOType=CI, then the following data mappings would
be considered to be valid, or invalid:
Note: This is an optional parameter. However, if specified,
it will be enforced at validation time, when the action is saved.
For example, if the metadata specfies MBOType="CI", and the Relationship
field is MULTIASSETLOCCI.CI.ASSET, then an exception will be thrown
and an error displayed when the action is saved.
|