set-expiration trigger action

Overview

One or more trigger actions can be set for a named event in the workflow.

When the workflow trigger event occurs the trigger will check that any required conditions are met, and if met the "set-expiration" action sets a new expiration date. The due date is a period is in the format ISO 8601.

"set-expiration"

"set-expiration" will set an expiry period for a state.

• action (set-expiration)
• dueDate (string) ❗️ Due date in format ISO 8601

^{❗️ indicates a mandatory parameter -  a "dueDate" parameter value must be specified}

"triggers":
[
	{"event": "on-change-state",
	"conditions":
	[
		{"final": true}
	],
	"actions":
	[
		{"action": "set-expiration",
			"dueDate": "P6M"}
	]}
]

If adding the JSON trigger using workflow builder there is no need to include the opening "triggers": JSON markup notation, since it will be added by workflow builder.

The "dueDate" period is set using ISO 8601 format. For example "P6M3W5D" will be 6 months, 3 weeks and 5 days from the date of transition into the state. This will override any existing expiration periods.

An existing expiration period can be removed using "clear-expiration".