diff --git a/extensions/adobe/experience/campaign/experienceevent.example.email-send.json b/extensions/adobe/experience/campaign/experienceevent.example.email-send.json index dc8852f4a..22f9c045b 100644 --- a/extensions/adobe/experience/campaign/experienceevent.example.email-send.json +++ b/extensions/adobe/experience/campaign/experienceevent.example.email-send.json @@ -59,12 +59,16 @@ "xdm:from": "no-reply@adobe.com", "xdm:testEnabled": true, "xdm:messageClass": "continuous", - "xdm:templateID": 1000 + "xdm:templateID": 1000, + "xdm:deliveryName": "DM200", + "xdm:deliveryLabel": "Birthday Wishes" }, "https://ns.adobe.com/experience/campaign/marketingCampaign": { - "xdm:id": 100 + "xdm:id": 100, + "xdm:campaignName": "CAMP2010" }, "https://ns.adobe.com/experience/campaign/orchestration": { "xdm:businessReason": "onJourneyEnter" - } + }, + "https://ns.adobe.com/experience/campaign/containerID": "customer-stage" } diff --git a/extensions/adobe/experience/campaign/experienceevent.schema.json b/extensions/adobe/experience/campaign/experienceevent.schema.json index ef716e28e..7a6d1746a 100644 --- a/extensions/adobe/experience/campaign/experienceevent.schema.json +++ b/extensions/adobe/experience/campaign/experienceevent.schema.json @@ -191,6 +191,18 @@ "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": + "A human-friendly name of the campaign activity which is originating this message." + }, + "xdm:deliveryName": { + "title": "Delivery Internal name", + "type": "string", + "description": + "A human-friendly identifier of the campaign activity which is originating this message." } } }, @@ -204,6 +216,12 @@ "type": "integer", "description": "Identifier of the marketing campaign to which activity originating this message belongs to." + }, + "xdm:campaignName": { + "title": "Campaign Internal name", + "type": "string", + "description": + "A human-friendly identifier of the marketing campaign which is originating this message." } } }, @@ -260,8 +278,44 @@ "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." } } }, diff --git a/extensions/adobe/experience/campaign/orchestration/experienceevent.schema.json b/extensions/adobe/experience/campaign/orchestration/experienceevent.schema.json new file mode 100644 index 000000000..f02416312 --- /dev/null +++ b/extensions/adobe/experience/campaign/orchestration/experienceevent.schema.json @@ -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": { + "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" +} diff --git a/extensions/adobe/experience/campaign/orchestration/reportingevent.example.1.json b/extensions/adobe/experience/campaign/orchestration/reportingevent.example.1.json index 556adbd29..31774cc81 100644 --- a/extensions/adobe/experience/campaign/orchestration/reportingevent.example.1.json +++ b/extensions/adobe/experience/campaign/orchestration/reportingevent.example.1.json @@ -31,7 +31,7 @@ "https://ns.adobe.com/experience/campaign/orchestrationAction": { "xdm:actionID": "https://ns.adobe.com/experience/campaign/orchestration/action/123", - "xdm:type": "parameterized_action" + "xdm:actionType": "parameterized_action" }, "https://ns.adobe.com/experience/campaign/orchestrationExternalEvent": { "@id": diff --git a/extensions/adobe/experience/campaign/orchestration/reportingevent.schema.json b/extensions/adobe/experience/campaign/orchestration/reportingevent.schema.json index d088ffd26..412cf4a82 100644 --- a/extensions/adobe/experience/campaign/orchestration/reportingevent.schema.json +++ b/extensions/adobe/experience/campaign/orchestration/reportingevent.schema.json @@ -65,30 +65,9 @@ }, "https://ns.adobe.com/experience/campaign/orchestrationAction": { "title": "Action on step transition", - "type": "object", - "description": "Action taken during a step transition happening for an user in state machine", - "properties": { - "xdm:actionID": { - "title": "Action identifier", - "type": "string", - "format": "uri", - "description": "Unique identifier denoting the associated action." - }, - "xdm:type": { - "title": "Action Type", - "type": "string", - "description": "The type of action to be performed.", - "meta:enum": { - "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" - } - } - } + "description": + "Action taken during a step transition happening for an user in state machine", + "$ref": "https://ns.adobe.com/experience/campaign/orchestration/experienceevent#/definitions/action" }, "https://ns.adobe.com/experience/campaign/orchestrationExternalEvent": { "title": "external event received", @@ -97,35 +76,14 @@ }, "https://ns.adobe.com/experience/campaign/journey": { "title": "Journey for users", - "type": "object", "description": "Journey created by marketer for its users", - "properties": { - "@id": { - "title": "Journey unique identifier", - "type": "string", - "format": "uri-reference", - "description": "The unique identifier of the journey created by the marketer." - } - }, - "required": [ - "@id" - ] + "$ref": "https://ns.adobe.com/experience/campaign/orchestration/experienceevent#/definitions/journey" }, "https://ns.adobe.com/experience/campaign/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 user is active" - } - }, - "required": [ - "@id" - ] + "description": + "Schema for describing the version of a journey, where version holds the state machine", + "$ref": "https://ns.adobe.com/experience/campaign/orchestration/experienceevent#/definitions/journeyVersion" } } }