How to Install and Set Up Limio for Salesforce

We're here to help you install the Limio for Salesforce managed package in your Salesforce org and integrate it with Limio and Zuora (if applicable). Follow the simple below to get started with Limio for Salesforce!

The information below is specifically for the initial installation of Limio for Salesforce into your Salesforce org. If you're upgrading the package, you only need to follow Step 1. The steps you've already completed will be saved and you won't need to do them again.

Step 1,2,3, 5, and 6 are necessary for Limio for Salesforce to work. Other steps are optional but may be important to achieve a required functionality (e.g. take credit card payments).

Necessary Steps

Install steps

Step 1: Install the package

Install the Limio for Salesforce Managed Package from the link provided by the Limio team. Please check the release notes Limio for Salesforce - Change Log for the relevant version you wish to install, and contact your CSM to confirm it.

The package is installed by appending the package unique link to the Salesforce instance, for example:

https://mycompany.my.salesforce.com/packaging/installPackage.apexp?p0=packageVersionId

When prompted, make sure to check "Install for All Users"

Integration steps

Step 2: Integrate with your Limio Commerce application

The next step is to connect Limio for Salesforce to your Limio Commerce application. This will involve setting up an Authentication Provider and Named Credentials in Salesforce. Follow all of the steps documented here: How to link your Limio and Limio for Salesforce applications.

Step 3 (optional): Configure Zuora hosted payment page

If agents use Zuora to process credit/debit card details or direct debit payments, a hosted payment method (HPM) page must be created in Zuora. Then, copy the Page ID of the HPM page you've created.

In Salesforce, navigate to Custom Metadata > ic Assist Config > Gateways. Edit the Config field and make sure that is in the following format, for each hosted page being configured:

{
  "paymentGateways": [
    {
      "paymentType": "xxxx-creditCard/directDebit",
      "name": "xxxx",
      "gatewayType": "Zuora",
      "gatewayName": "xxxx-thegatewayname",
      "availableRegions": [
        "xxx-listofregions"
      ],
      "availableCurrencies": [
        "xxx-listofcurrencies"
      ],
      "allowPrefill": false,
      "sfInstanceUrl": "",
      "gatewayConfig": {
        "URL": "xxx-yourzuorainstance",
        "PageId": "xxx-thepageid",
        "credentials": {
          "namedCredential": "ZuoraRestV2MI"
        }
      }
    }
  ]
}

A more in-depth guide on how to set up the Zuora HPM is available at How to create a new Zuora Hosted Payment Method to use in Limio for Salesforce

Step 4 (optional): Integrate with the Zuora application

Alright, to integrate Zuora into Salesforce using an iframe, you'd typically follow these steps after ensuring Step 3 is all set:

1. Go to `Setup` in Salesforce.
2. Enter `Named Credentials` in the Quick Find box and select `Named Credentials`.\
3. Click `New Named Credential`.
4. Provide the name `ZuoraRestV2MI`.
5. For the URL, enter the endpoint URL provided by Zuora. Follow the instructions provided by Zuora here.
6. Set the Identity Type to `Named Principal`, as it’s typically used for server-to-server communication.
7. Choose the appropriate Authentication Protocol such as Password Authentication for Zuora.
8. Fill in the required fields like Username and Password as provided by Zuora.
9. Save the Named Credential.

Step 5: Set up identity field

By default, Limio for Salesforce retrieves Subscriptions from Limio using the Salesforce Contact ID. If you use a different identifier or Person Accounts, you'll need to configure the correct identifier by following the provided instructions: How to specify what identifier to use to fetch Subscriptions from Limio.

UI steps

Step 6: Add Limio for Salesforce flow to a lightning app builder page

Limio for Salesforce consists of 2 main flows, the Acquisition Journey Flow and the Manage Customer Subscriptions Flow. In order to use the managed package capabilities, the 2 Flows should be added to a Lightning App Builder Page, or invoked by an action. The Flows must be added to either a Case, Contact, Account, or Person Account page.

Optional Additional Configuration Steps

Once steps 1-6 are completed, Limio for Salesforce is ready for use, but you can tailor the flows to your specific needs following our documentation: Customise Limio for Salesforce Flows .

Below are some of the possible customisation options:

Step 7: Add an external payment method (e.g. DTMF/IVR solutions)

If a custom payment method, that isn't a Zuora hosted page, is used, this can be configured with Salesforce flows. Instructions on how to do it can be found here Flow Customisation: Add a payment method selection and here Flow Customisation: Capture an additional payment

Step 8: Customise the customer subscriptions table

The customer subscriptions table comes with a set of pre-defined columns. More relevant columns can be shown instead, see how here: Flow Customisation: Subscriptions Table Columns

Step 9: Customise the offer catalog

The Limio for Salesforce offer catalog table has by default 4 columns, showing offer details. A more customised view can be tailored, based on the action being taken. Instructions can be found here: How to customise table columns in the Limio for Salesforce Offer Selector

Step 10: Create rules to filter intelligently the offer catalog

Similarly to the previous step, the offer catalog can be tailored to be loaded with specific filters, to find offers easily based on the specific journey. To configure it follow the instruction here: Create rules for filtering the Offer Catalog

Step 11: Set up cancel and refund reasons

As part of the cancel and refund journeys, custom reasons can be configured and captured. The following documents describes how to do it: Flow Customisation: add cancel reasons to the cancel journey, Flow Customisation: add cancel reasons to the cancel journey