This page has documentation about User Configurable Views used in the TB Reach application.
Child Pages- Installation
- App View Configurations
- Base Definitions
- Home View
- Main Configuration
- Patient Details View - In Treatment
- Patient Details View - Positive
- Patient Details View - Presumptive
- Registers Configurations
- User Configurable Login Page
User configurable views will be defined by using JSON objects saved in the OpenSRP couchdb database. They will be fetched by clients(phone or tablet) after configuring the OpenSRP base URL. OpenSRP server has a REST endpoint that the clients will use to sync views to the client.
...
By Default a view configuration file may have the below attributes
| Property | Datatype | Mandatory | Should be updated | Description |
|---|---|---|---|---|
| _id | String | * | No | CouchDB Internal document ID used to differentiate different documents within CouchDB |
| _rev | String | * | No | CouchDB Internal document revision number used to differentiate different revisions of the same documents within CouchDB. Dont amend this manually |
| type | String | * | No | CouchDB Internal document type used to differentiate different documents types within CouchDB. This should always be ViewConfiguration |
| identifier | String | * | No | This uniquely identifies this document. This will be used on the client to identify that this document if for a particular screen. This should not be amended |
| serverVersion | long | * | Yes | A long number denoting the unix timestamp when the document was updated/created. Its used for versioning by clients. Whenever a document is amended this property should be incremented to the current timestamp so that clients notice the document has changed and they can sync it. |
| metadata | Object | Yes | This will be an object that defines configuration at view level. It must have an attribute type that defines the type of configuration being defined. | |
| views | List of View Objects | Yes | This will be populated for screens with configurable view components. It contains a list of view objects. The view object is described below. | |
| labels | Map(Key value pairs) | Yes | This will be populated for language configuration files. It will have a key value pairs of labels where the key will be identical in all language files but the value will be different for each language. |