Process Map Events

DTOs:

Lifecycle.LifecycleEventDefinition

Properties

Name	Type	Description	Notes
lifecycleEventDefinitionGroupId	String
lifecycleEventDefinitionId	LifecycleEventDefinitionId
dateCreated	Date		[optional]
lastUpdated	Date		[optional]
eventSubType	String	Depending on the Event Type, the eventSubType further defines the Event Definition	[optional]
hasSubscribers	Boolean	Boolean flag	[optional]
hasQueueSubscribers	Boolean	Boolean flag	[optional]
hasWebhookSubscribers	Boolean	Boolean flag	[optional]
wipLimit	Number	Depending on the Event Subtype, the number of units of Work-In-Progress	[optional]
cycleTimeThreshold	Number	Depending on the Event Subtype, the number of units of Work-In-Progress	[optional]
cycleTimeUnit	String	Depending on the Event Subtype, the unit of time (combine with the cycle time threshold)	[optional]
alertPercent	Number	Integer representation for alert percentage (depending on the Event Sub Type)	[optional]
stepId	String	Copied from Lifecycle Event Definition Group.	[optional]
stepName	String	Copied from Lifecycle Event Definition Group.	[optional]
stepDescription	String	Copied from Lifecycle Event Definition Group.	[optional]
toStepId	String	Copied from Lifecycle Event Definition Group. Relevant only for process events.	[optional]
toStepName	String	Copied from Lifecycle Event Definition Group. Relevant only for process events.	[optional]
toStepDescription	String	Copied from Lifecycle Event Definition Group. Relevant only for process events.	[optional]

Enum: EventSubTypeEnum

PreStep (value: "PreStep")
PostStep (value: "PostStep")
StepWIPLimit (value: "StepWIPLimit")
StepCycleTime (value: "StepCycleTime")
ProcessWIPLimit (value: "ProcessWIPLimit")
ProcessCycleTime (value: "ProcessCycleTime")
ProcessWIPLimitAlert (value: "ProcessWIPLimitAlert")
ProcessCycleTimeAlert (value: "ProcessCycleTimeAlert")

Enum: CycleTimeUnitEnum

Years (value: "Years")
Months (value: "Months")
Weeks (value: "Weeks")
Days (value: "Days")
Hours (value: "Hours")

Lifecycle.LifecycleEventDefinitionGroup

Properties

Name	Type	Description	Notes
lifecycleEventDefinitionGroupId	String
dateCreated	Date		[optional]
lastUpdated	Date		[optional]
eventName	String		[optional]
eventDescription	String	Description of the event goes here	[optional]
eventType	String		[optional]
lifecycleId	String		[optional]
lifecycleVersionNo	Number		[optional]
stepId	StepIdentifier		[optional]
toStepId	StepIdentifier		[optional]
lifecycleEventDefinitionList	[LifecycleEventDefinition]		[optional]
published	Boolean	Boolean flag if group has been published	[optional]
publicationDate	Date	Datetime indicating the first time group was published to an appSpace	[optional]

Enum: EventTypeEnum

Step (value: "Step")
Process (value: "Process")

Subtypes:

SubEventType	Trigger Type	Time	Notes
PreStep	Change in Journey	Immediately
PostStep	Change in Journey	Immediately
StepWIPLimit	Change in Journey	Buffer 5 seconds / Mute 1 minute	Triggers with each additional Journey above WIP limit.
StepCycleTime	Poll	5 minutes	Only triggers once per Journey per cycle.

Notes:

Mute: If the same event occurs within the mute time, the event will not fire.
Buffer: Amount of time used to aggregate events so most relevant events are sent. This can translate to a delay as long as the buffer time.

PreStep

Description:

Event fires off before a step is made on the customer journey.

