Configure Experience Platform event definitions
Administrators can configure 51ºÚÁϲ»´òìÈ Experience Platform (AEP)-based event definitions, which enable Marketers to create account journeys that react to AEP Experience Events. Using AEP experience events in account journeys is a two-step process:
-
Create and publish an AEP event definition.
-
In an account journey, add a Listen for an event node and select an AEP event definition as a people event.
Each event definition requires the following Experience Platform input:
-
Schema – XDM schema that defines the Experience Event data structure. It must be based on an Experience Event and must be profile-enabled.
note note NOTE Coordinate with your Engineering team to ensure that the needed schemas are defined. Creating XDM schemas is a complex process performed by data engineers based on use case requirements across your organization. -
Event types – XDM ExperienceEvent eventType (maximum of 20 per event definition).
-
Fields – XDM fields that are present in the schema (maximum of 20 per event definition)
-
Name - A unique name for the event definition.
-
Description - A description for the event definition.
Limitations and guardrails
As you create and manage your event definitions to meet your organizational goals, keep the following in mind:
-
Journey Optimizer B2B Edition supports a maximum of 50 event definitions.
-
Only one AEP event definition can use a combined schema and set of event types. When you create an event definition using a schema (for example,
My Schema) and an event type (for example,Web Webpagedetails Page Views), no other event definition can use the combination ofMy SchemaandWeb Webpagedetails Page Views. -
An event definition can be used in more than one account journey.
-
AEP Experience Events can be used for decisioning purposes within an account journey, but are not retained. Therefore, no historical record of AEP Experience Events can be leveraged within Journey Optimizer B2B Edition.
-
The constraints for date of activity and minimum number of times are not supported.
-
After an event definition is published, the schema and name cannot be modified. However, you can add event types and fields by creating a draft version and publishing again.
-
Event definitions used in published journeys cannot be deleted.
Access and manage event definitions
-
In the left navigation, choose Administration > Configuration.
-
Click Events on the intermediate panel to display the list of event definitions.
From this page, you can create, publish, edit, and delete event definitions.
The table is sorted by the Modified column, with the most recently updated definitions at the top by default.
-
To access the details for an event definition, click the name.
Event definition status and lifecycle
In the Event definitions list, the Status column indicates the current status for each definition. The status determines its availability for use in account journeys, and the changes that you can make to it.
When you create an event definition, it is in draft status. It remains in this status until you publish it for use in account journeys. Available actions:
- Edit all details
- Publish
- Delete
When you publish an event definition, it becomes available for use in account journeys. The details cannot be modified. Available actions:
- Available for Listen for an event journey node
- Create draft version
- Delete (if not in-use)
When you create a draft from a published event definition, the published version remains available for use in account journeys, and the draft version can be modified. If you publish the draft version, it replaces the current published version and the event definition is updated for account journeys where it is not yet executed. Available actions:
- Edit all details
- Publish draft version
- Discard draft version
- Delete (if not in-use)
Filter the event definitions list
To search for an event definition by name, enter a text string into the search bar for a match.
Create an event definition
-
In the left navigation, choose Administration > Configuration.
-
Click Events on the intermediate panel to display the list of event definitions.
-
Click Create event at the top right.
-
Enter the Name (required) and Description (optional).
-
Set the Schema to use for the event definition.
The schema that you select determines the fields that are available to add to the definition, which are then available as constraints for a Listen for an event node in an account journey.
- Click Select schema.
- In the dialog, select a schema from the list of Experience Event-based schemas.
- Click Select.
-
Select the Event types to use for the event definition.
The event types that you select determine the events that are available as constraints for a Listen for an event node in an account journey.
- Click Select event types.
- In the dialog, select one or more event types from the list (maximum of 20).
- Click Select.
-
Select the Fields to use for the event definition.
The fields that you select determine the constraints that are available when the event is used for a Listen for an event node in an account journey.
note note NOTE The eventTypefield is required and automatically selected.- Click Select fields.
- In the dialog, select one or more fields from the list (maximum of 20).
- Click Select.
-
When the schema, event types, and fields are complete, click Create.
Upon creation, the list page is displayed and the new event is at the top of the list with a Draft status.
Publish an event definition
When you are satisfied that the draft event definition is complete and correct for your needs, you can publish it to make it available for use in account journeys. After the event definition is published, you can create a draft version if you need to make changes to it. However, you cannot change the schema, and you can only add event types and fields (you cannot delete them).
-
In the left navigation, choose Administration > Configuration.
-
Click Events on the intermediate panel to display the list of event definitions.
-
In the Event definitions list, click the name of the draft event definition to open the details page.
If needed, review the settings before you publish. You can edit the draft if it does not satisfy your requirements.
-
Click Publish at the top right.
-
In the confirmation dialog, click Publish.
The status for the event definition changes to Published and it is now available for use in account journeys.
Edit an event definition
-
In the left navigation, choose Administration > Configuration.
-
Click Events on the intermediate panel to display the list of event definitions.
Edits to an event definition depend on its current status:
- When an event definition is in Draft status, you can edit any of its details.
- When an event definition is in Published status, you cannot edit it. You can create a draft version that is editable and then replace the published version.
- When an event definition is in Published (with draft) status, you can change the draft version (edit the description, and add event types and fields).
-
From the Event definitions listing page, click the event definition name to open it.
Follow the steps according to the status:
-
Change any of the event definition details as needed.
Follow that same guidelines that are used for creating an event definition.
The changes are automatically saved in the draft.
-
When the event definition meets your criteria and you want to make it available for use account journeys, click Publish.
-
In the confirmation dialog, click Publish.
The status for the event definition changes to Published and it is now available for use in account journeys.
-
To update the event definition, click Create draft version at the top right.
-
In the confirmation dialog, click Create draft to open the draft version.
This action creates the draft version and returns to the list page, where the event definition is now in Published (with draft) status.
-
Click the event definition name to open it.
For a Published (with draft) event definition, the Published version tab is selected by default.
-
Select the Draft version tab.
-
Change any of the editable details (Description, Event types, and Fields) as needed.
Follow that same guidelines that are used for creating an event definition.
The changes are automatically saved in the draft.
-
When the draft event definition meets your criteria and you want to replace the current published version for use in account journeys, click Publish Draft.
-
In the confirmation dialog, click Publish.
When you publish the draft version, it replaces the current published version and the event definition is updated for account journeys where it is already in use but not yet executed.
When you open a Published (with draft) event definition, the Published version tab is selected by default.
-
Select the Draft version tab.
-
Change any of the editable details (Description, Event types, and Fields) as needed.
Follow that same guidelines that are used for creating an event definition.
The changes are automatically saved in the draft.
-
When the draft event definition meets your criteria and you want to replace the current published version for use in account journeys, click Publish Draft.
-
In the confirmation dialog, click Publish.
When you publish the draft version, it replaces the current published version and the event definition is updated for account journeys where it is already in use but not yet executed.
Delete an event definition
You can delete an event definition if it is not in use by a published account journey.
-
In the left navigation, choose Administration > Configuration.
-
Click Events on the intermediate panel to display the list of event definitions.
-
Locate event definition in list and click the Delete (
-
In the confirmation dialog, click Delete.
