Create a Form-Based App with a Salesforce Entity (Classic)

To create a form-based app that uses a Salesforce entity as its data source in the Classic Add an App experience, do the procedure in this topic.

Video: Form-Based App with Salesforce

Prerequisites

Good to Know

  • This procedure creates a new form-based app with these components:
    • A Create form where a runtime app user can enter data. This form is the main UI for the app.
    • An Update form where specific users can change the data that was entered on a Create form.
    • A View form that shows a list view of the data from all instances the Create and Update forms for your app.
    • A View form that shows a list view of the data from all instances the Create form that have been recently submitted for your app.
    • A View form that shows a list view of the data from all instances the Update form that have been recently submitted for your app.
  • The form name is based on your primary entity name.

    Format:

    • New [Primary Entity Name]
    • Update [Primary Entity Name]
    • All [Primary Entity Name, Plural]
    • Recently Created [Primary Entity Name, Plural]
    • Recently Modified [Primary Entity Name, Plural]

    Example:

    • New Customer
    • Update Customer
    • All Customers
    • Recently Created Customers
    • Recently Modified Customers
  • By default, the runtime app user can change the form, but you can set the app permissions to configure which AgilePoint NX users can create or update form data.

    For more information, refer to How Do I Use Application Level Permissions?

  • 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. Click App Builder.

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

    Add App button

Procedure

  1. On the App Type screen, select Form-Based App.


  2. Click Next.
  3. On the New App screen, complete these fields:


    Field Name Definition

    App Name

    Function:
    Specifies a name for your app.
    Accepted Values:
    One line of text that can have spaces.
    Default Value:
    None
    Example:
    Refer to:

    Language

    Function:
    Specifies the language for your app.
    Accepted Values:
    A language from the list.
    Default Value:
    None
    Accepts Process Data Variables:
    No
    Example:
    Refer to:

    Category

    Function:
    Specifies a category for your app.
    Accepted Values:
    A category from the list.

    The category list comes from Tenant Settings > Categories tab.

    Default Value:
    None
    Limitations:

    This field is available in these releases:

    App Description

    Function:
    An optional description for your app.
    Accepted Values:
    More than one line of text.
    Default Value:
    None
    Example:
    Refer to:

    Choose Theme

    Opens this Screen:
    Choose Process Model Theme
    Function of this Screen:
    Specifies a process theme.
  4. Click Next.
  5. On the Select Primary Data Source screen, select Salesforce Salesforce icon.


  6. Click Next.
  7. On the Salesforce Configuration screen, click the Configuration tab.


  8. On the Configuration tab, in the Data Source Name field, enter a custom name for your Salesforce repository.
  9. In the Salesforce list, select your Salesforce access token.

    To create a new access token, click Create Add Token icon. For more information, refer to Access Token for Salesforce.

  10. (Optional) Complete this field as necessary.
    Field Name Definition

    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:
  11. In the Primary Entity Name list, select an entity that you want your form to collect data.
  12. (Optional) Complete this field as necessary.
    Field Name Definition

    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:
  13. Click the Fields tab.


  14. On the Fields tab, select the fields you want your form to contain.
  15. Click the Related Entity 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.


  16. On the Related Entity tab, select the related entities you want your form to contain..
  17. Click Finish.
  18. On the eForm Builder screen, in the Toolbox, open any tab.
  19. Drag a form control onto your eForm.
  20. On the eForm Builder screen, configure your form as necessary.

    For more information, refer to eForm Builder.