Form-Based Application with SharePoint Data Source

This topic shows how to create a form-based app with SharePoint data source.

Examples

Form Based Applications – SharePoint Data Source
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

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 Software Update 1 or higher.

Good to Know

The application 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 application, instead of the default SharePoint list form.
By default, the Person or Group column from a SharePoint list is mapped to a People Picker form control, and you can select individual users only. If you want to select both users and groups, you must either change the form control type or create a lookup for the People Picker form control.
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
A New form for SharePoint form-based application does not support attachments. You can add attachments with an Edit form after a list item is created. This is a limitation for new list items in SharePoint.
A forms-based application that uses a SharePoint data source supports SharePoint lists only. It does not support document libraries. For a SharePoint document library, create a form-based application that uses a different data source, such as Data Entities, and upload documents with metadata to the document library.
The Standard List Form activity and Start List Form activity can not be used on the lists where forms-based application is created. The List Form activities are only for legacy applications.
Data binding from eForm controls to a SharePoint list occurs only if a process starts from an application that uses SharePoint as its primary data source. If an eForm is part of a process that starts from SharePoint, it can not use data binding.

How to Start

Create a form-based application.
On the New Application screen, click Next.
On the Select Primary Data Source screen, select SharePoint .
Click Next.

SharePoint Configuration screen > Configuration tab

Configures how to collect data from SharePoint for your eForm.

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 Example: Refer to: (Example) Create and Run a Form-Based Application with AgilePoint NX Data Entities Form Based Applications – SharePoint Data Source
SharePoint	Function: Specifies the access token that connects to your SharePoint site. Accepted Values: A list of access tokens configured for your environment. Default Value: None Accepts Process Data Variables: No Example: Refer to: (Example) Configure a Create List Item Activity to Put the Leave Information in the SharePoint List Form Based Applications – SharePoint Data Source (Example) Create a SharePoint Access Token
Add Token	Opens this Screen: Access Token for SharePoint. Function of this Screen: Configure an access token to connect to SharePoint..
Site URL	Function: Specifies the URL for your SharePoint site. Accepted Values: A valid SharePoint site URL. Default Value: None Accepts Process Data 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. Form Based Applications – SharePoint Data Source
List Name	Function: Specifies the name of your SharePoint list. Accepted Values: The name of your SharePoint list. Default Value: None Accepts Process Data Variables: No Example: Refer to: Form Based Applications – SharePoint Data Source

SharePoint Configuration screen > Fields tab

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

Prerequisites

Complete the SharePoint Configuration screen > Configuration tab.

Fields

Field Name	Definition
Check box	Function: Specifies whether to show a SharePoint field on your form. Accepted Values: Selected - Your form contains the SharePoint field. Deselected - The SharePoint field does not show on your form. Default Value: Selected Example: Refer to: Form Based Applications – SharePoint Data Source
Display Name	Function: Shows the fields in your SharePoint list. Accepted Values: Read only.
Data Type	Function: Shows the data type of a SharePoint field. Accepted Values: Read only.
Schema XPath	Function: Shows the xpath of the SharePoint field. Accepted Values: Read only.
Lookup Key	Function: Shows whether the SharePoint field has a lookup relationship. Accepted Values: Read only.
Mandatory	Function: Specifies whether the value is required in the SharePoint field. Accepted Values: Read only.
Unique	Function: Shows whether a duplicate value is permitted in the SharePoint field. Accepted Values: Read only.

SharePoint Configuration screen > Related Entity tab

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

Prerequisites

Complete the SharePoint Configuration screen > Configuration tab.
The Related Entity tab is available if the SharePoint list has a relationship.

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.

Fields

Field Name	Definition
Check box	Function: Specifies whether to use the SharePoint list relationship on your form. Accepted Values: Selected - Your form uses the relationship. Deselected - Your form does not use the relationship. Default Value: Deselected Example: Refer to: Form Based Applications – SharePoint Data Source
Primary Entity Name	Function: Shows the SharePoint list name that you specified on the SharePoint 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.. Accepted Values: Read only.
Primary Entity Key Field	Function: Shows the primary field for the 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.. Accepted Values: Read only.
Related Entity	Function: 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.. Accepted Values: Read only.
Dependent Field	Function: Shows the SharePoint field that has a child relationship with a field in the parent list. Accepted Values: Read only.
Field	Function: Shows the SharePoint fields associated with the SharePoint child list.