Export Records activity

An activity that exports the records from an AgilePoint NX entity as an XML, JSON, or Microsoft Excel file to your repository.


Export Record activity

Configure the Export Records activity

To configure the Export Records 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 Data Entities tab.

    AgilePoint Data Entities tab
  3. On the Data Entities tab, drag the Export Records activity onto your process.

    Export Record activity

General Configuration

Specifies the basic settings for the Export Record 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

Target Repository

Selects the target storage repository type for your file.

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.

Export Records Configuration

Specifies the configuration to export the records from an AgilePoint NX entity as an XML, JSON, or Microsoft Excel file to your repository.

Figure: Export Records Configuration screen

Export Record Configuration screen

Fields

Field NameDefinition

Standard Entities / Custom Entities

Description:
Specifies whether to show standard (out-of-the-box) entities or custom entities in the Entity Name list.
Allowed Values:
  • Standard Entities - Shows standard (out-of-the-box) entities in the Entity Name list.
  • Custom Entities - Shows custom entities in the Entity Name list.
Default Value:
Standard Entities

Entity

Description:
Specifies an entity from which to download the records.
Allowed Values:
An entity name from the list.
Default Value:
None
Accepts Variables:
Yes

Export as JSON / Export as XML / Export as Excel

Description:
Specifies whether to download the records from an AgilePoint NX entity as an XML, JSON, or Microsoft Excel file to your repository.
Allowed Values:
  • Export as JSON - Downloads the records as a JSON file from the entity to the specified repository.
  • Export as XML - Downloads the records as an XML file from entity to the specified repository.
  • Export as Excel - Downloads the records as a Microsoft Excel file from entity to the specified repository.
Default Value:
Export as JSON
Limitations:

Support for Microsoft Excel files is available in these releases: