Write Excel Table activity

An activity that lets you create or change data in a Microsoft Excel table with information from an AgilePoint NX app.


Write Excel Table activity

Configure the Write Excel Table activity

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

Prerequisites

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 Write Excel Table activity onto your process.

    Write Excel Table activity

General Configuration

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

Write Excel Table Configuration

Configures an operation to create a Microsoft Excel file.

Figure: Write Excel Table Configuration screen

Write Excel Table Configuration screen

Fields

Field NameDefinition

Design time - Repository Name

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 the app.
Allowed Values:

Read only

The runtime template file and the design time template file must have the same column names in the Excel table.

Runtime - Repository Name

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 or change a data in the Excel file when the process runs.
Allowed Values:

Read only

The runtime template file and the design time template file must have the same column names in the Excel table.

Save To

Description:
Shows the target path you configured in the Target Repository Configuration to save the Microsoft Excel document.
Allowed Values:
Read only.

File Name

Description:
Specifies the file name for your Microsoft Excel file to save in the target repository.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
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: