Add Journey context and delivery attributes in experience event #472
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -191,6 +191,16 @@ | |
| "type": "integer", | ||
| "description": | ||
| "The delivery template's ID used to initialize this delivery.\n\nThe type the template used in Adobe Campaign can be identified using the `messageClass`.\n\n* `messageClass` = `oneTime`: the template is standard delivery template.\n* `messageClass` = `continuous`: the template is a recurring delivery.\n* `messageClass` = `transactional`: the template is a transactionnal message template.\n" | ||
| }, | ||
| "xdm:deliveryLabel": { | ||
| "title": "Delivery Label", | ||
| "type": "string", | ||
| "description" : "Human friendly name of the campaign activity which is originating this message." | ||
| }, | ||
| "xdm:deliveryName": { | ||
|
There was a problem hiding this comment. I still think the term delivery is not needed here and in the Otherwise you could also make the case to call the ID field There was a problem hiding this comment. change from "name", "label" to deliveryName and "deliveryLabel" is requested in one of the review comments. |
||
| "title": "Delivery Internal name", | ||
| "type": "string", | ||
| "description" : "Friendly identifier of the campaign activity which is originating this message." | ||
|
There was a problem hiding this comment. I think the topic is that both the |
||
| } | ||
| } | ||
| }, | ||
|
|
@@ -202,6 +212,11 @@ | |
| "title": "Campaign ID", | ||
| "type": "integer", | ||
| "description": "Identifier of the marketing campaign to which activity originating this message belongs to." | ||
| }, | ||
| "xdm:campaignName": { | ||
|
There was a problem hiding this comment. Same discussion here for |
||
| "title": "Campaign Internal name", | ||
| "type": "string", | ||
| "description" : "Friendly identifier of the marketing campaign which is originating this message." | ||
| } | ||
| } | ||
| }, | ||
|
|
@@ -255,8 +270,37 @@ | |
| "type": "string", | ||
| "description": | ||
| "Business qualifier that identifies the event sent by the data source. It informs on the business reason for sending the event. It is unique per organization. This is used by Campaign orchestration to identify the event without inspecting its payload to determine which action should be triggered when the event is received. The value of this field is a contract between Campaign orchestration and the data source." | ||
| }, | ||
| "orchestrationDetails": { | ||
| "title": "Orchestration Details", | ||
| "description": "Set of attributes that are associated with every orchestration.", | ||
| "type": "object", | ||
| "properties": { | ||
| "journey": { | ||
| "title": "Journey for an entity", | ||
| "$ref": "https://ns.adobe.com/experience/campaign/orchestration/experienceevent#/definitions/journey", | ||
| "description": "Journey created by marketer for its entities." | ||
| }, | ||
| "journeyVersion": { | ||
| "title": "Journey Version for an entity", | ||
| "$ref": "https://ns.adobe.com/experience/campaign/orchestration/experienceevent#/definitions/journeyVersion", | ||
| "description": "Schema for describing the version of a journey, where version holds the state machine." | ||
| }, | ||
| "action": { | ||
| "title": "Action associated with a journey", | ||
| "$ref": "https://ns.adobe.com/experience/campaign/orchestration/experienceevent#/definitions/action", | ||
| "description": "Action that is executed for an entity when reached a step in in the journey state machine.", | ||
| "required":["xdm:actionID"] | ||
| } | ||
| }, | ||
| "required":["journey", "journeyVersion", "action"], | ||
| } | ||
| } | ||
| }, | ||
| "https://ns.adobe.com/experience/campaign/containerID": { | ||
| "title": "Container identifier", | ||
| "type": "string", | ||
| "description": "The identifier denoting the container with which campaign experience event is associated." | ||
| } | ||
| } | ||
| }, | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| { | ||
| "meta:license": [ | ||
| "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", | ||
| "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", | ||
| "you may not use this file except in compliance with the License. You may obtain a copy", | ||
| "of the License at https://creativecommons.org/licenses/by/4.0/" | ||
| ], | ||
| "$id": | ||
| "https://ns.adobe.com/experience/campaign/orchestration/experienceevent", | ||
| "$schema": "http://json-schema.org/draft-06/schema#", | ||
| "title": "Journey experience event", | ||
| "type": "object", | ||
| "description": "Orchestration extension to ExperienceEvent", | ||
| "definitions": { | ||
| "journey": { | ||
| "title": "Journey of an entity", | ||
| "type": "object", | ||
| "description": "Journey created for an entity by marketer.", | ||
| "properties": { | ||
| "@id": { | ||
| "title": "Journey unique identifier", | ||
| "type": "string", | ||
| "format": "uri", | ||
|
There was a problem hiding this comment. should this now be uri-reference? There was a problem hiding this comment. @lrosenthol I changed @id's format from uri to uri-reference [observed similar usages in the master branch] |
||
| "description": "The unique identifier of the journey created by the marketer." | ||
| } | ||
| }, | ||
| "required": ["@id"] | ||
| }, | ||
| "journeyVersion": { | ||
| "title": "Journey version", | ||
| "type": "object", | ||
| "description": "Schema for describing the version of a journey, where version holds the state machine", | ||
| "properties": { | ||
| "@id": { | ||
| "title": "Journey version identifier", | ||
| "type": "string", | ||
| "format": "uri", | ||
|
There was a problem hiding this comment. should this now be uri-reference? There was a problem hiding this comment. |
||
| "description": "The unique identifier denoting the version of journey on which the entity is active." | ||
| } | ||
| }, | ||
| "required": ["@id"] | ||
| }, | ||
| "action": { | ||
| "title": "Action on step transition", | ||
| "type": "object", | ||
| "description": "Action taken during a step transition that happened for an entity in state machine", | ||
| "properties": { | ||
| "xdm:actionID": { | ||
| "title": "Action identifier", | ||
| "type": "string", | ||
| "format": "uri", | ||
|
There was a problem hiding this comment. should this now be uri-reference? There was a problem hiding this comment. |
||
| "description": "Unique identifier denoting the associated action." | ||
| }, | ||
| "xdm:actionType": { | ||
| "title": "Action Type", | ||
| "type": "string", | ||
| "description": "The type of action to be performed.", | ||
| "meta:enum": { | ||
|
There was a problem hiding this comment. I am a bit at unease with the labels of this enum:
I think the labels should be consistently structured and not be tied to a current product name (which may change outside of our control and which limits the general applicability of this data structure. There was a problem hiding this comment. 1)This actionType is already introduced XDM reporting event and now I am referring the same in campaign experience event. If inconsistent names needs to be handled here then it would be a breaking change. Should I create a separate issue and assign it to the concern person? There was a problem hiding this comment. @ksradobe wrote:
This is a good call-out. Yet what is evolutionary state of this ? is it draft or stabilizing or finalized ? There was a problem hiding this comment. @fmeschbe It is in stabilizing state. There was a problem hiding this comment. Yes, I like that much better. How about
Thereby aligning with the new There was a problem hiding this comment. @fmeschbe pushed my changes. |
||
| "scheduled_notification": | ||
| "This action type allows to specify scheduled notifications and wait for the notifications as incoming events for steps", | ||
| "http_call": | ||
| "This action type is for a HTTP call on an external system", | ||
| "action_with_personalization": | ||
| "This action type describes an action with personalization that will be resolved at runtime for each voyager instance", | ||
| "parameterized_action": | ||
| "This action type describes an action with parameterization", | ||
| "send_journey_notification": | ||
| "This action type is to send notification for another journey", | ||
| "acs_writer": | ||
| "The ACS writer action performs REST calls to an Adobe campaign standard instance to write data", | ||
| "acs_message_center": | ||
| "The ACS message center action performs REST calls to an Adobe campaign standard instance to send messages with Message Center" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "allOf": [ | ||
| { | ||
| "$ref": "#/definitions/journey" | ||
| }, | ||
| { | ||
| "$ref": "#/definitions/journeyVersion" | ||
| }, | ||
| { | ||
| "$ref": "#/definitions/action" | ||
| } | ||
| ], | ||
| "meta:status": "stabilizing" | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ID isn't a number - it's a string.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here,"id" attribute is an integer as per the XDM schema.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is custom attribute xdm:id which is of type integer but not "@id" whose type is string