Adding Questionnaire Required Marker Configuration Capabilities to OpenSRP 2

[dubdabasoduba]

Context

• The SDK has added the ability to configure which required marker an application would use on their questionnaires.
• This PR Support required text and optional text configuration. google/android-fhir#1963 shows the new addition.
• Android SDK-supported required markers
  • Asterisk - Adds an asterisk(*) to the end of each required field.
    
  • Required Text - Adds a Required Text below the required fields.
    
  • Optional Text - Adds a Optional Text below the optional fields.
    
• These required markers are mutually exclusive and all can be used on the same form where necessary.
• OpenSRP 2 would need to update its configs to make sure that different applications can configure their apps to use the desired required field markers

Implementation Plan

Adding the Configs to the Application Configurations (Recommended)

• This approach would mean updating the Application Configuration file defined here.
• We would add a new attribute named requiredMarkers. This would hold the attributes to hide or show the different required markers.
• Adding this attribute to the Application Configuration would mean that all the forms rendered on the app would use the same required markers.
  • It does not give flexibility to change the required markers on the specific questionnaires.
• The default functionality would be to show the required text if the requiredMarkers attribute is not added.
• Here are the attributes to be added to the requiredMarkers attribute

{
  "appId": "app",
  "configType": "application",
  "appTitle": "eCBIS (CHA & CHSS)",
  "remoteSyncPageSize": 100,
  "languages": [
    "en"
  ],
  "useDarkTheme": false,
  "syncInterval": 15,
  "syncStrategy": [
    "Location"
  ],
  "loginConfig": {
    "showLogo": true,
    "enablePin": true
  },
  "requiredMarkers": {
    "showAsterisk": true,
    "showRequiredText": true,
    "showOptionalText": true
  }
}

Adding the Configs to the Questionnaire Configurations

• This approach would mean updating the Questionnaire Configuration file defined here.
• We would add a new attribute named requiredMarkers. This would hold the attributes to hide or show the different required markers.
• Adding this attribute to the Questionnaire Configuration would mean that all the forms rendered on the app could use different required markers.
  • It gives flexibility to change the required markers on the specific questionnaires but also goes aganist the idea of UI uniformity.
• The default functionality would be to show the required text if the requiredMarkers attribute is not added.
• Here are the attributes to be added to the requiredMarkers attribute

{
  "id": "recordAsSick",
  "title": "Record as Sick",
  "titleColor": "@{patientTextColor}",
  "visible": "@{isChildUnder2months}",
  "enabled": "@{patientActive}",
  "actions": [
    {
      "trigger": "ON_CLICK",
      "workflow": "LAUNCH_QUESTIONNAIRE",
      "questionnaire": {
        "id": "questionnaire-uuid",
        "title": "Record sick child",
        "resourceIdentifier": "@{patientId}",
        "requiredMarkers": {
          "showAsterisk": true,
          "showRequiredText": true,
          "showOptionalText": true
        }
      }
    }
  ]
}

NB: - We can also implement both and let projects decide which ones to use. If both are defined then the Questionnaire Configuration would override the Application Configuration.