Skip to main content

Leadspace for Salesforce: Upgrade to Package 4.45

  • Updated

Summary

This article will detail the specifications and upgrade steps for the new LS4SF package version 4.45, specifically for customers upgrading from package version 3.75.

What’s New?

There are several new features and updates for customers upgrading to 4.45. The following detail some of the more important features, especially for customers coming from a more recent, 3.x package.

Features 

There are some exciting new features available in package 4.45 that are not in package 3.75:

Minutely Periodic Sync 

The new ‘Minutely’ periodic sync gives customers the ability to set periodic sync definitions at much shorter intervals than ever before. You can now set your periodic syncs at iterations starting every 3 or 5 mins. in increments of 3 or 5 depending on what you set in the ‘Settings’ tab. This is especially beneficial when you need quick enrichment of new records, but have too much incoming volume for an event-based sync to handle

Custom Objects 

The new (and optional) ‘Custom Objects’ feature gives customers two new dedicated custom objects, ‘Company’ and ‘Person’, that contain the LS enriched data completed on the Salesforce Standard Objects (Account, Lead, Contact). Please refer to the Custom Objects article in our Knowledge Base for more information.

LS Utility

The Settings tab now houses an LS Utility button, which will scan your package setup for authorization settings, remote site settings, and permission sets. One click ‘Fix’ option for each to easily diagnose and fix common configuration issues.

New Settings Tab Options

There are some new additions to the settings tab thanks to the new Custom Objects and Minutely Periodic features:

  1. Single Enrichment Authentication: This allows you to work with Leadspace to designate a dedicated program ID and token for event-based syncs, which use our Single API endpoint.
  2. Sync Definition - Minute Interval: This allows you to set the minute iterations for your minutely sync. Note: Once you run a minutely sync, this cannot be changed.
  3. Receive Email Updates For Each Minutely Based Sync Activity: Toggle on if you want the email addresses listed in the Configurations > Email Addresses section to receive a notification after each minutely job.
  4. Custom Objects: Toggle on if you want to utilize new Company and Person Custom Objects. Note: Once you toggle on, the Lead, Account, and Contact Output Mapping tabs will no longer be accessible.
  5. New Bulk Size Options: Now choose either 400 or 500 as bulk sizes per API call.

Quality of Life Improvements

There are also some quality of life improvements for package 4.45. No action is needed for these changes.

Field Label Changes: Select fields have new, more logical field labels as part of the package. These fields are:

  • SYNC ID = Sync ID 
  • Number of records = Number of Records
  • ApexJobId = Apex Job ID

New Fields: The following fields have been added:

  • Processing Message
  • Number of Tries
  • JSON Response

New Statuses and Messaging: Due to the available frequency that Minutely syncs afford, a new status was added for the minutely periodic syncs ‘Done - Won’t Run’. This will populate one of two values in the ‘Processing Message’ field:

  • Skipped: Two of the same periodic jobs from the same sync definition are scheduled at the same time.
  • Skipped - SF Limitation of 100 jobs in a queue: Scheduled periodic job exceeds SFDC’s queue limit of 100.

Requirements

Here are some requirements regarding the installation and use of the package.

IMPORTANT: Starting with package 3.68, all LS4SF packages are now 'secure' packages due to requirements on the Salesforce App Exchange. This especially affects the functionality with Event Based Syncs, meaning that all users who create or update records to trigger these syncs will need to have the Leadspace Manager permission set applied to their profile assignments. If you have any questions, please contact support before proceeding.

Some other requirements include:

  • SFDC System Administrator must install the package
  • The creator of the Periodic Sync must have the proper permission set or SFDC profile access:
    • System Admin
    • Leadspace Manager
    • Leadspace Admin
  • After the upgrade, you must click the ‘Complete Upgrade’ button in the ‘Settings’ tab to see the new minutely option in Sync Definition creation.

Upgrade Steps

  1. Have a Salesforce System Administrator log into the SFDC instance to which you want to install. 
  2. Click the upgrade link here
    1. Full upgrade link is here: https://login.salesforce.com/packaging/installPackage.apexp?p0=04t3m000000kplc
  3. Choose ‘Install for All Users’ and Submit
  4. Once completed, click ‘Done’
  5. Go to the Settings tab and click the 'Update LS Statuses’ button. 
  6. Then click the 'Complete Upgrade' button
  7. Click 'Test Connection and Save' and scroll to the top to see the 'Success' message in yellow.

