Application configuration

These are app wide configurations used to control the application behaviour globally e.g. application theme, app language etc.

note

There can only be one instance of application configuration for the entire application. There are instances where the Event Workflow is added to the application config. See here The logGpsLocation config takes in a list of LocationLogOptions to toggle whether to capture GPS coordinates in the application. We can currently define this to capture Location GPS on Questionnaire submission by passing the log option QUESTIONNAIRE as shown in the sample JSON.

Sample JSON

{
    "appId": "app",
    "configType": "application",
    "appTitle": "eCBIS (CHA & CHSS)",
    "remoteSyncPageSize": 100,
    "languages": [
        "en"
    ],
    "useDarkTheme": false,
    "syncInterval": 15,
    "syncStrategies": [
        "Location",
        "Organization",
        "CareTeam",
        "Practitioner"
    ],
    "loginConfig": {
        "showLogo": true,
        "enablePin": true,
        "showAppTitle" : true,
        "logoHeight" : 120,
        "logoWidth" : 140
    },
    "deviceToDeviceSync": {
        "resourcesToSync": [
            "Group",
            "Patient",
            "CarePlan",
            "Task",
            "Encounter",
            "Observation",
            "Condition",
            "Questionnaire",
            "QuestionnaireResponse"
        ]
    },
    "logGpsLocations": [
        "QUESTIONNAIRE"
    ]
}

Config properties

Property	Description	Required	Default
appId	Unique identifier for the application	Yes
configType	Type of configuration	Yes	application
appTitle	Name of the application displayed on side menu (drawer)	No	""
remoteSyncPageSize	Sync batch size	Yes	100
languages	Supported languages	Yes	['en']
useDarkTheme	Indicate whether to apply dark theme	Yes	false
syncInterval	Configuration duration for periodic sync	Yes	30
syncStrategies	Tag every resource with the values for the resource types indicated here	Yes	emptyList()
loginConfig.showLogo	Display logo in login page	Yes	true
loginConfig.enablePin	Request user for pin after login; to be used for subsequent logins	No	false
loginConfig.logoHeight	Set the maximum height a logo can have	No	120
loginConfig.logoWidth	Set the maximum width a logo can have	No	140
loginConfig.showAppTitle	Toggle App title in LoginScreen visibility	No	true
deviceToDeviceSync.resourcesToSync	Types of resource to be synced from one device to another during peer connection	No	false
snackBarTheme	Color styling for the SnackBar	Yes	SnackBarThemeConfig()
reportRepeatTime	Time when to re-run reporting	Yes	""
taskStatusUpdateJobDuration	Interval of when to run status update service	Yes	PT15M
taskExpireJobDuration	Interval of when to run task expiry service	Yes	PT30M
taskCompleteCarePlanJobDuration	Interval of when to run task completion service	Yes	PT60M
showLogo	Toggle whether to show the logo	Yes	true
taskBackgroundWorkerBatchSize	Batch size of tasks to be fetched from the server	Yes	500
eventWorkflows	A list of EventWorkflows	Yes	emptyList()
settingsScreenMenuOptions	A list of SettingsOptionss that defines menu options to be displayed on the Settings screen	Yes	listOf(SettingsOptions.MANUAL_SYNC, SettingsOptions.SWITCH_LANGUAGES, SettingsOptions.RESET_DATA, SettingsOptions.INSIGHTS,)
logGpsLocation	A list of LocationLogOptions to toggle whether to capture GPS coordinates	Yes	emptyList()
usePractitionerAssignedLocationOnSync	If true, default to using logged in practitioner's location	Yes	true
navigationStartDestination	Set the defualt start destination for the navigation graph (supported options includes: REGISTER and MAP)	Yes	'REGISTER`