Excel Write (Document) activity

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


Excel Write activity

Configure the Excel Write activity

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

Examples

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 the Process Builder, in the Activity Library, open the Document tab.

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

    Excel Write activity

Procedure

  1. Complete the fields on the General Configuration screen.

    For more information, refer to Configure General Options for a System Activity.

  2. Click Design Time Repository Design Time Repository icon.
  3. On the Source Repository screen, select the data source for your design time template.
  4. Click Run Time Repository Run Time Repository icon.
  5. On the Runtime Repository screen, select the data source for your runtime template.
  6. Click Target Configuration Target Configuration icon.
  7. On the Target Repository screen, select the target location for your file.
  8. Click Excel Write Configuration Excel Write Configuration icon.
  9. Complete the fields on the Excel Write Configuration screen.

    For more information, refer to Write Data in an Excel File

  10. (Optional) Click Advanced Advanced icon > Email Notifications E-mail Notifications icon.

    For more information, refer to Configure E-mail Notifications for Any Activity.

General Configuration

Specifies the basic settings for the Excel Write activity.

Figure: General Configuration screen

General Configuration screen

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

Source Repository

Specifies the data source for your design time template

Figure: Source Repository screen

Source Repository screen

Fields

Field Name Definition

Amazon S3 Amazon S3 icon

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 Box icon

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 Dropbox icon

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 File System icon

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 FTP icon

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 Google Drive icon

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 Write > Design Time Template > Google Drive.

Example:
Refer to:

NetSuite NetSuite icon

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 OneDrive icon

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 OneDrive For Business icon

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 Salesforce icon

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 SFTP icon

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 SharePoint icon

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.

Figure: Runtime Repository screen

Runtime Repository screen

Fields

Field Name Definition

Amazon S3 Amazon S3 icon

Function:
Specifies that Amazon S3 is the data source for your runtime template.

To select your runtime template, complete the fields on Excel Write > Runtime Template > Amazon S3.

Box Box icon

Function:
Specifies that Box is the data source for your runtime template.

To select your runtime template, complete the fields on Excel Write > Runtime Template > Box.

Dropbox Dropbox icon

Function:
Specifies that Dropbox is the data source for your runtime template.

To select your runtime template, complete the fields on Excel Write > Runtime Template > Dropbox.

File System File System icon

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 Write > Runtime Template > File System.

FTP FTP icon

Function:
Specifies that FTP is the data source for your runtime template.

To select your runtime template, complete the fields on Excel Write > Runtime Template > FTP.

Google Drive Google Drive icon

Function:
Specifies that Google Drive is the data source for your runtime template.

To select your runtime template, complete the fields on Excel Write > Runtime Template > Google Drive.

Example:
Refer to:

NetSuite NetSuite icon

Function:
Specifies that NetSuite is the data source for your runtime template.

To select your runtime template, complete the fields on Excel Write > Runtime Template > NetSuite.

OneDrive OneDrive icon

Function:
Specifies that OneDrive is the data source for your runtime template.

To select your runtime template, complete the fields on Excel Write > Runtime Template > OneDrive.

OneDrive for Business OneDrive For Business icon

Function:
Specifies that OneDrive for Business is the data source for your runtime template.

To select your runtime template, complete the fields on Excel Write > Runtime Template > OneDrive for Business.

Salesforce Salesforce icon

Function:
Specifies that Salesforce account is the data source for your runtime template.

To select your runtime template, complete the fields on Excel Write > Runtime Template > Salesforce.

SFTP SFTP icon

Function:
Specifies that SFTP is the data source for your runtime template.

To select your runtime template, complete the fields on Excel Write > Runtime Template > SFTP.

SharePoint SharePoint icon

Function:
Specifies that SharePoint is the data source for your runtime template.

To select your runtime template, complete the fields on Excel Write > Runtime Template > SharePoint.

Target Repository

Selects the target storage repository type for your files.

Figure: Target Repository screen

Target Repository screen

Fields

Field Name Definition

Amazon S3 Amazon S3 icon

Function:
Specifies that Amazon S3 is the target location for your files.

To configure the target location for your file, complete the fields in Excel Write > Target Repository > Amazon S3.

Box Box icon

Function:
Specifies that Box is the target location for your files.

To configure the target location for your file, complete the fields in Excel Write > Target Repository > Box.

Dropbox Dropbox icon

Function:
Specifies that Dropbox is the target location for your files.

To configure the target location for your file, complete the fields in Excel Write > Target Repository > Dropbox.

File System File System icon

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 Excel Write > Target Repository > File System.

FTP FTP icon

Function:
Specifies that FTP is the target location for your files.

To configure the target location for your file, complete the fields in Excel Write > Target Repository > FTP.

Google Drive Google Drive icon

Function:
Specifies that Google Drive is the target location for your files.

To configure the target location for your file, complete the fields in Excel Write > Target Repository > Google Drive.

Example:
Refer to:

NetSuite NetSuite icon

Function:
Specifies that NetSuite is the target location for your files.

To configure the target location for your file, complete the fields in Excel Write > Target Repository > NetSuite.

OneDrive OneDrive icon

Function:
Specifies that OneDrive is the target location for your files.

To configure the target location for your file, complete the fields in Excel Write > Target Repository > OneDrive.

OneDrive for Business OneDrive For Business icon

Function:
Specifies that OneDrive for Business is the target location for your files.

To configure the target location for your file, complete the fields in Excel Write > Target Repository > OneDrive for Business.

Salesforce Salesforce icon

Function:
Specifies that Salesforce is the target location for your files.

To configure the target location for your file, complete the fields in Excel Write > Target Repository > Salesforce.

SFTP SFTP icon

Function:
Specifies that SFTP is the target location for your files.

To configure the target location for your file, complete the fields in Excel Write > Target Repository > SFTP.

SharePoint SharePoint icon

Function:
Specifies that SharePoint is the target location for your files.

To configure the target location for your file, complete the fields in Excel Write > Target Repository > SharePoint.

Excel Write Configuration

Configures an operation to create a Microsoft Excel file.

Figure: Excel Write Configuration screen

Excel Write Configuration screen

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.

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:

Field Mapping

Function:
Specifies the connection from the Microsoft Excel columns response parameter to your process schema.
Accepted 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.

Default Value:
None
Example:
Refer to:
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?