{
	"eventDefinition": {
		"toStepName": null,
		"eventSubType": "PreStep",
		"wipLimit": null,
		"stepId": "5980cd0b-6b64-4932-ab55-dcd6ad239d82",
		"stepDescription": null,
		"hasWebhookSubscribers": true,
		"lifecycleEventDefinitionId": "b90e3356-8619-4994-918e-364cfd139fcd",
		"alertPercent": null,
		"cycleTimeThreshold": null,
		"cycleTimeUnit": null,
		"lastUpdated": "2018-12-04T20:58:20.953Z",
		"toStepId": null,
		"dateCreated": "2018-12-04T20:58:20.953Z",
		"hasSubscribers": true,
		"stepName": "test name for next step",
		"toStepDescription": null,
		"lifecycleEventDefinitionGroupId": "3cef63b1-885a-416c-bf0c-f155f840cf77",
		"hasQueueSubscribers": true
	},
	"eventWrapper": {
		"serviceVersion": 1,
		"eventBodyClassName": "com.chassi.microservice.dtos.lifecycle.Journey",
		"serviceApi": "lifecycle",
		"eventHeaders": {
			"Accept": "application/xml, text/xml, application/json, application/*+xml, application/*+json",
			"breadcrumbId": "ID-DESKTOP-HT1K8D2-1543957066263-0-50",
			"X-Chassi-UserId": "302f4396-da35-446c-9554-c0f0dec91929",
			"Connection": "Keep-Alive",
			"journeyId": "96b92498-8042-46e0-a3f0-2c3816817abf",
			"User-Agent": "Apache-HttpClient/4.5.6 (Java/1.8.0_171)",
			"Host": "localhost:7081",
			"X-Chassi-AppSpaceId": "a9f8956e-b894-4e54-9589-340f1ba83164",
			"Accept-Encoding": "gzip,deflate",
			"Content-Length": "154",
			"X-Chassi-TenantId": "4b0ad1b0-7f9e-49d8-8eff-6d58353a53e4",
			"Content-Type": "application/json"
		},
		"eventOperationId": "event-journey-change-step",
		"eventSourceOperationId": "journey-change-step",
		"eventJsonBody": {
			"journeyTags": [],
			"joruneyCreateDate": "2018-12-04T20:58:25.191Z",
			"externalCustomerId": null,
			"metadata": [],
			"currentStepType": null,
			"stepStartDatetime": "2018-12-04T20:58:25.848Z",
			"currentStepId": "5980cd0b-6b64-4932-ab55-dcd6ad239d82",
			"lastUpdated": "2018-12-04T20:58:25.852Z",
			"dateCreated": "2018-12-04T20:58:25.205Z",
			"versionNo": 1,
			"customerId": null,
			"elapsedJourneyTime": 0,
			"currentStepElapsedSeconds": 0,
			"lifecycleVersionId": "2ab4eda6-b2a8-454b-8a82-b7f48f3ef43c",
			"currentCycleElapsedSeconds": 0,
			"currentStepName": "test name for next step",
			"previousStepId": "2cfc0467-f8a3-4fe0-b0a4-0e7ebabf04b5",
			"currentPath": "{\"steps\":[{\"stepId\":\"2cfc0467-f8a3-4fe0-b0a4-0e7ebabf04b5\",\"stepName\":\"Start Step\",\"stepTime\":0.0,\"pathIndex\":1.0},{\"stepId\":\"5980cd0b-6b64-4932-ab55-dcd6ad239d82\",\"stepName\":\"test name for next step\",\"pathIndex\":2.0}]}",
			"currentCycleNo": 1,
			"previousStepName": "Start Step",
			"journeyId": "96b92498-8042-46e0-a3f0-2c3816817abf",
			"lifecycleId": "4025c06c-d58e-42e9-b906-57814fc6dcc9",
			"cycleStartDatetime": "2018-12-04T20:58:25.191Z",
			"previousStepType": "Not_Started",
			"lifecycleName": null
		},
		"eventTimestamp": "2018-12-04T20:58:25.924Z"
	}
}

PostStep

Description:

Event fires off following a step change on the customer journey.

