- nodejs 6 or later
- python 2.7
- or Docker
docker build -t medic-conf:v0 . docker run medic-conf:v0 docker exec -it <container_name> /bin/bash
npm install -g medic-conf
sudo python -m pip install git+https://github.com/medic/pyxform.git@medic-conf-1.17#egg=pyxform-medic
npm install -g medic-conf
pip install git+https://github.com/medic/pyxform.git@medic-conf-1.17#egg=pyxform-medic
As Administrator:
npm install -g medic-conf
python -m pip install git+https://github.com/medic/pyxform.git@medic-conf-1.17#egg=pyxform-medic --upgrade
To enable tab completion in bash, add the following to your .bashrc/.bash_profile:
eval "$(medic-conf --shell-completion bash)"
To upgrade to the latest version
npm install -g medic-conf
medic-conf will upload the configuration from your current directory.
medic-conf --local
medic-conf --instance instance-name.dev
Username admin is used. A prompt is shown for entering password.
If a different username is required, add the --user switch:
--user user-name --instance instance-name.dev
medic-conf --url https://username:password@example.com:12345
medic-conf <--local|--instance instance-name|--url url> <...action>
The list of available actions can be seen in supported-actions.js.
medic-conf <--local|--instance instance-name|--url url> <...action> -- <...form>
This tool expects a project to be structured as follows:
example-project/
app_settings.json
contact-summary.js
resources.json
resources/
icon-one.png
…
targets.js
tasks.js
nools-extras.js
task-schedules.json
forms/
app/
my_project_form.xlsx
my_project_form.xml
my_project_form.properties.json
my_project_form-media/
[extra files]
…
contact/
person-create.xlsx
person-create.xml
person-create-media/
[extra files]
…
…
…
translations/
messages-xx.properties
…
If you are starting from scratch you can initialise the file layout using the initialise-project-layout action:
medic-conf initialise-project-layout
Configuration can be inherited from another project, and then modified. This allows the app_settings.json and contained files (task-schedules.json, targets.json etc.) to be imported, and then modified.
To achieve this, create a file called settings.inherit.json in your project's root directory with the following format:
{
"inherit": "../path/to/other/project",
"replace": {
"keys.to.replace": "value-to-replace-it-with"
},
"merge": {
"complex.objects": {
"will_be_merged": true
}
},
"delete": [
"all.keys.listed.here",
"will.be.deleted"
],
"filter": {
"object.at.this.key": [
"will",
"keep",
"only",
"these",
"properties"
]
}
}
- compile from:
- tasks
- rules
- schedules
- contact-summary
- backup from server
- upload to server
- fetch from google docs/google sheets/google drive and save locally as
.xlsx - backup from server
- delete all forms from server
- delete specific form from server
- upload to server
- upload to server
- upload of custom translations to the server
N.B. this feature is currently in development, and probably not ready for production yet.
To create users on a remote server, use the create-users action. The CSV file should be called users.csv, and an example is available in the tests directory.
To convert CSV to JSON docs, use the csv-to-docs action.
The name of the file determines the type of doc created for rows contained in the file. The possible types are: report, person, and place. Each of these has a further specifier provided in the filename:
place.{place_type}.csv: where{place_type}is the type of place specified in the file, one of:clinic,health_center,district_hospitalperson.{parent_place_type}.csv: where{parent_place_type}is the parent for the person, one of:clinic,health_center,district_hospitalreport.{form_id}.csv: where{form_id}is the form ID for all the reports in the file. You will need one file per form ID
Here are some examples:
File named place.district_hospital.csv adds the property "type":"district_hospital"
File named person.clinic.csv add the property "type":"person"
File named report.immunization_visit.csv add the property "type":"report", "form":"immunization_visit"
By default, values are parsed as strings. To parse a CSV column as a JSON type, suffix a data type to the column definition, e.g.
column_one,column_two:bool,column_three:int,column_four:float,column_five:date,column_six:timestamp
This would create a structure such as:
{
"_id": "09efb53f-9cd8-524c-9dfd-f62c242f1817",
"column_one": "some string",
"column_two": true,
"column_three": 1,
"column_four": 2.3,
"column_five": "2017-12-31T00:00:00.000Z",
"column_six": 1513255007072
}
To exclude a column from the final object structure, give it the type excluded:
my_column_that_will_not_be_a_property:excluded
This can be useful if using a column for doc references.
In the reference example below. A property on the JSON doc will be populated with the doc that matches the WHERE statement.
The CSV example below using the reference will find the doc with district_1 and create a parent property with the value of the district_1 doc
To reference other docs, replace the type suffix with a matching clause:
parent:place WHERE reference_id=COL_VAL
Refered to CSV Example:
| reference_id:excluded | is_name_generated | name | reported_date:timestamp |
|---|---|---|---|
| district_1 | false | D1 | 1544031155715 |
| district_2 | false | D2 | 1544031155715 |
| district_3 | false | D3 | 1544031155715 |
| reference_id:excluded | parent:place WHERE reference_id=COL_VAL | is_name_generated | name | reported_date:timestamp |
|---|---|---|---|---|
| health_center_1 | district_1 | false | HC1 | 1544031155715 |
| health_center_2 | district_2 | false | HC2 | 1544031155715 |
| health_center_3 | district_3 | false | HC3 | 1544031155715 |
This would create a structure such as:
{
"type": "health_center",
//Parent Property with district_1 doc as the value
"parent": {
"type": "district_hospital",
"parent": "",
"is_name_generated": "false",
"name": "D2",
"external_id": "",
"notes": "",
"geolocation": "",
"reported_date": 1544031155715,
"_id": "f223f240-5d6a-5a7a-91d4-46d3c59de73e"
},
"is_name_generated": "false",
"name": "HC7",
"external_id": "",
"notes": "",
"geolocation": "",
"reported_date": 1544031155715,
"_id": "480d0cd0-c021-5d55-8c63-d86576d592fc"
}
To reference specific properties of other docs:
parent:GET _id OF place WHERE reference_id=COL_VAL
In this example the health_ccenter doc will have a property of parent set to the _id of the refered to doc district_1 property of _id
NOTE: _id is a generated value that is inside the generated docs.
Refered to CSV Example:
| reference_id:excluded | is_name_generated | name | reported_date:timestamp |
|---|---|---|---|
| district_1 | false | D1 | 1544031155715 |
| district_2 | false | D2 | 1544031155715 |
| district_3 | false | D3 | 1544031155715 |
CSV Using Reference
| reference_id:excluded | parent:GET _id OF place WHERE reference_id=COL_VAL | is_name_generated | name | reported_date:timestamp |
|---|---|---|---|---|
| health_center_1 | district_1 | false | HC1 | 1544031155715 |
| health_center_2 | district_2 | false | HC2 | 1544031155715 |
| health_center_3 | district_3 | false | HC3 | 1544031155715 |
This would create a structure such as:
{
"type": "health_center",
//Parent property with the _id from district_1 as the value.
"parent": "0c31056a-3a80-54dd-b136-46145d451a66",
"is_name_generated": "false",
"name": "HC3",
"external_id": "",
"notes": "",
"geolocation": "",
"reported_date": 1544031155715,
"_id": "45293356-353c-5eb1-9a41-baa3427b4f69"
}
Note the special string COL_VAL - this matches the CSV column value for the row being processed.
Fetch logs from a production server.
This is a standalone command installed alongside medic-conf. For usage information, run medic-logs --help.
medic-logs <instance-name> <log-types...>
Accepted log types:
api
couchdb
gardener
nginx
sentinel
To compress PNGs and SVGs in the current directory and its subdirectories, two commands are available:
compress-pngs
compress-svgs
- only upload things which have changed (this could be a separate mode - e.g.
updatevsconfigure)
- bump version number in
package.json npm installto updatepackage-lock.jsonnpm run generate-changelogto updateCHANGELOG.mdnpm run release- try to work out how you can commit the CHANGELOG including the change that includes the CHANGELOG update before you run the release script
Copyright 2013-2018 Medic Mobile, Inc. hello@medicmobile.org
The software is provided under AGPL-3.0. Contributions to this project are accepted under the same license.