Form-Based App with Salesforce Data Source (Classic)

This topic explains how to create a form-based app with Salesforce data source in the Classic Add an App experience.

Background and Setup

Video: Form-Based App with Salesforce

Prerequisites

Good to Know

  • After you create a form-based app, you cannot change the app to use a different data source. For example, you can not change a form-based app to use a different entity or SharePoint list than the one specified when the app was created. This limitation also applies to cloned apps. That is, you cannot clone a form-based app, and then change the data source in the cloned app.

How to Start

  1. Create a form-based app.
  2. On the New App 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 send and receive data from Salesforce for your eForm.

Figure: Salesforce Configuration > Configuration tab

Salesforce Configuration Configuration tab

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:

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

Create Add Token icon
Opens this Screen:
Access Token for Salesforce.
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. For Microsoft Excel, entity refers to an Excel table.
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
Example:
Refer to:

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

Use Runtime App User Credentials
Function:
Specifies whether to use the credentials for the authenticated runtime app user to submit the form data to Salesforce.
Accepted 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 Process Data Variables:
No
Example:
Refer to:

Salesforce Configuration screen > Fields tab

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

Figure: Salesforce Configuration > Fields tab

Salesforce Configuration Fields tab

Prerequisites

Fields

Field NameDefinition

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.

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

Figure: Salesforce Configuration > Related Entity tab

Salesforce Configuration Related Entity tab

Prerequisites

Good to Know

Fields

Field NameDefinition

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. For Microsoft Excel, entity refers to an Excel table.
Accepted Values:
Read only.
Example:
Refer to:

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. For Microsoft Excel, entity refers to an Excel table.
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. For Microsoft Excel, entity refers to an Excel table.
Accepted Values:
Read only.
Example:
Refer to:

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