Skip to content

Configuration

This is the suggested configuration for the base solution in Lime Admin.

{
  "limetypes": [
    {
      "name": "person",
      "relations": [
        {
          "name": "consent",
          "defaultsource": "coworker",
          "propertyApproved": "approved",
          "propertyDate": "date",
          "propertyNote": "note",
          "propertySource": "source",
          "propertyConsenttype": "consenttype"
        }
      ]
    }
  ],
  "consenttype_limetypes": [
    {
      "name": "consenttype",
      "propertyActive": "active",
      "propertyDefault": "default",
      "propertyDescription": "description",
      "propertyReadonly": "readonly",
      "propertyTitle": "title"
    }
  ]
}

Limetypes

A list of the limetypes that consent should be enabled on. In most cases this is the person limetype.

Parameter Value
name Name of the limetype this consent configuration is for.
relations List of relations to consent on this limetype. In most cases there is only one relation.

Relations

A list of all consent relation properties on the limetype. In most cases this relation is called consent, but it's possible to have multiple relations.

Parameter Value
name Name of the relation property on the limetype that relates to consent.
defaultsource Setting for the default source on a consent if no source is explicitly set.
propertyApproved Name of the boolean property approved on consent.
propertyDate Name of the date property date on consent.
propertyNote Name of the text field property note on consent.
propertySource Name of the option property source on consent.
propertyConsenttype Name of the relation property on consent that relates to a consenttype.

Consenttypes

For each limetypes.relations.propertyConsenttype relation property configured, the consenttype limetype that the relation points to must be configured as below!

Consenttype limetypes

A list of consenttypes that consent can relate to via it's propertyConsenttype relation. In most cases there's only one consenttype configured.

Parameter Value
name Name of the limetype of this consenttype.
propertyActive Name of the boolean property active on consenttype.
propertyDefault Name of the boolean property default on consenttype.
propertyDescription Name of the text field property description on consenttype.
propertyReadonly Name of the boolean property readonly on consenttype.
propertyTitle Name of the string property title on consenttype.

In Lime Admin, go to Views > limetype consents configured for > table. Under "Actions" add the following:

  • action id: limepkg_consent.create-consents
  • action label: limepkg_consent.create-consents