New Data Source screen (Database)

Data Source Name

Function:

Specifies a name for your data source.

Accepted Values:

One line of text (a string) with no spaces.

Default Value:

None

Accepts Process Data Variables:

No

Example:

Refer to:

• (Example) Create and Run a Form-Based App with AgilePoint NX Data Entities
• (External) Form Based Apps – SharePoint Data Source

Database

Function:

Specifies the access token that connects to your database.

Accepted Values:

A list of access tokens configured for your environment.

Default Value:

None

Accepts Process Data Variables:

No

Create

Opens this Screen:

Access Token for Database

Function of this Screen:

Configure an access token to connect to a database..

Schema Name

Function:

Specifies your process schema.

Accepted Values:

A schema name from the list.

When you select a database, the schemas associated with the database show in this field.

Default Value:

None

Limitations:

• This field does not apply to MySQL databases.

Primary Entity Name

Function:

Specifies the database table to use for your app or process. The app stores data in this table and uses the columns in this table to create access tokens.

Accepted Values:

A database table from the list.

Default Value:

None.

When you select the database access token, the database tables show in the Primary Entity Name list.

Accepts Process Data Variables:

No

Autosave data in Database

Function:

Saves the application data in the external database.

Accepted Values:

• Selected - Saves the data in the external database, in addition to the AgilePoint NX workflow database.
• Deselected - Does not save the data in the external 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 Database 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 external database.
• Deselected - Saves the data in the external database, but not in the AgilePoint NX workflow database.

Default Value:

Deselected

Check box

Function:

Specifies the database columns to use on your process.

Accepted Values:

• Selected - Your process contains the database column.
• Deselected - The database column does not show on your process.

Default Value:

Selected

Display Name

Function:

Shows the database column associated with a database table.

Accepted Values:

Read only.

Data Type

Function:

Shows the data type of a database column.

Accepted Values:

Read only.

Lookup Key

Function:

Shows whether the database column has a lookup relationship.

Accepted Values:

Read only.

Required

Function:

Specifies whether the value is required in the database column.

Accepted Values:

Read only.

Unique

Function:

Shows whether a duplicate value is permitted in the database column.

Accepted Values:

Read only.

Configure Reference Entity

Opens this Screen:

Reference Entity Configuration screen

To Open this Field:

• This field shows if a primary entity field or a related entity field is referred from a reference entity.

Function of this Screen:

Changes the field for the reference entity.

Limitations:

The Configure Reference Entity option is available in these releases:

• AgilePoint NX OnDemand (public cloud), or AgilePoint NX Private Cloud or AgilePoint NX OnPremises v7.0 Software Update 2 or higher.

Reference Entity

Function:

Shows the reference table whose database column to change.

Accepted Values:

Read only.

Name

Function:

Specifies the database column to change for the reference table.

Accepted Values:

A database column from the list.

Default Value:

The column associated with the primary key.

Value

Function:

Shows the internal name of the database column.

Accepted Values:

Read only.

Check box

Function:

Specifies whether to use the relationship on your process.

Accepted Values:

• Selected - Your process uses the relationship.
• Deselected - Your process does not use the relationship.

Default Value:

Deselected

Primary Entity Name

Function:

Shows the database table name that you specified on the Database Configuration screen > Configuration tab.

Accepted Values:

Read only.

Primary Entity Key Field

Function:

Shows the primary key for the parent database table.

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 other database tables that have relationships with this table.

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

Function:

Shows the database columns associated with the relationship between tables.