1) Installing the BluSynergy Package in Salesforce

This section covers the installation process for the BluSynergy Salesforce application. 

Please note that you need "Billing Administrator" authorization in BluSynergy and System Administrator authorization in your salesforce.com profile.

1. Install Package

After logging into salesforce.com, before proceeding to installation, enable the native Salesforce Quotes feature by following the below steps. (Note - You can enable the Quotes feature without using it).

Click the Setup menu and then on the left sidebar menu, click the [Customize >> Quotes >> Quotes Settings]

Fig 1.1. Navigate to Quotes

Fig 1.2. Enable Quotes
Then select the Enable Quotes checkbox. Without this setting enabled, you will not be able to install the package.

Fig 1.3. Assign Quotes Related List to Opportunity Page Layout
If your organization is not using the Quotes functionality, you can leave the Page Layout unassigned and there will be no changes on your screens.

Once the above pre-requisite is complete, click on the link below to begin the installation process.

BluSynergy Salesforce Connector Version 2.27

After login your Salseforce org,  add above mentioned URL right next to force.com on your home page URL to install the package.


If your URL is https://yourDomain.lightning.force.com/lightning/page/home, use below URL to install package


Contact BluSynergy support to get the password to install the package.

2. Configure Access Level

Fig 2. Package Installation

In the above screen you are prompted for the Security Level. Select "Install for All Users" and click "Install" to continue. If you wish to give only specific users access to the billing and payment information, then you may create a Salesforce profile with the appropriate permissions. (review the Salesforce documentation on how to configure this).

3. Confirm Installation Complete

On successful install, you should have a confirmation message as seen below.

Salesforce recurring payments

Fig 3. Install Complete.

4. Create New Remote Site

    Next step would be to create New Remote Site, Click on "Remote Site Settings" as show in the image.

    Fig 4.1. Navigate to Remote Site Settings

    Click on "New Remote Site" as shown in the image below
    Fig 4.2. New Remote Site Settings

    Enter BluSynergy_Billing_Site in the Name and BluBilling site url of your organization in the Remote Site  URL

    Fig 4.3 Remote Site Settings

    Fig 4.4 Remote Site Settings Saved

   5. Create Connecting App

    A Connecting App should be created in Salesforce for the Package to communicate with the BluBilling API.

    Go to Apps page by clicking on the link in left menu as shown in below image

    Fig 5 Create connecting App

    Click on "New" Button to start creating connecting app.

    Fig 5.1 Create connecting App

Enter APP Name, Email and OAuth Settings

    Fig 5.2 Create connecting App

    Obtain Consumer Key and Consumer Secret which will be used later to authorize the app
    Fig 5.3 Create connecting App

    Consumer Key and Consumer Secret are generated.
    Fig 5.4 Create connecting App

    6. Configure BluSynergy For Salesforce

    Navigate to [ System >> Integration Settings >> SalesforceCRM ]

  1. To Configure WIth Salesforce follow these steps
  2. Select the Enable Outbound Notifications.
  3. Fill Username and password for connecting with BluSynergy from Salesforce.
  4. Select the enable Chatter Post for sending chatter feed from BluSynergy to Salesforce on some events Like :- onInvoiceGenerate, Customer balance changed. etc
  5. Enable Salesforce Production if you are using production account instead of Sandbox of salesforce.
  6. Enable Invoice Export if you want to export Invoices to Salesforce.
  7. Enable Commission Export: if you enabled Commission and you want to see commission on Salesforce.
  8. Select SF version number that you are installing.
  9. If You have Configured Business And Personal Account in Salesforce then add Person Record ID in "Salesforce Record Id For Personal"  See help on this field
  10. Hit "Save" button to save setting.
    Fig 6: Salesforce CRM configuration in BluSynergy

    7. Configure Connector Options

     Navigate to the "+" tab and click the "BluSynergy" link as shown in the circled areas below


      Fig 7: Configure Connector Options


    Add integration information to the Package set in previous steps by following below mentioned steps:

    1. Add username and password from Salesforce configutation in BluSynergy [set in STEP 6]

    2. Click on the link "Configure Inbound Integration"

    3. Enter Salesforce Consumer Key and Salesforce Consumer Secret obtained from Connecting App in Salesforce [set in step 5, shown in image 5.3]

    4. Click on "Verify" Button to complete the authorization process

Fig 7.1: Configure Connector Options

Fig 7.2. below shows the various options available for the connector. Note that these settings apply to all Salesforce users that have authorization to view the connector. 

 Show Navigation BarIf true, then the connector will show the navigation menus for "Statements", "Payments" and "Add a Payment Method". If false, then limited hyperlinks will be available to view the list of invoices or payments.
 Show Statements If false, then the user will not be able to view their statements/invoices
 Show Payments If false, then the user will not be able to view their previous payments
 Allow Payments If false, then the user will not be able to make a payment towards any outstanding invoices.
 Allow Profile Edit  If false, then the user will not be able to change the billing contact information. Note that this billing contact information is updated in the BluSynergy system only.
 Edit Order Options  Can be one or more of these values Cancel,Upgrade,Downgrade,New with regard to changing or creating Orders. 
 Note: "New" implies the creation of new orders via the Salesforce.com connector. This option is only recommended for very simple Plans (where the amount is entered in the Plan/Charges and only the Quantity needs to be entered during order capture.) It is specifically not supported for more complex Plan/Charge configurations such as "Tiered pricing", "Amount Entered at Order Placement", etc.
 PDF Mode If true, then the links on the History and Statement pages will show the invoice and payment receipt in PDF mode only (as opposed to being able to view a HTML webpage that has a separate "Download PDF" link)
 Login Url The URL to redirect if the session is expired. Do not change the default value unless instructed by BluSynergy support
 CSS Url The stylesheet to use for altering the UI (look and feel) properties of the connector screens. Do not change the default value unless instructed by BluSynergy support
 Username This username corresponds to a user in BluSynergy that has the Web Services API access (from Step 6 above OR alternatively from the [System >> Staff] menu)
 Password The password for the above credential
 Export Account to BluBilling When should an Account export to Blubilling. Default set to "Manual" where it will be exported by clicking "Configure Billing Account" button from Account page.
 Billing Contact Selection This selection defines which contact should consider as customer Billing contact.

