kazana-group-raw-data v1.0.0

kazana-groups-raw-data

Like kazana-raw-data, but has an api that allows groups of users read access to documents

Scope

The raw data module is the point of entry for new data. Data sources may be excels sheets, CSV files, 3rd party services or others. The user must not be blocked from submitting a new data report, the raw-data database should take anything.

1. All source data will be stored in its original form for reference
2. No parsing or format transformation is happening at this stage.
3. Data must not be changed at this point.

Configuration

The raw data module is configurable using ENV variables

Usage

kazana-raw-data is a core plugin of Kazana and gets started automatically in kazana apps.

kazana-groups-raw-data needs to be added as a plugin:

// index.js in your kazana app

module.exports = {
  // ...app
  plugins: ['kazana-group-raw-data']
}

When running as a plugin, the endpoints will be grouped under /kazana/group-raw-data/..., for example /kazana/group-raw-data/api/submissions

You can also run it separately for local development or deployment

git clone git@github.com:eHealthAfrica/kazana-group-raw-data.git
cd kazana-group-raw-data
npm install
npm start

Routes

User must be authenticated for all routes

GET /api/submissions
POST /api/submissions
GET /api/submissions/{id}
PUT /api/submissions/{id}
DELETE /api/submissions/{id}
# these routes have low test coverage
# and might not work with groups
POST /api/submissions/with-attachments
GET /api/submissions?filter=pending|withErrors|transformed
PUT /api/submissions/{id}/attachments
GET /api/submissions/{id}/attachments/{filename}
PUT /api/submissions/{id}/attachments/{filename}

Test

npm test

Credit

Brought to you by eHealth Africa — good tech for hard places.

License

Apache-2.0