Export Package activity

An activity that exports the specified packages to a document repository.


Export Package activity

Configure the Export Package activity

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 AgilePoint NX tab.

    AgilePoint NX tab
  3. On the AgilePoint NX tab, drag the Export Package activity onto your process.

    Drag Export Package activity

General Configuration

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

Export Package Configuration

Configures the packages to export to a specified document repository.

Figure: Export Package Configuration screen

Export Package Configuration screen

Fields

Field NameDefinition

AgilePoint NX

Description:
Specifies the access token that connects to your AgilePoint NX environment.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Variables:
No

Create Add Token icon

Opens this Screen:
Access Token for AgilePoint NX
Function of this Screen:
Configure an access token to connect to AgilePoint NX.

Package

Description:
Shows the list of packages to export.
Allowed Values:
A package from the list.

Set Import Password

Description:
Specifies a password that is required to import the package. It is optional whether to require an import password.
Allowed Values:
One line of text (a string).

Not Accepted:

  • Spaces
Default Value:
None
Accepts Variables:
Yes

Notes Or Instructions

Description:
Specifies any information that is required for a user to know when they import the app. For example, a user may need to know if the package will overwrite any access tokens or custom JavaScript, and how to handle such conflicts.
Allowed Values:
More than one line of text.

Format:

  • Rich text
Default Value:
None

Allow Publish On Import

Description:
When the package is imported, all the apps in the package are published by default, and ready to use at runtime.
Allowed Values:
  • Yes - All the apps in the package are published by default.
  • No - All the apps in the package are not published by default.
Default Value:
None

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.