Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

User configurable views will be defined by using JSON objects saved in the OpenSRP couchdb database. They will be fetched by clients after configuring the OpenSRP base url. OpenSRP server has a REST endpoint that the clients will use to sync views to the client. 

A background service on the client will occasionally fetch any modified or added configurable views from the OpenSRP server and save them on the client's sqlite database.The client will send the serverVersion of the its last sync and OpenSRP server will return the view configuration files that have changed since the last sync.

The property serverVersion will be used for versioning. If a view configuration file is edited the serverVersion of the view configuration file will have to be updated so that the view configuration can be picked by clients when syncing configurable views. The property is number denoting unix timestamp; one can get the current unix timestamp from https://www.unixtimestamp.com and use that to update the property. Failure to increment server version when editing the files manually will result in the view configuration not to be synched back to the clients.

A view configuration will have a property identifier. The field is used to identify a configuration file on the client e.g identifier of "login_view" can be used to denote that this configuration file is for login screen.This filed is immutable and changes to it will result in the view configuration to be ignored by clients.

  • No labels