Data Modify Action Properties

Data Modify Action General Properties lists data modify action properties.

Table 1. Data Modify Action General 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:
  • Announcement details
  • Announcement menu actions
  • Call out actions
  • Data modify 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.

Data Modify Action Source Properties lists the properties for the different source types.
Table 2. Data Modify Action Source Properties
Property Description
Source The source to use for the data modify action. One of the following:
  • Message or Object
  • LDAP Call Out Response
  • Workspace
  • Metadata
  • Constant
  • Time Unit and Count
  • Normalizer Value
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:
  • An MtxDiamRoMsg, MtxTcapMsg, or 5G message MDC or its descendants.
    Note: Using a field from the MtxTcapMsg MDC is deprecated.
  • A subscription, group, device, or user object MDC or its descendants.
  • A virtual field.
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:
  • Do Nothing if Source Empty — The profile continues to the next action in the profile without raising a warning.
  • Take Default if Source Empty — The profile uses the Default if Empty value as the source.
  • Fail if Source Empty — The profile stops execution and raises an error.
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:
  • Do Nothing if Source Empty — The profile continues to the next action in the profile without raising a warning.
  • Take Default if Source Empty — The profile uses the Default if Empty value as the source.
  • Fail if Source Empty — The profile stops execution and raises an error.
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:
  • Message
  • Segment
  • Component
  • Session
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:
  • Do Nothing if Source Empty — The profile continues to the next action in the profile without raising a warning.
  • Take Default if Source Empty — The profile uses the Default if Empty value as the source.
  • Fail if Source Empty — The profile stops execution and raises an error.
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:
  • Matrix — Use metadata defined in a policy table or a rate table.
  • Normalizer — Use metadata defined in a normalizer
.
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:
  • Do Nothing if Source Empty — The profile continues to the next action in the profile without raising a warning.
  • Take Default if Source Empty — The profile uses the Default if Empty value as the source.
  • Fail if Source Empty — The profile stops execution and raises an error.
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:
  • event_time — Use the event time.
  • existing — Use the existing date and time value.
  • min_event_existing — Use the minimum of the event time or the existing data and time value.
  • max_event_existing — Use the maximum of the event time or the existing data and time value.
    Note: If the destination field is empty, the event time is used.
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:
  • Do Nothing if Source Empty — The profile continues to the next action in the profile without raising a warning.
  • Take Default if Source Empty — The profile uses the Default if Empty value as the source.
  • Fail if Source Empty — The profile stops execution and raises an error.
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.
Data Modify Action Destination Properties lists the properties for the different destination types.
Table 3. Data Modify Action Destination Properties
Property Description
Destination Sets the destination to use for the data modify action. One of:
  • Message
  • LDAP Call Out Request
  • Workspace
  • Object
Message Properties
Destination Container Specifies the destination for the changed value. The destination can be one of the following:
  • MtxDiamRoMsg MDC or its descendants.
  • MtxTcapRoMsg MDC or its descendants
  • A 5G message MDC.
  • A virtual field.
Destination Field The MDC or virtual field to modify.
Destination Action The type of data modify action to perform. One of:
  • Create if Absent
  • Create or Update
  • Conditional Delete
  • Delete
  • Adjust Date Time — The source must be Time Unit and Count.
Destination Actions and Source Actions describes how the destination field is updated depending on the selected destination action and the selected source action.
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:
  • Create if Absent
  • Create or Update
  • Conditional Delete
  • Delete
  • Adjust Date Time — The source must be Time Unit and Count.
Destination Actions and Source Actions describes how the destination field is updated depending on the selected destination action and the selected source action.
Workspace Properties
Type One of:
  • Message
  • Segment
  • Component
  • Session
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:
  • Create if Absent
  • Create or Update
  • Conditional Delete
  • Delete
  • Adjust Date Time — The source must be Time Unit and Count.
Destination Actions and Source Actions describes how the destination field is updated depending on the selected destination action and the selected source action.
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:
  • Create if Absent
  • Create or Update
  • Conditional Delete
  • Delete
  • Adjust Date Time — The source must be Time Unit and Count.
Destination Actions and Source Actions describes how the destination field is updated depending on the selected destination action and the selected source action.

Destination Actions

How a selected destination action applies to the destination field depends on the source action selected in the data modify action. Destination Actions and Source Actions lists the destination action types and lists how each action is applied depending on the selected source action.
Table 4. Destination Actions and Source 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:
  • Empty — Use the source field to set the destination field.
  • Present — Do nothing.
If the source field is empty, log a warning.
If the source field is present and the destination field is:
  • Empty — Use the source field to set the destination field.
  • Present — Do nothing.
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:
  • Empty — Do not delete the destination field.
  • Present — Delete the destination field if present.
If the source field is:
  • Empty — Do not delete the destination field and log a warning message.
  • Present — Delete the destination field if present.
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.