After you save the above settings, go back to the previous screen and click on the link "Configure Inbound Integration". Enter the Salesforce Consumer Key and Salesforce Consumer Secret obtained from Step 5.

Click on "Verify" Button to complete the authorization process.

Notes: To make verification successful, you'll need to authorize the app in your organization, your profile, or your user.

  • To authorize all users in the org, you can go to Setup > Manage Apps > Connected Apps, edit app, and set Permitted Users to "All users may self-authorize."
  • To authorize usage just for your user profile (e.g. System Administrators), go to the same area, but click on the label of the app (BluSynergy), then add your profile to the list.
  • You could also add a permission set to the list, then add the permission set to your user account. This will enable access just for you.

ig 7.4: Configure Connector Options

After successful verification you will be asked for permission to allow BluSynergy's requests. Click on "Allow".

You will be redirected to Thank you page.

Note: If you see this error:
Then the typical cause is that the callback URL in In step #6 Create a "Connected App" in Saleforce does not tally with the endpoint URL in fig 7.3 above.

8. Configure Account Screen

In order to have the BluSynergy features show up on the Salesfoce "Account" page, you have two options:
  • Option 1 - Assign the BluSynergy Account page layout that provides the appropriate buttons, links, fields, etc. This option is suitable if you have not customized your Salesforce Account page. This is accessed via [AppSetup >> Customize >> Account >> Page Layouts >> Page Layout Assignment >> Edit the Assignment] screen.

Salesforce page layout for BluSynergy subscription billing connector
Fig 8.1 Assigning Page Layout by Profile

Account View Mapping in Salesforce.com

Fig 8.2 Account View Mapping in Salesforce.com

Fig 8.3 Account View Mapping in Salesforce.com

  • Option 2 - On the other hand, if you have customized your Salesforce Account page, then you may wish to control the placement and availability of various BluSynergy fields and buttons on your Salesforce Account webpage. Contact BluSynergy support for this option or have your Salesforce administrator customize the screen layout. This is done by going to [App Setup >> Customize >> Accounts >> Page Layouts] and dragging and dropping various "fields" and "buttons" on the screen template.
    fig 8.4 dragging fields and buttons onto account page.

fig 8.5 account page with new fields added.

fig 8.6 account page with Related List of Invoices And Payments.
Drag and Drop Invoices And Payments From the Related List Menu(Showing in fig 8.6)

9. Configure the Workflow to Map the Appropriate Salesforce field to the BluSynergy Customer Account Number

There needs to be a single field in your Salesforce Account object that maps to the BluSynergy Customer Account Number. A workflow is utilized to copy this user defined field into the "BluSynergy Customer No" field in the Salesforce Account object. This field is automatically created by the connector during installation.

Go to [SetUp >> Build >> Create >> Workflow and Approvals >> Workflow Rules >> New Rule] and 
  • Select the Object Account 
  • Enter the name of the rule: “BluSynergy CustomerNo Synch” 
  • Evaluation Criteria: Select “created, and any time it’s edited to subsequently meet criteria” 
  • Rule Criteria : “Account: BluSynergy Customer ID” not equal to “null” 

Blusynergy workflow for Salesforce connector

Fig 9.1. Blusynergy workflow for Salesforce connector

Then, continue with the following steps:
  • Save the rule. 
  • Edit the Workflow Action 
  • Click on Add Work Flow action then click on “add new field update” 
  • Enter the name and unique name the select the field to be updates as “BluSynergy Customer No” and then check the radio button “Use a formula to set the new value”. 
  • Then enter the field name of your Salesforce Account object that you wish to map to the BluSynergy Customer No (it is "Account Number" in Fig 7.2 below but you could map it to any field of your choice).
  • Finally you need to verify that this is working by creating a new Account, and assigning a value to your chosen field. On saving the account, the "BluSynergy Customer No" field should be updated to the same value as well.
Salesforce workflow for BluSynergy recurring billing connector

Fig 9.2. Blusynergy workflow for Salesforce connector

Once you add 'field updates', it will be displayed in the Workflow field updates table.

10. Synchronize the IDs for your existing Customers/Accounts

If you have existing "Customers" in BluSynergy or "Accounts" in Salesforce that need to be mapped, then you will need to perform a data synchronization so that the system identifiers from each system is cross populated in the other system. Contact professional services for this task.

11. Create Salesforce Tabs for Invoices and Payments 
Go to [Setup >> Create >> Tabs >> Custom Object Tabs(section) >> New >> Select Object and Style >> Next >> Add to profiles-> Next->Save.

fig 11.1 creating custom tabs

 Select the object and create new tab.

fig 11.2 select object

Click on "Next" and finish creating custom tabs.

This concludes the setup and configuration process.