Low Level Design

Introduction

About NMIS App

National Management Information System (NMIS) Mobile, a groundbreaking application developed by Tech Consultancy Team using JavaScript and React Native. This state-of-the-art app offers a robust solution for data collection across various services.

The NMIS app is built upon JavaScript and harnesses the versatility of React Native, enabling seamless cross-platform development. By utilising the feature flag parameter, the app can be easily transformed into an Android APK, offering users a wide array of customisation options and features.

The feature flag parameter plays a pivotal role in configuring the app's behaviour. It empowers administrators to selectively enable or disable specific features based on their requirements, define various authentication methods to enhance security, customise themes to align with organisational branding, set server URLs for seamless integration, and even specify different types of questions within forms to capture precise information.

This exceptional level of configurability ensures that the NMIS app can be adapted as a generic module for diverse services. Regardless of the sector, whether it's healthcare, education, public services, or any other domain, the NMIS app offers a flexible and scalable solution for efficient and standardised data collection.

With its user-friendly interface, intuitive design, and advanced integration capabilities, the Mobile App for National Management Information System (NMIS) sets a new standard in data collection and management. By prioritising data accuracy, efficiency, and accessibility, this app empowers organisations to streamline their information-gathering processes and make informed decisions.

The Purpose of NMIS App

The purpose of the NMIS mobile app is to provide enumerators in the field with a user-friendly and efficient tool for data collection, complementing the existing web form in the web application. The app is specifically designed to streamline data collection processes, enhance accessibility, and overcome limitations associated with web forms.

The key purposes of the NMIS mobile app include:

1. Simplified Data Collection: The app aims to simplify the data collection process for enumerators by providing an intuitive and mobile-optimised user interface. It allows enumerators to collect data in a straightforward and efficient manner, reducing the complexities associated with web forms.

2. Offline Data Collection: A crucial purpose of the app is to enable offline data collection. Enumerators can capture data even in areas with limited or no internet connectivity. The app securely stores the collected data locally on the device, ensuring data integrity and allowing for seamless synchronisation when an internet connection is available.

3. Improved Efficiency: The NMIS mobile app enhances the efficiency of data collection in the field. It eliminates the need for enumerators to rely solely on web forms accessed through browsers, which may involve additional login procedures or restricted access. The app provides a dedicated platform for enumerators, ensuring a smoother and faster data collection experience.

4. Streamlined Field Operations: By leveraging mobile-specific features, such as GPS integration for location tracking, the app streamlines field operations. Enumerators can efficiently capture geographical data alongside other relevant information, improving the accuracy and context of collected data.

5. Enhanced User Experience: The NMIS mobile app focuses on delivering an optimal user experience for enumerators. It leverages mobile devices' capabilities, such as touch gestures and responsive layouts, to provide a seamless and intuitive interface. This purposeful design promotes ease of use and reduces the learning curve for enumerators in the field.

In summary, the NMIS mobile app's purpose is to facilitate efficient and user-friendly data collection for enumerators in the field. It enhances accessibility, enables offline capabilities, and improves overall efficiency in capturing accurate and timely data.

Functional Overview

The NMIS mobile app offers a comprehensive range of functionalities tailored to support enumerators in their data collection tasks. This section provides a functional overview of the key features and capabilities of the app. With support for various question types, optional dependency logic, validation rules, offline data collection, seamless synchronisation, JSON form format, and a user-friendly interface, the app empowers enumerators to collect data accurately, efficiently, and conveniently in the field.

Data Collection Forms

• Enumerators can access and complete customised data collection forms using the app. These forms are designed to capture various types of information, including geolocation, text, number, options, multiple options, cascade, photo/video, and date.
• The app provides an intuitive interface for enumerators to input data based on the question type. Enumerators can provide accurate and precise information during the data collection process.

Optional Dependency Logic

• The app supports optional dependency logic, enabling dynamic display and requirement of questions based on responses to previous questions. This functionality enhances the data collection experience by adapting the form based on specific conditions or dependencies.
• Enumerators can seamlessly navigate through the form, with the app intelligently adjusting the display of questions based on the predefined dependencies. This ensures a smooth and efficient data collection process.