{
	"eventDefinition": {
		"toStepName": null,
		"eventSubType": "PostStep",
		"wipLimit": null,
		"stepId": "5980cd0b-6b64-4932-ab55-dcd6ad239d82",
		"stepDescription": null,
		"hasWebhookSubscribers": true,
		"lifecycleEventDefinitionId": "b90e3356-8619-4994-918e-364cfd139fcd",
		"alertPercent": null,
		"cycleTimeThreshold": null,
		"cycleTimeUnit": null,
		"lastUpdated": "2018-12-04T20:58:20.953Z",
		"toStepId": null,
		"dateCreated": "2018-12-04T20:58:20.953Z",
		"hasSubscribers": true,
		"stepName": "test name for next step",
		"toStepDescription": null,
		"lifecycleEventDefinitionGroupId": "3cef63b1-885a-416c-bf0c-f155f840cf77",
		"hasQueueSubscribers": true
	},
	"eventWrapper": {
		"serviceVersion": 1,
		"eventBodyClassName": "com.chassi.microservice.dtos.lifecycle.Journey",
		"serviceApi": "lifecycle",
		"eventHeaders": {
			"Accept": "application/xml, text/xml, application/json, application/*+xml, application/*+json",
			"breadcrumbId": "ID-DESKTOP-HT1K8D2-1543957066263-0-50",
			"X-Chassi-UserId": "302f4396-da35-446c-9554-c0f0dec91929",
			"Connection": "Keep-Alive",
			"journeyId": "96b92498-8042-46e0-a3f0-2c3816817abf",
			"User-Agent": "Apache-HttpClient/4.5.6 (Java/1.8.0_171)",
			"Host": "localhost:7081",
			"X-Chassi-AppSpaceId": "a9f8956e-b894-4e54-9589-340f1ba83164",
			"Accept-Encoding": "gzip,deflate",
			"Content-Length": "154",
			"X-Chassi-TenantId": "4b0ad1b0-7f9e-49d8-8eff-6d58353a53e4",
			"Content-Type": "application/json"
		},
		"eventOperationId": "event-journey-change-step",
		"eventSourceOperationId": "journey-change-step",
		"eventJsonBody": {
			"journeyTags": [],
			"joruneyCreateDate": "2018-12-04T20:58:25.191Z",
			"externalCustomerId": null,
			"metadata": [],
			"currentStepType": "In_Progress",
			"stepStartDatetime": "2018-12-04T20:58:25.848Z",
			"currentStepId": "5980cd0b-6b64-4932-ab55-dcd6ad239d82",
			"lastUpdated": "2018-12-04T20:58:25.852Z",
			"dateCreated": "2018-12-04T20:58:25.205Z",
			"versionNo": 1,
			"customerId": null,
			"elapsedJourneyTime": 0,
			"currentStepElapsedSeconds": 0,
			"lifecycleVersionId": "2ab4eda6-b2a8-454b-8a82-b7f48f3ef43c",
			"currentCycleElapsedSeconds": 20,
			"currentStepName": "test name for next step",
			"previousStepId": "2cfc0467-f8a3-4fe0-b0a4-0e7ebabf04b5",
			"currentPath": "{\"steps\":[{\"stepId\":\"2cfc0467-f8a3-4fe0-b0a4-0e7ebabf04b5\",\"stepName\":\"Start Step\",\"stepTime\":0.0,\"pathIndex\":1.0},{\"stepId\":\"5980cd0b-6b64-4932-ab55-dcd6ad239d82\",\"stepName\":\"test name for next step\",\"pathIndex\":2.0}]}",
			"currentCycleNo": 1,
			"previousStepName": "Active",
			"journeyId": "96b92498-8042-46e0-a3f0-2c3816817abf",
			"lifecycleId": "4025c06c-d58e-42e9-b906-57814fc6dcc9",
			"cycleStartDatetime": "2018-12-04T20:58:25.191Z",
			"previousStepType": "In_Progress",
			"lifecycleName": null
		},
		"eventTimestamp": "2018-12-04T20:58:25.924Z"
	}
}

StepWIPLimit

Description:

Each step of a customer journey has an option to set a limit to how many WIP should be on that step at any given time. When this limit is reached, an event is fired off. All WIP events are aggregated with a buffer of 5 seconds so that if many journeys are moved at the same time, only the relevant events are triggered. There is also a mute period of a minute, so that you will not be flooded with the same events.

