Skip to content

Configuration

The configuration of the dynamic checklist refers to installation and configuration of the addon.
For instructions on how to build your checklist, go to How it works.

Configuration consists of these points:

  • Lime Admin
  • Template builder
  • Checklist

Lime Admin

General config

In Lime Admin you do general configuration of the addon. You will find the settings in Lime Admin > Settings > Dynamic Checklist

Configure Checklist Owner(s)

Here you declare which Limetypes are Checklist Owner(s) followed by Template Property. This will affect what limetypes that are available in the Template builder.

  • Owner Limetype refers to the limetype where the checklist should be visible E.g helpdesk.
  • Template Property is a related limetype to the Checklist Owner, e.g. helpdesktype. Each template property has one connected checklist template.

Example for helpdesk:

limeadmin

Danger

Want to add new checklist owner after installing? All Checklist Owners needs the initialize checklist automation and the required data structure.

Run the addon installer for the given checklist owner and make sure to add the Initialize checklist automation For more information see Automation section under installation.

History types

Automatic history

When checking/unchecking checklist items automatic history notes are created. Per default the checklist history type is used, but this can also be configured to use any other type.

Forced history

When using the Force history note on a checklist item Per default the comment history type is used, but this can also be configured to use any other type.

Security (Access)

In Lime Admin you do security configuration of the addon. You will find the settings in Lime Admin > Settings > Dynamic Checklist > Security

Template Builder Access (Groups allowed to use Checklist Template Builder)

Configure which LISA-groups that should have access to the Dynamic Checklist Template Builder.
Administrators doesn't not automatically have access, so don't forget to add them!

Template builder

Browser Menu Item

Add the checklist builder to the browser menu with this configuration:

{
    "path": "checklist-builder/",
    "title": "Checklist builder",
    "icon": "checklist",
    "color": "rgb(var(--color-cyan-default))"
}

Info

Note that the Browser Menu Item will be visible to all users. A user without access that navigates to the builder will be shown an 'Access denied' message.

Checklist web component

The checklist web component can be put in either a custom tab, or as a card property.

Card Property

  1. Add the checklist webcomponent lwc-limepkg-dynamic-checklist-limeobject to the read-only field checklist_template.
  2. Set the colSpan to 5 and rowSpan to 2.
  3. Configure the Template Owner Property, Checklist Template Property and Current Checklist Item Property
  4. [Optional] enable Soft Reset and Re-create for permitted groups.

Example

{
    "property": "checklist_template",
    "readonly": true,
    "visible": true,
    "visibleOnCreate": false,
    "notifyCoworker": true,
    "help": {
        "readMoreLink": {
            "target": "_blank"
        }
    },
    "layout": {
        "colSpan": 5,
        "rowSpan": 2
    },
    "component": {
        "name": "lwc-limepkg-dynamic-checklist-limeobject",
        "props": {
            "templateOwnerProperty": "helpdesktype",
            "checklistTemplateProperty": "checklist_template",
            "currentChecklistItemProperty": "checklist_item_current",
            "security": {
                "allowRefreshTemplate": [
                    "Administrators",
                    "Users",
                    "Superusers"
                ],
                "allowReCreate": ["Administrators", "Superusers"]
            }
        }
    }
}

webcomponentexample

Custom tab

  1. Create a new custom tab where the checklist should be shown.
    • title: limepkg_dynamic_checklist.checklist.title
    • icon: checklist
  2. Add the checklist webcomponent lwc-limepkg-dynamic-checklist-limeobject.
  3. Configure the Template Owner Property, Checklist Template Property and Current Checklist Item Property
  4. [Optional] enable Soft Reset and Re-create for permitted groups.

Example

{
    "title": "limepkg_dynamic_checklist.checklist.title",
    "icon": "checklist",
    "color": "rgb(var(--color-sky-darker))",
    "id": "custom-tab-5",
    "component": {
        "name": "lwc-limepkg-dynamic-checklist-limeobject",
        "props": {
            "templateOwnerProperty": "helpdesktype",
            "checklistTemplateProperty": "checklist_template",
            "currentChecklistItemProperty": "checklist_item_current",
            "security": {
                "allowRefreshTemplate": ["Administrators", "Users"],
                "allowReCreate": ["Administrators"]
            }
        }
    }
}

webcomponenttabexample