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 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.
  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.
  10. (Optional) Click Advanced Advanced icon > Email Notifications E-mail Notifications icon.

    For more information, refer to Email Notifications screen (Process Activities).

General Configuration

Specifies the basic settings for the Excel Write 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.

Target Repository

Selects the target storage repository type for your files.

Figure: Target Repository screen

Target Repository screen

Fields

Field NameDefinition

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

Excel Write Configuration

Configures an operation to create a Microsoft Excel file.

Figure: Excel Write Configuration screen

Excel Write Configuration screen

Fields

Field NameDefinition

Repository Name - Design

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 a process.
Allowed 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

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 create Excel file when the process runs.
Allowed Values:
Read only.

Save To

Description:
Specifies the location and file name to save the resulting Microsoft Excel document.
Allowed 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 Variables:
Yes
Example:
Refer to:

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: