Process-Based App with SharePoint Data Source (Classic)

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

Background and Setup

Video: Create Your First App

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.
  • 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.
  • This topic applies to the classic Add an App experience. For the modern Add an App experience, refer to Process-Based App with SharePoint as the Data Source (Modern).

How to Start

  1. Sign in to AgilePoint NX.
  2. Click App Builder.

    Build Apps screen
  3. On the App Explorer screen, click Add App.

    Add App button
  4. On the App Type screen, click Process-Based App.

    Add App button
  5. Click Next.
  6. On the New App screen, complete the fields, and click Next.

    New Application screen
    .
  7. On the New Process Model screen, complete the fields, and click Next.

    New Process Model screen
    .
  8. On the Select Primary Data Source screen, select SharePoint SharePoint icon.

    Primary Data Source screen
  9. Click Next.

SharePoint Configuration screen > Configuration tab

Configures how to get data from SharePoint for your process.

Figure: SharePoint Configuration > Configuration tab

SharePoint Configuration 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 process.

Figure: SharePoint Configuration > Fields tab

SharePoint Configuration Fields tab

Prerequisites

Fields

Field NameDefinition

Check box
Function:
Specifies whether to show a SharePoint field on your process.
Accepted Values:
  • Selected - Your process contains the field.
  • Deselected - The field does not show on your process.
Default Value:
Selected

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

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

Figure: SharePoint Configuration Related Entity tab

SharePoint Configuration Related Entity tab

Prerequisites

Good to Know

Fields

Field NameDefinition

Check box
Function:
Specifies whether to use the SharePoint list relationship on your process.
Accepted Values:
  • Selected - Your process uses the relationship.
  • Deselected - Your process 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.