Configure a unitary event configure-an-event

Unitary events are linked to a specific profile. They can be rule-based or system-generated. Read more on unitary event this section.

Here are the first steps to configure a new event:

  1. In the ADMINISTRATION menu section, select Configurations. In the Events section, click Manage. The list of events is displayed.

  2. Click Create Event to create a new event. The event configuration pane opens on the right side of the screen.

  3. Enter the name of your event. You can also add a description.

    note note
    Only alphanumeric characters and underscores are allowed. The maximum length is 30 characters.
  4. In the Type field, choose Unitary.

  5. In the Event ID type field, select the event ID type you want to use: Rule Based or System Generated. Read more on event ID types in this section.

  6. The number of journeys that use this event is displayed in the Used in field. You can click the View journeys icon to display the list of journeys using this event.

  7. Define the schema and payload fields: this is where you select the event information (usually called a payload) journeys expects to receive. You will then be able to use this information in your journey. See this section.

    note note
    When you select the System Generated type, only schemas that have the eventID type field are available. When you select the Rule Based type, all Experience Event schemas are available.
  8. For rule-based events, click inside the Event ID condition field. Using the simple expression editor, define the condition that will be used by the system to identify the events that will trigger your journey.

    In our example, we wrote a condition based on the profile’s city. This means that whenever the system receives an event that matches this condition (City field and Paris value), it will pass it to journeys.

    note note
    The advanced expression editor is not available when defining the Event ID condition. In the simple expression editor, not all operators are available, they depend on the data type. For example, for a string type of field, you can use “contains” or “equal to”.
    If you modify your schema with new enumeration values after creating the event, you need follow these steps to apply the changes to the existing event: unselect the enumeration field from the event fields, confirm the selection, then select the enumeration field again. The new enumeration value is now displayed.
  9. Add a namespace. This step is optional but recommended as adding a namespace allows you to leverage information stored in the Real-time Customer Profile Service. It defines the type of key the event has. See this section.

  10. Define the profile identifier: choose a field from your payload fields or define a formula to identify the person associated to the event. This key is automatically setup (but can still be edited) if you select a namespace. Indeed, journeys picks the key that should correspond to the namespace (for example, if you select an email namespace, the email key will be selected). See this section.

  11. Click Save.

    The event is now configured and ready to be dropped into a journey. Additional configuration steps are required to receive events. See this page.

Define the payload fields define-the-payload-fields

The payload definition allows you to choose the information the system expects to receive from the event in your journey and the key to identify which person is associated to the event. The payload is based on the Experience Cloud XDM field definition. For more information on XDM, refer to Adobe Experience Platform documentation.

  1. Select an XDM schema from the list and click on the Fields field or on the Edit icon.

    All the fields defined in the schema are displayed. The list of fields varies from one schema to another. You can search for a specific field or use the filters to display all nodes and fields or only the selected fields. According to the schema definition, some fields may be mandatory and pre-selected. You cannot unselect them. All fields that are mandatory for the event to be received properly by journeys are selected by default.

    note note
    For system-generated events, make sure that you have added the “orchestration” field group to the XDM schema. This will ensure that your schema contains all the required information to work with Journey Optimizer.

  2. Select the fields that you expect to receive from the event. These are the fields which the business user will leverage in the journey. They must also include the key that will be used to identify the person associated to the event (see this section).

    note note
    For system-generated events, the eventID field is automatically added in the list of fields selected so that Journey Optimizer can identify the event. The system pushing the event should not generate an ID, it should use the one available in the payload preview. See this section.
  3. When you’re done selecting the needed fields, click Ok or press Enter.

    The number of selected fields appears in the Fields field.

Select the namespace select-the-namespace

The namespace allows you to define the type of key used to identify the person associated to the event. Its configuration is optional. It is required if you want to retrieve, in your journeys, additional information coming from the Real-time Customer Profile. The namespace definition is not needed if you’re only using data coming from a third-party system through a custom data source.

You can either use one of the predefined ones or create a new one using the Identity Namespace service. Refer to Adobe Experience Platform documentation.

If you select a schema that has a primary identity, then the Profiler identifier and Namespace fields are pre-filled. If there is no identity defined, we select identityMap > id as the primary key. Then you have to select a namespace and the key will be pre-filled (below the Namespace field) using identityMap > id.

When selecting fields, primary identity fields are tagged.

Select a namespace from the drop-down list.

Only one namespace is allowed per journey. If you use several events in the same journey, they need to use the same namespace. See this page.

You can only select a people-based identity namespace. If you have defined a namespace for a lookup table (for example: ProductID namespace for a Product lookup), it will not be available in the Namespace dropdown list.

Define the profile identifier define-the-event-key

The key is the field, or combination of fields, which is part of the event payload data and that allows the system to identify the person associated to the event. The key can be, for example, the Experience Cloud ID, a CRM ID, or an email address.

To use data stored in Adobe Real-time Customer Profile database, the event key must be the information you defined as a profile’s identity in the Real-time Customer Profile Service.

The profile identifier allows the system to perform the reconciliation between the event and the individual’s profile. If you select a schema that has a primary identity, then the Profile identifier and Namespace fields are pre-filled. If there is no identity defined, the identityMap > id is the primary key. Then you must select a namespace, and the key is automatically pre-filled using identityMap > id.

When selecting fields, primary identity fields are tagged.

If you need to use a different key, such as a CRM ID or an email address, you need to add it manually, as explained below:

  1. Click inside the Profile identifier field, or on the pencil icon.

  2. Select the field chosen as the key in the list of payload fields. You can also switch to the advanced expression editor to create more complex keys (for example, a concatenation of two fields of the events).

When the event is received, the value of the key allows the system to identify the person associated to the event. Associated to a namespace (see this section), the key can be used to perform queries on Adobe Experience Platform. See this page.
The key is also used to check that a person is in a journey. Indeed, a person cannot be at two different places in the same journey. As a result, the system does not allow the same key, for example the key CRMID=3224, to be at different places in the same journey.

You also have access to the advanced expression functions (Advanced mode) if you want to perform additional manipulations. These functions let you manipulate the values used to carry out specific queries such changing formats, performing field concatenations, taking into account only a part of a field (for example the 10 first characters). See this page.

Preview the payload preview-the-payload

The payload preview allows you to validate the payload definition.

For system-generated events, when you create an event, before viewing the payload preview, save your event and re-open it. This step is needed to generate an event ID in the payload.
  1. Click the View Payload icon to preview the payload expected by the system.

    You can notice that the fields selected are displayed.

  2. Check the preview to validate the payload definition.

  3. Then, you can share the payload preview with to the person responsible for the event sending. This payload can help them design the setup of an event pushing to Journey Optimizer. See this page.