Skip to content

Installation Instructions

Preparations

Installation

This is your checklist during the installation.

  1. Create Lime Connect account.
  2. Add limepkg-userlike as a dependency to your solution.
  3. Build and deploy your solution.
  4. In Lime Admin, go to the Setup page in Lime Connect's settings and follow the instructions.
    • If you're only planning on using the "Portal", it is enough to install Users and Groups and then skip to Portal
    • Create an instance for each limetype the installation should target. Choose whether media files should be imported as documents, and if so, configure the document limetype.
  5. Configure the add-on.
  6. Configure in LISA.
  7. Configure Lime Connect.
  8. Configure Desktop Client.

Lime Connect Account

Start with creating a free trial account from Lime Connect's homepage.

Use the format:

Sign-up Sheet Name Value
First name Lime
Last name Admin
Email address userlike\<customername>@lime.tech
Password Generate from Keeper

After you have created the trial account. Notify Lime Connect by filling in this form. Lime Connect will change the account from a trial account into the correct type based on input values. If you can't get past this step, contact tim.berghoff@userlike.com.

LISA

Descriptives and Icons (If Lime CRM Desktop Client)

  1. Add the descriptive expression found in legacy/lip/lisa/descriptives/ulconversation.txt to the ulconversation table.
  2. Add the icon found in legacy/lip/lisa/icons/userlike.ico to the ulconversation table.

Additional Data Structure

  1. Make sure the length of the note field on the history limetype is set to max (set length to 0). The history note will be truncated with ... if the chat transcript doesn't fit.

Policies

  1. Create one new table specific policy called tbl_conversation and apply that policy on the conversation table.

  2. Set the following privileges for the groups that should be able to use Lime Connect in Lime CRM:

    Policy name R W A D Apply to
    tbl_conversation • • • conversation table

    Note

    Using Lime Connect in Lime CRM means that the user can manage conversations in Lime CRM. For example, connect a new conversation to a limeobject that already exists.

API User

Go to policies and set the correct privileges for the (System) Userlike integration group on each table policy. This is an example of common settings:

| Read | Write | Add | Delete | Apply to |
|-|-|-|-|-|
| • | • | • | | Conversation table |
| • | • | • | | History table |
| • | • | • | | ALL tables that are configured as instance limetypes. Typically: helpdesk, deal |
| • | • | • | | Document table - if you want to import media files as documents in Lime CRM |
| • | • | | | Person table - if you want to attach the identified person to the created instance limeobject and to the created history notes |
| • | • | | | Coworker table - if you want to attach the identified coworker to the created instance limeobject and to the created history notes |
| • | • | | | Company table - if you want to attach the identified person's company to the instance limeobject and to the created history notes |

Lime Connect

Configure Lime Connect according to these instructions.

  • Enter this as the Lime CRM URL: <SERVER_URL>/<APP_NAME>/limepkg-userlike/userlike/.
  • From the installation report copy the generated API key for the newly created userlike@lime user and use it as token.

Desktop Client

The desktop app uses the same configuration as the web client but the following steps are required to enable the desktop version.

  1. Add VBA module AO_Userlike.
  2. Add LBS apps addon_userlike to your Actionpad apps folder.
  3. Use the following example in your GeneralExplorerHandler to hijack the new conversation command in Lime CRM (adjust ulconversation if you are using another limetype):
    Private Sub m_Explorer_BeforeCommand(ByVal Command As CommandEnum, ByVal Parameter As Variant, Cancel As Boolean)
    On Error GoTo ErrorHandler

    If Not m_Explorer is Nothing Then
        If m_Explorer.Class.Name = "ulconversation" Then
            If Command = lkCommandNew Then
                Cancel = True
                Call AO_Userlike.OpenDialog
            End If
        End If
    End If

    Exit Sub
ErrorHandler:
    Call LC_UI.ShowError("GeneralExplorerHandler.m_Explorer_BeforeCommand")
End Sub

Info

You might need to enable that VBA events are caught also for explorers on inspectors if you are running an old Lime Base, read more here.

Portal

The Portal displays CRM data about the contact directly inside the Lime Connect operator view. Follow these steps to set it up.

1. Generate a JWT Shared Secret

In Lime Admin, navigate to the Portal section of the Lime Connect runtime config. Use the built-in JWT Secret Generator to generate a shared secret. Copy the generated secret — this step only displays it, it does not write it to the application config.

2. Set the JWT Shared Secret in Application Config

Add the generated secret to the application config under secrets.limepkg-userlike.portal_jwt_shared_secret. See Portal Application Config for on-premise and Cloud instructions.

3. Configure Portal Views and Lookup

In Lime Admin, configure which limetypes, properties, aggregations, and lookup rules the portal should use. See Portal Configuration for details.

4. API User Permissions

The (System) Userlike integration group (userlike@lime) needs Read access to all limetypes configured in the portal views and lookups. Update the API user policies accordingly.

Note

If you are upgrading an existing installation, make sure to add Read access for the portal limetypes. The API user may already have permissions for instance limetypes (helpdesk, deal, etc.) but might be missing access to limetypes only used in the portal (e.g., person, company).

5. Configure Lime Connect Custom Panel

In Lime Connect, set up a custom panel with the following settings:

Setting Value Comment
Name Lime CRM A display name for the panel tab e.g., "Lime CRM", or "Customers' CRM"
App URL <SERVER_URL>/<APP_NAME>/limepkg-userlike/portal/client/
Icon URL https://cdn.lime-crm.com/packages/@lundalogik/lime-webclient/46.2027.1/dist/assets/favicons/favicon.svg
API version 2 2 or higher is required
JWT signing key The same secret generated in step 1

Lime Connect custom add-on configuration step 1

Lime Connect custom add-on configuration step 2