New Data Source screen (Salesforce)

Configures a Salesforce entity as your data source.

Figure: Salesforce Configuration screen

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

    Select Salesforce
  4. Click Next.

Salesforce Configuration screen > Configuration tab

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

Figure: Salesforce Configuration screen

Salesforce Configuration screen

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:

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

Salesforce Configuration screen > Fields tab

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

Figure: Salesforce Configuration Fields screen

Salesforce Configuration Fields screen

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.

Lookup Key

Description:
Shows whether the field has a lookup relationship.
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.

Salesforce Configuration screen > Related Entity

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

Figure: Salesforce Configuration Related Entity screen

Salesforce Configuration Related Entity screen

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

Primary Entity Name

Description:
Shows the entity name that you specified on the Salesforce Configuration screen > Configuration tab.
Allowed Values:
Read only.

Primary Entity Key Field

Description:
Shows the entity field that contains the primary field.
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 the entities that have relationships with the primary entity.
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 dependent field of the related entity.
Allowed Values:
Read only.

Field Field icon

Description:
Shows the fields associated with the related entity.