Skip to main content
Version: Current

Copy Worksheet

Description

The Copy Worksheet activity creates a copy of an existing worksheet within an Excel workbook.

The copied worksheet can be inserted at the beginning, end, or a specific position within the workbook and assigned a new worksheet name.


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


Source Worksheet Selection

Selects the worksheet to be copied.

Learn more → Excel Worksheet Selection


Insert Mode

Determines where the copied worksheet is inserted within the workbook.

Supported values:

  • Start — Inserts the worksheet at the beginning of the workbook.
  • End — Inserts the worksheet at the end of the workbook.
  • Custom — Inserts the worksheet at a specific position defined by Target Sheet Index.

Target Sheet Name

Name assigned to the copied worksheet.

The worksheet name must be unique within the workbook.


Target Sheet Index

Optional zero-based position where the copied worksheet is inserted.

This property is used only when Insert Mode is set to Custom.

For example:

IndexPosition
0First worksheet
1Second worksheet
2Third worksheet

Behavior

The source worksheet, including its data, formulas, formatting, comments, merged cells, and worksheet structure, is copied to a new worksheet.

The original worksheet remains unchanged.


Outputs

Target 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