Skip to content

Latest commit

 

History

History
688 lines (310 loc) · 16.1 KB

journeyStepEventActionExecutionFieldsMixin.schema.md

File metadata and controls

688 lines (310 loc) · 16.1 KB

Journey Orchestration Step Event Action Execution Fields Schema

https://ns.adobe.com/experience/journeyOrchestration/stepEvents/journeyStepEventActionExecutionFields

This Fieldgroup will have Journey Action Metadata Fields.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted adobe/experience/journeyOrchestration/stepEvents/journeyStepEventActionExecutionFieldsMixin.schema.json

Journey Orchestration Step Event Action Execution Fields Properties

Property Type Required Defined by
https://ns.adobe.com/experience/journeyOrchestration/stepEvents object Optional Journey Orchestration Step Event Action Execution Fields (this schema)
* any Additional this schema allows additional properties

Journey Orchestration Action Execution Fields.

https://ns.adobe.com/experience/journeyOrchestration/stepEvents

  • is optional
  • type: object
  • defined in this schema

object with following properties:

Property Type Required
https://ns.adobe.com/experience/journeyOrchestration/actionBusinessType string Optional
https://ns.adobe.com/experience/journeyOrchestration/actionErrorContext string Optional
https://ns.adobe.com/experience/journeyOrchestration/actionExecutionError string Optional
https://ns.adobe.com/experience/journeyOrchestration/actionExecutionErrorCode string Optional
https://ns.adobe.com/experience/journeyOrchestration/actionExecutionOriginCode string Optional
https://ns.adobe.com/experience/journeyOrchestration/actionExecutionOriginError string Optional
https://ns.adobe.com/experience/journeyOrchestration/actionExecutionTime integer Optional
https://ns.adobe.com/experience/journeyOrchestration/actionGroupID string Optional
https://ns.adobe.com/experience/journeyOrchestration/actionGroupName string Optional
https://ns.adobe.com/experience/journeyOrchestration/actionID string Optional
https://ns.adobe.com/experience/journeyOrchestration/actionName string Optional
https://ns.adobe.com/experience/journeyOrchestration/actionParameterized boolean Optional
https://ns.adobe.com/experience/journeyOrchestration/actionSchedulerCount integer Optional
https://ns.adobe.com/experience/journeyOrchestration/actionType string Optional
https://ns.adobe.com/experience/journeyOrchestration/batchDeliveryID string Optional
https://ns.adobe.com/experience/journeyOrchestration/channel string Optional
https://ns.adobe.com/experience/journeyOrchestration/consent object Optional
https://ns.adobe.com/experience/journeyOrchestration/deliveryJobID string Optional
https://ns.adobe.com/experience/journeyOrchestration/experimentationID string Optional
https://ns.adobe.com/experience/journeyOrchestration/experimentationName string Optional
https://ns.adobe.com/experience/journeyOrchestration/fromSegmentTrigger boolean Optional
https://ns.adobe.com/experience/journeyOrchestration/interactionType string Optional
https://ns.adobe.com/experience/journeyOrchestration/isSendTimeOptimized boolean Optional
https://ns.adobe.com/experience/journeyOrchestration/messageID string Optional
https://ns.adobe.com/experience/journeyOrchestration/publishedMessageID string Optional
https://ns.adobe.com/experience/journeyOrchestration/surfaceID string Optional
https://ns.adobe.com/experience/journeyOrchestration/treatmentID string Optional
https://ns.adobe.com/experience/journeyOrchestration/treatmentName string Optional
actionBusinessType

The business solution powering the executed action. E.g: ACC, Epsilon.

https://ns.adobe.com/experience/journeyOrchestration/actionBusinessType

  • is optional
  • type: string

string

ActionErrorContext

Provides context of the error. Potential values: 'authCallError': error has occured in scope of custom or Adobe.IO authentication by calling the authentication endpoint to generate an access token, 'callError': error has occured on action call endpointTreatment name applied to execute the action

https://ns.adobe.com/experience/journeyOrchestration/actionErrorContext

  • is optional
  • type: string

string

actionExecutionError

Error condition that prevented Journey Runtime from executing the action. E.g: timeout on the action step, capping on the action API etc, http error.

https://ns.adobe.com/experience/journeyOrchestration/actionExecutionError

  • is optional
  • type: string

string

actionExecutionErrorCode

Error code corresponding to actionExecutionError.

https://ns.adobe.com/experience/journeyOrchestration/actionExecutionErrorCode

  • is optional
  • type: string

string

actionExecutionOriginCode

Error code corresponding to actionExecutionOriginError.

https://ns.adobe.com/experience/journeyOrchestration/actionExecutionOriginCode

  • is optional
  • type: string

string

actionExecutionOriginError

In case of timeout or http error, the latest API response message. E.g: invalid payload, internal server error.

https://ns.adobe.com/experience/journeyOrchestration/actionExecutionOriginError

  • is optional
  • type: string

string

actionExecutionTime

Time(ms) inside Journey Engine to call the necessary APIs to execute the action.

