Workflow Node Settings

Common settings and actions for Workflow Builder nodes, organized by setting type.

For output link settings, see Output Links.

Node Actions

Universal Actions

These actions are available on every node.

Action	Description
Edit	Opens the node settings panel. Available when you select a node on the canvas.
Delete	Removes the node from the canvas. Available from the actions drop-down when a node is selected.

Timer Start Node and Signal Start Node

These actions display on Timer Start and Signal Start nodes only. They are also governed by Start Node Administration.

Action	Description
Start	Activates the node and begins the timer or signal listener.
Stop	Deactivates the node. Settings become editable again after stopping.
Run Once	Triggers the node a single time without activating it on a recurring schedule.

Settings Reference

Label

Available on all nodes.

Setting	Field	Type	Description
Label	`label`	Text input	A display name for the node on the canvas.

Path

Available on: Timer node, Timer Start node, and Signal Start node.

Setting	Field	Type	Description
Path	`nodeId`	Text input	The unique identifier automatically generated for the node. Preset and not editable.

Scheduling

Available on: Timer node and Timer Start node.

Setting	Field	Type	Default	Description
Type	`timerType`	Radio button	Relative	The scheduling mode to use. Options include: Relative, Exact, or cron.

Relative (default): Fires after a set amount of time.

Setting Field Type Default Description

Time Amount timeAmount Number input — The duration to wait.

Time Unit timeUnit Drop-down — The unit of time. Options include: Minutes, Hours, Days, Weeks, Months, or Years.

Setting	Field	Type	Default	Description
Time Amount	`timeAmount`	Number input	—	The duration to wait.
Time Unit	`timeUnit`	Drop-down	—	The unit of time. Options include: Minutes, Hours, Days, Weeks, Months, or Years.

Exact: Fires at a specific scheduled time.

Setting Field Type Default Description

Frequency frequency Drop-down — How often to fire. Options include: Daily, Weekly, Monthly, or Yearly.

Day of Week dayOfWeek Drop-down — The day to fire. Options include: Sunday through Saturday. Visible when Frequency is Weekly.

Day of Month dayOfMonth Drop-down — The day of the month to fire. If the selected day doesn't exist in a given month, fires on the last day of that month. Visible when Frequency is Monthly or Yearly.

Month monthOfYear Drop-down — The month to fire. Options include: January through December. Visible when Frequency is Yearly.

Time time Time input — The time of day to fire, in UTC.

Setting	Field	Type	Default	Description
Frequency	`frequency`	Drop-down	—	How often to fire. Options include: Daily, Weekly, Monthly, or Yearly.
Day of Week	`dayOfWeek`	Drop-down	—	The day to fire. Options include: Sunday through Saturday. Visible when Frequency is Weekly.
Day of Month	`dayOfMonth`	Drop-down	—	The day of the month to fire. If the selected day doesn't exist in a given month, fires on the last day of that month. Visible when Frequency is Monthly or Yearly.
Month	`monthOfYear`	Drop-down	—	The month to fire. Options include: January through December. Visible when Frequency is Yearly.
Time	`time`	Time input	—	The time of day to fire, in UTC.

Cron: Fires based on a cron expression for advanced scheduling.

Setting Field Type Default Description

Cron Expression cronExpression Text input — A valid cron expression defining the schedule (for example, 0 9 * * 1 runs every Monday at 9:00 AM).

Setting	Field	Type	Default	Description
Cron Expression	`cronExpression`	Text input	—	A valid cron expression defining the schedule (for example, `0 9 * * 1` runs every Monday at 9:00 AM).

Error Message

Available on: Exclusive Gateway node and Inclusive Gateway Split node.

Setting	Field	Type	Default	Description
Error Message	`errorMessage`	Text area	—	The message displayed when no output link condition is met.

Boundary Event Condition

Available on: Timed Event node.

Setting	Field	Type	Default	Description
Activate When...	`startCondition`	Text input	—	A condition expression that determines when the event becomes active, for example, `status="Pending"`. Leave empty to activate immediately.

Triggering Event

Available on: Signal Start node.

Setting	Field	Type	Default	Description
Triggering Event	`triggeringEvent`	Drop-down	—	The platform event that begins this workflow. Options include: On Promotion (Specific Application), On Promotion (All Applications), On Save (Specific Module), On Save (All Modules), On Save (Specific Workflow), On Save (All Workflows).
Application	`applicationId`	Module selector	—	The application to monitor for promotion. Visible when Triggering Event is On Promotion (Specific Application).
Module	`moduleId`	Module selector	—	The module to monitor for saves. Visible when Triggering Event is On Save (Specific Module).
Workflow	`workflowId`	Module selector	—	The workflow to monitor for saves. Visible when Triggering Event is On Save (Specific Workflow).

Signal Display

Available on: Signal node.

Setting	Field	Type	Default	Description
Use an Existing Module	`useExistingModule`	Toggle	OFF	When set to ON, this setting displays an existing module to end-users at this point in the workflow instead of the default message.
Add a Module	`form`	Module selector	—	The module to display to end-users. Visible when Use an Existing Module is ON.
Use Template	`useTemplate`	Toggle	OFF	When set to ON, this setting displays a custom message to end-users generated from a template expression.
Template	`template`	Text input	—	A template expression that generates the HTML message displayed to end-users. Supports `{{ }}` syntax for dynamic values. Visible when Use Template is ON.

Handoff

Available on: Handoff node.

Setting	Field	Type	Default	Description
Continue Current	`continueCurrentSubmission`	Toggle	ON	When set to ON, this setting carries the current submission into the next workflow.
Choose Workflow To Handoff To	`workflow`	Drop-down	—	The workflow to hand off to.
Choose Node To Start From	`workflowNode`	Drop-down	—	The start node in the target workflow. Visible when Choose Workflow To Handoff To is set.

Message

Available on: Message node.

Setting	Field	Type	Default	Description
Label	`label`	Text input	`message-{n}`	A display name for the node.
Send through	`channel`	Drop-down	—	The messaging channel to use. Options include: Email.
To	`to`	Text input	—	The recipient address. Supports template expressions. Visible when Send through is Email.
Cc	`cc`	Text input	—	Additional recipients to copy. Supports template expressions. Visible when Send through is Email.
Bcc	`bcc`	Text input	—	Additional recipients to blind copy. Supports template expressions. Visible when Send through is Email.
From Name	`fromName`	Text input	—	The display name shown as the sender. Visible when Send through is Email.
Reply To	`replyTo`	Text input	—	The reply-to address for the email. Visible when Send through is Email.
Subject	`subject`	Text input	—	The email subject line. Supports template expressions. Visible when Send through is Email.
Template	`template`	Text input	—	The message body. Supports template expressions using `{{ }}` syntax. Visible when Send through is Email.
Generate and Send Refer String	`generateReferString`	Toggle	OFF	When set to ON, this setting generates an authenticated link and includes it in the message.
Refer String TTL (in minutes)	`referStringExpiry`	Number input	`10`	The number of minutes before the refer string link expires. Visible when Generate and Send Refer String is ON.
Refer String Redirect Target	`redirectTarget`	Text input	—	The path end-users are redirected to when they follow the refer string link. Supports template expressions. Visible when Generate and Send Refer String is ON.

Changelog

Date	Change
—	Initial publication.

Documentation Index