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 consits of these points:

  • Lime Admin
  • Template builder web component
  • LBS app
  • Checklist web component

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.

  • 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.

Info

Don't forget to configure a search view for your Template Property so it is searchable in the Template builder

Example for helpdesk: limeadmin

Danger

Want to add new checklist owner after installing? All Checklist Owners needs a custom limeobject to function. If you want add a new Checklist Owner, you would also need to add the requried field structure and add a custom limeobject for that limetype. For more information see Custom limeobject - configure where the checklist should be used.

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.

Disable relation picker in template builder

In later versions of the Template builder we have changed the Template Property Id from a regular input field to a relation picker.

In some occasions, you don't have correct views or search indexes for the template property table. Which could cause issues with the picker, in that scenario you can disable the picker and use the old input field instead by checking the Disable relation picker and components in template builder checkbox

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!

Re-create checklist Access

What users are allowed to use the Re-create checklist action (also known as hard reset)

Soft reset checklist Access

What users are allowed to use the Soft reset checklist action

Template builder web component

This step is required to be able to add new checklist templates.
Access to the checklist template builder is through the startpage of the webclient. Ensure that the template builder access has been configured before continue with this step.

If the startpage design hasn't been configured in your solution the button to access the template builder should appear on the top left of your startpage. If not, you need to design your startpage.

Designing your startpage

By designing the startpage you configure where on the startpage the Template builder webcomponent should be visible. Instructions on how to add wiget to your Startpage (Platform documentation).

This is the component you will need to add:

lwc-limepkg-dynamic-checklist-template-builder

Either as a Small Square or Small Rectangle, what ever suits your startpage the best.

LBS app (Desktop)

These steps are only needed if you intend to use the dynamic checklist in the desktop client.

  1. Copy the addon_dynamic_checklist folder in the apps catalog to the subfolder apps in the Actionpad folder.
  2. Import the AO_DynamicChecklist.bas to your VBA.
  3. Compile and Save the VBA.
  4. Initialize the LBS app for each Checklist Owner you have configured. E.g helpdesk.html.
  5. Publish Actionpads.
<!-- Dynamic Checklist app -->
<div
    data-app="{
    app:'addon_dynamic_checklist',
    config:{}
}"
></div>

Description of configurable properties

property default value required other
maxHeight 600px no
minWidth 260px no
afterDeadlineColor #d9534f no Color of checklist items that missed deadline
readOnly false no If use are allowed to use the checklist (actions, check/uncheck and so on)
showUserActionWhenNotDone (if readOnly is true it's false else true) no User action are hidden behind the three dots, with this set to true they are always shown when on a checklist item with User-Actions

Config Example

<!-- Dynamic Checklist app (userGroup is set in lime admin instead) -->
<div
    data-app="{
    app:'addon_dynamic_checklist',
    config:{
      maxHeight: '400px',
      readOnly: lbs.vm.helpdesk.helpdeskstatus.key == 'done'
    }
}"
></div>

Checklist web component (Webclient)

These steps are only needed if you intend to use the dynamic checklist in the webclient.

  1. Ensure that the webclient uses the new card design. Read more here.
  2. [Optional] Create a new divider where the checklist should be shown.
  3. Configure the view on your checklist owner to include the checklist fields of your choosing. checklist_template is always needed.
  4. Set the field checklist_template to Read-only.
  5. Add the checklist webcomponent lwc-limepkg-dynamic-checklist-limeobject to the field checklist_template.

  6. Set the colSpan to 5 and rowSpan to 2.

    Example

webcomponentexample

Other configuration

Checklist_item Views in the webclient

By accessing a checklist item you can get information of who has checked and unchecked. Don't forget to configure the views for the checklist_item limetype.
Recommended icon to use in limetype extensions is called checkbox.

Checklist Item Actions

A checklist item can be configured to exectute certain actions when checked or unchecked. This could either be a Checklist item Actions or it could call a Custom Endpoint.