After you've authenticated your external system to ClientSuccess, the next step is to configure your field level mappings which you can access from your Integrations Configuration page. This article will serve as a high level explanation of what you're seeing on this page. For a how-to on actually configuring your mappings, please see our Field Mappings Setup Guide (coming soon).
How to get to this page:
We'll break this page down into several sections.
Save Changes, Object Mapping and Resource Filter
This section is meant for cancelling/saving changes you've made to your mappings, as well as providing a reference indicating which object you're syncing with, and what your Resource Filter is currently set at.
Two important notes:
- Please do not forget to save any changes before navigating away from this page. There is currently no reminder to save, should you forget to hit "Save" before closing the page.
- Should you need to adjust either your object mapping (which external object your ClientSuccess object is pointing towards), or your Resource Filter, please contact email@example.com as this is not editable from the UI.
Add New Field Mapping
1. Add New Field Mapping: From this section, you'll have the option of adding a new mapping to your existing integration. The UI will require you to follow a specific order when adding new fields, as outlined below.
2. ClientSuccess Fields: First, select the ClientSuccess field you're wanting to map to.
3. Salesforce Fields: Your next step will be to select the Salesforce field you want to pair with the ClientSuccess side. As you click the dropdown labeled "Salesforce Field Options", the integration will ping your Salesforce API and retrieve a list of fields from your own instance of Salesforce.
- The fields returned will be all fields within the object you've mapped to (i.e. Account, Opportunity etc.), that are accessible in your Salesforce layout (not hidden).
- You may notice that some fields are grayed out, and not clickable. This is because the ClientSuccess field you selected, and the Salesforce field you're attempting to pair are not compatible. Please see our Field Mappings Setup Guide for more details (coming soon).
4. Direction: The same options available to you in your Object Sync Direction are available in your field level Sync Direction:
Push & Pull: Updates in both ClientSuccess and Salesforce will push back and forth, for this field
Push to Salesforce: Only ClientSuccess to Salesforce pushing of data supported, for this field
Pull fromSalesforce: Only Salesforce to ClientSuccess pulling of data supported, for this field
Disabled: No syncing for this field will occur
The field level Sync Direction selected here will be overridden by your object sync direction set in your Integrations Configuration page. Should you set a field to sync bi-directionally ("Push & Pull"), but your object is set to only "Pull from Salesforce", data for this field will only pull from Salesforce.
5. Add: Once you have selected your two fields to pair, and their Sync Direction, click "Add" to add this mapping to your layout.
After adding a new mapping to your layout, you will still need to select "Save" from the top of the page in order to complete your edits.
Existing Mappings - Review/Edit
This section of your Field Mappings page is where you can view mappings that are already in place, and edit these existing mappings' sync direction, and the Salesforce field piece of the mapping.
We group your mappings into 3 field types:
Client ID/Association Fields
- Here you will see any fields you've configured to be used as "unique IDs" between ClientSuccess and Salesforce.
- You will also see any fields where "relationships" or associations between data points need to be considered.
- This section has the potential to be quite complex. As such, we've written a Field Mappings Setup Guide (coming soon) to address how to be successful in leveraging these fields.
- This is where you will see fields mapped to what we refer to in ClientSuccess as "Primary Fields", or "out-of-the-box" fields that are included on every Client Record. Fields such as Client Name, Client As Of Date, and address details.
Client Custom Fields
- As you can imagine, this section will include any ClientSuccess Custom Fields you've created for a given object (Clients/Contacts).
On the right-hand side of each mapping (with the exception of the "ID - CRM ID [Lookup]" mapping which is required), you'll see a small trash can. Click this to remove a mapping.
Once you're ready to begin setting up your mappings, or for best practices on adding/removing mappings, please see our Field Mappings Setup Guide (coming soon).