Validation Rules

• The app incorporates validation rules to ensure data accuracy and integrity. Real-time validation feedback is provided to enumerators, such as error messages or prompts for missing or invalid data.
• Enumerators receive immediate feedback, ensuring that data entered meets the specified criteria and reducing the likelihood of errors. This promotes data quality and reliability.

Offline Data Collection

• Enumerators can collect data even in offline environments, leveraging the app's offline functionality.
• The app securely stores the collected data on the device, allowing enumerators to continue their work without an internet connection.
• Once an internet connection is available, the app automatically synchronises the collected data with the central server.

Seamless Synchronisation

• The app seamlessly synchronises collected data with the central server once an internet connection is available. This ensures that no data is lost during the process.
• Enumerators can trust that their data is securely transmitted and integrated into the NMIS system. Synchronisation happens in the background, allowing enumerators to focus on their data collection tasks without worrying about manual data transfer.

JSON Form Format

• The app receives the data collection forms in JSON format.
• The JSON structure follows the format used in the Akvo React Form, which used by the Burkina Faso PDHA, WAI-SDG, ISCO or Kenya RTMIS Web Page.
• Enumerators can easily navigate and interact with the forms within the app, as the JSON structure provides a familiar format. This simplifies the transition from the web form to the mobile app and ensures a consistent data collection experience.

User-Friendly Interface

• The app offers a user-friendly interface designed specifically for mobile devices. It prioritises ease of use and intuitive navigation, optimised for the smaller screens and touch gestures of smartphones and tablets.
• Enumerators can efficiently navigate through the forms, input data, and access various features. The intuitive interface reduces training requirements and contributes to a seamless and pleasant data collection experience.

The functional overview of the NMIS mobile app highlights its robust capabilities in supporting enumerators during data collection activities. With support for various question types, optional dependency logic, validation rules, and the ability to handle JSON forms, the app provides a powerful tool that enhances the efficiency, accuracy, and convenience of field data collection processes.

Design Considerations

When designing the NMIS mobile app, several key considerations were taken into account to ensure a seamless and user-friendly experience for enumerators in the field. The following design principles guided the development process:

Mobile-Optimised Interface

The app's interface is specifically designed for mobile devices, prioritising ease of use and intuitive navigation. It takes into account the limited screen space and touch interactions of smartphones and tablets, ensuring a seamless user experience for enumerators.

Offline Functionality

Recognising the potential lack of internet connectivity in remote areas, the app includes robust offline capabilities. Enumerators can collect data without an active internet connection, and the app securely stores the data locally on the device. Once a connection is available, the app automatically synchronises the collected data with the central server.

Responsive and Adaptive Design

The app features a responsive and adaptive design, adjusting its layout and functionality based on the screen size and orientation of different devices. This ensures optimal presentation and usability, regardless of the device used by enumerators.

Clear and Intuitive Form Design

The design of data collection forms prioritises clarity and simplicity. Questions are presented in a logical and easy-to-understand manner, reducing cognitive load for enumerators and enabling efficient data entry.

Visual Feedback and Validation

The app provides visual feedback and validation to guide enumerators during data collection. Real-time validation checks highlight errors or missing information, ensuring the accuracy and completeness of collected data. Clear visual cues and informative prompts assist enumerators in providing accurate and valid responses.

Streamlined Navigation

The app features streamlined navigation, allowing enumerators to move through the data collection process effortlessly. Intuitive icons, buttons, and gestures provide smooth transitions between questions and sections, reducing friction and improving efficiency.

Accessibility Considerations

The app adheres to accessibility guidelines to ensure inclusivity for all users. It incorporates features such as adjustable text size, colour contrast for readability, and support for assistive technologies. By prioritising accessibility, the app promotes equal access and usability for individuals with diverse needs.

Security and Data Privacy

Data security and privacy are paramount considerations in the app's design. The app incorporates robust security measures to protect collected data, including encryption during transmission and adherence to industry best practices. Enumerators can trust that the data they collect is handled securely and confidentially.

