ForEachSheet

This activity helps the users to iterate through and retrieve the collection of sheets in the specified workbook.

Properties

Configuration

Each activity requires a connection with Google Sheets authentication. Once you select the respective project name where Google Sheets has been authenticated, the activity will automatically retrieve the available connections for that project.

Below are the properties available after the project has been integrated:

Google: *This parameter indicates the account name associated with the integration.

INPUT

WorkbookName:  *This parameter specifies the existing spreadsheet where the sheet details needs to be retrieved. It offers multiple ways to choose the spreadsheet: 
1. Browse Option: When selecting the “Click on Browse” option, it will automatically list the folders and spreadsheets available for the specified account. The user must manually select the spreadsheet each time when using this option.
2. Three-Line Menu: Clicking on the “Three lines” icon will open a context menu with the following two options. 1
a. Reload Folder Picker: Refreshes the selected folder or spreadsheet.
b. Use Variable: Allows you to provide the “Workbook Name” as a variable in “String” format. You can either hardcode the values as a string or use a variable of the “String” datatype. Below are the values that can be provided as variable,
     i. URL or ID: After creating the workbook in the specified Google account, you will receive the workbook’s URL and ID. You can use these as a reference to add a new sheet within the workbook.
    ii. Spreadsheet Name: You can either hardcode the name as a string or provide a variable of the “String” datatype.

ForEach: This parameter represents each sheet retrieved from the list of sheets in the specified workbook. You can customize its name as needed.

MISC

DisplayName: Displays the name of the activity. The activity name can be customized, which aids in troubleshooting.

SkipOnError: Specify the “Boolean” value as “True” or “False.”
True: Continue executing the workflow regardless of any errors thrown.
False: Halt the workflow if it encounters any errors.
None: If the option is left blank, the activity will, by default, behave as if “False” were chosen.

Version: It indicates the version of the feature being used.

OUTPUT

Result: It provides the ability to view the execution status of the activity. It returns values in “Boolean.”

True: Indicates that the activity has been executed successfully without any errors.
False: Indicates that the activity has been unsuccessful due to an unexpected error being thrown.

The number of sheets processed: This parameter helps you to get the count of the sheets available in the specified workbook. It returns values in “Integer” datatype. 

 * Represents mandatory fields to execute the workflow.

How to Retrieve the Name of a Sheet?

1. Drag and drop the activity into the workflow.
2. Double-click the activity and select the workbook from which the sheets should be retrieved.
3. In the ForEach property, the default name will appear as CurrentSheet.
4. Use this name in a Write Log activity inside the “Do” part of the “ForEachSheet” activity to display the name of each sheet in the specified workbook.