For support, please use the contact form on the contact page.
For full documentation, follow the QuickStart guide below and click on the Documentation link in the Manager.
Quick Start:
Always back up your data and test in a sandbox environment.
- Install the managed package into your sandbox environment first ( we don’t recommend testing on production )
- In Setup > Object Manager, click on the object you want to sync first ( The included examples use the Contact Object – so you can always start there )
- Click: Lightning Record Pages then click the new button toward the top right
- Choose record page, hit the next button, type a label like “Contact Sync Admin”, chose you object i.e: Contact or your_object__c, click next
- You will get a list of template choices, at the top where it says “Choose Page Template”, look right and click on “Clone Salesforce Default page”
- Contact – Grouped View Default (for example will be selected), just click Finish
- Drag the sfPlugins_Command_Center aura widget into the very top right (or wherever you want it) and click Save
- Click the Activation button to the left of Save and choose App, Record Type, and Profile
- Click assign, choose your app(s) ( i.e.: Sales Console ) click next, choose an option ( Desktop makes the most sense )
- Choose a record type ( i.e.: master ) click next and choose a profile like “System Administrator” or something more restricted and click next.
- You should not allow regular users to access the app, even though it is password protected. Always store your credentials, backups, and exports in a secure location following all PII, security, and compliance standards.
- Click Save.
- Assuming that you assigned the lighting page to the profile of the user you are logged in as: visit your object page and click on a record to see the record detail. ( You may need to create a dummy record if the object has no rows )
- Go view your new record page, which will look something like:
- And click on the Login button
- The default username and password is: syncManagerAdmin and sfPluginsAdminPass
- Once logged in, click on Configuration Options and change the username and password
- The login screen has a “Forgot Username and/or Password” button – using this button will email the password to all system admins
Troubleshooting:
Always back up your data and test in a sandbox environment.
- See the in-app documentation for more troubleshooting tips
- Use the “API Preview” mode. The preview will catch and display most errors and give you tips on how to solve the the issue.
- Make sure that API Debug mode is off to sync live results. Take care: records will still be updated in debug mode
- Always test your connection credentials with Postman or cURL before entering the credentials into Salesforce – this will tell you whether or not your target API is behaving as expected
- Remote Site Settings – found under Setup, these settings are required to access API endpoints from within Salesforce. Please make sure that you add https://yourDomain to remote site settings before connecting to any APIs
- Named Credentials – some APIs will use Salesforce named credentials to authenticate and make subsequent calls to a protected API. Named credentials can be tricky to set up and there are many resources through Google that can help you connect. In almost all cases, if you can access your target API through cURL ( through a regular internet connection ) or Postman, you can likely do so from the sfPlugins app via named credentials. Please be aware of any VPN or other factors that may affect cURL results.
- Enable API Debug mode on your sync. Then paste an example JSON response in the API Mock field. This will allow you to test the integration without connecting to a live API – sometimes this can be helpful to determine if you issue is with the API or the mapping. You can get a sample response through cURL or Postman.
- When all else fails you can log a support ticket ( 2 hours free with purchase of an app ) having tried all of the above
- For support requests, please be ready to provide the following:
- A sandbox with the app installed and your test configuration
- Sample API Mock data and export of your Sync Options ( please be aware of any PII or sensitive data )
- Ideally we would be able to connect to your target API and test from both Mock and live data, from our servers ( where we have detailed logging capability ) and your Sandbox environment
- For support requests, please be ready to provide the following:
Usage Terms:
This application is provided by the copyright holders and contributors “as is” and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright owner or contributors be liable for any direct, indirect, incidental, special, exemplary, consequential or similar damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this application, even if advised of the possibility of such damage.
Subject to the foregoing, and appropriate licensing and permission from the copyright holder, this application may be: distributed, transmitted, used, or otherwise exploited by salesforce.com or its affiliates, any customer or partner of salesforce.com or its affiliates, or any developer of applications that interface with the salesforce.com application, for any purpose, commercial or non-commercial, related to use of the salesforce.com application, and in any way, including by methods that have not yet been invented or conceived.
Always test data manipulation thoroughly in sandbox and backup your data regularly, and also before using in production.This app is to be used at the customer’s sole discretion and risk.
Additional support is available from sfplugins.com at an hourly rate.