Skip to content

Installation Instructions

The installation of dynamic checklist consists of:

  • Adding the limepkg as a dependency in your solution
  • Creating atleast one custom limeobject depending on where you want to use the checklist (Checklist Owner(s))
  • Adding the correct fields and tables
  • Adding VBA and Actionpad app for the desktop client
  • Configuring where the checklist webcomponent should be shown in the webclient

Preparations

Check that the requirements are met.

Installation

Dependecy

Add limepkg-dynamic-checklist as a dependecy to your solution in pyproject.toml.
In Lime-project use poetry add limepkg-dynamic-checklist.

Custom limeobject - configure where the checklist should be used

The dynamic checklist requires a custom limeobject for the limetype(s) where the checklist should be installed. This means that you either have to create a new one, or add to an existing one. A limetype where the checklist is installed is called a Checklist Owner.
How to create a Limeobject (Platform documentation).

Checklist Owner

For each Checklist Owner you need to make the following import:

from limepkg_dynamic_checklist import checklist_owner

and in before_update() execute:

checklist_owner.before_update(self, uow)

Code Example for custom limeobject Helpdesk

from lime_type.limeobjects import LimeObject
from limepkg_dynamic_checklist import checklist_owner


class Helpdesk(LimeObject):
    def before_update(self, uow, **kwargs):
        super().before_update(uow, **kwargs)

        checklist_owner.before_update(self, uow)


def register_limeobject_classes(register_class):
    register_class('helpdesk', Helpdesk)

Adding the required tables and fields

Dynamic checklist requires a basic structure and Checklist Owner(s) structure when it comes to fields and tables:

This can be added by using the Setup part of Lime admin by going to: Lime Admin > Settings > Dynamic Checklist > Setup

It will use the Addon-installer to create the needed tables and fields, you can read about the structure under Technical

Info

If you only use the web client, there's no need to install the LIP package.

Using desktop? Then you need the LIP package as well.

Data structure is installed using Addon-installer See above

The LIP package needs to be installed for the desktop app to work. It contains:

  • Localizations
  • VBA modules
  • LBS app

How to install:

  1. Install the LIP-package in one of the following ways (choose one):
    1. Run lip.Install "dynamicchecklist" in VBA's immediate window.
    2. Download the latest LIP-package from the latest release and Install the LIP package by running lip.InstallFromZip in the Immediate Window in the VBA editor and select your downloaded LIP-file.
  2. Adding a new history type "Checklist" with key checklist. (Could be configured to use another type later on in Lime Admin)
  3. [Optional] If you intend to use the checklist in the desktop client, see configuration for desktop to add the actionpad app and VBA.

Helpdesk example

image

Configuration

With the required dependecies, custom limeobject and datastructure in place its time to configure where to use the Dynamic Checklist.