AgilePoint Data Entities Configuration screen

Configures an entity in AgilePoint NX Data Entities for your data source.

Background and Setup

How to Start

  1. On the Application Explorer screen, expand [App Name] > Processes.
  2. Click your process name.

    Application Explorer screen
  3. Do one of these:
    • Click Schema.

      Application Explorer screen
      1. Select Schema.xsd

        Application Explorer screen
      2. Click Edit.

        Application Explorer screen
    • In the content pane, double-click Process Model.
      1. Double-click your process.
      2. Click Form Data Form Data icon.
      3. On the Data screen, in the Data Source, click Edit Edit icon.
  4. On the Data Model screen, click Add Data Source Add Data Source icon.

    Application Explorer screen
  5. On the Select Data Source screen, select Data Entities Data Entity icon.
  6. Click Next.

AgilePoint Data Entities Configuration > Configuration tab

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

Figure: AgilePoint Data Entities Configuration > Configuration tab

AgilePoint Data Entity Configuration Configuration tab

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:

Save Data In 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

Save A Copy Of Data In 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 Entities Configuration > Fields tab

Specifies the entity fields from entity.

Figure: AgilePoint Data Entities Configuration > Fields tab

AgilePoint Data Entities 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.

Lookup Key

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

Required

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.

Configure Reference Entity Configure Reference Entity icon

Opens this Screen:
Reference Entity Configuration screen
To Open this Field:
Function of this Screen:
Configures to change the field for the reference entity.
Limitations:

The Configure Reference Entity option is available in these releases:

Reference Entity Configuration screen

Configures to change the field for the reference entity.

Changes on this screen, effect the results of lookups.

Figure: Reference Entity Configuration screen

Reference Entity Configuration screen

Prerequisites

Fields

Field Name Definition

Reference Entity

Function:
Shows the reference entity whose field to change.
Accepted Values:
Read only.

Name

Function:
Specifies the field to change for the reference entity.
Accepted Values:
A field from the list.
Default Value:
The primary field field.

Value

Function:
Shows the internal name of the primary field.
Accepted Values:
Read only.

AgilePoint Data Entities Configuration > Related Entity tab

Specifies related entity to use in app or process.

Figure: AgilePoint Data Entities Configuration > Related Entity tab

AgilePoint Data Entities 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. For Microsoft Excel, entity refers to an Excel table.
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. For Microsoft Excel, entity refers to an Excel table.
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.