Map Operations Rule

A Data Map Operations rule allows you to add, remove, or change a data map entry A name (key) and value pair in the data map for a job.. It does not return a value.

Note: Each action must have a name by which it is identified, and this name must be unique within the form in which it appears. This name can be modified in the Name field of the action and is displayed in View > Actions after the action has been created.

The following are the properties for a Map Operations rule.

Important! Content in an action or rule is case sensitive.

Value

Description

Name

The name for the action or rule.

Trigger source

The field that is used in conjunction with a trigger event to interactively run the rule. For example, a button that runs a query when clicked, a prompt that runs a query when submitted, or a form that runs a query when loaded.

Trigger event

The event that is used in conjunction with the trigger source to run the rule. For example, clicking a button, entering text at a prompt, loading a form, or submitting a job.

Priority

The order in which the rules that have otherwise identical triggers are run. Trigger values are compared only if the triggers have the same trigger source, trigger event, and trigger key (if any). The type of trigger source is irrelevant. The trigger source with the lowest value for priority is run first.

Conditional

Determine whether to perform an action based on the result of a comparison of values or the result of a logical operation.

Name
Operator
- Equals
- Not Equal
- Equals Ignore Case
- Not Equal Ignore Case
- Less Than
- Greater Than
- Is Missing
- Is Not Missing
- Is Empty
- Is Not Empty
Value

Data ref

The name of the data map entry to be added, removed, or changed in the data map.

Value

The value of the data map entry to be added, removed, or changed in the data map.

Operation

The operation to perform on the data map entry.

PUT: Add or change the specified data map entry.
DELETE: If the specified data map entry exists, delete it. After deletion, requests for that name return NULL or notExists.

Literal value

The Literal Value attribute is a required Boolean value that indicates whether the value in the data map entry specified by the operation should be treated as a literal value and used in its current form, or whether the names of data map entries in the value should be resolved to values in the data map.

false: Resolve any names of data map entries within the value. That is, replace them with their associated values from the data map.
true: Do not resolve any names of data map entries within the value. That is, use the literal text.

Data type

A description of the data returned by or referred to by the data map entry A name (key) and value pair in the data map for a job.. The default value is STRING.

Values

Value	Description
STRING	A text string. Any number or date/time included is treated as text.
INTEGER	A signed integer value.
NUMBER	A signed decimal value.
BOOLEAN	A value of true or false.
BINARY	An array of bytes.
DATE	A date/time value stored in one of the following formats: Epoch time The number of seconds since 00:00:00 UTC on 1 January 1970, not including leap seconds. yyyy-MM-dd hh:mm:ss

Merge policy

For an action, always select the default value, mergeAll.

Action

For an action that can return a value, this property determines whether that value remains in the data map when the action finishes running and returns control to its parent rule. The default value is override.

Values

Note: The impact of an action returning control to its parent is also affected by Merge policy.

Value	Description
override	When control is returned to the parent, the value produced by the action is retained for the data map entry, replacing any previous value for the data map entry.
notExists	When control is returned to the parent, the value produced by the action is retained for the data map entry only if a data map entry with that name did not exist prior to the execution of this action. Otherwise, the previous value for the data map entry is reinstated.
delete	When control is returned to the parent, the data map entry is deleted from the data map.
append	If the data map entry existed before the action was run, then when control is returned to the parent the new value for the data map entry is concatenated onto the end of the old value.
prepend	If the data map entry existed before the action was run, then when control is returned to the parent the new value for the data map entry is concatenated onto the beginning of the old value.

Tip: If you require more complex behavior than is available using a Map Operations rule, consider using a business rule that includes a mapOperations business rule component. For more information about business rules, see Implementing Business Logic.