Configuring HCM to Campaign and Country Needs

Configuration document for DIGIT HCM v1.4

Overview

This document will cover the steps to configure HCM for a campaign. Every new campaign in a country or province will ideally require a few configurations to be done on the basic HCM application to cater to the exact needs of the campaign.

Steps for configuring HCM to campaign and country needs

First, the application must be installed using the procedure mentioned here. For easy installation, you may refer to this video. Once the application is installed, you will have access to the admin console and workbench using which a campaign can be configured to the needs of the country and campaign.

  1. Loading of new boundary hierarchy/boundary

a. Each country will have its boundary hierarchy, which must be configured using the console/workbench feature. Refer to the documentation for doing this. The login URL will be the <domain configured during the installation>/workbench-ui/employee/user/language-selection

b. After the hierarchy has been configured, the boundary master data will be uploaded.

  1. Setting up a campaign and related master data using the HCM Console

a. Refer to this document for using the console for campaign setup

b. Set up users for various roles

c. Set up all other masters for HCM

  1. Setting up the configuration parameters for the HCM app

a. Using the workbench link, configure the parameters per the instructions.

  1. Changing the labels and messages as per the campaign needs

a. Login to the workbench URL, select the localisation option and appropriately change the values for the keys. Refer to this document for instructions.

b. These localisation changes will apply to both the web and the mobile application.

  1. Making the APK as per the new configuration

a. Once the master data and language configuration, including loading of values are done, you are ready to make an APK.

b. Follow the steps mentioned here to make the APK which can then be installed on your Android device.

  1. Installing the APK on a device and making it ready for use

a. Once the APK is made, it can be downloaded and installed on the device.

b. Enable the permissions to run background services.

c. Enable the permission to access the camera.

d. Enable location permissions.

e. Check for the other recommended prerequisites mentioned below

i. ​​RAM: Recommended is 6GB and minimum is 4GB.

ii. Processor: Octa-core processors.

iii. Battery: Minimum 5000 mAh. The higher the mAh, the better it is. Battery consumption is heavily dependent upon phone searching, network searching, and GPS usage.

iv. Screen: Generally the bigger the better for the field teams, but a minimum 6.5-inch screen size is recommended.

v. Storage: Minimum 32 GB. Typically 4 GB or 6GB RAM phones are available with more than 32 GB storage.

  1. Login to the new application on the device

b. Login using the user credentials created using the console.

  1. Login to the web application

a. Using the domain URL configured while installing, you should be able to log in to the web application.

b. Select the language of your choice.

c. You can use the user credentials configured using the console.

d. Once logged in you can see the menu options are per the roles assigned to this user.

  1. Configuring Dashboard

a. Kibana will be installed as part of the installation. Visualisations relevant to the campaign can be added to the dashboard by following the steps mentioned here.

b. Follow the Kibana help documents for adding new charts and graphs.

c. You should be able to log in to the web application using the dashboard role the user created as part of Step 1.

Last updated

https://creativecommons.org/licenses/by/4.0/