Form-Based App with SharePoint Data Source (Classic)

This topic shows how to create a form-based app with SharePoint data source in the Classic Add an App experience.

Background and Setup

Examples

Prerequisites

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.
  • 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 app 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 app that uses a SharePoint data source supports SharePoint lists only. It does not support SharePoint document libraries. If you want a form-based app to upload data to a SharePoint document library, use form controls, such as the File Upload control, to upload documents the document library.
  • The Standard List Form activity and Start List Form activity can not be used on the lists where forms-based app is created. The List Form activities are only for legacy apps.
  • Data binding from eForm controls to a SharePoint list occurs only if a process starts from an app 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.
  • 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

  1. Create a form-based app.
  2. On the New App screen, click Next.
  3. On the Select Primary Data Source screen, select SharePoint SharePoint icon.
  4. Click Next.

SharePoint Configuration screen > Configuration tab

Configures how to retrieve data from SharePoint for your eForm.

Figure: SharePoint Configuration > Configuration tab

Configuration tab

Fields

Field NameDefinition

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:

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:

Create Add Token icon
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:

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:

SharePoint Configuration screen > Fields tab

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

Figure: SharePoint Configuration > Fields tab

Fields tab

Prerequisites

Fields

Field NameDefinition

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:

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.

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

Figure: SharePoint Configuration > Related Entity tab

Related Entity tab

Prerequisites

Good to Know

Fields

Field NameDefinition

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:

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. For Microsoft Excel, entity refers to an Excel table.
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. For Microsoft Excel, entity refers to an Excel table.
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. For Microsoft Excel, entity refers to an Excel table.
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 Field icon
Function:
Shows the SharePoint fields associated with the SharePoint child list.