{
	"eventDefinition": {
		"toStepName": "test name for next step",
		"eventSubType": "StepWIPLimit",
		"wipLimit": 2,
		"stepId": "33fef084-3598-46ce-a32d-edc08387e180",
		"stepDescription": null,
		"hasWebhookSubscribers": true,
		"lifecycleEventDefinitionId": "243195e9-5a18-40bd-90bc-70d050a63404",
		"alertPercent": null,
		"cycleTimeThreshold": null,
		"cycleTimeUnit": null,
		"lastUpdated": "2018-12-06T19:12:53.920Z",
		"toStepId": "7253568e-4c48-494e-90e5-b5ad8bdec2ee",
		"dateCreated": "2018-12-06T19:12:53.920Z",
		"hasSubscribers": true,
		"stepName": "Start Step",
		"toStepDescription": null,
		"lifecycleEventDefinitionGroupId": "2957fc5a-1a62-4e00-8eca-e95ee518782b",
		"hasQueueSubscribers": true
	},
	"eventWrapper": {
		"serviceVersion": 1,
		"eventBodyClassName": null,
		"serviceApi": "lifecycle",
		"eventHeaders": {
			"CurrentWIPCount": "1"
		},
		"eventOperationId": null,
		"eventSourceOperationId": null,
		"eventJsonBody": null,
		"eventTimestamp": "2018-12-06T19:13:02.233Z"
	}
}

StepCycleTime

Description:

Similar to WIP limits, a cycle time can be set to each step, indicating how long a customer should be on any given step on the customer journey. Cycle time events are polled every 5 minutes. If a poll detects that the journey has reached the threshold over the last 5 minutes, an event will be fired. Once the event has been fired, it will not send any subsequent events for that threshold.

{
	"eventDefinition": {
		"toStepName": null,
		"eventSubType": "StepCycleTime",
		"wipLimit": null,
		"stepId": "8d7a724a-0cf2-4822-9c4c-f634957838ad",
		"stepDescription": null,
		"hasWebhookSubscribers": true,
		"lifecycleEventDefinitionId": "dfaf2c44-ca80-4c14-8c09-4210f1690588",
		"alertPercent": null,
		"cycleTimeThreshold": 2,
		"cycleTimeUnit": "Minutes",
		"lastUpdated": "2018-12-06T19:20:59.868Z",
		"toStepId": null,
		"dateCreated": "2018-12-06T19:20:59.868Z",
		"hasSubscribers": true,
		"stepName": "Start Step",
		"toStepDescription": null,
		"lifecycleEventDefinitionGroupId": "e60be8a1-89ab-455d-991c-c8ca47dc9f7f",
		"hasQueueSubscribers": true
	},
	"eventWrapper": {
		"serviceVersion": 1,
		"eventBodyClassName": "com.chassi.microservice.dtos.lifecycle.Journey",
		"serviceApi": "lifecycle",
		"eventHeaders": {},
		"eventOperationId": null,
		"eventSourceOperationId": null,
		"eventJsonBody": {
			"journeyTags": [],
			"joruneyCreateDate": "2018-12-06T19:21:01.285Z",
			"externalCustomerId": null,
			"metadata": [],
			"currentStepType": "Not_Started",
			"stepStartDatetime": "2018-12-06T19:21:01.285Z",
			"currentStepId": "8d7a724a-0cf2-4822-9c4c-f634957838ad",
			"lastUpdated": "2018-12-06T19:21:01.293Z",
			"dateCreated": "2018-12-06T19:21:01.293Z",
			"versionNo": 1,
			"customerId": null,
			"elapsedJourneyTime": 144,
			"currentStepElapsedSeconds": 144,
			"lifecycleVersionId": "b91e1a58-a0e6-4233-bac6-97aa1180f524",
			"currentCycleElapsedSeconds": 144,
			"currentStepName": "Start Step",
			"previousStepId": null,
			"currentPath": "{\"steps\":[{\"stepId\":\"8d7a724a-0cf2-4822-9c4c-f634957838ad\",\"stepName\":\"Start Step\",\"pathIndex\":1.0}]}",
			"currentCycleNo": 1,
			"previousStepName": null,
			"journeyId": "7de7da5f-d193-42b3-876c-c843f8b8aebd",
			"lifecycleId": "089a7157-c612-4341-a57b-b8c47451b3d9",
			"cycleStartDatetime": "2018-12-06T19:21:01.285Z",
			"previousStepType": null,
			"lifecycleName": null
		},
		"eventTimestamp": "2018-12-06T19:23:25.998Z"
	}
}