https://ns.adobe.com/experience/journeyOrchestration/actionExecutionTime

  • is optional
  • type: integer

integer

ActionGroupID

Action Group ID

https://ns.adobe.com/experience/journeyOrchestration/actionGroupID

  • is optional
  • type: string

string

ActionGroupName

Action Group Name

https://ns.adobe.com/experience/journeyOrchestration/actionGroupName

  • is optional
  • type: string

string

actionID

GUID generated when the action is first authored on the JO canvas. Replicating the same action indirectly, by means of duplicating the journey or publishing a new version does not generate a new actionID.

https://ns.adobe.com/experience/journeyOrchestration/actionID

  • is optional
  • type: string

string

actionName

Name of the action as it appears on the Journey Canvas, if the action is internal to JO Runtime, then action name is set to stepName field.

https://ns.adobe.com/experience/journeyOrchestration/actionName

  • is optional
  • type: string

string

actionParameterized

True if the journey runtime passed in dynamic values retrieved at runtime to successfully execute the action. E.g: This field will be set to true, if a custom http action requires some values from external data sources for successful execution.

https://ns.adobe.com/experience/journeyOrchestration/actionParameterized

  • is optional
  • type: boolean

boolean

actionSchedulerCount

Number of times the Journey Runtime Scheduler was invoked to fulfil the given journey step. E.g for a Wait step, count of actionSchedulerCount=1

https://ns.adobe.com/experience/journeyOrchestration/actionSchedulerCount

  • is optional
  • type: integer

integer

actionType

Denotes the action channel invoked. E.g: Email, SMS, customHttp

https://ns.adobe.com/experience/journeyOrchestration/actionType

  • is optional
  • type: string

string

batchDeliveryID

(Deprecated).This describes the delivery Id for the batch Journey.

https://ns.adobe.com/experience/journeyOrchestration/batchDeliveryID

  • is optional
  • type: string

string

Channel

Channel Name like email, push, sms

https://ns.adobe.com/experience/journeyOrchestration/channel

  • is optional
  • type: string

string

Consent

Fields corresponding to action consent.

https://ns.adobe.com/experience/journeyOrchestration/consent

  • is optional
  • type: object

Unknown type object.

{
  "title": "Consent",
  "description": "Fields corresponding to action consent.",
  "type": "object",
  "properties": {
    "https://ns.adobe.com/experience/journeyOrchestration/rejectedPoliciesCount": {
      "title": "RejectedPoliciesCount",
      "description": "Count of rejected consent policies",
      "type": "integer"
    },
    "https://ns.adobe.com/experience/journeyOrchestration/rejectedPolicies": {
      "title": "RejectedPolicies",
      "description": "Rejected Consent Policy details array object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "xdm:ID": {
            "title": "ID",
            "description": "ID of the rejected Consent policy.",
            "type": "string"
          },
          "xdm:name": {
            "title": "Name",
            "description": "Name of the corresponding rejected Consent policy.",
            "type": "string"
          }
        }
      }
    }
  },
  "simpletype": "`object`"
}
deliveryJobID

(Deprecated).This describes the delivery Job Id for the batch Journey.

https://ns.adobe.com/experience/journeyOrchestration/deliveryJobID

  • is optional
  • type: string

string

ExperimentationID

Experimentation ID

https://ns.adobe.com/experience/journeyOrchestration/experimentationID

  • is optional
  • type: string

string

ExperimentationName

Experimentation Name

https://ns.adobe.com/experience/journeyOrchestration/experimentationName

  • is optional
  • type: string

string

fromSegmentTrigger

(Deprecated).This describes if the Batch Journey triggered from Audisence Segment.

https://ns.adobe.com/experience/journeyOrchestration/fromSegmentTrigger

  • is optional
  • type: boolean

boolean

InteractionType

Indicate the interaction type, either 'marketing' or 'transactional'. Remark: this will be relevant for message and custom actions

https://ns.adobe.com/experience/journeyOrchestration/interactionType

  • is optional
  • type: string

string

IsSendTimeOptimized

Indicate if the message execution has been delayed by applying a send time optimization

https://ns.adobe.com/experience/journeyOrchestration/isSendTimeOptimized

  • is optional
  • type: boolean

boolean

MessageID

Message ID referenced in inline message action of a journey

https://ns.adobe.com/experience/journeyOrchestration/messageID

  • is optional
  • type: string

string

PublishedMessageID

Published message ID in inline message action of a journey

https://ns.adobe.com/experience/journeyOrchestration/publishedMessageID

  • is optional
  • type: string

string

SurfaceID

Surface ID

https://ns.adobe.com/experience/journeyOrchestration/surfaceID

  • is optional
  • type: string

string

TreatmentID

Treatment ID applied to execute the action

https://ns.adobe.com/experience/journeyOrchestration/treatmentID

  • is optional
  • type: string

string

TreatmentName

Treatment name applied to execute the action

https://ns.adobe.com/experience/journeyOrchestration/treatmentName

  • is optional
  • type: string

string