Process-Based App with SharePoint as the Data Source

Background and Setup

Prerequisites

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v8.0 or higher.

Good to Know

The app that uses SharePoint as a data source can only be accessed through the SharePoint Dashboard app or a SharePoint list. When you create a new list item, SharePoint uses the form-based app, instead of the default SharePoint list form.
SharePoint does not have a date-only data type. If you configure a field in SharePoint to show the date only, it is stored in SharePoint as date-time in UTC format. The regional settings of the SharePoint site where this value is stored can result in data changes based on the time zone.
If you want to use time zone conversion for a date-only value in SharePoint, AgilePoint recommends you use a field that is not data-bound. If a SharePoint date-time field is configured to show the date only, a data-bound field will always send an absolute date.
These time zones are not supported for SharePoint data-bound date-only fields. If the regional settings for your SharePoint site is configured to use one of these time zones, you might see a different date in the SharePoint UI.
- UTC – 11:00 Coordinated Universal Time-11
- UTC – 12:00 International Date Line West
When you create a new app, the first version is automatically checked in.
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 Process-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: This field is available in these releases: AgilePoint NX OnDemand (public cloud) AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v9.0 or higher

How do you want to set up your process? screen

Configures the basic information for your process.

Fields

Field Name	Definition
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 SharePoint data source for your process-based app.

Fields

Field Name	Definition
Select Data Source	Description: Specifies the primary data source your app uses to store and retrieve data. Allowed Values: Blank - Lets you create a new process-based app. AgilePoint Data Entities - Configures an entity in AgilePoint NX Data Entities for your data source. Database - Configures a database as your data source. Salesforce - Configures a Salesforce entity as your data source. SharePoint - Configures a SharePoint list as your data source. Excel Table - Configures a Microsoft Excel table as your data source. Default Value: AgilePoint Data Entities

Field Name

Definition

Select Data Source

Description:

Specifies the primary data source your app uses to store and retrieve data.

Allowed Values:

Blank - Lets you create a new process-based app.
AgilePoint Data Entities - Configures an entity in AgilePoint NX Data Entities for your data source.
Database - Configures a database as your data source.
Salesforce - Configures a Salesforce entity as your data source.
SharePoint - Configures a SharePoint list as your data source.
Excel Table - Configures a Microsoft Excel table as your data source.

Default Value:

AgilePoint Data Entities

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

Configures how to get data from SharePoint for your process.

Fields

Field Name	Definition
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
SharePoint	Description: Specifies the access token that connects to your SharePoint site. Allowed Values: A list of access tokens configured for your environment. Default Value: None Accepts Variables: No Example: Refer to: (Example) Create a SharePoint Access Token
Site URL	Description: Specifies the URL for your SharePoint site. Allowed Values: A valid SharePoint site URL. Default Value: None Accepts Variables: No Example: http://[machine name]:[port]/sites/[site name] Note: You must include the /sites in the Site URL for the site to be created successfully.
List Name	Description: Specifies the name of your SharePoint list. Allowed Values: The name of your SharePoint list. Default Value: None Accepts Variables: No

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

Specifies the fields from your SharePoint list to use in your process.

Prerequisites

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

Fields

Field Name	Definition
Check box	Description: Specifies whether to show a SharePoint field on 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 in your SharePoint list. Allowed Values: Read only.
Data Type	Description: Shows the data type of a SharePoint field. Allowed Values: Read only.
Required	Description: Specifies whether the value is required in the SharePoint field. Allowed Values: Read only.
Unique	Description: Shows whether a duplicate value is permitted in the SharePoint field. Allowed Values: Read only.

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

Specifies the SharePoint list relationships to use in a process-based app.

Prerequisites

Complete the How do you want to set up your entity? > 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
Check box	Description: Specifies whether to use the SharePoint list relationship on your form. Allowed Values: Selected - Your form uses the relationship. Deselected - Your form does not use the relationship. Default Value: Deselected Example: Refer to: (External) Form Based Apps – SharePoint Data Source
Display Name	Description: Shows other SharePoint lists that have relationships with SharePoint parent list. 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 your SharePoint list. 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.

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