Salesforce

Salesforce Search

Prelim supports dynamic Salesforce object search, enabling users to retrieve and work with any standard or custom object available in their Salesforce instance. This allows for more flexible and scalable integrations.

• Object Types Supported:
  • Standard objects (e.g., Account, Opportunity, Contact)
  • Custom objects (e.g., FinServ__FinancialAccount__c, etc.)

Process Logic:

1. Prelim searches the Salesforce Account object.
2. Prelim will use the selected account to pull all related opportunities linked to the account in the Salesforce Opportunity object.

👍

Important Note

The names of the Salesforce objects and the paths to the Salesforce fields are completely customizable, and you will need to receive the exact object names and paths from the customer. Unlike the core apps, there is not a definitive standard for the fields we can search for.

Credentials

1. Identify whether the institution is using sandbox or production.
2. Required Information from the Institution
   1. For both the Salesforce App and Salesforce Search, request these credentials:
      1. Username
      2. Password
      3. Client ID
      4. Client Secret

👍

Best Practices

• Provide credentials securely (never over unsecured channels like email).

Installing the app

1. Install Salesforce or Salesforce Search from the Prelim App Store.
2. If you don’t see the app, contact your Prelim customer success manager or email [email protected].
3. After installation:
   1. Go into the Form Builder and configure the input settings.

📘

Permission Required

App Settings permission must be enabled for your role.

Configuring the Search App

The search app will show results from one table in Salesforce, however the search may be done across multiple objects.

Follow these steps to configure the app:

1. Go to the Settings tab

   1. If the Salesforce Search Input is in a list view, select “List View” for “Where is this object being mapped to?” and enter the list view input ID

   2. Check whether the search criteria will be entered by the user in the search modal or if it will prefill from an input

      1. Example of search criteria via search modal: User types in Name or Tax ID and we conduct a search across the Account Object with the Name and Tax ID the user entered
      2. Example of search criteria from inputs: We have an ID for an item in the Account table, and we want to search for all items in the Opportunity table that match this Account ID. The Account ID would be in an input on the form, possibly prefilled from a previous Salesforce Search App.

   3. Add the name of the object where the final results should live under “Primary Object Name”

      1. Example: you use Account Number to search the Financial Account object, but the item in the results will still be in the Account object and linked to from the Financial Account object. The Primary Object Name would be “Account”.

   4. Add the columns you want to be displayed with the search results

      1. This will only be the label for the column
      2. You can also rearrange the columns to change the order
      3. Example:
      

   5. Add all the mappings that should go back to Prelim

      1. These will be mapped from the Primary Object
      2. The path to the field you want passed back can include linking to another table, e.g. setting the path to Owner.Treasury_Management_Officer_TMO__r.Name to get the treasury officer’s name from an item in the Account table.
      3. Example:
      
2. Go to the Object Tab
   1. Add an object. This will be the table against which you will query. Here is how to fill out the configuration:

      1. API Name - the name of the object in Salesforce

      2. Object ID Path - the path to the unique identifier in the Primary Object

         1. If the object is the same as the primary object, it will likely just be “Id”. If it is a different object, it may be different e.g. Finserv__PrimaryOwner__r.Id

      3. Search Criteria - what you’ll be using to search

         1. Salesforce Field Path - The field in the table you’re searching against (ex: Name)
         2. Label - How the input will be labeled to the user when they are typing into the modal (in case the Salesforce Field Path is not very readable)
         3. Data Type / Input - In the case where the search criteria come from inputs, enter the input to pull from for this field
         4. You can add multiple search criteria
         5. Example:
         

      4. Display Columns - what values from the results you will display to the user

         1. Same as above, enter the field in Salesforce the data is coming from and select which column it should be mapped to
         2. The available columns are defined in the Settings tab
         3. Example:
         
   2. You can add multiple objects in case some of the search criteria is not found in the main object
      1. Example: Search by Account Number is done in the Financial Account object. Then the item in the Financial Account object has an “Owner” field which links to the item in the Account object that we really want. Explanations for how to fill out the mappings for this scenario are described above.
      2. This is a pretty niche use case - most likely you will only need 1 object mapped per input.
3. Linking to a previous search input
   1. If you want to link searches together, include a hidden field on the form in which to map the Id of the object in the first search input, and then include that input in the search criteria in the second search input

Troubleshooting

1. If you are receiving the error “Salesforce Error: Failed to get access token” make sure you have your VPN turned on if testing locally and that you are in production if testing from an environment.
2. If you are receiving the error “Failed to query” make sure all of the Salesforce object names and paths are typed correctly.