Skip to main content
Version: Current

Add Sheet

Description​

Adds a new sheet to a Google Spreadsheet.

The new sheet is created as a worksheet tab within the specified spreadsheet.

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​

Display Text​

A user-defined name for the activity, displayed on the workflow canvas to help identify its purpose.

Connection Name​

The configured Google Sheets connection used to access Google Sheets resources.

Spreadsheet​

The spreadsheet in which the new sheet will be created.

You can:

  • Select a spreadsheet using the Google Drive Picker.
  • Provide a spreadsheet identifier dynamically through Process Data.

Sheet Name​

The name assigned to the new sheet.

Index​

The zero-based position where the sheet will be inserted.

Examples:

ValueResult
0Inserts the sheet as the first tab.
1Inserts the sheet as the second tab.
EmptyAdds the sheet at the end of the spreadsheet.

If not specified, the sheet is added at the end of the spreadsheet.

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
  • All relevant incoming paths complete before execution

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
  • Retry

Learn more → Error Handling

Output​

Sheet Properties​

Properties describing the newly created sheet.

Common properties include:

  • Sheet ID
  • Sheet Name
  • Index
  • Sheet Type
  • Grid Properties

For details, refer to the Google Sheets documentation:

https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/sheets

Remarks​

  • The authenticated Google account must have permission to modify the spreadsheet.
  • Sheet names must be unique within a spreadsheet.
  • If the specified sheet name already exists, the activity may fail depending on Google Sheets validation rules.
  • The newly created sheet is immediately available to subsequent Google Sheets activities.