New Data Source screen (SharePoint)

Configures a SharePoint list as your data source.

Figure: SharePoint Configuration screen

SharePoint Configuration screen

Background and Setup

Prerequisites

How to Start

  1. Open the Data Model screen.

    For information about how to open this screen, refer to Data Model screen.


    Open Data Model
  2. On the Data Model screen, click Add Data Source Add Data Source icon.

    Application Explorer screen
  3. On the Select Data Source screen, select SharePoint.

    Select SharePoint
  4. Click Next.

SharePoint Configuration screen > Configuration tab

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

Figure: SharePoint Configuration screen

SharePoint Configuration screen

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.
Example:
Refer to:

Site URL
Function:
Specifies the URL for your SharePoint site.
Accepted Values:
A valid SharePoint site URL.
Default Value:
None
Accepts Process Data Variables:
Yes
Example:

List Name
Function:
Specifies the name of the SharePoint list.
Accepted Values:
A valid SharePoint list name.
Default Value:
None
Accepts Process Data 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
Function:
Saves the application data in AgilePoint SharePoint.
Accepted 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

SharePoint Configuration screen > Fields tab

Specifies the SharePoint columns to use in your app.

Figure: SharePoint Configuration Fields screen

SharePoint Configuration Fields screen

Prerequisites

Fields

Field NameDefinition

Check box
Function:
Specifies the SharePoint columns to use on your app or process.
Accepted 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
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.

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 related entity in for SharePoint to use in your app.

Figure: SharePoint Configuration screen > 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.