Form-Based App with AI

Background and Setup

Examples

(External) GenAI for Building Master – Detail Forms
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

An AgilePoint license that supports GenAI.
These access rights:
- Enable App Builder Access
- Create, Delete, And Import Apps
- Create Process Models
- Allow Generative AI Access
For more information, refer to:
- Roles
- (Example) Add a Role
You must be a member of the Entity Designers or Global Data Entities Permission Managers permission group.
On the App Builder > Common > Settings tab, turn on these settings:
- Generative AI
- Excel
- PDF
- Image
- Let AI Decide
AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v9.0 Software Update 1 or higher.

Good to Know

You can use a Microsoft Excel file as a template for your form. The Excel file must meet these requirements:
- The file cannot be larger than 10 MB.
- Only the first sheet is considered.
- The first row is considered the field name.
You can use an image file as a template for your form. The image file must meet these requirements:
- Supported file types are .png, .jpg, and .jpeg.
- The file cannot be larger than 10 MB.
- Regardless of the file height, only one form is generated.
- Any other content is ignored, including images, icons, or descriptive text.
You can use a PDF file as a template for your form. The PDF file must meet these requirements:
- The file cannot be larger than 10 MB.
- The PDF cannot be more than 5 pages.
- Regardless of the number of pages, only one form is generated.
- Any other content is ignored, including images, icons, or descriptive text.
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.
Once configured, the primary data source in a data source bound app cannot be deleted. Deleting the primary data source can lead to unexpected behavior or errors in your app because it is the main source of data for the app.

How to Start

Click App Builder.
On the App Builder Home screen, click Add App.
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.

Fields

Field Name	Definition
App Type	Description: Specifies the type of app to create. Allowed Values: Processed-Based App - Creates a process-based app. Form-Based App - Creates a form-based app. Default Value: Process-Based App

How will people identify your app? screen

Configures the basic information for your app.

Fields

Field Name	Definition
App Name	Description: Specifies a name for your app. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Default Value: None
Language	Description: Specifies the language for your app. Allowed Values: A language from the list. Default Value: None Accepts Variables: No
Category	Description: Specifies a category for your app. Allowed Values: A category from the list. The category list comes from Tenant Settings > Categories tab. Default Value: None
Description	Description: An optional description for your app. Allowed Values: More than one line of text. Default Value: None
Enable Collaborative Development	Description: Specifies whether app designers can use collaborative development to work on the app. Allowed Values: Selected - App designers can use collaborative development to work on the app. Deselected - Collaborative development is not enabled for the app. Only one user at a time can check out the files for the app. Default Value: Deselected Example: Refer to: (Example) Open an App in a Collaborative Development Mode Limitations: On the App Builder > Common screen (Settings), turn on Allow Collaborative Development For Apps. This field is available in these releases: AgilePoint NX OnDemand (public cloud) AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v9.0 or higher

Do you want create widget form (not typical) screen

Specifies whether to create a widget form.

Good to Know

Widget forms are not supported for GenAI.

Procedure

On the Do you want create widget form (not typical) screen, click Not Required.
Click Next.

Do you want AI to create your form? screen

Specifies whether to create the form with GenAI.

Fields

Field Name	Definition
Create Form With AI / Auto Generate Form From SharePoint / Create Form Myself	Description: Specifies whether to create an eForm with GenAI. Allowed Values: Create Form With AI - GenAI creates the form based on input the app designer provides as a prompt. Auto Generate Form From SharePoint - Creates the form with a SharePoint list. For more information, refer to Form-Based App with AI and SharePoint. Create Form Myself - Opens the Where do you want to store the data for your app? screen to let you create the form. For more information, refer to : Form-Based App with an Existing AgilePoint Data Entity as the Data Source (Modern) Form-Based App with a Database as the Data Source (Modern) Form-Based App with Salesforce as the Data Source (Modern) Form-Based App with SharePoint as the Data Source (Modern) Form-Based App with Microsoft Excel as the Data Source (Modern) Default Value: Create Form With AI

Field Name

Definition

Create Form With AI / Auto Generate Form From SharePoint / Create Form Myself

Description:

Specifies whether to create an eForm with GenAI.

Allowed Values:

