Skip to content

Installation Instructions

Preparations

Add limepkg-engage Dependency

  • Add limepkg-engage to your solution
poetry add limepkg-engage

Create a Lime Admin User

  • Go to the Engage user registration page

  • Fill out the details of the form as follows:

    • **Email: ** limeadmin@<customerdomain>
    • **First Name: ** Lime
    • **Last Name: ** Admin
    • **Organization Name: ** Any appropriate organization name

This will make the lime admin user an “Account Owner” for Engage. Don't worry we will add the customer as an “Account Manager” in the next step.

Save the User Credentials

Please save this email and password in Password State on the customers card.

You will now be able to login with this account and you'll land on an empty Dashboard.

Create a Customer User

You must be logged in as the Lime Admin user for this step

  • From the dashboard page click on the Lime Admin name and image in the upper right corner and navigate to Manage Organization
  • Click the Create New User button to open the user creation form
  • You will be asked to add a Name, Email and Password. Do not use your own information, instead use the information of person at the customer who will be responsible for Engage. Make sure you select Power User for the Account Role. That way they the person will also be an “Account Owner” for Engage.

Save the User Credentials

Please save this email and password in Password State on the customers card.

Generate Engage API Key

You must be logged in as the Lime Admin user for this step

  • From the dashboard page click on the Lime Admin name and image in the upper right corner and navigate to Edit Profile
  • Navigate to API Access Token via the left side menu
  • Generate a new API token and save it to Password State somewhere on the Lime Admin user

Connect CRM to the Engage API

Engage uses application configuration to manage api credentials.

On Premise Installation

  • Enable application configuration by adding the application_configuration feature flag to your web server and event handler config.yaml files. It should look something like:
features:
  application_configuration: true
  • Create or open %programdata%\Lundalogik\LIME Pro Server\application_config.yaml.
  • Update the application_config.yaml file and add an engage section to the secrets configuration. In the engage section you will need to add an entry api_key: <api-key-generated-earlier> using the api key that was generated earlier. The application_config.yaml should look something like this:
<application-name>:
  secrets:
    engage:
      api_key: <api-key-generated-earlier>

Note: Remember to replace <application-name> with your application name.

Cloud Installation

  • Application configuration in cloud is configured via CAFE (Cloud Admin Front End)
  • Open the CAFE page for your solution
  • Edit the secrets configuration and add an engage section with the entry api_key: <api-key-generated-earlier>. Your secret configuration should look something like this
engage:
  api_key: <api-key-generated-earlier>

Managing Engage Users

Lime FAQ Manage Users In this FAQ you fill find information about

  • Adding Users
  • Bulk Importing Users
  • Activating/Deactivating Users
  • Deleting Users
  • Changing Users Roles

Lime FAQ Using Tags In this FAQ you will find information about Tags. It is recommended that you add Tags to users for easier user management and competition creation.