Skip to main content

Set Up

Package Install

  1. Ensure you have an Admin user login for the Org to which you want to install the package
  2. Click on the Install Link provided by Metronome
  3. Authenticate into Salesforce with your username/password
  4. Select option Install for all Users
  5. Wait for installation to finish.
    • This process takes a varying amount of time, you may see the installation finish within a couple seconds or the request may time out (but continue to run) and you will then receive an email notifying you that the installation is complete
  6. After installation, any users that need access to the Metronome app will need to be added to the Metronome User Permission Set.
  7. Log into Salesforce and navigate through the App Launcher to the Metronome App

Data Sync

The following sections provide step-by-step instructions for how to install and configure the Metronome Salesforce Package.

Configure

  1. In the Configuration Options field input your Metronome Account API Key
    • Note, this field will never show as populated for security reasons
  2. Select the desired Window Size
    • The current version of the package only supports Day
  3. Click the Submit button
  4. Now refresh the browser

Start Scheduled Job

  1. Once the configuration is complete, click the Start button in the Package Start section of the Metronome Configuration page
  2. The Salesforce integration will now begin fetching data from your Metronome account
    • Jobs currently run daily at 3am local time.

Create a customer plan via Salesforce Flow

You can integrate Metronome into your sales process by associating your customers with a Metronome plan by using Salesforce Flow.

If you need help setting this up or more recommendations for how to do the data mapping, reach out to your Metronome representative.

Configure

Create a new Flow

A screenshot of the Flow configuration

If you are new to Flow Builder, please visit Salesforce’s page on how to build a flow.

  1. Navigate to Flows in Setup and click New Flow
  2. Choose Record-Triggered Flow
  3. Choose the object that should initiate the trigger.
    • If you want to create a customer plan when an opportunity is set to Closed Won, choose opportunity
  4. Trigger the flow when a record is created or updated
  5. Choose any conditions that are relevant to your sales process.
    • This could be when the opportunity stage name changes to Closed Won
  6. Optimize the flow for Actions and Related Records
  7. Click the check box that says Include a Run Asynchronously path to access an external system after the original transaction for the triggering record is successfully committed
    • The Metronome Apex Action runs in the background and can only run asynchronously

Add Apex Action

Now that the flow template has been created, click the plus icon under the Run Asynchronously flow and select Action

A screenshot of adding the Flow Apex action

Once you've added the action, you'll be prompted to configure the Metronome Submit Plan action.

A screenshot of the Metronome Submit Plan configuration

Fields can be set to a value or any variable that's available in Salesforce Flow. For more information on what variables are available, visit here.

Here are some common examples of variables that would be useful:

  • {!${Record.Account.Name} would capture the opportunity account name
  • {!$Record.Metronome_Plan__c.Metronome_Plan_ID__c}} would capture the Metronome Plan ID if a custom lookup field was on the opportunity

Data Mapping

If your customer plans contain price adjustments or credit grants, some data mapping will be required in order to successfully create a customer plan in Metronome.

The SOQL query in the Apex Action configuration is a place to capture anything custom that you may have on your contracts. In most cases, this would be opportunity product or quote lines. In order to associate a record to line item in Metronome, a custom field is required to associate a Metronome charge ID.

  • Metronome needs to know a way to associate a charge on a plan from a contract or quote in Salesforce. Products most closely resemble a Metronome charge. If a Product is added to each quote line, it makes sense to store this value on a Product.
  • Recommended field name: Metronome_Charge_ID__c
  • Charge IDs can be found via the List plan charges API endpoint

If you have multiple plans in Metronome, a plan will need to be selected during the sales process in order to associate it with a customer. A custom lookup field to NOME__Metronome_Plan__c can be added to the triggering record or any related object (i.e. quotes) and then referenced in the Flow action. charge IDs can be found via the List plan charges API endpoint

  1. Metronome plan ID
  2. Customer name
    • Recommendation: {!${Record.Account.Name} if using opportunity as the record
  3. Account ID
    • Recommendation: {!Record.AccountId} if using opportunity as the record
  4. Starting on
    • Date at which the contract should start
  5. Version (recommendation: 1. This will enable future functionality to have multiple processes with different data)
  6. SOQL query
    • The query used to gather the data necessary to create the contract
    • Sample SOQL query if using opportunity and opportunity products
    • NOTE: Each line item in your contract (e.g. quote line Items or opportunity products) will need to have a Metronome charge ID. This is required if you plan to have custom pricing.
  7. Search for the apex action named Metronome - Submit Plan
  8. Add Metronome plan IDs to your CPQ flow
    • When submitting a contract, a Metronome plan ID is required in order to associate a customer with a specific plan that you’ve created. If you’ve already configured the data sync, Metronome Plans should already be syncing to Salesforce. You can create a custom lookup field on an opportunity or quote to indicate which plan should be associated with the customer.
    • Recommended field name: Metronome_Plan__c
  9. Add Metronome charge ID custom field (only required if you have price adjustments. If you only use standard pricing on your plans, you can skip this step.)
    • Metronome needs to know a way to associate a charge on a plan from a contract or quote in Salesforce. Products most closely resemble a Metronome charge. If a Product is added to each quote line, it makes sense to store this value on a Product.
    • Recommended field name: Metronome_Charge_ID__c
    • Charge IDs can be found via the List plan charges API endpoint

NOTE: Customers can only be associated with an existing plan in Metronome. Creating custom plans on a per-customer basis is currently not supported.