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 |
|---|---|---|
| @@ -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-reference", | ||
| "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-reference", | ||
| "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-reference", | ||
| "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_request": | ||
| "This action type is for a HTTP call on an external system", | ||
| "personalized_action": | ||
| "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", | ||
| "journey_notification": | ||
| "This action type is to send notification for another journey", | ||
| "campaign_request": | ||
| "This action performs REST calls to a campaign instance to write data", | ||
| "messageService_request": | ||
| "The message service action performs REST calls to campaign instance to send messages with messaging service" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "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