Skip to content

Introduction#

In this tutorial, we will walk through the steps to create and configure a Checklist in your system, covering the basics of Checklist items, their scopes, execution modes, and specific parameters for configuration.

Checklist Structure#

A Checklist consists of a procedure, in the form of a sequence of Checklist items, that need to be carried out at a specific situation. A good example is a maintenance Checklist.

Each Checklist Item can be of four types:

  • Manual Task - a manual procedure where additional data can be collected.
  • Manual Action - a DEE action rule which is manually triggered.
  • Automatic Action - a DEE action rule which is automatically triggered.
  • Signature - as item which needs to be signed with the user name and password.

In addition, each Checklist item can be:

  • Sequential - needs to be performed in a sequence.
  • Floating - can be performed at any time (not possible for Automatic Actions) and can be (re)ordered.
  • Optional - it is not necessary to be carried out (not possible for Automatic Actions), that is, it can be skipped.
  • Mandatory - it needs to be performed.
  • Execute Out of Order - can be performed in any order.

The following diagram perfectly explains how the different objects connect with the Checklist entity.

graph LR
    A1[Maintenance Activity] --- Main[Checklist]
    A2[Maintenance Activity Order] --- L1
    Main === L1[Checklist Instance]
    N1[Protocol Instance Path] --- L1
    A3[Material] --- L1
    L1 === L2[Checklist Instance Item]
    L2 === L3[Checklist Instance Item Parameter]
    Main === L4[Checklist Item]
    L4 -.- A4[Role]
    L4 === L5[Checklist Item Parameter]
    C1[Material Checklist Context] -.- Main

classDef mermaid_title color:#000, fill:#fafafa, stroke:#fafafa, stroke-width:0x, font-size:100%, font-weight:200;
classDef mermaid_start color:#000, fill:#fafafa, stroke:#fafafa, color:#fafafa, stroke-width:0x, font-size:100%, visibility: hidden;
classDef mermaid_businessdata color:#000, fill:#65CDE8, stroke:#65CDE8, stroke-width:0px, font-size:100%;
classDef mermaid_businessdata:hover color:#FFF;
classDef mermaid_nonbusinessdata color:#000, fill:#B7DEE8, stroke:#B7DEE8, stroke-width:0px, font-size:100%;
classDef mermaid_entity color:#000, fill:#FB9F53, stroke:#FB9F53, stroke-width:0px, font-size:100%;
classDef mermaid_entity:hover color:#FFF;
classDef mermaid_entitylinked color:#000, fill:#FCD5B5, stroke:#FCD5B5, stroke-width:0px, font-size:100%;
classDef mermaid_context color:#000, fill:#B9CDE5, stroke:#B9CDE5, stroke-width:0px, font-size:100%;
classDef mermaid_context:hover color:#FFF;
classDef mermaid_optional color:#000, fill:#B7DEE8, stroke:#65CDE8, stroke-width:1px, font-size:100%, stroke-dasharray: 5 5;

class Main mermaid_entity
class A1,A2,A3,A4 mermaid_businessdata
class L1,L2,L3,L4,L5 mermaid_entitylinked
class C1 mermaid_context
class N1 mermaid_nonbusinessdata

click Main "../../../../../userguide/business-data/checklist"
click A1 "../../../../../userguide/business-data/maintenance-plan"
click A2 "../../../../../userguide/business-data/maintenance-activity-order"
click A3 "../../../../../userguide/business-data/material"
click A4 "../../../../../userguide/administration/security/roles"
click C1 "../../../../../userguide/administration/tables/smart-tables/materialchecklistcontext"

Scope#

The scope of the Checklist is used to filter the application of the Checklist, and can be:

  • General - general purpose checklist.
  • Maintenance Management - applicable to Maintenance Management.
  • Exception Management - applicable to Exception Management.
  • Material Tracking - applicable to Material Tracking.
  • Resource Tracking - applicable to Resource Tracking.

Execution Mode#

A Checklist can be executed in two modes:

  1. Immediate - the Checklist will be executed all at once and data will be committed at once. In this case, the Checklist must not contain any Manual or Automatic actions.

    Note

    This option is not available for the following scopes:

    • Exception Management
    • Maintenance Management

  2. Long Running - the Checklist is executed over a long period of time with intermediate data persistency.

Restrictions#

Based on the selected scope, some restrictions apply. For more information, see Restrictions.

Checklist Items#

For each Checklist item, you may define a series of properties. For more information, see Checklist Items.