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.
Before proceeding with the installation, you must enable the native Salesforce Quotes feature. (Note: You can enable the Quotes feature even if you do not plan to use it.)
To enable the Quotes feature:
Log in to your Salesforce.com account.
Click the Setup menu (gear icon in the top right corner).
In the left sidebar, navigate to:
Customize → Quotes → Quote Settings
On the Quote Settings page, check the box to enable Quotes.
Click Save.
After enabling Quotes, you can proceed with installing the BluSynergy package.
Fig 1.1. Navigate to Quotes
Fig 1.2. Enable Quotes
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 does not use the Quotes functionality, you may leave the Page Layout unassigned. This will ensure that there are no changes to your existing screens or workflows.
Once the prerequisite is complete, you can begin the installation process.
Log in to your Salesforce organization.
In your browser’s address bar, append the following installation URL to the Salesforce home page URL (after .force.com):
/packaging/installPackage.apexp?p0=04tKb0000002H6j
Press Enter to navigate to the installation page.
Follow the on-screen instructions to install the BluSynergy Salesforce Connector Version 2.98.
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 or as seen below.
Once you got mail then you can start further steps to setup.
Fig 3. Install Complete.
3. Configure a New Remote Site
Step 1: Navigate to Setup
Click the Gear Icon (⚙️) in the top-right corner.
Select "Setup".
In the Quick Find box (left-hand menu), type Remote Site Settings.
Click on Remote Site Settings under the Security section.
Fig 4.1. Navigate to Remote Site Settings
Click the "New Remote Site" button at the top.
Fig 4.2. New Remote Site Settings
Fill in the required information:
Remote Site Name: A unique name (e.g., BluSynergy_Billing_Site)
Remote Site URL: The full base URL of the BluBilling site url of your organization (e.g., https://api.blusynergy.com)
(Optional) Add a description for clarity.
✅ Ensure the "Active" checkbox is selected.
Fig 4.3 Remote Site Settings
Fig 4.4 Remote Site Settings Saved
4. Create a Connected App
To enable communication between Salesforce and the BluBilling API, a Connected App must be configured within Salesforce.
Navigate to Setup by clicking the gear icon (⚙️) in the top-right corner.
In the Quick Find box, type "App Manager", then select App Manager from the results.
Fig 5.1 Create connected App
Fig 5.2 Create connected App
Click on "New External Client App" Button to start creating connecting app.
Enter APP Name, Email and OAuth Settings and save the all details
Fig 5.3 Create connected App
Fig 5.3(1) Create connecting App
After creating the Connected App, you must retrieve the Consumer Key and Consumer Secret, which will be required later to authorize the integration with the BluBilling API.
Fig 5.3(1) Create connecting App
Fig 5.3(2)
Fig 5.3(3)
This screen appears when you are connected and have already created a record before the Salesforce Summer ’24 Connected App changes.
Consumer Key and Consumer Secret are generated.
Fig 5.3(4)
5. Configure BluSynergy For Salesforce
To integrate BluSynergy with Salesforce, follow the steps below:
➡️ Navigation Path
Go to:
System → Integration Settings → SalesforceCRM
🔔 Outbound Notifications
Enable Outbound Notifications to allow BluSynergy to send event updates to Salesforce.
🔐 Salesforce Credentials
Enter the Salesforce Username and Password used for authentication from BluSynergy to Salesforce.
💬 Chatter Integration (Optional)
Enable Chatter Post to send Chatter feeds to Salesforce for key events, such as:
Invoice generation (onInvoiceGenerate)
Customer balance changes.etc
🌐 Salesforce Environment
Enable Salesforce Production if you're connecting to a Production Org.
Leave it unchecked if you're integrating with a Sandbox environment.
📤 Invoice Export (Optional)
Enable Invoice Export to push invoices from BluSynergy to Salesforce.
📈 Commission Export (Optional)
Enable Commission Export if commissions are configured and need to be visible in Salesforce.
⚙️ API Version
Select the Salesforce API Version matching your Salesforce installation.
👤 Person Account Configuration (Optional)
If using both Business and Person Accounts, specify the Record Type ID for Person Accounts in the field:
“Salesforce Record ID for Personal”
Refer to the help tooltip for guidance.
💾 Save Configuration
Click the "Save" button to apply and store your integration settings.
Fig 6: Salesforce CRM configuration in BluSynergy
6. Configure Connector Options
Navigate to the App Launcher and search for “BluSynergy Configuration”.
Once inside the app, click on the "Organisation Settings" button, as highlighted in the circled areas below.
Fig 7: Configure Connector Options
To complete the integration, add the Salesforce connection details to your BluSynergy Package configuration by following the steps below:
➡️ Step: Add Salesforce Credentials to BluSynergy
Use the Salesforce Username and Password configured earlier in BluSynergy.
(These were set during the Salesforce Integration Configuration, see Step 5 above.)
Fig 7.1: Configure Connector Options
Fill all information and save it.
Figure 7.2 below illustrates the various configuration options available for the connector.
Please note that these settings are global and apply to all authorized Salesforce users with access to the connector.
Fig 7.2: Configure Connector Options
After saving the above settings, return to the previous screen and click the "Configure Inbound Integration" link.
Enter the Salesforce Consumer Key and Salesforce Consumer Secret obtained in Step 4 (shown in Image 5.3(4)), then click the "Verify" button to complete the authorization process.
Note:
To successfully complete verification, you must authorize the app for use in your Salesforce organization, profile, or user account.
You have a few options for authorization:
Authorize for all users in the org:
Go to Setup > Manage Apps > Connected Apps, edit the app, and set Permitted Users to "All users may self-authorize."
Authorize only for a specific user profile (e.g., System Administrators):
In the same area, click the app label (e.g., BluSynergy), and add your desired profile to the list of authorized profiles.
Authorize only for specific users via permission set:
Add a permission set to the authorized list, then assign that permission set to individual user accounts. This allows selective access.
Fig 7.3: Configure Connector Options
After successful verification, you will be prompted to grant permission for BluSynergy's requests. Click on 'Allow' to proceed.
Fig 7.4: Configure Connector Options
You will be redirected to "Thank you" page.
Note:
If you encounter the following error:
error=redirect_uri_mismatch&error_description=redirect_uri%20must%20match%20configuration
It typically means that the Callback URL entered in Step #4: Create a "Connected App" in Salesforce does not match the endpoint URL shown in Figure 5.3(1) above.
To enable BluSynergy features on the Salesforce Account page, you have two configuration options:
Option 1 – Assign the BluSynergy Account Page Layout
This layout includes the necessary buttons, links, and fields required for BluSynergy functionality. This option is ideal if your Salesforce Account page has not been heavily customized.
You can apply it by navigating to:
Object Manager → Account → Page Layouts → Page Layout Assignment → Edit Assignment
Fig 8.1 Assigning Page Layout by Profile
Option 2 – Use a Custom Page Layout
If you have already customized your Salesforce Account page, you may prefer to control the placement and visibility of BluSynergy related fields and buttons manually.
You can either:
Contact BluSynergy Support for assistance with this configuration, or
Have your Salesforce Administrator customize the layout as needed.
To do this, navigate to:
App Setup → Customize → Accounts → Page Layouts
Then use drag-and-drop to place the relevant fields and buttons from BluSynergy onto the desired sections of the page layout.
fig 8.4 dragging fields and buttons onto account page.
fig 8.4: account page with new fields added.
Drag and Drop Invoices And Payments From the Related List Menu(Showing in fig 8.6)
fig 8.6 account page with Related List of Invoices And Payments.
To display BluSynergy features on the Salesforce Lightning Account page, you’ll need to either use the default Lightning page provided by BluSynergy or customize your own Lightning Record Page.
Option 1 – Use the Default BluSynergy Lightning Page
If you haven’t made custom changes to your Account Lightning pages, you can activate the default BluSynergy Lightning Record Page, which includes pre-configured components.
Steps:
Navigate to Setup → Object Manager → Account → Lightning Record Pages
Fig.9.1
2. Click Activate, then choose whether to assign it:
As the Org Default
As the App Default
Or for specific Profiles
Option 2 – Customize Your Own Lightning Page
If you’ve already customized your Lightning Record Page, you can manually add BluSynergy components to your existing layout.
Steps:
Go to an Account record in Lightning Experience.
Click the gear icon (⚙️) → Edit Page
In the Lightning App Builder, drag and drop the appropriate BluSynergy Lightning components from the left panel onto your page layout.
Components may be named like "Make a Payment", "Configure Billing Account", "Show Billing & Payments", etc.
If you're unsure which components or buttons to add, please contact BluSynergy Connector Support for guidance.
Click Save, then Activate the page (if it’s not already active).
Tip: You can assign the custom page by app, record type, or user profile for better control.
Fig.9.2
You can follow the same steps to configure Lightning pages for other objects such as Payments, Orders, and Invoices by adding the relevant BluSynergy components to those record pages.
To ensure accurate data mapping, there must be a single field in the Salesforce Account object that corresponds to the BluSynergy Customer Account Number.
The connector automatically creates a field named "BluSynergy Customer No" in the Account object during installation. You will need to configure a workflow rule to copy your user-defined Salesforce field into this BluSynergy field.
Steps to Create the Workflow Rule:
Navigate to:
Setup → Build → Create → Workflow and Approvals → Workflow Rules → New Rule
Select Object:
Choose Account
Enter Rule Name:
BluSynergy Customer No Sync
Evaluation Criteria:
Select "created, and every time it’s edited to subsequently meet criteria"
Rule Criteria:
Set the condition:
Account: BluSynergy Customer ID not equal to null
Fig 9.1. Blusynergy workflow for Salesforce connector
After setting the workflow rule criteria, proceed with the following steps to complete the field mapping:
Save the Workflow Rule.
Click "Add Workflow Action", then select "New Field Update".
Enter a name (e.g., BluSynergy Customer No Update) and unique name for the action.
For Field to Update, select:
Account field → BluSynergy Customer No
Choose the option:
"Use a formula to set the new value".
In the formula editor, enter the API name of the Salesforce Account field you want to map.
For example, if you're mapping from the Account Number field (as shown in Figure 9.2), enter:
AccountNumber
You may substitute this with any other custom or standard field of your choice.
Save the Field Update and then activate the workflow rule.
To confirm the setup works correctly:
Create a new Account record.
Enter a value into the field you've mapped (e.g., Account Number).
Save the Account.
Upon saving, the BluSynergy Customer No field should automatically update with the same value you entered.
Fig 9.2. Blusynergy workflow for Salesforce connector
Once you add 'field updates', it will be displayed in the Workflow field updates table.
11. Synchronize the IDs for your existing Customers/Accounts
If you have existing Customers in BluSynergy or Accounts in Salesforce that need to be mapped, you will need to perform a data synchronization. This process ensures that the system identifiers from each platform are properly cross-populated in the other system.
Note: Please contact BluSynergy Professional Services to perform this synchronization accurately and efficiently.
This concludes the setup and configuration process.