Import App activity

An activity that imports an app from an external data source to AgilePoint NX.


Import Application activity

Configure the Import App activity

To configure the Import App activity, do the procedure in this topic.

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 Import App activity onto your process.

    Drag Import App activity

General Configuration

Specifies the basic settings for the Import App 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 original, or source, location type for your files.

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.

Import App Configuration > App

Specifies the configuration to import an app in AgilePoint NX.

Figure: Import App Configuration > App tab

Import App Configuration App tab

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.

Publish App After Importing?

Description:
Specifies if the demo application is published when the import is complete.
Allowed Values:
  • Deselected - Does not publish the app.
  • Selected - Publishes the app.
Default Value:
Deselected

Version Increment Count

Description:
Specifies the process data variable that gets the version number of the app.
To Open this Field:
  1. On the Import App Configuration screen, in the App tab, select Want to Publish App After Importing.
Allowed Values:
A process data variable
Default Value:
None
Accepts Variables:
Yes

Description

Description:
An optional description for your app.
To Open this Field:
  1. On the Import App Configuration screen, in the App tab, select Want to Publish App After Importing.
Allowed Values:
More than one line of text.
Default Value:
None

Import App Configuration > Response

Specifies the configuration to get the details of the app and store the information in process data variables.

Figure: Import App Configuration > Response tab

Import App Configuration Response tab

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.

App ID

Description:
Specifies the process data variable that contains the application ID.
Allowed Values:
A variable.

Format:

  • String

Accepted:

  • Letters
  • Numbers

Not Accepted:

  • Spaces
  • Special characters
Default Value:
None
Accepts Variables:
Yes

App Type

Description:
Specifies the process data variable that contains the type of processes in your app.
Allowed Values:
A process data variable.

You can use App Data screen to specify a process data variable.

Default Value:
None
Accepts Variables:
Yes

App Internal Name

Description:
Specifies a process data variable that contains the internal, or technical, name of your app.
Allowed Values:
A process data variable that accepts an alphanumeric string with no spaces. It does not accept these special characters:
  • <
  • >
  • &
  • "
  • '
  • @
  • #
  • +
  • ?
  • ^
Default Value:
None
Accepts Variables:
Yes

App Display Name

Description:
Specifies the process data variable that contains the name of your app that shows in the AgilePoint NX UI.
Allowed Values:
A process data variable that accepts an alphanumeric string that can have spaces.
Default Value:
None
Accepts Variables:
Yes

Status

Description:
Specifies the process data variable that contains the status of your app.
Allowed Values:
A process data variable that accepts an alphanumeric string with no spaces.
Default Value:
None
Accepts Variables:
Yes

Created By

Description:
Specifies the process data variable that contains the user name who created the app.
Allowed Values:
A process data variable in this format:
  • [domain name]\[user name]
Default Value:
None
Accepts Variables:
Yes
Example:
MyDomain\Administrator

Created Date

Description:
Specifies the process data variable that contains the date the app was created.
Allowed Values:
A variable.

Format:

  • DateTime
Default Value:
None
Accepts Variables:
Yes