Manage Checklist

Overview

The Checklist module allows administrators to configure role-based checklists used during campaign execution. All checklist data is MDMS-driven, fully configurable, and supports:

• Role-based templates

• Multiple question types

• Nested (dependent) questions

• Localization

• Create, view, preview, and update flows

Steps

The checklist feature depends on the following MDMS schema codes:

Mandatory Schema Codes

• HCM-ADMIN-CONSOLE.rolesForChecklist Defines which user roles the checklist applies to.

• HCM-ADMIN-CONSOLE.ChecklistTemplates Defines the checklist questions, options, and hierarchy.

• HCM-ADMIN-CONSOLE.appFieldTypes Defines supported question types (e.g., single choice, multiple choice).

Example: Role Configuration

"code": "HCM-ADMIN-CONSOLE.rolesForChecklist"
"code": "HCM-ADMIN-CONSOLE.ChecklistTemplates"
"code": "HCM-ADMIN-CONSOLE.appFieldTypes"

Example Data for the above schema codes// Some code```postman_json

rolesForChecklist

{
    "tenantId": "mz",
    "schemaCode": "HCM-ADMIN-CONSOLE.rolesForChecklist",
    "uniqueIdentifier": null,
    "data": {
        "key": 1,
        "code": "DISTRIBUTOR"
    },
    "isActive": true
}

ChecklistTemplates

appFieldTypes

User enters the checklist search screen by clicking on the configure app.

The Search Checklist is the screen where u can search for created checklist and also create checklists for whose templates have been created. View button is present for the created checklists and Configure button for those which need to be created.

The Create Checklist page loads the default template for that particular use role and checklist type and then can be edited as per the user. On submission the api creates the checklist (service definition) and create localisation for all the questions and options

The questions can be Single Choice (Radio button) or Multiple Choice (Checkbox) and each single choice option can have multiple sub questions. Nesting is allowed uptil 3 levels. Nesting can be done by clicking on the Dependency button. Options can also have comments attached to them. Add options and delete options feature is also given. The required checkbox is to make any question mandatory.

Preview Checklist shows the mobile view of the created checklist

The View Checklist page shows the current checklist and is non-editable.

The create and update pages work same. The update checklist page loads the already created questions to be edited and can be reached by clicking the update button on view checklist button.

The following API’s are called while checklist creation :

1. Question type search: /mdms-v2/v2/_search this is used to search the types of questions like radio button or checkboxes and these are taken from the mdms with schema code HCM-ADMIN-CONSOLE.appFieldTypes

2. Create: /service-request/service/definition/v1/_create : used to create the service definition which is the checklist.

3. Upsert: /localization/messages/v1/_upsert All the questions and options are localised by this api under the module name hcm-checklist

The following api is called to view the previously created checklist :

1. service-request/service/definition/v1/_search

The following API’s are called while checklist update :

1. Create: /service-request/service/definition/v1/_update : used to update the service definition which is already created.

Action	Role
service-request/service/definition/v1/_create	CAMPAIGN_MANAGER
service-request/service/definition/v1/_update	CAMPAIGN_MANAGER
service-request/service/definition/v1/_search	CAMPAIGN_MANAGER
localization/messages/v1/_upsert	CAMPAIGN_MANAGER