Create Form With AI - GenAI creates the form based on input the app designer provides as a prompt.
Auto Generate Form From SharePoint - Creates the form with a SharePoint list.
For more information, refer to Form-Based App with AI and SharePoint.
Create Form Myself - Opens the Where do you want to store the data for your app? screen to let you create the form.
For more information, refer to
:

Default Value:

Create Form With AI

How do you want the AI to create the form? screen

Specifies the type of input for GenAI to create an eForm.

Good to Know

You can use a Microsoft Excel file as a template for your form. The Excel file must meet these requirements:
- The file cannot be larger than 10 MB.
- Only the first sheet is considered.
- The first row is considered the field name.
You can use an image file as a template for your form. The image file must meet these requirements:
- Supported file types are .png, .jpg, and .jpeg.
- The file cannot be larger than 10 MB.
- Regardless of the file height, only one form is generated.
- Any other content is ignored, including images, icons, or descriptive text.
You can use a PDF file as a template for your form. The PDF file must meet these requirements:
- The file cannot be larger than 10 MB.
- The PDF cannot be more than 5 pages.
- Regardless of the number of pages, only one form is generated.
- Any other content is ignored, including images, icons, or descriptive text.

Fields

Field Name	Definition
Excel / PDF / Image / Let AI Decide	Description: Specifies the type of input for GenAI to create an eForm. Allowed Values: Excel - Uses an Excel file you upload as the data to create the form. PDF - Uses a PDF file you upload as a template or model to create the form. Image - Uses an image file you upload as a template or model to create the form. Let AI Decide - Provides a text box where you can enter a description of the form as a prompt. GenAI creates a form based on common field types for the form description you enter. Default Value: None

Field Name

Definition

Excel / PDF / Image / Let AI Decide

Description:

Specifies the type of input for GenAI to create an eForm.

Allowed Values:

Excel - Uses an Excel file you upload as the data to create the form.
PDF - Uses a PDF file you upload as a template or model to create the form.
Image - Uses an image file you upload as a template or model to create the form.
Let AI Decide - Provides a text box where you can enter a description of the form as a prompt. GenAI creates a form based on common field types for the form description you enter.

Default Value:

None

Select the repository that contains your form's template screen

Specifies the location of the Microsoft Excel file for your form template.

Prerequisites

This screen shows only if you select Excel on the How do you want the AI to create the form? screen.

Good to Know

You can use a Microsoft Excel file as a template for your form. The Excel file must meet these requirements:
- The file cannot be larger than 10 MB.
- Only the first sheet is considered.
- The first row is considered the field name.

Fields

Field Name	Definition
Upload File	Function: Specifies a Microsoft Excel file that stores the data to create an eForm. You can drag the Excel file from your local machine. Allowed Values: An Excel file where the columns in a table represent input fields for a task form. Click Upload File to select a file from your local machine. The file must follow the business rules for GenAI. Default Value: None
Box	Opens this Screen: Document Repository for Box Function of this Screen: Specifies the location of your file in Box.
Google Drive	Opens this Screen: Document Repository for Google Drive Function of this Screen: Specifies the location of your file in Google Drive.
OneDrive	Opens this Screen: Document Repository for OneDrive Function of this Screen: Specifies the location of your file in OneDrive.
OneDrive For Business	Opens this Screen: Document Repository for OneDrive for Business Function of this Screen: Specifies the location of your file in OneDrive for Business.
SharePoint	Opens this Screen: Document Repository for SharePoint Function of this Screen: Specifies the location of your file in SharePoint.

Select the repository that contains your form's template screen

Specifies the location of the image file for your form template.

Prerequisites

This screen shows only if you select Image on the How do you want the AI to create the form? screen.

Good to Know

You can use an image file as a template for your form. The image file must meet these requirements:
- Supported file types are .png, .jpg, and .jpeg.
- The file cannot be larger than 10 MB.
- Regardless of the file height, only one form is generated.
- Any other content is ignored, including images, icons, or descriptive text.

Fields

