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 settings​

Use Process Data to bind supported inputs to workflow values or upstream outputs. See Common Activity Features for shared execution, error-handling, and output-persistence settings. Availability depends on the activity.

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.


Execution settings​

Configure Wait All Incoming when execution paths converge, and On Error for failure handling. Select Inherit where available to use the workflow-level error policy.

Example: Create a named sheet​

Set Sheet Name to Summary and Sheet Index to 0 to insert the new worksheet first. Bind Output Sheet Name to the Sheet Name field of the next worksheet activity. Use a unique worksheet name; indexes can change when sheets are inserted or moved.