Skip to main content
Version: Current

Add Worksheet

Description

The Add Worksheet activity creates a new worksheet in an Excel workbook.

The worksheet can optionally be assigned a name and inserted at a specific position within the workbook.


Common Capabilities

Process Data Support

info

This activity supports dynamic configuration using variables from the Process Data drawer.

You can bind values from Model Data, Form Data, System Data, Enterprise Variables, and Activity Outputs.

Learn more → Using Process Data


Design-Time Configuration

Workbook Configuration

This activity requires an Excel workbook.

Learn more → Excel Workbook Configuration


Sheet Name

Optional name for the new worksheet.

If not specified, Excel automatically generates a worksheet name.


Sheet Index

Optional zero-based position where the worksheet should be inserted.

If not specified, the worksheet is added at the end of the workbook.


Outputs

Output Sheet Name

Returns the name of the worksheet that was created.


Worksheet

Returns information about the worksheet that was created.

This expandable output can be used to inspect worksheet details in subsequent workflow activities.


Wait All Incoming

Execution Control

Controls how this activity behaves when multiple incoming execution paths converge.

Determines whether the activity executes when any incoming path completes, or only after all relevant paths have completed.

Learn more → Execution Control


On Error

Error Handling Strategy

Defines how the workflow behaves if this activity encounters a runtime error.

Supported strategies include Fault, Continue, Suspend, and Retry.

Learn more → Error Handling