Form-Based App with Database as the Data Source (Modern)

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

Background and Setup

Prerequisites

Good to Know

  • This topic applies to the Modern Add an App Experience. For the Classic Add an App Experience, refer to Form-Based App with Database Data Source (Classic).
  • 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. Click App Builder.

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

    Add App button
  3. On the What type of app would you like to build? screen, click Form-Based App.

What type of app would you like to build? screen

Configures the type of app to create.

Figure: What type of app would you like to build? screen

What type of app would you like to build screen

Fields

Field Name Definition

App Type

Function:
Specifies the type of app to create.
Accepted Values:
Default Value:
Process-Based App

How will people identify your app? screen

Configures the basic information for your app.

Figure: How will people identify your app? screen

How will people identify your app screen

Fields

Field Name Definition

App Name

Function:
Specifies a name for your app.
Accepted Values:
One line of text that can have spaces.
Default Value:
None

Language

Function:
Specifies the language for your app.
Accepted Values:
A language from the list.
Default Value:
None
Accepts Process Data Variables:
No

Category

Function:
Specifies a category for your app.
Accepted Values:
A category from the list.

The category list comes from Tenant Settings > Categories tab.

Default Value:
None

Description

Function:
An optional description for your app.
Accepted Values:
More than one line of text.
Default Value:
None

Do you want create widget Form (not typical) screen

Specifies the type of the form to create.

Figure: Do you want create widget Form (not typical) screen

Do you want create widget From screen

Fields

Field Name Definition

Widget Form

Function:
Specifies whether to create a widget form that can show information on a custom page in Page Builder.
Accepted Values:
  • Not Required - Creates a standard form-based app, which can not be used in a widget.
  • Yes, Create Widget Form - Creates a widget form to show information based on lookups. Widget forms can only be used in Page Builder.
Default Value:
Not Required

Where do you want to store the data for your app? screen

Specifies to store and retrieve the data from the data source for your form-based app.

Figure: Where do you want to store the data for your app? screen

Where do you want to store the data for your app screen

Fields

Field Name Definition

Select Data Source

Function:
Specifies the primary data source your app uses to store and retrieve data.
Accepted Values:
Default Value:
AgilePoint Data Entities

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

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

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

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

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

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

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

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

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

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.

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.

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

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

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

Related Entities 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

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.

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.

Anything else right now? screen

Configures the optional features for your form-based app.

Figure: Anything else right now? screen

Anything else right now screen

Fields

Field Name Definition

Access Tokens

Opens this Screen:
The configuration screen for your access token. The specific screen that shows depends on your access token type.

For more information, refer to Access Tokens.

Function of this Screen:
Configures an access token.

Document Repositories

Opens this Screen:
The configuration screen for your document repository. The specific screen that shows depends on your document repository type.

For more information, refer to Document Repositories.

Function of this Screen:
Configures your document repository.

Style Sheets

Function:
Uploads CSS files to change the look and feel of your eForms.

Groups and Roles

Function:
Creates groups and roles for the access rights for an app.

Images

Function:
Uploads image files to customize your app.

JavaScript

Function:
Uploads JavaScript files to use in eForms.

Who can access your app? screen

Configures the permission groups for an app.

Figure: Who can access your app? screen

Who can access your app screen

Fields

Field Name Definition

App Owners

Opens this Screen:
App Owners tab
Function:
Specifies the users and groups who are App Owners.

App Designers

Opens this Screen:
App Designers tab
Function:
Specifies the users and groups who are App Designers.

App Initiators

Opens this Screen:
App Initiators tab
Function:
Specifies the users and groups who are App Initiators for an app.
Limitations:
Users and groups can only be assigned to the App Initiators permission group after an app is published.