New Data Source screen (Database)

Configures a database as your data source.

Figure: How do you want to set up your entity? screen

How do you want to set up your entity screen

Background and Setup

Prerequisites

How to Start

  1. Click App Builder.

    Click App Builder
  2. On the App Builder Home screen, click All Apps.

    Click All Apps
  3. On the All Apps screen, on an app, click Edit Edit icon.

    Click Edit
  4. On the App Details screen, click Add New Add New icon > Data Source.

    Click Data Source
  5. On the Please select data source type screen, select Database.

    Select Database
  6. Click Next.

How do you want to set up your entity? > Configuration tab

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

Figure: How do you want to set up your entity? > Configuration tab

How do you want to set up your entity 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:

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 Add Token icon
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

How do you want to set up your entity? > Fields tab

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

Figure: How do you want to set up your entity? > Fields tab

How do you want to set up your entity Fields screen

Prerequisites

Fields

Field NameDefinition

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.

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 Configure Reference Entity icon
Opens this Screen:
Reference Entity Configuration screen
To Open this Field:
Function of this Screen:
Changes the database column for the reference table.
Limitations:

The Configure Reference Entity option is available in these releases:

Reference Entity Configuration screen

Changes the database column for the reference table.

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 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.

How do you want to set up your entity? > Related Entities tab

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

Figure: How do you want to set up your entity? > Related Entities tab

How do you want to set up your entity Related Entities tab

Prerequisites

Fields

Field NameDefinition

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

Display Name
Description:
Shows the database tables that have relationships with this table and their dependent fields.
Allowed Values:
Read only.

Data Type
Description:
Shows the data type of a database column.
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.