Field Name	Definition
Upload File	Function: Specifies an image file to use to create an eForm. You can drag the image file from your local machine. Allowed Values: An image file that shows a mockup, template, or model for a task form. Click Upload File to select a file from your local machine. The file must follow the business rules for GenAI. Default Value: None
Box	Opens this Screen: Document Repository for Box Function of this Screen: Specifies the location of your file in Box.
Google Drive	Opens this Screen: Document Repository for Google Drive Function of this Screen: Specifies the location of your file in Google Drive.
OneDrive	Opens this Screen: Document Repository for OneDrive Function of this Screen: Specifies the location of your file in OneDrive.
OneDrive For Business	Opens this Screen: Document Repository for OneDrive for Business Function of this Screen: Specifies the location of your file in OneDrive for Business.
SharePoint	Opens this Screen: Document Repository for SharePoint Function of this Screen: Specifies the location of your file in SharePoint.

Select the repository that contains your form's template screen

Specifies the location of the PDF file for your form template.

Prerequisites

This screen shows only if you select PDF on the How do you want the AI to create the form? screen.

Good to Know

You can use a PDF file as a template for your form. The PDF file must meet these requirements:
- The file cannot be larger than 10 MB.
- The PDF cannot be more than 5 pages.
- Regardless of the number of pages, only one form is generated.
- Any other content is ignored, including images, icons, or descriptive text.

Fields

Field Name	Definition
Upload File	Function: Specifies a PDF file to use to create an eForm. You can drag the PDF file from your local machine. Allowed Values: A PDF file that shows a mockup, template, or model for a task form. Click Upload File to select a file from your local machine. The file must follow the business rules for GenAI. Default Value: None
Box	Opens this Screen: Document Repository for Box Function of this Screen: Specifies the location of your file in Box.
Google Drive	Opens this Screen: Document Repository for Google Drive Function of this Screen: Specifies the location of your file in Google Drive.
OneDrive	Opens this Screen: Document Repository for OneDrive Function of this Screen: Specifies the location of your file in OneDrive.
OneDrive For Business	Opens this Screen: Document Repository for OneDrive for Business Function of this Screen: Specifies the location of your file in OneDrive for Business.
SharePoint	Opens this Screen: Document Repository for SharePoint Function of this Screen: Specifies the location of your file in SharePoint.

What do you want your app to do? screen

Specifies a text prompt to create the form. Describe the purpose of the form with as much detail and as accurately as possible.

Prerequisites

This screen shows only if you select Let AI Decide on the How do you want the AI to create the form? screen.

Fields

Field Name	Definition
Form Description	Description: Specifies a text prompt to create the form. Describe the purpose of the form with as much detail and as accurately as possible. GenAI creates a form based on common field types for the type of form you describe. Allowed Values: More than one line of text. Default Value: None

Review the data fields for your app screen

Configures the fields for your eForm.

Good to Know

GenAI creates the form fields based on the uploaded file or the form description you entered. You can add, change, and delete fields based on your business requirements.
You can drag the form fields to change the order.

Fields

Field Name	Definition
Select All	Description: Selects all the fields. Allowed Values: Selected - Selects all the form fields. Deselected - Deselects all the form fields.
Name	Description: Specifies the text label for the field that displays on the form. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Special characters Default Value: The field name specified in the imported file.
ID	Description: Specifies a unique, technical name for the form field. When you enter the value in the Name field, this field shows the value you entered in the Name field with no spaces. Allowed Values: One line of text (a string). Accepted: Letters Numbers Default Value: Shows the value in the Name field with no space.
Data Type	Description: Specifies the data type used in the form field. Allowed Values: A data type from the list. Default Value: Shows a data type interpreted for the field from the imported file.
Field Type	Description: Specifies the type of form control used for the field. Allowed Values: A form control from the list. Default Value: A form control type that is interpreted from the input. For example, a field called "Amount" might be assigned a Currency form control.
Regenerate	Description: Deletes the changes and restores the default values for the form.
Add Field	Function: Adds a row for a new field.
Delete Field	Function: Deletes the selected row from the fields list.
Configure Picklist	Opens this Screen: Configure Picklist > Generate With AI screen Description: Configures a picklist with GenAI. Limitations: This field shows only if the data type for the field is Picklist.
Configure Child Table	Opens this Screen: Configure child entity fields screen Description: Configures the form fields for fields that are formatted as a table in the uploaded file. Limitations: This field shows only if the data type for the field is Table.
Mark as Mandatory	Description: Specifies whether the form field is required. Allowed Values: Selected - The field must have a value. Deselected - A value is not required for the field. Default Value: The value configured for the field.
Number Of Columns	Description: Specifies the number of columns to show on the eForm. Allowed Values: An integer. Range: 1-10 Default Value: 2
Show Line Break Fields	Description: Specifies whether to group the form fields based on the column layout on the form template you upload. Allowed Values: Selected - Groups the form fields with horizontal line breaks based on the column layout shown in the uploaded file. If you create the fields with the Excel or Generate using AI options, the fields are grouped based on the number of columns specified in the Number Of Columns field. Deselected - Groups the form fields in a single list in the order shown in the uploaded file, as it reads left to right. Default Value: Deselected

