Salesforce Data Source Configuration (New Process Model)

This topic explains how to create a process-based app with Salesforce data source.

Prerequisites

How to Start

  1. Create a process-based application.
  2. On the New Application screen, click Next.
  3. On the New Process Model screen, click Next.
  4. On the Select Primary Data Source screen, select Salesforce Salesforce icon.
  5. Click Next.

Salesforce Configuration screen > Configuration tab

Configures how to collect data from Salesforce for your process.

Screen



Fields

Field Name Definition

Data Source Name

Function:
Specifies a name for your data source.
Accepted Values:
One line of text with no spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
Refer to:

Salesforce

Function:
Specifies the access token that connects to your Salesforce application.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Process Data Variables:
No

Add Token Add Token icon

Opens this Screen:
New Salesforce Access Token (Form-Based Application).
Function of this Screen:
Configures a new access token for Salesforce in a form-based app..

Custom Entities Only

Function:
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..
Accepted 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 Process Data Variables:
No

Primary Entity Name

Function:
Specifies the Salesforce entity from which you want your process to collect data.
Accepted 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 Process Data Variables:
No

Autosave data in Salesforce

Function:
Saves the application data in AgilePoint Salesforce.
Accepted 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

Allow to save a copy of data in AgilePoint NX

Function:
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.

Accepted 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 Logged in User Credentials

Function:
Specifies whether to use the credentials for the authenticated form user to submit the form data to Salesforce.
Accepted Values:
  • Selected - Uses the credentials of the authenticated form user to submit the form data to Salesforce.

    Only use this option in these conditions:

    • Your organization uses Salesforce authentication for AgilePoint NX.
    • Your form 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 Process Data Variables:
No

Salesforce Configuration screen > Fields tab

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

Screen



Prerequisites

Fields

Field Name Definition

Check box

Function:
Specifies the fields to use in 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 associated with an entity.
Accepted Values:
Read only.

Data Type

Function:
Shows the data type of a field.
Accepted Values:
Read only.

Lookup Key

Function:
Shows whether the field has a lookup relationship.
Accepted Values:
Read only.

Mandatory

Function:
Specifies whether the field is required.
Accepted Values:
Read only.

Unique

Function:
Shows whether a duplicate value is permitted in the field.
Accepted Values:
Read only.

Salesforce Configuration screen > Related Entity

Specifies related entity to use on your process for Salesforce.

Screen



Prerequisites

Fields

Field Name Definition

Check box

Function:
Specifies the related entities to use on your process.
Accepted Values:
  • Selected - Your process contains the related entity.
  • Deselected - Your process does not use the related entity.
Default Value:
Deselected

Primary Entity Name

Function:
Shows the entity name that you specified on the Salesforce 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..
Accepted Values:
Read only.

Primary Entity Key Field

Function:
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..
Accepted Values:
Read only.

Related Entity

Function:
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..
Accepted Values:
Read only.

Dependent Field

Function:
Shows the dependent field of the related entity.
Accepted Values:
Read only.

Field Field icon

Function:
Shows the fields associated with the related entity.