Form-Based App with Database Data Source (Classic)

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

Background and Setup

Prerequisites

Good to Know

  • The form name is based on your database table name.

    Format:

    • New [Database Table Name]
    • Update [Database Table Name]
    • All [Database Table Name, Plural]
    • Recently Created [Database Table Name, Plural]
    • Recently Modified [Database Table Name, Plural]

    Example:

    • New Customer
    • Update Customer
    • All Customers
    • Recently Created Customers
    • Recently Modified Customers
  • The Oracle database creates only 1 view with the name in the format All [Database Table Name, Plural]. The Recently Created and Recently Modified views will not be created for Oracle database.
  • AgilePoint does not support non-English characters in database table column names. These characters are supported:
    • Alphanumeric
    • Underscore
    • Space
  • After you create a form-based app, you cannot change the app to use a different data source. For example, you can not change a form-based app to use a different entity or SharePoint list than the one specified when the app was created. This limitation also applies to cloned apps. That is, you cannot clone a form-based app, and then change the data source in the cloned app.

How to Start

  1. Create a form-based app.
  2. On the New App screen, click Next.
  3. On the Select Primary Data Source screen, select Database Database icon.
  4. Click Next.

Database Configuration screen > Configuration tab

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

Figure: Database Configuration > Configuration tab

Database Configuration Configuration tab

Fields

Field Name Definition

Data Source Name

Function:
Specifies a name for your data source.
Accepted Values:
One line of text 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
Example:
Refer to:

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.
Example:
Refer to:

Primary Entity Name

Function:
Specifies the database table to use for your form. The form-based 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

Database Configuration screen > Fields tab

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

Figure: Database Configuration > Fields tab

Database Configuration Fields tab

Prerequisites

Fields

Field Name Definition

Check box

Function:
Specifies the database columns to use on your form.
Accepted Values:
  • Selected - Your form contains the database column.
  • Deselected - The database column does not show on your form.
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 form-based app.

Figure: Database Configuration > Related Entity tab

Database Configuration Related Entity tab

Prerequisites

Good to Know

Fields

Field Name Definition

Check box

Function:
Specifies whether to use the relationship on your form.
Accepted Values:
  • Selected - Your form uses the relationship.
  • Deselected - Your form 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.
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.

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.