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.

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?

  • Documentation for Integrations with Third-Party, External, or Open Source Technologies

    The highest priority for AgilePoint NX Product Documentation is accuracy. Whenever feasible, AgilePoint provides input details, business rules, or example values for third-party integrations. These can include any technology that is not native to AgilePoint NX, such as Salesforce, Active Directory, or REST. However this information is subject to change without notice to AgilePoint. Because we can not guarantee the accuracy of this information, the details provided for third-party product input values, as well as examples for third-party product integrations, are limited in the AgilePoint documentation. It is the responsibility of third-party vendors to provide documentation related to these aspects of their software and services.

    For examples of use case implementations or configuration field input values for third-party products, AgilePoint recommends these resources:

    • AgilePoint Community Forums - An AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
    • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
    • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.
    • Third-Party Vendor Documentation - Whenever feasible, AgilePoint provides links to third-party vendor documentation.

      This does not include technology standards or protocols, such as JavaScript, REST, or FTP. Resources for these technical standards are publicly available on the Internet.

How to Start

  1. On the Application Explorer screen, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, in the Activity Library, open the Document Document icon tab.
      2. On the Document Document icon tab, drag the Excel Write Excel Write icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your 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 > E-mail Notifications E-mail Notifications icon.

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

General Configuration

Specifies the common information for a system activity.

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:
Refer to:

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

Design Time Repository

Specifies the data source for your design time template.

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 Design Time Template Configuration (Amazon S3) - Excel Write (Document).

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 Design Time Template Configuration (Box) - Excel Write (Document).

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 Design Time Template Configuration (Dropbox) - Excel Write (Document).

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 Design Time Template Configuration (FTP) - Excel Write (Document).

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 Design Time Template Configuration (Google Drive) - Excel Write (Document).

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 Design Time Template Configuration (NetSuite) - Excel Write (Document).

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 Design Time Template Configuration (OneDrive) - Excel Write (Document).

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 Design Time Template Configuration (OneDrive For Business) - Excel Write (Document).

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 Design Time Template Configuration (Salesforce) - Excel Write (Document).

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 Design Time Template Configuration (SFTP) - Excel Write (Document).

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 Design Time Template Configuration (SharePoint) - Excel Write (Document).

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 Design Time Template Configuration (Local File System) - Excel Write (Document).

Runtime Repository

Specifies the data source for your runtime template.

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 Runtime Template Configuration (Amazon S3) - Excel Write (Document).

Box Box icon

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

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).

FTP FTP icon

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 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 Runtime Template Configuration (Google Drive) - Excel Write (Document).

NetSuite NetSuite icon

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

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 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 Runtime Template Configuration (OneDrive For Business) - Excel Write (Document).

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 Runtime Template Configuration (Salesforce) - Excel Write (Document).

SFTP SFTP icon

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

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).

File System File System icon

Function:
Specifies that a local file system is the data source for your runtime template.

To select your runtime template, complete the fields on Runtime Template Configuration (Local File System) - Excel Write (Document).

Target Repository

Selects the target storage repository type for your files.

Screen



Fields

Field Name Definition

Amazon S3 Amazon S3 icon

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

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

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).

FTP FTP icon

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

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).

NetSuite NetSuite icon

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

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

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

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

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

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).

File System File System icon

Function:
Specifies that a local file system is your document target location.

To configure the target location for your file, complete the fields in Target Repository Configuration (Local File System) - Excel Write (Document).

Excel Write Configuration

Configures an operation to create a Microsoft Excel file.

Screen



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 Microsoft Excel template file that is used when you are creating or changing 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 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

Field Mapping

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