Read Excel Table activity

An activity that reads data from a Microsoft Excel table, and then stores the values in variables that can be used in the process.


Read Excel Table activity

Configure the Read Excel Table activity

To configure the Read Excel Table activity, do the procedure in this topic.

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 Document tab.

    Document tab
  3. On the Document tab, drag the Read Excel Table activity onto your process.

    Read Excel Table activity

General Configuration

Specifies the basic settings for the Read Excel Table 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

Source Repository

Specifies the data source for your design time template.

Figure: Source Repository screen

Source Repository screen

Fields

Field NameDefinition

Source Repository

Opens this Screen:
The configuration screen for your document repository. The specific screen that shows depends on your document repository type.

For more information, refer to Document Repositories.

Function of this Screen:
Configures your document repository.

Runtime Repository

Specifies the data source for your runtime template.

Figure: Runtime Repository screen

Runtime Repository screen

Fields

Field NameDefinition

Runtime Repository

Opens this Screen:
The configuration screen for your document repository. The specific screen that shows depends on your document repository type.

For more information, refer to Document Repositories.

Function of this Screen:
Configures your document repository.

Read Excel Table Configuration

Specifies an operation to read and store data from a Microsoft Excel table.

Figure: Read Excel Table Configuration screen

Read Excel Table Configuration screen

Fields

Field NameDefinition

Design time - Repository Name

Description:
Shows the access token of the document source repository type you selected for design time.
Allowed Values:
Read only.

Design Time Template

Description:
Shows the name of the Microsoft Excel template file that Process Builder uses when you create or change the app.
Allowed Values:

Read only

The runtime template file and the design time template file must have the same column names in the Excel table.

Runtime - Repository Name

Description:
Shows the access token of the document source repository type you selected for runtime.
Allowed Values:
Read only.

Runtime Template

Description:
Shows the name of the Microsoft Excel template file the activity uses to read the Excel file when the process runs.
Allowed Values:

Read only

The runtime template file and the design time template file must have the same column names in the Excel table.

Field Mapping

Description:
Specifies the connection from the Microsoft Excel columns response parameter to your process schema.
Allowed Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper screen.

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

Default Value:
None
Example:
Refer to: