Delete Sheet activity

An activity that deletes a sheet from Google Sheets.


Delete Sheet activity

Configure the Delete Sheet activity

Prerequisites

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the Google Sheets tab.

    Open Google Sheets tab
  3. On the Google Sheets tab, drag the Delete Sheet activity onto your process.

    Drag Delete Sheet activity

General Configuration

Specifies the basic settings for the Delete Sheet activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field NameDefinition

Display Name

Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Delete Sheet Configuration

Specifies the information about a sheet to delete from Google Sheets.

Figure: Delete Sheet Configuration screen

Delete Sheet Configuration screen
Field NameDefinition

Google Workspace

Function:
Specifies the access token that connects to your Google Workspace service.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None

Create Add Token icon

Opens this Screen:
Access Token for Google Workspace
Function of this Screen:
Configure an access token to connect to Google Workspace.
Example:
Refer to:

File Path

Function:
Specifies whether to select the path of the spreadsheet from which to delete the sheet.
Accepted Values:
  • Choose Spreadsheet Path - Specifies an absolute path for the spreadsheet.

    When you select the access token from the Google Workspace field, this field shows the folders associated with the access token.

  • Spreadsheet ID Or URL - Specifies the ID or URL for the spreadsheet.
Default Value:
Spreadsheet ID Or URL

Spreadsheet ID Or URL

Function:
Specifies the ID or URL of the spreadsheet from which to delete the sheet.
To Open this Field:
  1. On the Delete Sheet Configuration screen, in the File Path field, select Spreadsheet ID Or URL.
Accepted Values:
  • An integer that represents a spreadsheet ID.

    The spreadsheet URL comes from Google Sheets.

  • One line of text (a string) in URL format that points to a spreadsheet URL.

    The spreadsheet ID comes from Google Sheets.

Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Sheet Name Or ID

Function:
Specifies the name or ID of the sheet to delete.
Accepted Values:
  • A sheet name from the list.

    When you select a spreadsheet from the File Path field, this field shows the sheet names associated with the spreadsheet.

  • An integer that represents a sheet ID.

    The sheet ID comes from Google Sheets.

Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Store Response Status in this Variable

Function:
Specifies the process data variable to store the status of whether the sheet is deleted.
Accepted Values:
A process data variable that accepts a text string with no spaces.

The status can be one of these:

  • Successful
  • Failed
Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?