Software Architecture

Build Configuration Parameters

Server URL

During the development and build phase of the NMIS mobile app, the server URL parameter is used to specify the default endpoint or API URL of the NMIS server. This URL is typically determined by the development team based on the specific deployment environment (e.g., development, staging, production). By providing the server URL as a build parameter, the app is pre-configured with the appropriate endpoint to communicate with the NMIS server. This ensures that the built app connects to the correct server once it is installed and launched on users' devices.

The server URL parameter in the build process ensures that the app is ready to establish a connection with the designated NMIS server by default. This allows enumerators or users to seamlessly interact with the server without having to manually input or configure the server URL during the initial setup of the app. By incorporating the server URL parameter as a build parameter, the NMIS mobile app simplifies the setup process and reduces the configuration overhead for users, ensuring that they can quickly access and communicate with the designated NMIS server after installing the app.

Debug Mode

During the build process of the NMIS mobile app, developers can include a "Debug Mode" build parameter to control the activation of a dedicated mode designed to assist in debugging and troubleshooting issues during app development.

1. Debugging Capabilities: When the app is in Debug Mode, developers gain access to additional tools and capabilities for troubleshooting and identifying potential issues. This includes features such as enhanced logging, detailed error messages, runtime inspection, and the ability to set breakpoints for stepping through the code.
2. Enhanced Logging: Debug Mode often includes more extensive logging capabilities, providing developers with a detailed view of the app's internal workings. This helps in tracking the execution flow, identifying errors, and understanding the sequence of events leading up to specific issues.
3. Diagnostic Information: Debug Mode allows developers to collect and analyze diagnostic information, such as variable values, stack traces, and system-level details. This information is instrumental in identifying the root causes of errors or unexpected behavior, facilitating efficient bug fixing.
4. Real-time Feedback: Debug Mode enables real-time feedback during app development. Developers can observe the app's behavior, identify potential issues, and make immediate adjustments or corrections, improving the efficiency of the debugging process.
5. Controlled Environment: Debug Mode provides a controlled environment for developers to test and troubleshoot app features and functionality. It allows them to isolate and focus on specific parts of the app, enabling effective debugging and minimising interference from external factors.
6. Development Workflow: Debug Mode supports an iterative development workflow. Developers can make changes, test them, debug issues, and refine their code until the desired functionality is achieved. This iterative approach helps in improving the overall quality and reliability of the app.

More about debugging: https://reactnative.dev/docs/debugging

App Version Control

This parameter ensures that the app is running on the correct version by specifying the version number or code. It helps in maintaining compatibility and consistency between the app and the server, ensuring seamless functionality and data syncing.

App Version Control is essential for maintaining a structured and organised approach to app development, deployment, and updates. It involves assigning unique version numbers or codes to each release of the app, allowing users to identify, track, and manage different versions effectively.

Key aspects of App Version Control include:

1. Version Numbering: App developers assign version numbers to each release of the app. Version numbers typically follow a structured format, such as X.Y.Z, where X represents a major version, Y denotes a minor version, and Z signifies a patch version. This numbering scheme provides a systematic way to indicate the significance of changes and updates.

2. Release Management: App Version Control helps manage the release process by distinguishing between major updates, minor feature enhancements, and bug fixes. Each version represents a distinct set of changes and serves as a reference point for development, testing, and deployment.

3. Compatibility and Upgrades: Version control allows users to determine whether their installed app version is compatible with the server or requires an update. It helps ensure that users are running the correct version that aligns with the server's capabilities and data structures.

4. Bug Tracking and Issue Resolution: Version control plays a crucial role in bug tracking and issue resolution. By referring to specific app versions, developers can identify when bugs were introduced, track fixes, and provide relevant updates to users. It facilitates efficient communication and collaboration among development teams, testers, and users.

5. User Support and Communication: Version control helps streamline user support by enabling precise identification of the app version in use. Users can easily communicate their installed version when reporting issues, allowing support teams to provide targeted assistance and troubleshoot problems effectively.

