New Data Source screen (Salesforce)

Configures a Salesforce entity 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 Salesforce.

    Select Salesforce
  6. Click Next.

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

Configures how to collect data from Salesforce for your app or process.

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 the data source.
Allowed Values:
One line of text (a string).

Not Accepted:

  • Spaces
Default Value:
None
Accepts Variables:
No
Example:
Refer to:

Salesforce
Description:
Specifies the access token that connects to your Salesforce application.
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 Salesforce
Function of this Screen:
Configure an access token to connect to Salesforce.
Example:
Refer to:

Custom Entities Only
Description:
Specifies whether to show only Salesforce custom entities in the Primary Entity Name 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:
  • Selected - Shows Salesforce custom entities in the Primary Entity Name list.
  • Deselected - Shows all Salesforce entities in the Primary Entity Name list.
Default Value:
Deselected
Accepts Variables:
No

Primary Entity Name
Description:
Specifies the Salesforce entity from which you want your process to retrieve data.
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:
A Salesforce entity from the list.
Default Value:
None.

When you select the Salesforce access token, the name of the entities show in the Primary Entity Name list.

Accepts Variables:
No

Autosave Data In Salesforce
Description:
Saves the application data in AgilePoint Salesforce.
Allowed Values:
  • Selected - Saves the data in Salesforce, in addition to the AgilePoint NX workflow database.
  • Deselected - Does not save the data in Salesforce.
Default Value:
Selected

Save A Copy Of Data In AgilePoint NX
Description:
Specifies whether to save the data in the AgilePoint NX workflow database.

When you select this field, you can deselect Autosave data in Salesforce field, and save the data only in the workflow database.

Allowed Values:
  • Selected - Saves the data in the AgilePoint NX workflow database, in addition to Salesforce.
  • Deselected - Saves the data in Salesforce, but not in the AgilePoint NX workflow database.
Default Value:
Deselected

Use Runtime App User Credentials
Description:
Specifies whether to use the credentials for the authenticated runtime app user to submit the form data to Salesforce.
Allowed Values:
  • Selected - Uses the credentials of the authenticated runtime app user to submit the form data to Salesforce.

    Only use this option in these conditions:

    • Your organization uses Salesforce authentication for AgilePoint NX.
    • Your runtime app users have permissions to submit data to your Salesforce entity that is associated with the form-based app.
  • Deselected - Uses the access token credentials you select in the Salesforce field on the Salesforce Configuration screen > Configuration tab to submit an entity to Salesforce.
Default Value:
Selected
Accepts Variables:
No

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

Specifies the fields from your Salesforce entity to use in your app or process.

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 fields to use in your process.
Allowed Values:
  • Selected - Your process contains the field.
  • Deselected - The field does not show on your process.
Default Value:
Selected

Display Name
Description:
Shows the fields associated with an entity.
Allowed Values:
Read only.

Data Type
Description:
Shows the data type of a field.
Allowed Values:
Read only.

Required
Description:
Specifies whether the field is required.
Allowed Values:
Read only.

Unique
Description:
Shows whether a duplicate value is permitted in the field.
Allowed Values:
Read only.

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

Specifies related entity to use on your application or process for Salesforce.

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

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

Prerequisites

Fields

Field NameDefinition

Check box
Description:
Specifies the related entities and their associated fields to use in your process.
Allowed Values:
  • Selected - The process contains the related entities and their assoicated fields.
  • Deselected - The process does not use the related entities.
Default Value:
Deselected

Display Name
Description:
Shows the fields associated with an entity.
Allowed Values:
Read only.

Data Type
Description:
Shows the data type of a field.
Allowed Values:
Read only.

Required
Description:
Specifies whether the field is required.
Allowed Values:
Read only.

Unique
Description:
Shows whether a duplicate value is permitted in the field.
Allowed Values:
Read only.