Skip to main content

Creating a Cluster Activity

A Cluster Activity is an activity that groups two or more existing Simple or Event Source activities under a single, unified entry point. From a workflow builder's perspective it looks and behaves like a single activity — but internally it orchestrates a set of member activities as a coordinated unit.

Use a Cluster Activity when you want to:

  • Surface a logical set of related operations as one reusable action (e.g., "Send Order Confirmation" which internally triggers an email, an SMS, and a CRM update).
  • Abstract away the complexity of multiple coordinated steps from the workflow designer.
  • Reuse the same multi-step pattern across many workflows without repeating the wiring every time.
info

Location: Library > My Artifacts > Activities — click Create Activity, then select Cluster as the activity type.


How It Differs from a Simple Activity

Simple ActivityCluster Activity
Executable on its ownYesNo — executed through its member activities
Has a Testing stepYesNo — testing is skipped
Configuration formDrag-and-drop form builderMember activities table
MembersNoneOne or more Simple / Event Source activities from the same group
Wizard steps4 (Add Details → Configuration → Testing → Publish)3 (Add Details → Configuration → Publish)

The Creation Wizard

Cluster Activities use a 3-step wizard — the Testing step is omitted because a cluster is not independently executable:

StepNamePurpose
1Add DetailsName, type, group, description, icon
2ConfigurationDefine the cluster members
3PublishReview and publish organisation-wide

Step 1 — Add Details

The metadata fields are the same as for a Simple Activity:

FieldRequiredDescription
IconOptionalSVG icon shown in the activity palette.
Activity NameRequiredUnique within the selected group; no spaces or special characters; max 35 characters.
Activity TypeRequiredSelect Cluster.
Activity GroupRequiredThe group this cluster belongs to and the pool from which member activities are drawn.
DescriptionOptionalMarkdown-supported description of what this cluster does as a whole.
TagsOptionalLabels for filtering and discovery.
AccessOptionalDefault: on. Controls organisation-wide visibility.

Activity Group and Members

The Activity Group you select here directly determines which activities are available as cluster members in Step 2. Only approved Simple and Event Source activities from the selected group can be added.

warning

Changing the Activity Group after members have been added will reset all cluster data — a confirmation dialog will appear before the change is applied.


Step 2 — Configuration (Cluster Members)

The Configuration step replaces the form builder with the Cluster Members table. Each row in the table represents one activity that is part of this cluster.

Adding a Member

Click Add Activity to insert a new row. Configure each row:

ColumnRequiredDescription
NameRequiredSelect an activity from the dropdown. Only approved Simple and Event Source activities from the selected group are listed. Each activity can only be added once.
TypeAuto-setSet automatically based on the selected activity: SIMPLE for Simple activities, TRIGGER for Event Source activities. Read-only.
Event NameOptionalA logical name for the event or action this member represents within the cluster (e.g., sendEmail, updateCRM).
DescriptionOptionalDocuments the role of this member within the cluster.

Removing a Member

Click the trash icon on a row to remove that member from the cluster.

Member Constraints

  • Only SIMPLE and EVENT_SOURCE activity types can be cluster members.
  • An activity can only appear once per cluster (the dropdown disables already-selected activities).
  • Member activities from other groups are not visible — the group scope is fixed by the Activity Group set in Step 1.

Step 3 — Publish

A read-only summary shows:

  • Cluster metadata (name, group, description, tags)
  • The full list of member activities with their types, event names, and descriptions

Click Publish to make the cluster available organisation-wide. Once published, the cluster appears in the activity palette as a single entry. Workflow builders drag it into their workflow like any other activity.


How a Cluster Executes at Runtime

When a workflow containing a Cluster Activity runs:

  1. The engine reads the cluster's member list.
  2. It expands the cluster into its constituent activities.
  3. Each member activity executes within the cluster's execution context in the order defined.
  4. The cluster's overall result is derived from the combined outputs of its members.

Member activities are hidden from the activity palette — they do not appear as standalone options for workflow builders. This keeps the palette clean and forces use of the cluster as the intended entry point.


Editing a Cluster Activity

  1. Navigate to Library > My Artifacts > Activities.
  2. Find the cluster and click Edit.
  3. You can add or remove members, update the event names and descriptions, and change the metadata.
  4. The Activity Group change triggers a confirmation warning and resets member data if confirmed.
  5. Click Publish to release the updated cluster.
note

Editing a published cluster creates a draft. Deployed workflows continue using the live version until the draft is published.