Skip to content

Latest commit

 

History

History
317 lines (142 loc) · 8.45 KB

journeyStepEventDataFetchFieldsMixin.schema.md

File metadata and controls

317 lines (142 loc) · 8.45 KB

Journey Orchestration Step Data Fetch Fields Schema

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

Journey Orchestration Data Fetch Field for a Step Event.

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

Journey Orchestration Step Data Fetch Fields Example

{
  "https://ns.adobe.com/experience/journeyOrchestration/fetchTotalTime": 300,
  "https://ns.adobe.com/experience/journeyOrchestration/fetchError": "http",
  "https://ns.adobe.com/experience/journeyOrchestration/fetchPlatformTotalTime": 300,
  "https://ns.adobe.com/experience/journeyOrchestration/fetchPlatformCount": 48,
  "https://ns.adobe.com/experience/journeyOrchestration/fetchCustomTotalTime": 434,
  "https://ns.adobe.com/experience/journeyOrchestration/fetchErrorContext": "authCallError"
}

Journey Orchestration Step Data Fetch Fields Properties

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

Journey Step Event Data Fetch Field.

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/fetchCount integer Optional
https://ns.adobe.com/experience/journeyOrchestration/fetchCustomCount integer Optional
https://ns.adobe.com/experience/journeyOrchestration/fetchCustomTotalTime integer Optional
https://ns.adobe.com/experience/journeyOrchestration/fetchError string Optional
https://ns.adobe.com/experience/journeyOrchestration/fetchErrorCode string Optional
https://ns.adobe.com/experience/journeyOrchestration/fetchErrorContext string Optional
https://ns.adobe.com/experience/journeyOrchestration/fetchOriginError string Optional
https://ns.adobe.com/experience/journeyOrchestration/fetchOriginErrorCode string Optional
https://ns.adobe.com/experience/journeyOrchestration/fetchPlatformCount integer Optional
https://ns.adobe.com/experience/journeyOrchestration/fetchPlatformTotalTime integer Optional
https://ns.adobe.com/experience/journeyOrchestration/fetchTotalTime integer Optional
https://ns.adobe.com/experience/journeyOrchestration/fetchTypeInError string Optional
fetchCount

(Deprecated)Sum of number of calls made to custom data source and to AEP to fetch the required details to process a step. E.g: To process a condition step.

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

  • is optional
  • type: integer

integer

fetchCustomCount

Number of calls made to custom data source and to AEP to fetch the required details to process a step. E.g: To process a condition step.

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

  • is optional
  • type: integer

integer

fetchCustomTotalTime

Total time(ms) to fetch all the required fields from the custom data source to execute the step.

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

  • is optional
  • type: integer

integer

fetchError

Error condition that prevented Journey Runtime from executing the fetch. E.g: capping on the Data Source API etc, http error.

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

  • is optional
  • type: string

string

fetchErrorCode

Error code corresponding to fetchError.

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

  • is optional
  • type: string

string

FetchErrorContext

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/fetchErrorContext

  • is optional
  • type: string

string

fetchOriginError

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

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

  • is optional
  • type: string

string

fetchOriginErrorCode

Error code corresponding to fetchOriginError.

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

  • is optional
  • type: string

string

fetchPlatformCount

Number of calls made to AEP to fetch the required details to process a step.

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

  • is optional
  • type: integer

integer

fetchPlatformTotalTime

Total time(ms) to fetch all the required fields from the custom data source to execute the step.

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

  • is optional
  • type: integer

integer

fetchTotalTime

(Deprecated).Sum of fetchPlatformTotalTime and fetchCustomTotalTime.

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

  • is optional
  • type: integer

integer

fetchTypeInError

The source of the first error that occurred while fetching fields to compute a journey step. Set to either Custom or AEP.

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

  • is optional
  • type: string

string