Form-Based App with AgilePoint Data Entities Data Source (Classic)

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

Background and Setup

Video: Form-Based App Overview (Classic)

Video: Know Your App Builder IDE (Classic)

Examples

(Example) Create and Run a Form-Based App with AgilePoint NX Data Entities (Classic)
Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Prerequisites

On the App Builder Process Designer Settings screen, set Default App Wizard Experience to Classic.
AgilePoint NX OnDemand (public cloud), or AgilePoint NX Private Cloud or AgilePoint NX OnPremises v7.0 or higher.

Good to Know

This topic applies to the classic Add an App experience. For the modern Add an App experience, refer to Form-Based App with an Existing AgilePoint Data Entity as the Data Source (Modern).
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

Create a form-based app.
On the New App screen, click Next.
On the Select Primary Data Source screen, select Data Entities .
Click Next.

AgilePoint Data Entities Configuration screen > Configuration tab

Configures how to collect data from Data Entities for your eForm.

Fields

Field Name	Definition
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: The videos on this page (Example) Create and Run a Form-Based App with AgilePoint NX Data Entities (External) Form Based Apps – SharePoint Data Source
Custom Entities Only	Function: Specifies whether to show only custom entities in the Primary Entity Name list. Accepted Values: Selected - Shows only the custom entities in the Primary Entity Name list. Deselected - Shows both standard entities and custom entities in the Primary Entity Name list. Default Value: Deselected Accepts Process Data Variables: No Example: Refer to: The videos on this page
Primary Entity Name	Function: Specifies the AgilePoint NX entity from which your form collects data. Accepted Values: The AgilePoint NX entity from the list. Default Value: AgilePoint NX entities. Accepts Process Data Variables: No Example: Refer to: The videos on this page

AgilePoint Data Entities Configuration screen > Fields tab

Specifies the entity fields from entity.

Prerequisites

Complete the AgilePoint Data Entity Configuration screen > Configuration tab.

Fields

Field Name	Definition
Show Internal Fields	Function: Specifies whether to show the internal names of default entity fields from AgilePoint Data Entities. Accepted Values: Selected - Shows the internal names of default entity fields. Deselected - Does not show default entity fields. Default Value: Deselected
Check box	Function: Specifies the fields to use on your form. Accepted Values: Selected - Your form contains the field. Deselected - The field does not show on your form. Default Value: Selected Example: Refer to: The videos on this page (External) Form Based Apps – SharePoint Data Source
Display Name	Function: Shows the fields associated with an entity. Accepted Values: Read only.
Data Type	Function: Shows the data type of a field. Accepted Values: Read only.
SchemaXPath	Function: Shows the xpath of the field in your AgilePoint NX process field. Accepted Values: Read only.
Lookup Key	Function: Shows whether the field has a lookup relationship. Accepted Values: Read only.
Required	Function: Specifies whether the field is required. Accepted Values: Read only.
Unique	Function: Shows whether a duplicate value is permitted in the field. Accepted Values: Read only.

AgilePoint Data Entities Configuration screen > Related Entity tab

Specifies related entity to use on your form for AgilePoint NX Data Entities.

Prerequisites

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

Good to Know

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.

Fields

Field Name	Definition
Checkbox	Function: Specifies the related entities to use on your form. Accepted Values: Selected - Your form contains related entity. Deselected - Your form does not use the related entity. Default Value: Deselected Example: Refer to: The videos on this page (External) Form Based Apps – SharePoint Data Source
Primary Entity Name	Function: Shows the entity name that you specified on the AgilePoint Data Entity Configuration screen > Configuration tab. 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 entity field that contains the primary field. 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 the entities that have relationships with the primary entity. 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	Function: Shows the fields associated with the related entity.