6. Feature Rollouts and A/B Testing: App Version Control facilitates controlled feature rollouts and A/B testing. Developers can release new features gradually, targeting specific app versions, user groups, or geographic regions. This approach allows for better evaluation of feature performance and user feedback before widespread deployment.

JSON Build Parameters Format

Below are the build parameter formats:

{
  "authenticationType": ["code_assignment", "username", "password"],
  "serverURL": "https://api.example.com/nmis",
  "debugMode": false,
  "dataSyncInterval": 300,
  "errorHandling": true,
  "loggingLevel": "verbose",
  "appVersion": "1.2.0"
}

• authenticationType: an array that includes multiple options: code_assignment, username, and password. This configuration allows users to choose one or more authentication methods based on their requirements.This reflects the optional nature of the authentication types and allows for flexibility in selecting authentication methods, including the use of a code assignment before entering a username (with or without a password). It also considers the scenario where multiple enumerators can utilise a single app, accommodating projects with limited budgets for purchasing individual devices.
• serverURL: Specifies the endpoint or API URL of the NMIS server as https://nmis.akvotest.org/api.
• debugMode: Indicates that debug mode is disabled with a value of false.
• dataSyncInterval: Defines the default data sync interval as 300 seconds (5 minutes).
• errorHandling: Specifies that error handling is enabled with a value of true.
• loggingLevel: Sets the logging level to verbose.
• appVersion: Represents the version number of the app as 1.2.0.
  

App Configuration Settings

The app configuration settings parameter provides a range of customisable options, such as default language preferences, notification settings, and display preferences. It allows users to tailor the app's behavior and appearance according to their specific preferences.

1. Data Sync Options: Data syncing options allow users to configure how and when the app synchronise data with the server. Users can choose to enable or disable automatic syncing, specify Wi-Fi-only syncing, or define the sync interval, giving them control over the data transfer process.
2. Data Sync Interval: The Data Sync Interval configuration setting allows users or enumerators to define the frequency at which the NMIS mobile app automatically syncs data with the server. This setting can be adjusted within the app's user interface or settings menu, providing flexibility for users to tailor the sync interval according to their specific needs and preferences.
3. Language Selection: Language selection settings enable users to choose their preferred language for the app's interface. This feature ensures that the app is accessible to users who are more comfortable with languages other than the default language.
4. Feature Toggles: Feature toggles allow users to enable or disable specific features or functionalities within the app. This empowers users to customise their app experience by activating or deactivating certain capabilities based on their needs or preferences.

Data Collection Workflow

Below explanation illustrates the step-by-step workflow of the NMIS mobile app, ensuring a seamless and user-friendly experience for data collection, user management, form selection, survey duration tracking, form navigation, and submission handling.

Ask Permissions

At the beginning of the app, the user is prompted to grant permissions for accessing the camera, location, and files on their device. This ensures that the app can utilise these features for data collection and other functionalities.

Input Assignment Code Page

The Input Assignment Code page is a crucial step in the NMIS mobile app's data collection workflow. This page serves as the entry point for enumerators to access the forms assigned to them. Here's a more detailed explanation of the Input Assignment Code page:

Add User Page

Since there is no user information available initially, the user is directed to the "Add User" page. At least one user needs to be added to proceed. Users can be added with or without a password. This page is displayed as the first step once a session is available. This page allows enumerators to create user profiles within the app. Here's a more detailed explanation of the Add User page:

1. Purpose: The Add User page serves the purpose of enabling enumerators to create user profiles within the NMIS mobile app. It ensures that each enumerator has a unique identity and allows for personalised data collection.

2. User Profile Creation: On the Add User page, enumerators can input relevant information to create their user profiles. This typically includes details such as their name, contact information, role, and any other required fields.

3. User Authentication: The Add User page may also provide the option for enumerators to set up a password for their user profiles. This authentication feature ensures that only authorised individuals can access and utilise the app using their designated user accounts.

4. User Account Flexibility: The Add User page allows for user accounts to be created with or without a password. This flexibility accommodates varying security requirements and administrative preferences. Enumerators can choose the appropriate account setup based on their specific needs.

