Excel Write (Document) activity

An activity that lets you create and change a Microsoft Excel file based on a Microsoft Excel template.

Configure the Excel Write activity

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

Examples

(Example) Configure an Excel Write 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 Write (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?
Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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

On the Application Explorer screen, do one of these:
- Open a Process.
- Create a Process.
Do one of these:
- Add an activity:
  1. In the Process Builder, in the Activity Library, open the Document tab.
  2. On the Document tab, drag the Excel Write activity onto your process.
- Change an activity:
  1. In your process, double-click your activity.

Procedure

Complete the fields on the General Configuration screen.
For more information, refer to Configure General Options for a System Activity.
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 Target Configuration .
On the Target Repository screen, select the target location for your file.
Click Excel Write Configuration .
Complete the fields on the Excel Write Configuration screen.
For more information, refer to Write Data in an Excel File
(Optional) Click Advanced > E-mail Notifications .
For more information, refer to Configure E-mail Notifications for Any Activity.

General Configuration

Specifies the basic settings for the Excel Write activity.

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 Design Time Template Configuration (Amazon S3) - Excel Read (Document).
Box	Function: Specifies that Box is the data source for your design time template. To select your design time template, complete the fields on Design Time Template Configuration (Box) - Excel Read (Document).
Dropbox	Function: Specifies that Dropbox is the data source for your design time template. To select your design time template, complete the fields on Design Time Template Configuration (Dropbox) - Excel Read (Document).
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 Design Time Template Configuration (File System) - Excel Read (Document).
FTP	Function: Specifies that FTP is the data source for your design time template. To select your design time template, complete the fields on Design Time Template Configuration (FTP) - Excel Read (Document).
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 Design Time Template Configuration (Google Drive) - Excel Write (Document). Example: Refer to: (Example) Configure an Excel Write 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 Design Time Template Configuration (NetSuite) - Excel Read (Document).
OneDrive	Function: Specifies that OneDrive is the data source for your design time template. To select your design time template, complete the fields on Design Time Template Configuration (OneDrive) - Excel Read (Document).
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 Design Time Template Configuration (OneDrive For Business) - Excel Read (Document).
Salesforce	Function: Specifies that Salesforce is the data source for your design time template. To select your design time template, complete the fields on Design Time Template Configuration (Salesforce) - Excel Read (Document).
SFTP	Function: Specifies that SFTP is the data source for your design time template. To select your design time template, complete the fields on Design Time Template Configuration (SFTP) - Excel Read (Document).
SharePoint	Function: Specifies that SharePoint is the data source for your design time template. To select your design time template, complete the fields on Design Time Template Configuration (SharePoint) - Excel Read (Document).

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 Runtime Template Configuration (Amazon S3) - Excel Write (Document).
Box	Function: Specifies that Box is the data source for your runtime template. To select your runtime template, complete the fields on Runtime Template Configuration (Box) - Excel Write (Document).
Dropbox	Function: Specifies that Dropbox is the data source for your runtime template. To select your runtime template, complete the fields on Runtime Template Configuration (Dropbox) - Excel Write (Document).
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 Runtime Template Configuration (File System) - Excel Write (Document).
FTP	Function: Specifies that FTP is the data source for your runtime template. To select your runtime template, complete the fields on Runtime Template Configuration (FTP) - Excel Write (Document).
Google Drive	Function: Specifies that Google Drive is the data source for your runtime template. To select your runtime template, complete the fields on Runtime Template Configuration (Google Drive) - Excel Write (Document). Example: Refer to: (Example) Configure an Excel Write Activity
NetSuite	Function: Specifies that NetSuite is the data source for your runtime template. To select your runtime template, complete the fields on Runtime Template Configuration (NetSuite) - Excel Write (Document).
OneDrive	Function: Specifies that OneDrive is the data source for your runtime template. To select your runtime template, complete the fields on Runtime Template Configuration (OneDrive) - Excel Write (Document).
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 Runtime Template Configuration (OneDrive For Business) - Excel Write (Document).
Salesforce	Function: Specifies that Salesforce account is the data source for your runtime template. To select your runtime template, complete the fields on Runtime Template Configuration (Salesforce) - Excel Write (Document).
SFTP	Function: Specifies that SFTP is the data source for your runtime template. To select your runtime template, complete the fields on Runtime Template Configuration (SFTP) - Excel Write (Document).
SharePoint	Function: Specifies that SharePoint is the data source for your runtime template. To select your runtime template, complete the fields on Runtime Template Configuration (SharePoint) - Excel Write (Document).

Target Repository

Selects the target storage repository type for your files.

Fields

Field Name	Definition
Amazon S3	Function: Specifies that Amazon S3 is your document target location. To configure the target location for your file, complete the fields in Target Repository Configuration (Amazon S3) - Excel Write (Document).
Box	Function: Specifies that Box is your document target location. To configure the target location for your file, complete the fields in Target Repository Configuration (Box) - Excel Write (Document).
Dropbox	Function: Specifies that Dropbox is your document target location. To configure the target location for your file, complete the fields in Target Repository Configuration (Dropbox) - Excel Write (Document).
File System	Function: Specifies that the file system on the AgilePoint Server machine is the target data source location for the file. To configure the target location for your file, complete the fields in Target Repository Configuration (File System) - Excel Write (Document).
FTP	Function: Specifies that FTP is your document target location. To configure the target location for your file, complete the fields in Target Repository Configuration (FTP) - Excel Write (Document).
Google Drive	Function: Specifies that Google Drive is your document target location. To configure the target location for your file, complete the fields in Target Repository Configuration (Google Drive) - Excel Write (Document). Example: Refer to: (Example) Configure an Excel Write Activity
NetSuite	Function: Specifies that NetSuite is your document target location. To configure the target location for your file, complete the fields in Target Repository Configuration (NetSuite) - Excel Write (Document).
OneDrive	Function: Specifies that OneDrive is your document target location. To configure the target location for your file, complete the fields in Target Repository Configuration (OneDrive) - Excel Write (Document).
OneDrive For Business	Function: Specifies that OneDrive for Business is your document target location. To configure the target location for your file, complete the fields in Target Repository Configuration (OneDrive For Business) - Excel Write (Document).
Salesforce	Function: Specifies that Salesforce is your document target location. To configure the target location for your file, complete the fields in Target Repository Configuration (Salesforce) - Excel Write (Document).
SFTP	Function: Specifies that SFTP is your document target location. To configure the target location for your file, complete the fields in Target Repository Configuration (SFTP) - Excel Write (Document).
SharePoint	Function: Specifies that SharePoint is your document target location. To configure the target location for your file, complete the fields in Target Repository Configuration (SharePoint) - Excel Write (Document).

Excel Write Configuration

Configures an operation to create a Microsoft Excel file.

Fields

Field Name	Definition
Repository Name - Design time	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 application 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.
Save To	Function: Specifies the location and file name to save the resulting Microsoft Excel document. Accepted Values: One line of text that can have spaces. A process data variable. You can use Process Data screen to specify a process data variable. Default Value: None Accepts Process Data Variables: Yes Example: Refer to: (Example) Configure an Excel Write Activity
Field Mapping	Function: Specifies the connection from the Microsoft Excel columns response parameter to your schema. Accepted Values: Click the Schema Mapping button to open the Schema Mapper. Use this screen to connect the response to the data model for your process. Default Value: None Example: Refer to: (Example) Configure an Excel Write Activity Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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?