New Data Source screen (Database)

Background and Setup

Prerequisites

A process-based app.

How to Start

Open the Data Model screen.
For information about how to open this screen, refer to Data Model screen.
On the Data Model screen, click Add Data Source .
On the Select Data Source screen, select Database.
Click Next.

Database Configuration screen > Configuration tab

Configures how to collect data from a database table for your app or process.

Fields

Field Name	Definition
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: (External) Form Based Apps – SharePoint Data Source
Database	Description: Specifies the access token that connects to your database. Allowed Values: A list of access tokens configured for your environment. Default Value: None Accepts 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	Description: Specifies your process schema. Allowed 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	Description: 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. Allowed 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 Variables: No
Autosave data in Database	Description: Saves the application data in the external database. Allowed 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	Description: 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. Allowed 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

Database Configuration screen > Fields tab

Specifies the database columns to use in your app or process.

Figure: Database Configuration Fields screen

Prerequisites

Complete the Database Configuration screen > Configuration tab.

Fields

Field Name	Definition
Check box	Description: Specifies the database columns to use on your process. Allowed Values: Selected - Your process contains the database column. Deselected - The database column does not show on your process. Default Value: Selected
Display Name	Description: Shows the database column associated with a database table. Allowed Values: Read only.
Data Type	Description: Shows the data type of a database column. Allowed Values: Read only.
Lookup Key	Description: Shows whether the database column has a lookup relationship. Allowed Values: Read only.
Required	Description: Specifies whether the value is required in the database column. Allowed Values: Read only.
Unique	Description: Shows whether a duplicate value is permitted in the database column. Allowed 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 database column for the reference table. Limitations: The Configure Reference Entity option is available in these releases: AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 Software Update 2 or higher.

Reference Entity Configuration screen

Configures to change the database column for the reference table.

Prerequisites

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 Software Update 2 or higher.
Complete the Database Configuration screen > Configuration tab.

Good to Know

Changes on this screen affect the results of lookups.

Fields

Field Name	Definition
Reference Entity	Description: Shows the reference table whose database column to change. Allowed Values: Read only.
Name	Description: Specifies the database column to change for the reference table. Allowed Values: A database column from the list. Default Value: The column associated with the primary key.
Value	Description: Shows the internal name of the database column. Allowed Values: Read only.

Database Configuration screen > Related Entity tab

Specifies the primary key/foreign key database table relationships to use in an app or process.

Figure: Database Configuration Related Entity screen

Prerequisites

Complete the Database Configuration screen > Configuration tab.
The Related Entity tab is available if the primary entity has a related entity.

Fields

Field Name	Definition
Check box	Description: Specifies whether to use the relationship on your process. Allowed Values: Selected - Your process uses the relationship. Deselected - Your process does not use the relationship. Default Value: Deselected
Primary Entity Name	Description: Shows the database table name that you specified on the Database Configuration screen > Configuration tab. Allowed Values: Read only.
Primary Entity Key Field	Description: 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. Allowed Values: Read only.
Related Entity	Description: 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. Allowed Values: Read only.
Dependent Field	Description: Shows the dependent field of the related entity. Allowed Values: Read only.
Field	Description: Shows the database columns associated with the relationship between tables.