5. Accessibility upon Session Availability: The Add User page is the initial page displayed when a session becomes available in the app. Enumerators are prompted to create their user profiles before proceeding to other data collection activities.

Survey Selection Page

Once a user is added, the user is directed to the "Survey Selection" page. This page displays the available surveys/forms for the user to select from, presenting an overview of the options for data collection.

1. Purpose: The Survey Selection page serves as the central hub where enumerators can browse and select surveys or forms specific to their assigned tasks. It provides an overview of available surveys and relevant statistics, aiding in efficient data collection.
2. User-Specific Surveys: The Survey Selection page displays surveys or forms based on the assignment code entered earlier. All users with the same assignment code will have access to the same set of surveys. This ensures consistency among enumerators working on the same project and facilitates centralised data collection.
3. Survey List and Statistics: Enumerators are presented with a list of surveys or forms relevant to their assignment code. Each survey entry includes basic statistics, such as the number of submitted responses or other relevant metrics. These statistics offer valuable insights into the progress of data collection and help enumerators make informed choices.
   
4. Intuitive User Interface: The Survey Selection page is designed with an intuitive user interface, allowing enumerators to navigate through the available surveys easily. Clear navigation elements, search functionality, or filtering options may be provided to enhance usability and enable efficient survey selection.
   

Select Action from Selected Form

After selecting a survey/form, the user is presented with options to perform actions related to the selected form. The available actions include starting a new survey, editing a saved submission, or viewing a submitted submission. This single page provides enumerators with clear navigation options for managing the selected form. Here's a more detailed explanation:

1. Purpose: The "Select Action from Selected Form" page aims to provide enumerators with clear and distinct actions they can take regarding the selected form. It serves as a centralised control panel for managing the form and offers intuitive navigation options.
2. Single Page Design: The decision to have a single page with the three buttons - Preview, Start New, Edit Saved Submission, and View Submitted Submission - is to present enumerators with a comprehensive overview of the available actions in a clean and straightforward manner. This layout minimise confusion and allows for easy access to different functionalities.
3. Preview Button: The Preview button enables enumerators to access a preview of the selected form. By clicking this button, enumerators can review the form's structure, questions, and any other relevant details before proceeding with data collection. This feature helps them become familiar with the form's content and layout.
4. Start New Button: The Start New button initiates a new data collection session for the selected form. Enumerators can begin entering data and providing responses based on the form's questions. This button is used when starting a fresh data collection process for the selected form.
5. Edit Saved Submission Button: The Edit Saved Submission button allows enumerators to modify a previously saved but incomplete submission for the selected form. By clicking this button, enumerators can access the partially completed submission and make any necessary changes or additions.
6. View Submitted Submission Button: The View Submitted Submission button provides access to previously submitted and completed submissions for the selected form. Enumerators can review the data they have previously submitted, ensuring data accuracy and allowing for reference purposes.

Starting The Submission

This process combines three key elements: The Timer, Question Group Navigation, and Submission. Here's a detailed explanation of how these components work together:

1. The Timer:

   • When the enumerator starts a new data collection session for a selected form, a timer is initiated in the background. The timer tracks the duration of the survey from the moment it is started until it is submitted. This feature provides valuable insights into the time taken for each survey and helps monitor data collection efficiency.

2. Question Group Navigation:

   • To streamline the data collection process and avoid overwhelming the enumerator, not all question groups are displayed simultaneously. Instead, the form is divided into logical sections or question groups. Enumerators proceed through the form by answering questions within the current question group.

   • The app enables question group navigation by presenting navigation buttons, such as "Next" and "Previous." The "Next" button is disabled until all questions within the current group are completed. Once the enumerator finishes answering the questions, the "Next" button becomes active, allowing them to proceed to the next question group.

   • This approach helps maintain focus and clarity, guiding enumerators through the form step-by-step and reducing the risk of missing or skipping questions.

