Skip to main content
All CollectionsIntegrations
Salesforce App
Salesforce App

Learn how to install QuotaPath's Salesforce App

Updated over 6 months ago

QuotaPath customers can download and install the QuotaPath app from the Salesforce AppExchange in order to view QuotaPath earnings data directly in their Salesforce instance.

In this article, we'll review the requirements for installing QuotaPath's Salesforce app, supported features, how to install the app, how to set up your QuotaPath workspace, how to sync data, and how to uninstall the app.

Requirements

  • QuotaPath's Salesforce app is available to any QuotaPath customer, including Essential, Growth and Premium subscription tiers.

  • QuotaPath customers must have the Salesforce integration connected to their workspace and mapped to their compensation plans.

  • Earnings must be calculated off of fields on the Opportunity object in Salesforce (i.e. Account executive or managers compensated on 'Closed Won' opportunities, or sales development representatives compensated on created or qualified opportunities)

Supported Features

The QuotaPath app includes the following features in the managed package:

  • New Custom Application called "QuotaPath"

  • New Custom Object called “QuotaPath Earnings” containing the following fields:

    • QuotaPath Earnings Owner: user lookup

    • Earnings: currency

    • Earnings Date: date

    • Path: text

    • Plan: text

    • QuotaPath Record Name: text

    • QuotaPath Record ID: number

    • View QuotaPath Record: URL

    • Opportunity: opportunity lookup

  • New Custom Settings called “QuotaPath Settings” where a Salesforce admin will enter their QuotaPath workspace URL

  • New External Credentials where a Salesforce admin will enter the QuotaPath API Token

  • Scheduled Job to automatically sync data for 'This Year' once a day at midnight, added post-install

  • Action called “QuotaPath Sync” that manually initiates data sync. Sync time periods include This Month, Last Month, This Year and Last Year

  • Permission Sets for:

    • QuotaPath System Admin: Permission to read/write all QuotaPath Earnings data

    • QuotaPath Admin: Permission to read all QuotaPath Earnings data

    • QuotaPath User: Permission to read only personal QuotaPath Earnings data

  • Pre-built Reports and Dashboards using “QuotaPath Earnings” data

How to Install

In order to install the QuotaPath app in your Salesforce instance, a Salesforce Admin will need to follow the below steps:

Salesforce AppExchange Marketplace: Go to the QuotaPath app in the Salesforce App Exchange here.

Install QuotaPath App: Click 'Get It Now' to begin installing the QuotaPath App into your Salesforce instance.

QuotaPath Workspace URL: Go to 'Custom Settings' in Setup:

  1. Select 'QuotaPath Settings'

  2. Click 'Manage'

  3. Click 'New'

  4. In the 'QuotaPath URL' field, paste your QuotaPath workspace URL in the format: https://<workspace.name>.quotapath.com

    1. Be sure to remove any trailing '/' on the workspace URL

  5. Click 'Save' when complete

QuotaPath API Key: Go to 'Named Credentials' in Setup:

  1. Select 'QuotaPath Creds'

  2. In the Principals section, click the dropdown arrow next to QuotaPathAdminPrincipal and select 'Edit'

  3. In the pop up modal, click 'Add' in the Authentication Parameters section

  4. Enter 'API_Token' in the Name field, and enter your QuotaPath API Token into the Value field. This is a 40 character value that will need to match exactly as it is listed in QuotaPath.

    1. Visit this article to learn how to generate a QuotaPath API Token

  5. Click 'Save' when complete

System Admin External Credentials: Go to 'Profiles' in Setup:

  1. Click to 'Edit' the System Administrator profile

  2. Go to the Enabled External Credential Principal Access section and click 'Edit'

  3. Add the QuotaPathAdminPrincipal to the enabled external credentials and click 'Save'

QuotaPath Permission Sets: Go to 'Users' in Setup:

  1. Click 'Edit' next to a user to update permission sets

  2. Go to the Permission Set Assignments section and click 'Edit Assignments'

  3. Add one of the following permission sets and click 'Save:

    1. QuotaPath Admin: Permission to view all QuotaPath Earnings records

    2. QuotaPath User: Permission to view only personal QuotaPath Earnings records

  4. Repeat the above steps for each user. Alternatively, you can follow these steps to bulk update the permission sets.

Opportunity Layout: (Optional) Go to Object Manager in Setup and choose Opportunity. In the Page Layouts, go to Related Lists, select QuotaPath Earnings and add to your Opportunity page layout.

How to Set Up QuotaPath

Before or after installing the QuotaPath app in your Salesforce instance, you'll also need to complete the below steps as part of your QuotaPath implementation alongside your Customer Experience Manager:

Salesforce Integration Connected: QuotaPath's Salesforce integration is connected on the Integrations page in Settings in your QuotaPath workspace. For more information on setting up the Salesforce integration, please visit this article.

Plans Mapped to Salesforce Integration: Compensation plans are built and mapped to the connected Salesforce integration source.

QuotaPath Deals Closed Won: QuotaPath earnings records are 'closed won'.

Earnings Approved: Earnings are approved from the Deals or Payouts pages. (If approval workflow is turned off, ignore this step.)

QuotaPath Earnings records will start to appear in your Salesforce instance as soon as they are approved. Currently, payout eligibility and payout data will not appear in QuotaPath Earnings records. In addition, since QuotaPath Earnings records are associated to Opportunities in Salesforce, any manually added deals or payouts in QuotaPath will not appear in Salesforce. If a QuotaPath clawback record is associated to Salesforce Opportunity record, then it will appear in Salesforce as well.

How to Sync Data

QuotaPath Earnings data will be automatically refreshed every night at midnight for the last year. In addition, you can use the 'QuotaPath Sync' action in Salesforce to trigger a manual sync - found at the bottom of the app section. The 'QuotaPath Sync' action will appear when viewing the QuotaPath Earnings application in Salesforce:

You can choose to sync data for one of the following time periods: This Month, Last Month, This Year or Last Year.

Syncing data will call the QuotaPath API, which means that it does not affect your Salesforce API usage.

Optionally, you can also add the 'QuotaPath Sync' action to your Global Action menu for quick access.

How to Uninstall

In order to uninstall the QuotaPath App in your Salesforce instance, go to 'Installed Packages' in Setup, and select 'Uninstall' next to the QuotaPath Earnings package.

Did this answer your question?