Configure Picklist > Generate With AI screen

Configures a picklist with GenAI.

Configure Picklist screen — Figure: Configure Picklist > Generate With AI screen

Good to Know

This screen applies to the Generate With AI option on the Configure Picklist screen. For the Select Picklist option, refer to Configure Picklist > Select Picklist screen.

How to Start

On the Review the data fields for your app screen, in the Data Type field, select Picklist.

Fields

Field Name	Definition
Select Option To Configure Picklist	Description: Specifies whether to create a picklist with GenAI. Allowed Values: Generate With AI - GenAI creates the picklist based on input the app designer provides as a prompt. Select Picklist – Uses a picklist that exists in AgilePoint NX. For more information, refer to Configure Picklist > Select Picklist screen. Default Value: Generate With AI
Picklist Description	Description: Specifies a text prompt to create a picklist. Describe the purpose of the picklist with as much detail and as accurately as possible. Allowed Values: More than one line of text. Default Value: None
Generate	Description: Creates a picklist. GenAI creates the picklist based on the picklist description the app designer enters as a prompt.
Display Name	Description: Specifies the name that shows for the picklist. To Open this Field: Click Generate. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Special characters Default Value: None
Internal Name	Description: Specifies a unique, technical name for the picklist. To Open this Field: Click Generate. Allowed Values: One line of text (a string). Accepted: Letters Numbers Default Value: None
Name	Description: Specifies the name that shows for the picklist item. To Open this Field: Click Generate. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Special characters Default Value: None
Value	Description: Specifies a unique, technical name for the picklist item. To Open this Field: Click Generate. Allowed Values: One line of text (a string). Accepted: Letters Numbers Default Value: None
Add Field	Function: Adds a row for the Name and Value fields.
Delete Field	Description: Deletes the specified picklist item.
Save	Function: Saves the configuration for the picklist.

Configure Picklist > Select Picklist screen

Configures the picklist that exists in AgilePoint NX.

Good to Know

This screen applies to the Select Picklist option on the Configure Picklist screen. For the Generate With AI option, refer to Configure Picklist > Generate With AI screen.

How to Start

On the Review the data fields for your app screen, in the Data Type field, select Picklist.

Fields

Field Name	Definition
Select Option To Configure Picklist	Description: Specifies whether to create a picklist with GenAI. Allowed Values: Generate With AI - GenAI creates the picklist based on input the app designer provides as a prompt. For more information, refer to Configure Picklist > Generate With AI screen. Select Picklist – Uses a picklist that exists in AgilePoint NX. Default Value: Generate With AI
Picklist	Description: Specifies a picklist to configure to a form field. Allowed Values: A picklist from the list. Default Value: None
Name	Description: Shows the name for the picklist item. To Open this Field: In the Picklist field, select a picklist. Allowed Values: Read only.
Value	Description: Shows the unique, technical name for the picklist item. To Open this Field: In the Picklist field, select a picklist. Allowed Values: Read only.
Save	Function: Saves the configuration for the picklist.

Configure child entity fields screen

Configures the form fields for fields that are formatted as a table in the uploaded file.

Good to Know

This screen shows only if your eForm has fields formatted as a table.
If the uploaded file has a table, GenAI creates a Subform, Data Grid, or Comments form control.
The control type is specified in the Field Type field on the Review the data fields for your app screen.

How to Start

On the Review the data fields for your app screen, in the Data Type field, select Table.

Fields

