Data Modify Action Properties
Data Modify Action General Properties lists data modify action properties.
Property | Description |
---|---|
Name | A descriptive name for the data modify action. Note: You must specify a name that is unique across all the following types of
actions:
|
Description | Information about the purpose of the data modify action. |
External ID | (Optional) Use this field to identify this item in MATRIXX pricing items. An External ID is saved to the pricing configuration file and loaded into the Pricing Database. Set the External ID value to any alphanumeric character that is meaningful to your implementation. An External ID can be used, for example, to relate offers in the MATRIXX system to products in an external pricing plan. It can be used, for example, by the Subscriber Management API to query and purchase product offers and bundle IDs. |
Start Date/Time | The day, month, and year that sets when the data modify action
becomes activated in the pricing database. For revisions, the start date defaults to the date the revision is created. Setting future start dates allows you to have several inactive revisions, with each one becoming valid as soon as the start date occurs. Only one revision can be active in the system at one time. |
Property | Description |
---|---|
Source | The source to use for the data modify action. One of the
following:
Note: If the selected source is
Normalizer Value, then the data
modify profile that references this data modify action is
only used on a matrix containing the referenced
normalizer(s). |
Message or Object Properties | |
Source Container | The source container from which to copy a field value into
the destination field. You can select one of the following:
|
Source Field | The source field, including array and list fields, for the data modify action. You cannot use a field from an expanded array or list. |
Tier Name | (Optional) If the source container is an MtxGroupObject MDC
or a descendant of MtxGroupObject, specifies the group tier to
use. If set, MATRIXX Engine retrieves the DMA source object based on the specified tier.
If the group does not have a tier, MATRIXX Engine considers the source field to be empty and processes it
according to the action selected in Source
Action. If the tier is not set, MATRIXX Engine retrieves the source object associated with the group
initiator.
Note: If the initiator is a
subscriber or device and the tier is not specified, MATRIXX Engine considers the source field to be empty and processes
it according to the action selected in Source
Action. |
Source Action | Select the action to take if the
source field is empty:
|
Default if Empty | The default value to use if the source field is empty and Source Action is set to Take Default if Source Empty. |
LDAP Call Out Response Properties | |
Calling | Select to set the call out response party to the calling
party. Sets the value of
MtxDataModifyActionRev.ResponseParty to 0.
|
Called | Select to set the call out response party to the called party
(the default). Sets the value of
MtxDataModifyActionRev.ResponseParty to 1.
|
Source Container | The source container from which to copy a field value into the destination MDC or virtual field. For a destination MDC, you can select from the MtxLdapResponseDataExtension MDC or its descendants. |
Source Field | The source field, including array and list fields, for the data modify action. You cannot use a field from an expanded array or list. |
Source Action | Select the action to take if the
source field is empty:
|
Default if Empty | The default value to use if the source field is empty and Source Action is set to Take Default if Source Empty. |
Workspace Properties | |
Type | One of:
|
Source Container | The source container is determined from the selected workspace type. |
Source Field | The source field, including array and list fields, for the data modify action. You cannot use a field from an expanded array or list. |
Source Action | Select the action to take if the
source field is empty:
|
Default if Empty | The default value to use if the source field is empty and Source Action is set to Take Default if Source Empty. |
Metadata Properties | |
Type | Select:
|
Pricing Object | (Matrix type) Select the pricing object to use for sourcing the metadata. |
Table | (Matrix type) Select the policy or rate table to use. |
Normalizer | (Normalizer type) Select the normalizer to use for sourcing the metadata. |
Metadata Name | Select the name of the metadata to use. To use values from normalizer results fields, select --Name-- for the name field or --Description-- for the description field. |
Source Action | Select the action to take if the
source field is empty:
|
Default if Empty | The default value to use if the source field is empty and Source Action is set to Take Default if Source Empty. |
Constant Properties | |
Constant Type | The source container, descended from the MtxDataModifySourceConstant MDC, for the type of constant you want to use. |
Constant Value | Sets the value of the constant. The value must match the selected constant type. |
Time Unit and Count Properties | |
Base Date Time | The base event time to use when extending the destination
DateTime field:
|
Count Offset | The offset value by which to extend the selected base date and time. |
Units | The type of unit to use for the count offset (days, weeks, months, years, hours, minutes, seconds, or milliseconds). |
Normalizer Calculated Value Properties | |
Normalizer | The balance difference or difference range normalizer that provides the calculated value. |
Use Absolute Value | Whether the absolute value (that is, the positive value) of the difference is saved. The default is false (that is, the calculated difference is saved). |
Source Action | Select the action to take if the
source field is empty:
|
Default if Empty | The default value to use if the source field is empty and Source Action is set to Take Default if Source Empty. |
Property | Description |
---|---|
Destination | Sets the destination to use for the data modify action. One
of:
|
Message Properties | |
Destination Container | Specifies the destination for the changed value. The
destination can be one of the following:
|
Destination Field | The MDC or virtual field to modify. |
Destination Action | The type of
data modify action to perform. One of:
|
LDAP Call Out Request Properties | |
Call Out Name | The PreRating call out action to use for the destination. The
destination MDC type is set from the
MtxSubscriberInfoQueryAction.ExtensionType
field of the selected call out action. |
Destination Container | The container that has the field you want to modify, where
valid containers are the MtxLdapRequestDataExtension MDC, its
descendants, or a virtual field. The LdapCallOutRequest field of the PreRating call out action selected in the Call Out Name field must have a matching MDC type. |
Destination Field | The MDC or virtual field to modify. |
Destination Action | The type of
data modify action to perform. One of:
|
Workspace Properties | |
Type | One of:
|
Destination Container | The destination container is determined from the selected workspace type. |
Destination Field | The MDC field to modify. |
Destination Action | The type of
data modify action to perform. One of:
|
Object Properties | |
Destination Container | Specifies the subscription, group, device, user, or offer object MDC to use for the destination. |
Destination Field | The MDC field to modify. |
Destination Action | The type of
data modify action to perform. One of:
|
Destination Actions
Destination Action | Source Action - Do Nothing if Source Empty | Source Action - Fail if Source Empty | Source Action - Take Default if Source Empty |
---|---|---|---|
Create if Absent | If the source field is empty, do nothing. If the source
field is present and the destination field is:
|
If the source field is empty, log a warning. If the source
field is present and the destination field is:
|
Sets the destination field only if it is empty. If the
destination field is present, do nothing. If the source and destination fields are both empty, use the default value to set the destination field. If the default value is not set, the price loader logs an error. If the source field is present and the destination field is empty, use the source field to set the destination field. |
Create or Update | If the source field is empty, do nothing. If the source field is present, delete the destination field if present. Use the source field to set the destination field. |
If the source field is empty, log a warning. If the source field is present, delete the destination field if present. Use the source field to set the destination field. |
If the source field is empty, use the default value to set
the destination field. If the default value is not set, the
price loader logs an error. If the source field is present, delete the destination field if present. Use the source field to set the destination field. |
Adjust Date Time | Source action fields are disabled. | Source action fields are disabled. | Source action fields are disabled. |
Conditional Delete | If the source field is:
|
If the source field is:
|
Delete the destination field, if present. |
Delete | Ignored (source fields are disabled). The destination field is deleted, if present. | Ignored (source fields are disabled). The destination field is deleted, if present. | Ignored (source fields are disabled). The destination field is deleted, if present. |