We now need to cleanup and add some new Remote Site Settings. The 4.45 package comes with a Utility tool that will assist us with creating the proper Remote Site Settings in your SFDC Setup:

  1. In the LS4SF Application, go to the Settings Tab
  2. Scroll to the bottom of the page and click on the LS Utilities button
  3. In the "Remote Site Settings" section of the tool, you should see a message similar to this, where 'customobject' is the name of your SFDC organization / env.:mceclip0.png
  4. Copy the URL and go to Setup > Remote Site Settings
  5. Click 'New Remote Site' and add the following:
    1. Remote Site Name: LeadspaceRS
    2. Remote Site URL: Paste what you copied from the Utility message
  6. Save and go back to the LS Utility screen
  7. Click 'Fix' and 'Recheck' and you should see a green 'Passed' message. This confirms all other remote sites were created correctly.mceclip0.png
  8. If you do NOT see a green 'Passed' message, you will likely see another URL similar to in Step 3. If you do, copy this URL and go back to Setup > Remote Site Settings > New Remote Site
    1. Remote Site Name: Leadspace_4
    2. Remote Site URL: Paste what you copied from the Utility message
  9. Go back to the utility and click 'Fix' then 'Recheck'. You should now see a green 'Passed' message
  10. Now, in Setup > Remote Site Settings, you should see 5 or 6 remote sites, depending on whether you needed to add 1 or 2 during the setup (steps above).

LS Utility Check

mceclip0.png

  1. Go back to Settings and click LS Utilities button again
  2. If any of the setting throw a red error, click 'Fix' then 'Recheck'

Leadspace Job Handler

  • If error persists after fix/recheck, please go to Setup > Scheduled Jobs and delete Leadspace Job Handler
  • Go back to LS Utilities and click Fix then Recheck. You should get a green 'Passed' as the utility will correctly re-create the Job Handler job

Leadspace Job Handler Worker

  • This worker ONLY applies if you have setup and run a new 'Minutely Periodic Sync'. If you have not yet done this, disregard any red error here

Check Output Field Mapping Names

  • Some output mapping names have changed in package 4.45. If you see a red error here, Fix and Recheck should change the names accordingly in all object mapping tabs

Permission Sets

  • This will likely show a red error if the permission sets were already created in a previous version.
  • Go to Setup > Permission Sets and delete the Leadspace Manager and Leadspace Admin permission sets
  • Go back to LS Utilities and click Fix and Recheck. This will create the permission sets automatically with all needed setup permissions.

If the permission set section still shows an error, we have a workaround:

  1. Go to Setup > Permission Sets
  2. Create new permission set with the following criteria:
    1. Label: Leadspace Admin
    2. API Name: LeadspaceAdmin (no spaces or underscores)
    3. Savemceclip0.png
  3. Go back to the Permission Sets and click on 'Leadspace Admin' 
  4. Scroll to System Permissions 
  5. Edit and enable Customize Application
  6. Save and go back to LS4SF App > Settings
  7. Click the LS Utility and click 'Fix' and 'Recheck' on the Leadspace Permission Sets
  8. This should completely create both permission sets

Remote Site Settings

  • This should show green passed as we set these up earlier in the setup.

We now need to do a little cleanup, per the ‘New Features’ above > Cleanup section. If using Salesforce Lightning UI, please switch to Classic View as the following is only available in classic.

  1. Go to Setup > Accounts or Leads or Contacts > Fields. Scroll down to Account Custom Fields & Relationships
  2. Look for the fields with the envelope and red X. You’ll notice that the ones to delete have ‘Leadspace’ in the API Name. The new fields have LS instead.
  3. Click ‘Delete’
  4. Repeat this for all 3 standard objects: Contacts, Leads, Accounts

**Note: If you have any active sync definitions that use any of the fields deleted above, you will need to edit the sync definition and replace the deleted criteria/filter with the new version.

Technical Specifications

Apex Jobs

The apex classifications and jobs are mostly the same as with packages prior to 4.45. The one main change is with the ‘minutely’ sync where we’ve added a new ‘worker’ job to schedule the syncs. 

Here’s how it works with the minutely sync:

  • As with the current, hourly periodic syncs, Leadspace Job Handler runs once per hour at the top of the hour.
  • NEW: Leadspace Job Handler (worker: date/time stamp) queues up the sync activity at the next, minutely interval
  • As a result, the scheduled apex job Sch_EnrichmentJob will queue the next interval
  • Scheduled apex jobs Batch_EnrichmentJob and Batch_PollingJob will run
  • When enrichment and polling jobs are status ‘Completed’, the Sch_EnrichmentJob will abort
  • The process will repeat at the next scheduled interval

API Specifications

  • All periodic syncs in LS4SF including the new minutely solution use Leadspace’s Bulk API v3.
    • API rate limit for Bulk API is set to 30 TP/s
    • 1800 records per minute
    • 5400 records every 3 min. Interval

Behavior

  • In the minutely sync, if a sync activity is still running when another scheduled job kicks off, the new job will run independently and not affect concurrent jobs already running. The exception is if concurrent jobs exceed 10 (Known Issue).

Best Practices / Limitations

  • Minutely sync not created to run large amts. of records. The formula to calculate how many max records can run for any given interval is as follows:
    • 30 x 60 x Minute interval. 
    • If you are using Frequency = 3 mins. then 5,400 records
  • ‘Status’ dropdown in Sync Definition does not currently work (feature request). If you need to ‘Pause’ or ‘Disable’ a job, please use the ‘Edit’ option on the Sync Definition
  • Pause any active, periodic sync that has the same criteria as the one you want to create with the new ‘minutely’ frequency
  • Do not run over 10 periodic syncs at one time (Known Issue)
  • Minutely sync kickoff is subject to SFDC limitations and resources

Related articles