This article will detail the steps needed to perform a fresh install of the Leadspace for Salesforce application.
IMPORTANT NOTE: Our current packages are secure packages which create some changes to Event-Based Syncs. Salesforce users that create or update records that trigger Event-Based Sync triggers will now require the Leadspace Manager or Leadspace Admin permission set. If you have any questions or concerns about this before you would like to proceed, please create a support ticket and we'll be happy to answer your questions.
Installation Steps
- Contact your Salesforce System Admin
- System Admin will login to the Salesforce instance you want to install (UAT, Sandbox, Production, etc.)
- Click the upgrade link here
- Select 'Install for all Users'
NOTE: There is no longer the need to have separate installation links for your Sandbox/UAT and Production accounts. Now, you can login to the instance you want to upgrade and just click on the upgrade link.
KEEP IN MIND:
- If you are simply updating your existing package, please refer to Leadspace for Salesforce: Upgrade to 4.45
- For first time installation, please continue below.
- Order of actions are important to keep; remote site settings, then settings tab, then permission set, then fields mapping.
Create Remote Site Settings
- Navigate to Setup --> Remote Site Settings and create 3 new remote site settings:
LeadspaceSync1:
- Navigate to the “Settings” tab of Leadspace for Salesforce
- Right click anywhere on the page -> "Inspect"
- Enter the “Console” tab, type ”remSite()”, and press enter
- Copy the returned URL from the “https” to the “.com” (included) and create a new remote site setting.
LeadspaceSync2:
- Copy the instance from your salesforce URL
- https://<INSTANCE>.salesforce.com
LeadspaceSync3:
- Copy the instance from your salesforce URL
- https://<INSTANCE>.lightning.force.com
Navigate to App
Open the App Launcher and select 'Leadspace for Salesforce' or 'Leadspace Audience Sync' Go to the 'Settings' tab. From here, you will need to enter the following information:
Authentication
- Program Id: You should have received an email with the subject "Leadspace API V 3.0 credentials". Input the Program Id from the email.
- Secret: Input the Secret from the email.
Intent Authentication
Note: This is only for customers who have purchased intent models from Leadspace. This is a separate program ID and secret used to update account intent data ONLY. You can refer to Leadspace for Salesforce: Weekly Intent article for more information.
- Program Id: Separate program ID for Intent ONLY. You should have received an email with the subject "Leadspace API V 3.0 credentials". Input the Program Id from the email.
- Secret: Input the Secret from the email.
Single Enrichment Authentication
- If Leadspace has setup a specific token for you to use for Event Based Syncs, enter the Program ID and Secret provided by Leadspace here.
Configurations
- Email Addresses: Input the email(s) of whoever should receive an email when a sync job completes.
- Number of Allowed Transactions: Set the limit for allowed transaction of any single job. Recommendation is 350,000 per Leadspace
- Record Bulk Size: How many records per API call do you want? Up to 500
- Logs Level: Default 'Info' provides Info and Errors
- Sync Definition - Minute Interval: If you are using the new, 'minutely' periodic sync, indicates the interval of options. Options are 3 and 5 mins.
- Receive email updates for Minutely Based Sync Activity: Toggle on to receive email updates for each sync job created at the 'per minute' interval selected in Sync Definitions jobs.
- Event Based Trigger: Toggle on if you want to create event based jobs (create or update)
- Custom Objects: Toggle on if you want to stop using LS Custom Fields on your standard objects (Account, Lead, Contact) and want to start using custom objects (Company and Person). NOTE: Once this is selected, it cannot be undone. Please consult with your CSM if you have any questions on this.
Endpoints
The 'Endpoint' values in this section are filled in by default. The buttons are referenced throughout this document.
- Click Complete Upgrade: Locks in new 'Minutely' periodic options in Sync Definitions
- Click Test Connection & Save: The standard 'Save' button, tests all endpoints and settings and provides a 'Success' or 'Failed' message at the top of the page. This also creates the 2 Leadspace Permission Sets:
- Leadspace Manager
- Leadspace Admin
- Click Update LS Statuses: Ensures that all sync types, fields, and options are available in sync definitions. NOTE: Mainly used if upgrading to 4.45 from an older package.
- LS Utilities: Diagnostic utility, assists with identifying issues with output mapping, remote site settings, and permission sets. Also ensures you have Apex and Cron jobs setup correctly per the package installation.
- Fix: If you see any errors in red, click fix.
- Refresh: Once you get a pass, click Refresh to lock in the fix
Assign Permission Sets
In SFDC, navigate to Setup --> Permission Sets. You should see 2 permission sets listed.
- Leadspace Manager: More restrictive, users can ONLY create sync definitions
- Leadspace Admin: More permissive, should be given to users who need to Admin the LS4SF application. Leadspace Admins can configure app settings, set input and output mapping, and run sync jobs
You will need to make sure at least one user has Leadspace Manager and/or Leadspace Admin, unless a SFDC System Admin will be running and creating all syncs and managing the package. To assign permission sets to a user:
- Click on the permission set
- Click on Manage Assignments
- Click Add Assignments
- Select the user who should have the permission set assigned
If you need to manually create permission sets for any reason, additional reference can be found here: https://support.leadspace.com/hc/en-us/articles/360012335619-Leadspace-for-Salesforce-Create-Leadspace-Admin-Permission-Set
Configure Input Mapping
Navigate to the Input Field Mapping tab to define your input fields. Leadspace uses certain fields as input in order to best identify and enrich people and companies. Here is where you will tell Leadspace specifically which fields from each object to use as input for enrichment.
These are the default values. Make sure to click Save after each modification on this page:
Configure Output Mappings
Each standard object has a dedicated output mapping tab. By default, the package contains 3 output tabs:
- Account Output Mapping
- Contact Output Mapping
- Lead Output Mapping
You will need to navigate to each of these individually to set the desired output mapping for enriched records. Note that you will want to make sure all mapping is complete before click the 'Update Mapping' button in the top-right corner.
- If you want to create a New Field to map the line item field to, make sure to click in the Map to Field column and select <Create New Field> from the drop down:
- If you want to map to an existing field in Salesforce, click on the dropdown in the Map to Field column --> Select your SFDC field to map
- Make sure checkboxes 'Active' and 'Override' are checked
- When all of your mapping is complete, click Update Mapping in the top-right corner
Please note that the Leadspace for Salesforce app is required to create the following fields. These fields are managed package fields. Please note you will need at least five fields available for each of the objects (Leads, Contacts, Account) for the app to install.
- Last Leadspace Activity Date: The last date the record was sent through the app.
- Leadspace Error Code: Indicates if an error has occurred.
- Leadspace Error Message: Indicates the type of error that has occurred.
- Leadspace Record Status: Indicates if the enrichment of the record was a success or failure.
- Leadspace Related Bulk Id: The id of the bulk the record belonged to.
These fields are technical validation fields and are required for the app to work properly. Customers may also use these fields to help filter and report on records that have been enriched through the app. For example, "Last Leadspace Activity Date is blank" will yield all records that have not been sent through the app, and vice versa.
Create a Test Sync Definition
Once the setup is complete, it is best practice to run one or two records through Leadspace for Salesforce to ensure that the app has been set up properly.
Follow these instructions to create a new sync job, and ensure that the status of the sync job is 'Success'. You should also run a report on the records run, and ensure that the Leadspace fields have been populated.
If you have any questions or issues, please reach out to Leadspace Support for assistance.