Process-Based App with Database Data Source (Classic)

This topic explains how to create a process-based app with database in the Classic Add an App experience.

Background and Setup

Video: Create Your First App

Examples

Prerequisites

Good to Know

  • AgilePoint does not support non-English characters in database table column names. These characters are supported:
    • Alphanumeric
    • Underscore
    • Space
  • When you create a new app, the first version is automatically checked in.
  • This topic applies to the classic Add an App experience. For the modern Add an App experience, refer to Process-Based App with Database as the Data Source (Modern).

How to Start

  1. Sign in to AgilePoint NX..
  2. Click App Builder.

    Build Apps screen
  3. On the App Explorer screen, click Add App.

    Add App button
  4. On the App Type screen, click Process-Based App.

    Add App button
  5. Click Next.
  6. On the New App screen, complete the fields, and click Next.

    New Application screen
    .
  7. On the New Process Model screen, complete the fields, and click Next.

    New Process Model screen
    .
  8. On the Select Primary Data Source screen, select Database Database icon.

    Primary Data Source screen
  9. Click Next.

Database Configuration screen > Configuration tab

Configures how to collect data from a database table for a process-based app.

Figure: Database Configuration > Configuration tab

Database Configuration Configuration tab

Good to Know

Fields

Field NameDefinition

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:

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 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
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 process. The process-based app stores data in this table and uses the columns in this table to create access tokens
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:
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

Database Configuration screen > Fields tab

Specifies the database columns to use in a process-based app.

Figure: Database Configuration > Fields tab

Database Configuration Fields tab

Prerequisites

Fields

Field NameDefinition

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.

SchemaXPath
Function:
Shows the xpath of the 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.

Database Configuration screen > Related Entity tab

Specifies the primary key / foreign key database table relationships to use in a process-based app.

Figure: Database Configuration > Related Entity tab

Database Configuration Related Entity tab

Prerequisites

Good to Know

Fields

Field NameDefinition

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 Field icon
Function:
Shows the database columns associated with the relationship between tables.