Create and Manage Pull Data Structures

Pull Data Structures respond to requests for data from other systems. For example, to provide a CRM with information about a customers recent interaction history.

To create a Pull Data Structure

  1. In MXO , choose Configure.

  2. Select Data Structures and then click Create.

  3. Select **Pull **as the type of structure you want to create.

  4. Click Let's get started.

  5. Provide the following details for your structure:

    FieldDescription
    NameA unique name for this structure.
    DescriptionOptional. A description for this structure.
    API NameThe unique API name for this structure. MXO uses the API name to create an API service URL. This URL is the web service endpoint for accessing customer data in this structure, after the structure is published.

  6. Create your data structure. Click the plus button next to your data structure and select one of the following:

    FieldDescription
    Data AttributeA single item of data. For example, Age, Gender, Email Address.
    NodeOrganizes your structure into nodes to make it easier to view the information it contains.
    List NodeEnables you to push lists of data to external systems. For example, the positive and negative click counts for a list of actions. Select the list to use in your structure.

  7. Add any data attributes you want to make available to the external system. Provide the following details for each data attribute:

    FieldDescription
    Attribute NameA name for the attribute that is easily identifiable by the external system. Attribute and Node names must be unique against other attributes in the same parent node. For example, you can have a customer_name attribute inside the root node, and another customer_name attribute inside a sub-node. Names cannot contain any spaces and are subject to XML validation.
    Attribute ValueThe value to send as an attribute to the external system. You can use any AEP data items available in the Data Item Picker (MXO filters out any items not considered to be AEP data items, such as functions and action attributes), any data items derived from Eligibility Rules, or any Hardcoded value. Any value entered directly into the Attribute value field is passed to the external system as a hardcoded value.
    Value TypeThe value type. You can choose between a String, Numeric, Date, or Boolean value. MXO identifies the value type automatically, based on the data type of any attribute you select using the Data Item Picker.

  8. Click Save.

Note: You can organize your structure into nodes to make it easier to view the information it contains, as shown in the example scenario.

Edit a Data Structure

  1. In MXO , choose Configure.
  2. Select Data Structures.
  3. Click on an structure to open it for editing.
  4. Make your required changes and then click Finished.
Note: You must republish whenever you make changes to your structure for those changes to be reflected in your other systems. This may require changes to any of the systems requesting this structure.

Copy a Data Structure

From time to time you may want to clone an existing structure, rather than creating a new one from scratch.

  1. In MXO , choose Configure.
  2. Select Data Structures.
  3. Click the Copy icon next to the structure you want to clone.
  4. Rename the new structure and make any other required changes.
  5. Click Save.

Delete a Data Structure

  1. In MXO , choose Configure.
  2. Select Data Structures.
  3. Click the Delete icon next to the structure you want to delete.
  4. Click Yes, delete it.
Note: You cannot delete a structure that is currently in use. You must remove any dependencies associated with the structure first.