Syncplicity Support

Search our knowledgebase to get the help you need, today

Follow

Configure Syncplicity and Salesforce

The following topics describe configuring the integration between Syncplicity and Salesforce.

Create a group

Use this procedure to create a user group in My Syncplicity. You create a group and later associate an API user to it. For more information about groups see Managing groups.

  1. In My Syncplicity, select Admin > Groups in the top toolbar to open the Manage Groups page.
  2. Under Other Tasks, click Create a new group to open the Create Group page. There are three pages for creating a group, but you use only the first one.
  3. Type a name in the Group name field and click Next three times to create the group.

Create a user with API User role. 

Use this procedure to create a user with an application programming interface (API) role. This API user only can make API calls. It is needed for Syncplicity to communicate with Salesforce over an API. For more information about Syncplicity users, including API users, see About administrator roles.

  1. Log on to My Syncplicity as an administrator.
  2. In My Syncplicity, select Admin > User Accounts in the top toolbar to open the Manage Users page.
  3. Click Add a User to open the Add and Configure New Users page. There are three pages for adding a user, but you use only the first two.
  4. Type at least one email address in the Email Addresses field.
  5. Select API User from the Role drop-down field.
  6. Click Next to open the Group Membership section of the Add and Configure New Users page.
  7. In the provided field, start typing the name of the group you created earlier. This triggers a search matching your string. Select your group name. Alternately, click Add groups from my Syncplicity company directory to find your group.
  8. Click Next twice to create the user.

Give user API privileges

Use this procedure to give API privileges to Syncplicity users.

  1. In My Syncplicity, click View and edit existing users to open the Manage Users page. Or, select Admin > User Accounts in the top toolbar to open the Manage Users page.
  2. Search for the user with the API User role that you created in the preceding steps.
  3. Click the user's email address to open the Personal Information page for the user.
  4. In the Privileges section, click Modify for the Manage all users privilege to open the Select Groups to Manage dialog.
  5. Find and select the group you created earlier and click Save.
  6. In the Privileges section, click Modify for the Access only own content through API privilege to open the Select Content API Access dialog.
  7. Make sure Access only own content through API is selected and click Save.
  8. In the Privileges section, click Modify for the API Scope privilege to open the Edit API Scope dialog. Enable read, create, update, delete privileges according to the table at the end of this procedure and click Save. Then go to the next step.
  9. In the Privileges section, click Create application token for the Application Token privilege to open the Application Token dialog with the new token.
  10. Copy the token and keep it handy for use later. Click Close to exit the dialog.

Edit API Scope settings

Use the following table to make selections in the Edit API Scope dialog displayed in a preceding step. Enable only the privileges with yes in the table cells.

Privilege Read Create Update Delete
Provisioning
Company yes      
Users yes      
Groups        
Group Members        
Devices        
Policies yes      
Legal Holds        
Custom Metadata        
Document Sign yes yes   yes
Content
Folders yes yes   yes
Files yes yes   yes
Links yes yes yes yes
Files/Folder Metadata yes yes yes yes
Folder Participation yes yes   yes

Connect Salesforce and Syncplicity

Use this procedure to establish communication between Syncplicity and Salesforce by API, connecting with the Syncplicity API user's API token you generated in the previous procedure.

Perform the following steps in Salesforce.

  1. Log on to Salesforce as an administrator.
  2. Click the App Launcher icon at the top left and click Syncplicity in the list of apps.
  3. Type the user email address in the Syncplicity Service Account Email field. This email address can be the Syncplicity service account email address.
  4. Paste the token in the Syncplicity Application Token field.
  5. Click Connect.

Once connected, a screen like the following is displayed in Salesforce.

Set root folder name

Use this procedure to specify a different root folder name for Syncplicity in Salesforce.

  1. Log on to Salesforce as an administrator and open the Syncplicity Settings page.
  2. Click Edit in the Content Settings section.
  3. Type the name you want for the root folder in the Root Folder field. For example: SalesforceSyncplicity.
  4. Click Save to change the name.

Set synchronization

When user access rights to Salesforce records are downgraded, they are synchronized to the corresponding Syncplicity folder permission using permission synchronization jobs. The job can be triggered manually or scheduled to run at intervals.

Synchronize manually

Use this procedure to synchronize Syncplicity manually in Salesforce.

  1. Log on to Salesforce as an administrator and open the Syncplicity Settings page.
  2. Click Sync Now in the Sync Salesforce and Syncplicity Permissions section to perform permission synchronization immediately. A message is displayed briefly indicating a batch job has started.

Schedule a synchronization job

Use this procedure to run a Syncplicity synchronization job on a schedule in Salesforce.

  1. Log on to Salesforce as an administrator and open the Syncplicity Settings page.
  2. Click Schedule Updates in the Sync Salesforce and Syncplicity Permissions section to open the Schedule Apex page where you can schedule a batch job.
  3. Complete the fields:
    • Type a name in the Job Name field.
    • Use lookup to specify SyncplicityPermissionsBatchJobScheduler in the Apex Class field.
    • Set the frequency, start and end dates, and preferred start time.
  4. Click Save to run the batch job on the specified schedule.

Map folders

You must map folders for the Salesforce records for which the Syncplicity Panel is enabled. Mapping defines the hierarchy of a Salesforce record to create the folder structure in Syncplicity.

Once Syncplicity folders are created for a Salesforce record using an existing mapping, best practice is not to change the mapping. If mapping is changed, the folders for existing Salesforce records created using older mapping remain in the old mapping hierarchy. Only new Salesforce records follow the new mapping hierarchy.

Map folders for standard objects

Perform the following steps in Salesforce. Repeat to add folder mapping for other standard objects.

Account

  1. On the Syncplicity Settings page, click Add New Folder Mapping in the Current Syncplicity Folder Mapping section at the bottom of the page.
  2. Select Account and click Add.
  3. In Selected objects:
    • Set the Parent Object Name to None
    • Type Accounts in the Syncplicity Folder Name field
    • Select Mount As Root
  4. Click Save Settings.

Opportunity

  1. Select Opportunity and click Add.
  2. In Selected objects:
    • Set the Parent Object Name to Account - AccountId
    • Type Opportunities in the Syncplicity Folder Name field
    • Disable Mount As Root
  3. Click Save Settings.

Map a folder for a custom object

Perform the following steps in Salesforce. Repeat to add folder mapping for other custom objects.

Proposal

  1. On the Syncplicity Settings page, click Add New Folder Mapping in the Current Syncplicity Folder Mapping section at the bottom of the page.
  2. Select Proposal and click Add.
  3. In Selected objects:
    • Set the Parent Object Name to Opportunity - Opportunity_c
    • Type Proposals in the Syncplicity Folder Name field
    • Disable Mount As Root
  4. Click Save Settings.

 

Powered by Zendesk