3. Submission:

   • Once the enumerator completes all the questions in the form, the app provides a final step: the submission process. At this stage, the "Next" button for the question group transforms into a "Submit" button.

   • Clicking the "Submit" button submits the completed form to the server, finalising the data collection process. The app may display a confirmation prompt to ensure the enumerator intends to submit the form.

   • Upon submission, the collected data is securely transmitted to the server for further processing and analysis. The enumerator receives a confirmation message or notification, indicating a successful submission.

Back Button Confirmation and Three Dots Menu Options

In addition to the primary submission workflow, there are an additional behaviour that enhances user control and flexibility. This feature allows users to utilise the back button on their Android device and provides options for managing forms, saving submissions, and selecting language preferences. Here's a detailed explanation:

Back Button Confirmation:

When users click the back button on their Android device while in the midst of data collection, a confirmation popup appears. This popup offers users a choice between two options:

• Save and Exit: Users can choose to save the current submission and exit, allowing them to resume data collection from the same point at a later time. The saved submission is stored for future retrieval and modification.
• Exit without Saving: Users can opt to exit the current form without saving the submission. This choice allows them to return to the form selection screen without storing any incomplete data.

Kebab Menu Options:

The NMIS mobile app includes a three dots menu, located in the top-right corner of the screen, which provides additional options in submission:

• Save and Exit: This option allows users to save the current submission and exit the form, ensuring that progress is retained for future continuation.
• Exit without Saving: This option enables users to exit the form without saving the submission, providing a quick way to return to the form selection screen.
• Language Selection: The three dots menu includes the language selection feature, allowing users to choose their preferred language for the app's interface. By selecting their desired language, users can customise the app to suit their language preference.

---

UI Design Overview

Design can be found in: https://www.figma.com/file/gFCAgrblItKsGkONiGu7Ij

The design in the provided Figma link represents the user journey and interface design of the mobile module for the NMIS app based on the discussions held during the planning phase. It showcases the layout, interaction, and visual elements to ensure a seamless and user-friendly experience for enumerators during the data collection process. Here's an overview of what the design entails:

---

Error Handling

Error handling is a critical aspect of the NMIS mobile app's development, aimed at providing a seamless and user-friendly experience. As with any software application, various errors and exceptions may occur during its usage. To ensure smooth operation and effective user guidance, comprehensive error handling mechanisms have been implemented. The app employs a proactive approach to detect and handle errors, offering clear and concise messages that assist users in resolving issues. Below are some common errors that may arise during app usage, along with brief explanations of each:

1. Invalid Assignment Code: Occurs when the user enters an incorrect or unrecognised assignment code during the initial setup, prompting them to verify and re-enter the code.
2. Network Connection Failure: Arises when the app encounters connectivity issues, such as a lack of internet connection or poor signal strength. Users are notified about the problem and are guided to check their network settings or retry when a stable connection is available.
3. Form Retrieval Failure: If the app fails to retrieve forms from the server, an error message is displayed, suggesting users try again later or contact support for assistance.
4. Missing or Incomplete Data: Alerts users when attempting to submit a form with mandatory fields left blank or incomplete, ensuring all required information is provided before proceeding.
5. Server Error: Indicates server-related issues during data submission, such as database connectivity problems or server timeouts. Users are informed about the error and provided options to retry or seek further support.
6. Authentication Errors: Occur when there are authentication issues, such as invalid login credentials or an expired session. Users are guided to re-enter correct information or re-authenticate as required.
7. Unexpected App Crashes: In the event of unexpected errors or crashes, users receive user-friendly error messages informing them of the issue and suggesting actions like restarting the app or contacting support.
8. Input Validation Errors: Alert users to invalid data entries, such as incorrect phone number formats or email addresses, and provide specific error messages to facilitate proper data input.
9. Insufficient Permissions: Notify users when the app requires specific permissions to access device features and guide them to grant the necessary permissions for proper app functionality.
10. General Error Handling: Implement a robust error handling mechanism to catch and handle any unforeseen errors or exceptions, ensuring users receive informative and helpful error messages for effective troubleshooting and problem resolution.

Risks and Mitigation Strategies