Type element
Defines, together with On, how the action is executed.
Note
Not all Protocol.Actions.Action.Type values can be used in combination with the different Protocol.Actions.Action.On types. See Possible combinations of “On” and “Type”.
Type
Parent
Attributes
| Name | Type | Required | Description |
|---|---|---|---|
| allowed | string | If Action/Type is "stuffing": If the byte specified in the "value" attribute is followed by one of the characters specified in this attribute, then it will not be repeated. | |
| arguments | string | If Action/Type is "wmi", this attribute specifies the names of the columns to be returned (separated by semicolons). | |
| endoffset | unsignedInt | If Action/Type is "stuffing", this attribute specifies the (fixed) end position that delimits the part of the data block in which stuffing has to be performed. | |
| id | unsignedInt | If Action/Type is "read file", this attribute specifies the ID of the parameter containing the directory in which the file can be found. If Action/Type is "replace", this attribute specifies the ID of the parameter that contains the ID of the parameter that has to be put in the command/response. If Action/Type is "increment", this attribute specifies the ID of the parameter that holds the increment value. | |
| nr | string | If Action/Type is "read file", this attribute specifies the number of bytes to be read. If Action/Type is "replace", this attribute specifies the (0-based) position of the parameter in the command/response. If Action/Type is "set", "set and get with wait", "set with wait", "open", "close", "lock", "unlock", "priority lock" or "priority unlock", this attribute specifies the (0-based) connection ID. | |
| options | string | This attribute allows defining different options depending on the type of action. | |
| reschedule | EnumTrueFalse | If Action/Type is "restart timer" and this attribute is set to “true”, then the timer will immediately start again. Feature introduced in DataMiner 8.5.4 (RN 9189). | |
| returnValue | string | If Action/Type is "read file", this attribute specifies the ID of the parameter in which to store the retrieved file content. If Action/Type is "wmi", this attribute specifies the ID of the parameter containing the returned values (if "table" is set to "true", this ID should be the ID of a parameter of type "array"). | |
| regex | TypeNonEmptyString | If Action/Type is "aggregate", this attribute allows to specify the regular expression to use for filtering. | |
| scale | string | If Action/Type is "set info", this attribute specifies the scale to be set on the parameter. | |
| script | string | If Action/Type is "wmi", this attribute specifies the WMI class (e.g. Win32_PerfRawData_PerfOS_Memory). | |
| sequence | string | If Action/Type is "set info", this attribute specifies the sequence to be set on the parameter. | |
| startoffset | unsignedInt | If Action/Type is "read file", this attribute specifies the ID of the parameter containing the start offset (i.e. the number of bytes to skip before starting to read the file). If Action/Type is "stuffing", this attribute specifies the (fixed) start position that delimits the part of the data block in which stuffing has to be performed. | |
| value | string | If Action/Type is "stuffing", this attribute specifies the actual stuffing character, i.e. the byte that has to be repeated. |
Remarks
Note
For an overview of which attributes are supported on which action, refer to Actions overview.