Process-Based App with Salesforce Data Source (Classic)

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

Background and Setup

Video: Create Your First App

Examples

Prerequisites

Good to Know

How to Start

  1. Sign in to AgilePoint NX.
  2. Click App Builder.

    Build Apps screen
  3. On the App Explorer screen, click Add App.

    Add App button
  4. On the App Type screen, click Process-Based App.

    Add App button
  5. Click Next.
  6. On the New App screen, complete the fields, and click Next.

    New Application screen
    .
  7. On the New Process Model screen, complete the fields, and click Next.

    New Process Model screen
    .
  8. On the Select Primary Data Source screen, select Salesforce Salesforce icon.

    Primary Data Source screen
  9. Click Next.

Salesforce Configuration screen > Configuration tab

Configures how to send and receive data from Salesforce for your process.

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

Primary Entity Name
Function:
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.
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

Save 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

Save A Copy Of Data In 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 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

Salesforce Configuration screen > Fields tab

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

Figure: Salesforce Configuration > Fields tab

Salesforce Configuration Fields tab

Prerequisites

Fields

Field NameDefinition

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.

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

Figure: Salesforce Configuration > Related Entity tab

Salesforce Configuration Related Entity tab

Prerequisites

Fields

Field NameDefinition

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. For Microsoft Excel, entity refers to an Excel table.
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. 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.

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.