Process-Based Application with AgilePoint Data Entities Data Source

This topic explains how to create a process-based app with AgilePoint NX Data Entities.

Video: Create Your First App

Video: Create a New AgilePoint NX App

Examples

Prerequisites

Good to Know

  • When you create a new application, the first version is automatically checked in.

How to Start

  1. Sign in to AgilePoint NX.
  2. Click Build Apps Build Apps icon.

    Build Apps icon
  3. On the Application Explorer screen, click Add App.

    Add App button
  4. On the Application Type screen, click Process-Based Application.

    Add App button
  5. Click Next.
  6. On the New Application screen, complete the fields, and click Next.

    New Application screen
    .
  7. On the New Process Model screen, complete the fields, and click Next.

    New Process Model screen
    .
  8. On the Select Primary Data Source screen, select Data Entity Data Entity icon.

    Primary Data Source screen
  9. Click Next.

AgilePoint Data Entity Configuration screen > Configuration tab

Configures how to collect data from Data Entities for your process.

Figure: AgilePoint Data Entity Configuration > Configuration tab

AgilePoint Data Entity Configuration screen

Fields

Field Name Definition

Data Source Name
Function:
Specifies a name for your data source.
Accepted Values:
One line of text with no spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
Refer to:

Custom Entities Only
Function:
Specifies whether to show only custom entities in the Primary Entity Name list.
Accepted Values:
  • Selected - Shows only the custom entities in the Primary Entity Name list.
  • Deselected - Shows both standard entities and custom entities in the Primary Entity Name list.
Default Value:
Deselected
Accepts Process Data Variables:
No

Primary Entity Name
Function:
Specifies the AgilePoint NX entity from which your process to collect data.
Accepted Values:
The AgilePoint NX entity from the list.
Default Value:
AgilePoint NX entities.
Accepts Process Data Variables:
No
Example:
Refer to:

Autosave data in AgilePoint Data Entities
Function:
Saves the application data in AgilePoint Data Entities.
Accepted Values:
  • Selected - Saves the data in the Data Entities database, in addition to the AgilePoint NX workflow database.
  • Deselected - Does not save the data in the Data Entities database.
Default Value:
Selected

Allow to save a copy of data in AgilePoint NX
Function:
Specifies whether to save the data in the AgilePoint NX workflow database.

When you select this field, you can deselect Autosave data in AgilePoint Data Entities field, and save the data only in the workflow database.

Accepted Values:
  • Selected - Saves the data in the AgilePoint NX workflow database, in addition to the Data Entities database.
  • Deselected - Saves the data in the Data Entities database, but not in the AgilePoint NX workflow database.
Default Value:
Deselected

AgilePoint Data Entity Configuration screen > Fields tab

Specifies the entity fields from entity.

Figure: AgilePoint Data Entity Configuration > Fields tab

AgilePoint Data Entity Configuration Fields tab

Prerequisites

Fields

Field Name Definition

Show Internal Fields
Function:
Specifies whether to show the internal names of default entity fields from AgilePoint Data Entities.
Accepted Values:
  • Selected - Shows the internal names of default entity fields.
  • Deselected - Does not show default entity fields.
Default Value:
Deselected

Check box
Function:
Specifies the fields to use in your process.
Accepted Values:
  • Selected - Your process contains the field.
  • Deselected - The field does not show on your process.
Default Value:
Selected

Display Name
Function:
Shows the fields associated with an entity.
Accepted Values:
Read only.

Data Type
Function:
Shows the data type of a field.
Accepted Values:
Read only.

SchemaXPath
Function:
Shows the xpath of the field in your AgilePoint NX process field.
Accepted Values:
Read only.

Lookup Key
Function:
Shows whether the field has a lookup relationship.
Accepted Values:
Read only.

Mandatory
Function:
Specifies whether the field is required.
Accepted Values:
Read only.

Unique
Function:
Shows whether a duplicate value is permitted in the field.
Accepted Values:
Read only.

AgilePoint Data Entity Configuration screen > Related Entity tab

Specifies related entity to use in a process-based app.

Figure: AgilePoint Data Entity Configuration > Related Entity tab

AgilePoint Data Entity Configuration Related Entity tab

Prerequisites

Fields

Field Name Definition

Check box
Function:
Specifies the related entities to use on your process.
Accepted Values:
  • Selected - Your process contains the related entity.
  • Deselected - Your process does not use the related entity.
Default Value:
Deselected

Primary Entity Name
Function:
Shows the entity name that you specified on the AgilePoint Data Entity Configuration screen > Configuration tab.
Accepted Values:
Read only.

Primary Entity Key Field
Function:
Shows the entity field that contains the primary field.
Note: The word entity on this screen refers to a container within your data model. For Data Entities or Salesforce, this container is called an entity. For a database, entity refers to a database table. For SharePoint Integration, entity refers to a SharePoint list..
Accepted Values:
Read only.

Related Entity
Function:
Shows the entities that have relationships with the primary entity.
Note: The word entity on this screen refers to a container within your data model. For Data Entities or Salesforce, this container is called an entity. For a database, entity refers to a database table. For SharePoint Integration, entity refers to a SharePoint list..
Accepted Values:
Read only.

Dependent Field
Function:
Shows the dependent field of the related entity.
Accepted Values:
Read only.

Field Field icon
Function:
Shows the fields associated with the related entity.