Process-Based App with an Existing Entity in AgilePoint NX Data Entities as the Data Source

This topic explains how to create a process-based app with an existing entity in AgilePoint NX Data Entities as the data source in the Modern Add an App Experience.

Background and Setup

Video: Process-Based App (Modern)

Video: AgilePoint Platform Overview

Prerequisites

Good to Know

  • 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

  1. Click App Builder.

    Click App Builder
  2. On the App Builder Home screen, click Add App.

    Click Add App
  3. On the What type of app would you like to build? screen, click Process-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 NameDefinition

App Type
Description:
Specifies the type of app to create.
Allowed 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 NameDefinition

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

This field is available in these releases:

How do you want to set up your process? screen

Configures the basic information for your process.

Figure: How do you want to set up your process? screen

How do you want to set up your process screen

Fields

Field NameDefinition

Process Model Name
Description:
Specifies a name for your process.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
No

Description
Description:
A description for your process.
Allowed Values:
More than one line of text.
Default Value:
None
Accepts Variables:
No

Process Triggered By
Description:
Specifies what causes the process to start.
Allowed Values:
  • eForms - The process starts when a user submits a form made with eForm
  • External Forms - The process starts when a user submits a form that is made with a form technology other than eForms, such as Java or ASP.NET.
  • Message/Event - The process starts when an email account receives an e-mail, a specified event occurs.
  • System Integration - A specified event happens in an external system, such as Salesforce or a database.
  • Parent Process - The process is the child, or subprocess, to another process.

    If you create a process model in a process-based app that already has a process models, this is the only option.

    The limit of one parent process model in a process-based app was enforced in AgilePoint NX OnPremises v7.0 Software Update 1. In earlier releases, this was a limit according to the license, but the options in this list allowed more than one parent process.

  • SharePoint - A specified event happens in SharePoint. For example, a user creates a list or list item.
  • InfoPath Form Services - A specified event happens in SharePoint On Premises. For example, a user submits a form.
  • Salesforce - A specified event happens in Salesforce. For example, a user creates an entity.
Default Value:
eForms

Number of Swimlanes
Description:
Specifies a number of swimlanes to be added to the Process Builder screen to organize the steps in your process.
Allowed Values:
A number from 0 to 20.
Default Value:
1

Swimlanes Orientation
Description:
Specifies the direction for your swimlanes.
Allowed Values:
  • Horizontal - Shows swimlanes from left to right.
  • Vertical - Shows swimlanes from top to bottom.
Default Value:
Horizontal

Choose Theme
Description:
Specifies a process theme to show on the My Apps screen in Work Center.

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

Select Data Source
Description:
Specifies the primary data source your app uses to store and retrieve data.
Allowed Values:
Default Value:
AgilePoint Data Entities

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

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

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

Configuration tab

Fields

Field NameDefinition

Data Source Name
Description:
Specifies a name for your data source.
Allowed Values:
One line of text (a string).

Not Accepted:

  • Spaces
Default Value:
None
Accepts Variables:
No

Custom Entities Only
Description:
Specifies whether to show only custom entities in the Primary Entity list.
Allowed Values:
  • Selected - Shows only the custom entities in the Primary Entity list.
  • Deselected - Shows both standard entities and custom entities in the Primary Entity list.
Default Value:
Selected
Accepts Variables:
No

Primary Entity
Description:
Specifies the AgilePoint NX entity from which your process to collect data.
Allowed Values:
The AgilePoint NX entity from the list.
Default Value:
AgilePoint NX entities.
Accepts Variables:
No

Save Data in Data Entities
Description:
Saves the application data in AgilePoint Data Entities.
Allowed Values:
  • Selected - Saves the data in the Data Entities database, in addition to the AgilePoint NX workflow database.
  • Deselected - Does not save the data in the Data Entities database.
Default Value:
Selected

Save A Copy Of Data In AgilePoint NX
Description:
Specifies whether to save the data in the AgilePoint NX workflow database.

When you select this field, you can deselect Save Data in Data Entities field, and save the data only in the workflow database.

Allowed Values:
  • Selected - Saves the data in the AgilePoint NX workflow database, in addition to the Data Entities database.
  • Deselected - Saves the data in the Data Entities database, but not in the AgilePoint NX workflow database.
Default Value:
Selected

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

Specifies the entity fields from entity.

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

Fields tab

Prerequisites

Fields

Field NameDefinition

Show Internal Fields
Description:
Specifies whether to show the internal names of default entity fields from AgilePoint Data Entities.
Allowed Values:
  • Selected - Shows the internal names of default entity fields.
  • Deselected - Does not show default entity fields.
Default Value:
Deselected

Check box
Description:
Specifies the fields to use in your process.
Allowed Values:
  • Selected - Your process contains the field.
  • Deselected - The field does not show on your process.
Default Value:
Selected

Display Name
Description:
Shows the fields associated with an entity.
Allowed Values:
Read only.

Data Type
Description:
Shows the data type of a field.
Allowed Values:
Read only.

Required
Description:
Specifies whether the field is required.
Allowed Values:
Read only.

Unique
Description:
Shows whether a duplicate value is permitted in the field.
Allowed Values:
Read only.

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

Specifies related entity to use in a process-based app.

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

Related Entities tab

Prerequisites

Good to Know

Fields

Field NameDefinition

Check box
Description:
Specifies the related entities and their associated fields to use in your process.
Allowed Values:
  • Selected - The process contains the related entities and their assoicated fields.
  • Deselected - The process does not use the related entities.
Default Value:
Deselected

Display Name
Description:
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.
Allowed Values:
Read only.

Data Type
Description:
Shows the data type of an entity.
Allowed Values:
Read only.

Required
Description:
Specifies whether the related entity is required.
Allowed Values:
Read only.

Unique
Description:
Shows whether a duplicate value is permitted in the related entity.
Allowed Values:
Read only.

Anything else right now? screen

Configures the optional features for your process-based app in the Modern Add an App Experience.

Figure: Anything else right now? screen

Anything else right now screen

Fields

Field NameDefinition

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.

Figure: Who can access your app? screen

Who can access your app screen

Fields

Field NameDefinition

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.

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