Field Name	Definition
Select All	Description: Selects all the fields. Allowed Values: Selected - Selects all the form fields. Deselected - Deselects all the form fields.
Name	Description: Specifies the text label for the field that displays on the form. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Special characters Default Value: The field name specified in the imported file.
ID	Description: Specifies a unique, technical name for the form field. When you enter the value in the Name field, this field shows the value you entered in the Name field with no spaces. Allowed Values: One line of text (a string). Accepted: Letters Numbers Default Value: Shows the value in the Name field with no space.
Data Type	Description: Specifies the data type used in the form field. Allowed Values: A data type from the list. Default Value: Shows a data type interpreted for the field from the imported file.
Field Type	Description: Specifies the type of form control used for the field. Allowed Values: A form control from the list. Default Value: A form control type that is interpreted from the input. For example, a field called "Amount" might be assigned a Currency form control.
Add Field	Function: Adds a row for a new field.
Delete Field	Function: Deletes the selected row from the fields list.
Configure Picklist	Opens this Screen: Configure Picklist > Generate With AI screen Description: Configures a picklist with GenAI. Limitations: This field shows only if the data type for the field is Picklist.
Mark as Mandatory	Description: Specifies whether the form field is required. Allowed Values: Selected - The field must have a value. Deselected - A value is not required for the field. Default Value: The value configured for the field.
Generate Fields with AI	Description: Creates the form fields for the subform with GenAI. Opens the Generate Child Table Fields screen where you can enter a description of the subform as a prompt in a text box. GenAI creates the form fields based on common field types for the subform description you entered.

Set up your primary entity screen

Configures the primary entity for your app.

Good to Know

An entity is like a database table that stores the data for your app. Most apps only have one entity. More complex apps may have one or more secondary entities.

Fields

Field Name	Definition
Entity Display Name	Description: Specifies the name that shows for the primary entity. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Special characters Default Value: None
Entity Name	Description: Specifies a unique, technical name for the primary entity. When you enter a value in the Entity Display Name field, the field shows the value specified in the Entity Display Name field with no spaces. After this name is created, it can not be changed. Allowed Values: One line of text (a string). Accepted: Letters Numbers Default Value: None
Description	Description: Specifies an optional text description for the primary entity. Allowed Values: More than one line of text. Default Value: None
Primary Field	Description: Specifies the primary field for the primary entity. Allowed Values: A form field from the list. Default Value: None

Set up secondary entity screen

Configures the related entity for your app.

Good to Know

This screen shows only if your eForm has fields formatted as a table.
A secondary entity stores data for form fields that are formatted as a table in the uploaded file. A secondary entity is sometimes referred to as a related entity.

Fields

Field Name	Definition
Entity Display Name	Description: Shows the name of the related entity that has a relationship with the primary entity. Allowed Values: Read only.
Entity Name	Description: Shows a unique, technical name for the related entity. Allowed Values: Read only.
Description	Description: Specifies an optional text description for the related entity. Allowed Values: More than one line of text. Default Value: None
Primary Field	Description: Specifies the primary field for the related entity. Allowed Values: A form field from the list. Default Value: None
Parent Primary Field	Description: Specifies the primary field for the primary entity where you want to create a relationship. Allowed Values: A form field from the list. Default Value: None
Relationship Name	Description: Specifies the text label that shows for the relationship in the entity. Allowed Values: One line of text (a string). Accepted: Letters Numbers Default Value: None
Child Field Display Name	Description: Specifies the dependent field for an entity that is a child of the related entity. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Special characters Default Value: None
Child Field Name	Description: Specifies a unique, technical name for the dependent field. When you enter the value in the Child Field Display Name field, this field shows the value you entered in the Child Field Display Name field with no spaces. Allowed Values: One line of text (a string). Accepted: Letters Numbers Default Value: None

Anything else right now? screen

Configures the optional features for your form-based app.

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	Description: Uploads CSS files to change the look and feel of your eForms.
Groups and Roles	Description: Creates groups and roles for the access rights for an app.
Images	Description: Uploads image files to customize your app.
JavaScript	Description: Uploads JavaScript files to use in eForms.

Who can access your app? screen

Configures the permission groups for an app.

Fields

Field Name	Definition
App Owners	Opens this Screen: App Owners Function: Specifies the users and groups who are App Owners.
App Designers	Opens this Screen: App Designers (permission group) Function: Specifies the users and groups who are App Designers.
App Initiators	Opens this Screen: App Initiators Description: 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.