Skip to content

Installation Instructions

Preparations

Installation

  1. If on-premise or isolated app in cloud:
    • Add the package limepkg-consent as a dependency in your solution.
    • Build and deploy your solution.
  2. In Lime Admin, go to the Setup page in Consent's settings and follow the instructions.
  3. Configure the add-on.
  4. Configure in LISA.
  5. Set up desktop client.

Setup

The setup chooses which limetypes get consent. Each chosen limetype X gets a relation X.consent to consent.X, the consent view gets its parts for X, and the consent config gets a relation named consent for X.

  • Default: the limetypes that consent already belongs to, or person when there are none. An existing installation gets exactly what it already has.
  • Limetypes are never removed. Consent keeps every limetype it already belongs to, so leaving one out of the setup changes nothing. It stays in the database, the views and the config. Remove a relation by hand in LISA if you really want it gone.
  • The config is merged. Only the chosen limetypes are added to the config, so consent isn't turned on for a limetype that another package gave a relation to consent. Relations and consenttypes that are already configured are kept as they are. A new relation gets the default source empty, and maps consent's fields the way an existing relation does.
  • Manual steps. Limetypes that can't get consent are listed as manual steps instead of being installed:
    • Limetypes named after consent or one of its fields, such as source or note.
    • Limetypes where X.consent or consent.X already exists but isn't the relation between them.
    • Limetypes that consent already belongs to under another name.
    • New relations when the source field isn't an option field with the key empty.
  • One owner per consent. With more than one limetype, a consent's card and the dialog that creates it show only the owner the consent belongs to. A consent created without an owner, such as from the consent list, shows every owner to pick from. This needs the webclient feature switch useRuleVisibility, and for the dialog, Lime CRM 3.102 or later. Without the switch every owner shows, as before. Turn the switch on before you run the installer: the consent view is saved without the rule while the switch is off, whether by the installer or in Lime Admin.
  • Other packages, such as Lime Marketing, can install consent for their own limetypes with the same installer. Once they do, the database structure and views are the same whichever package installs consent.

Desktop client

The desktop client's VBA module and Lime Bootstrap apps only support consent on person.

LISA

  1. Add the icons for the tables consent and consenttype. The icons are found in the folder lisa\icons in the LIP package. If you cannot find the tables in LISA, refresh the browser.
  2. Add descriptive expressions for consent and consenttype. The descriptive expressions are found in text files in the folder lisa\descriptives.
  3. Set the Option Query property on the field consent.consenttype according to the text file in the folder lisa\optionqueries.

  4. Set the following permissions for normal users.

    Policy name R W A D Apply to
    tbl_consent • • • consent table
    fld_consenttype • consenttype field on consent table
    tbl_consenttype • • consenttype table

Desktop Client

  1. Add VBA module AO_Consent, found under lip/vba.
  2. Copy the folders for the three Lime Bootstrap apps in the lip\apps folder to the Actionpads\apps folder.
  3. Add the apps:

Index App

Include the following code in your index.html (note the extra property 'view': 'index'):

<div data-app="{
    app: 'addon_consent',
    config:{
        'view': 'index',
        'groups': ['Administrators', 'Users']
    }
}"></div>

Person App

Include the following code on each actionpad of which Limetype you have configured for Consent (eg person.html):

<div data-app="{
    app: 'addon_consent',
    config: {
        'groups': ['Administrators', 'Users']
    }
}"></div>