New Data Source screen (SharePoint)

Configures a SharePoint list as your data source.

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

How do you want to set up your entity screen

Background and Setup

Prerequisites

How to Start

  1. Click App Builder.

    Click App Builder
  2. On the App Builder Home screen, click All Apps.

    Click All Apps
  3. On the All Apps screen, on an app, click Edit Edit icon.

    Click Edit
  4. On the App Details screen, click Add New Add New icon > Data Source.

    Click Data Source
  5. On the Please select data source type screen, select SharePoint.

    Select SharePoint
  6. Click Next.

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

Configures how to collect data from a SharePoint list for your app.

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

How do you want to set up your entity 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
Example:
Refer to:

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:

Create Add Token icon
Opens this Screen:
Access Token for SharePoint
Function of this Screen:
Configure an access token to connect to SharePoint.
Example:
Refer to:

Site URL
Description:
Specifies the URL for your SharePoint site.
Allowed Values:
A valid SharePoint site URL.
Default Value:
None
Accepts Variables:
Yes
Example:

List Name
Description:
Specifies the name of the SharePoint list.
Allowed Values:
A valid SharePoint list name.
Default Value:
None
Accepts Variables:
No
Limitations:
In these releases, this field does not show document libraries in the list if you use SharePoint as a primary data source for an form-based app or a process-based app that starts with an eForm.

Autosave Data in SharePoint
Description:
Saves the application data in AgilePoint SharePoint.
Allowed Values:
  • Selected - Saves the data in SharePoint, in addition to the AgilePoint NX workflow database.
  • Deselected - Saves the data only in in the AgilePoint NX database.
Default Value:
Deselected

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

Specifies the SharePoint columns to use in your app.

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

How do you want to set up your entity Fields tab

Prerequisites

Fields

Field NameDefinition

Check box
Description:
Specifies the SharePoint columns to use on your app or process.
Allowed Values:
  • Selected - Your app or process contains SharePoint columns.
  • Deselected - The SharePoint column does not show on your app or 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 Entity tab

Specifies related entity in for SharePoint to use in your app.

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

How do you want to set up your entity Related Entity tab

Prerequisites

Good to Know

Fields

Field NameDefinition

Check box
Description:
Specifies whether to use the SharePoint list relationship on your process.
Allowed Values:
  • Selected - Your process uses the relationship.
  • Deselected - Your process does not use the relationship.
Default Value:
Deselected
Example:
Refer to:

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

Primary Entity Key Field
Description:
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.
Allowed Values:
Read only.

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

Dependent Field
Description:
Shows the SharePoint field that has a child relationship with a field in the parent list.
Allowed Values:
Read only.

Field Field icon
Description:
Shows the SharePoint fields associated with the SharePoint child list.