Excel Read (Document) activity

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

Configure the Excel Read activity

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

Examples

(Example) Configure an Excel Read Activity

Good to Know

In most text fields, you can use process data variables as an alternative to literal data values.
To use only SharePoint as your source and target data source, refer to Excel Read (SharePoint) activity.
You can configure whether this activity waits for other activities before it runs.
For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?
This section shows the configuration settings on the configuration screens for this activity. Other configuration settings apply to system activities. For more information, refer to:
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?

How to Start

Open Process Builder.
For information about how to open this screen, refer to Process Builder.
In Process Builder, in the Activity Library, open the Document tab.
On the Document tab, drag the Excel Read activity onto your process.

Procedure

Complete the fields on the General Configuration screen.
Click Design Time Repository .
On the Source Repository screen, select the data source for your design time template.
Click Run Time Repository .
On the Runtime Repository screen, select the data source for your runtime template.
Click Excel Read Configuration .
Configure the Excel Read activity options on the Excel Read Configuration screen.
(Optional) Click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).

General Configuration

Specifies the basic settings for the Excel Read activity.

Good to Know

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

Fields

Field Name	Definition
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

Field Name

Definition

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:

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

Source Repository

Specifies the data source for your design time template.

Fields

Field Name	Definition
Amazon S3	Function: Specifies that Amazon S3 is the data source for your design time template. To select your design time template, complete the fields on Excel Read > Design Time Template > Amazon S3.
Box	Function: Specifies that Box is the data source for your design time template. To select your design time template, complete the fields on Excel Read > Design Time Template > Box.
Dropbox	Function: Specifies that Dropbox is the data source for your design time template. To select your design time template, complete the fields on Excel Read > Design Time Template > Dropbox.
File System	Function: Specifies that the file system on the AgilePoint Server machine is the data source for your design time template. To select your design time template, complete the fields on Excel Read > Design Time Template > File System.
FTP	Function: Specifies that FTP is the data source for your design time template. To select your design time template, complete the fields on Excel Read > Design Time Template > FTP.
Google Drive	Function: Specifies that Google Drive is the data source for your design time template. To select your design time template, complete the fields on Excel Read > Design Time Template > Google Drive. Example: Refer to: (Example) Configure an Excel Read Activity
NetSuite	Function: Specifies that NetSuite is the data source for your design time template. To select your design time template, complete the fields on Excel Read > Design Time Template > NetSuite.
OneDrive	Function: Specifies that OneDrive is the data source for your design time template. To select your design time template, complete the fields on Excel Read > Design Time Template > OneDrive.
OneDrive for Business	Function: Specifies that OneDrive for Business is the data source for your design time template. To select your design time template, complete the fields on Excel Read > Design Time Template > OneDrive for Business.
Salesforce	Function: Specifies that Salesforce is the data source for your design time template. To select your design time template, complete the fields on Excel Read > Design Time Template > Salesforce.
SFTP	Function: Specifies that SFTP is the data source for your design time template. To select your design time template, complete the fields on Excel Read > Design Time Template > SFTP.
SharePoint	Function: Specifies that SharePoint is the data source for your design time template. To select your design time template, complete the fields on Excel Read > Design Time Template > SharePoint.

Runtime Repository

Specifies the data source for your runtime template.

Fields

Field Name	Definition
Amazon S3	Function: Specifies that Amazon S3 is the data source for your runtime template. To select your runtime template, complete the fields on Excel Read > Runtime Template > Amazon S3.
Box	Function: Specifies that Box is the data source for your runtime template. To select your runtime template, complete the fields on Excel Read > Runtime Template > Box.
Dropbox	Function: Specifies that Dropbox is the data source for your runtime template. To select your runtime template, complete the fields on Excel Read > Runtime Template > Dropbox.
File System	Function: Specifies that the file system on the AgilePoint Server machine is the data source for your runtime template. To select your runtime template, complete the fields on Excel Read > Runtime Template > File System.
FTP	Function: Specifies that FTP is the data source for your runtime template. To select your runtime template, complete the fields on Excel Read > Runtime Template > FTP.
Google Drive	Function: Specifies that Google Drive is the data source for your runtime template. To select your runtime template, complete the fields on Excel Read > Runtime Template > Google Drive. Example: Refer to: (Example) Configure an Excel Read Activity
NetSuite	Function: Specifies that NetSuite is the data source for your runtime template. To select your runtime template, complete the fields on Excel Read > Runtime Template > NetSuite.
OneDrive	Function: Specifies that OneDrive is the data source for your runtime template. To select your runtime template, complete the fields on Excel Read > Runtime Template > OneDrive.
OneDrive for Business	Function: Specifies that OneDrive for Business is the data source for your runtime template. To select your runtime template, complete the fields on Excel Read > Runtime Template > OneDrive for Business.
Salesforce	Function: Specifies that Salesforce is the data source for your runtime template. To select your runtime template, complete the fields on Excel Read > Runtime Template > Salesforce.
SFTP	Function: Specifies that SFTP is the data source for your runtime template. To select your runtime template, complete the fields on Excel Read > Runtime Template > SFTP.
SharePoint	Function: Specifies that SharePoint is the data source for your runtime template. To select your runtime template, complete the fields on Excel Read > Runtime Template > SharePoint.

Read Excel Document Configuration

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

Fields

Field Name	Definition
Repository Name - Design	Function: Shows the access token of the document source repository type you selected for design time. Accepted Values: Read only.
Design Time Template	Function: Shows the name of the Microsoft Excel template file that Process Builder uses when you create or change a process. Accepted Values: Read only Note: The runtime template file and the design time template file must have the same field names and the same types of content. The file must exist on the app designer's local machine at design time.
Repository Name - Runtime	Function: Shows the access token of the document source repository type you selected for runtime. Accepted Values: Read only.
Runtime Template	Function: Shows the name of the Microsoft Excel template file the activity uses to create Excel file when the process runs. Accepted Values: Read only.
Field Mapping	Function: Specifies the connection from the Microsoft Excel columns response parameter to your process schema. Accepted Values: Click the Schema Mapping 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: (Example) Configure an Excel Read Activity (Example) Schema Mapper