New Data Source screen (Data Entities)

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

Figure: AgilePoint Data Entities Configuration > Configuration tab

AgilePoint Data Entity Configuration Configuration tab

Background and Setup

Prerequisites

How to Start

  1. Open the Data Model screen.

    For information about how to open this screen, refer to Data Model screen.


    Open Data Model
  2. On the Data Model screen, click Add Data Source Add Data Source icon.

    Application Explorer screen
  3. On the Select Data Source screen, select Data Entities.

    Select Data Entities
  4. 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 NameDefinition

Data Source Name
Description:
Specifies a name for your data source.
Allowed Values:
One line of text (a string).

Not Accepted:

  • Spaces
Default Value:
None
Accepts Variables:
No
Example:
Refer to:

Custom Entities Only
Description:
Specifies whether to show only custom entities in the Primary Entity Name list.
Allowed 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 Variables:
No

Primary Entity
Description:
Specifies the AgilePoint NX entity from which your process to collect data.
Allowed Values:
The AgilePoint NX entity from the list.
Default Value:
None
Accepts Variables:
No
Example:
Refer to:

Save Data In Data Entities
Description:
Saves the application data in AgilePoint Data Entities.
Allowed 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 AgilePoint NX
Description:
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.

Allowed 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 NameDefinition

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

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

Display Name
Description:
Shows the fields associated with an entity.
Allowed Values:
Read only.

Data Type
Description:
Shows the data type of a field.
Allowed Values:
Read only.

Lookup Key
Description:
Shows whether the field has a lookup relationship.
Allowed Values:
Read only.

Required
Description:
Specifies whether the field is required.
Allowed Values:
Read only.

Unique
Description:
Shows whether a duplicate value is permitted in the field.
Allowed 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:
Changes the field for the reference entity.
Limitations:

The Configure Reference Entity option is available in these releases:

Reference Entity Configuration screen

Changes the field for the reference entity.

Figure: Reference Entity Configuration screen

Reference Entity Configuration screen

Prerequisites

Good to Know

  • Changes on this screen affect the results of lookups.

Fields

Field NameDefinition

Reference Entity
Description:
Shows the reference entity whose field to change.
Allowed Values:
Read only.

Name
Description:
Specifies the field to change for the reference entity.
Allowed Values:
A field from the list.
Default Value:
The primary field field.

Value
Description:
Shows the internal name of the primary field.
Allowed 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 NameDefinition

Check box
Description:
Specifies the related entities and their associated fields to use in your process.
Allowed Values:
  • Selected - The process contains the related entities and their assoicated fields.
  • Deselected - The process does not use the related entities.
Default Value:
Deselected

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

Primary Entity Key Field
Description:
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.
Allowed Values:
Read only.

Related Entity
Description:
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.
Allowed Values:
Read only.

Dependent Field
Description:
Shows the dependent field of the related entity.
Allowed Values:
Read only.

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