Form-Based Application with Salesforce Data Source

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

Video: Form-Based App with Salesforce

Prerequisites

How to Start

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

Salesforce Configuration screen > Configuration tab

Configures how to collect data from Salesforce for your eForm.

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 form 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

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 form-based app.

Screen



Prerequisites

Fields

Field Name Definition

Check box

Function:
Specifies the fields to use on your form.
Accepted Values:
  • Selected - Your form contains the field.
  • Deselected - The field does not show on your form.
Default Value:
Selected.
Example:
Refer to:

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

Screen



Prerequisites

Good to Know

Fields

Field Name Definition

Checkbox

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

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.