Read Rows activity

An activity that reads one or more rows from Google Sheets.


Read Rows activity

Configure the Read Rows 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 Read Rows activity onto your process.

    Drag Read Rows activity

General Configuration

Specifies the basic settings for the Read Rows 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
Description:
Specifies the activity name that shows in your process.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts 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
Description:
Specifies an optional text description for your activity.
Allowed Values:
More than one line of text.
Default Value:
None
Accepts Variables:
No

Read Rows Configuration

Specifies the information to read one or more rows from Google Sheets.

Figure: Read Rows Configuration screen

Read Rows Configuration screen

Fields

Field NameDefinition

Google Workspace
Description:
Specifies the access token that connects to your Google Workspace service.
Allowed 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
Description:
Specifies whether to select the path of the spreadsheet from which to read the rows.
Allowed 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
Description:
Specifies the ID or URL of the spreadsheet from which to read the rows.
To Open this Field:
  1. On the Read Rows Configuration screen, in the File Path field, select Spreadsheet ID Or URL.
Allowed 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 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?

Sheets / Named Range
Description:
Specifies whether to read the rows from a named range in Google Sheets.
Allowed Values:
  • Sheets - Reads the rows from a sheet.
  • Named Range - Reads the rows from a named range.
Default Value:
Sheets

Sheet Name Or ID
Description:
Specifies the name or ID of the sheet from which to read the rows.
To Open this Field:
  1. On the Read Rows Configuration screen, select Sheets.
Allowed 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 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?

Named Range
Description:
Specifies the named range from which to read the rows.
To Open this Field:
  1. On the Read Rows Configuration screen, select Named Range.
Allowed Values:
  • A named range from the list.

    When you select the spreadsheet from the File Path field, this field shows the named ranges associated with the spreadsheet.

  • One line of text (a string) that can have letters, numbers, spaces, and special characters.

    The line of text represents a named range.

Default Value:
None
Accepts 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?

Maximum Rows
Description:
Specifies the maximum number of rows to read.
Allowed Values:
An integer.
Default Value:
10,000

First Row Is A Header Row
Description:
Specifies whether to use the first row of the sheet as a header row.
Allowed Values:
  • Deselected - Uses the column letters as a header row and does not use the first row of the sheet.
  • Selected - Uses the first row of the sheet as a header row.
Default Value:
Deselected

Map Response to Application Schema
Description:
Maps information about the columns of the sheet from Google Sheets to your process schema.
Allowed Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

Use this screen to connect the response to the data model for your process.

Because the query can return more than one result, the parent node in the external data source must be mapped to a node in the AgilePoint NX process schema that is a repeating schema element. The child nodes in both data models must also be mapped, but child nodes in AgilePoint NX inherit the repeating behavior from their parent node.

Default Value:
None
Example:
Refer to: