Feat: merge ODK central work #6337

jniles · 2022-01-25T08:24:52Z

This PR adds in ODK Central functionality to the BHIMA server. Here is what the ODK administration interface looks like:

You'll need to set your own username/password and ODK Central URL to test it out.

This installation is very bare-bones. The way this works is somewhat documented in #6235 (comment).

This PR is plucked from work done by @jniles and @mbayopanda in sprint-prosani.

Closes #6235.
Closes #6302.
Closes #6322.

TESTING (based on session with @jniles )

Use bhima test (rebuild db, etc)
Go to Administration > ODK Settings
- Enter the ODK Central login credentials in the left-most panel (ODK Integration Settings)
- In the middle panel, click on
  - Synchronize enterprise settings
  - Synchronize users
  - Synchronize forms
Go to Adminstration > User Management
- In the action menu for Superuser, click on the [ODK QR Code] link to display the QR code (leave it up on your screen)
On your mobile phone
- If you have not installed ODK Collect, do that
- In ODK Collect, click on the [Configure with QR code] button on the entry screen. This should bring up the "Test Enterprise" page
- Click on [Get Blank Form]. It should show that it has downloaded a form
- On the bottom right of the page, click on the [Get Selected] button. This downloads the form and sends you back to the "Test Enterprise" page.
- Click on [Fill Blank Form] and select the form. This should start filling out the form.
- Fill out the form
  - For Nombre des articles, enter 1
  - For the barcode, first go to Bhima (Stock Lots) and display the barcode for lot VITAMIN-A. Then scan that barcode with your phone. When you click next, it should show the lot you selected.
  - Finish the form ([X] Mark form as finalize, press [Save Form and Exit])
- Back on the "Test Enterprise" page, click [Send Finalized Form]. Select the form you just completed and press [Send Selected] on the bottom right of the page.
- Back on Bhima go to Administration > ODK Settings
- Click on: Synchronize Submissions [Sync]
- Go to Stock > Stock Movements and verify that you have a new stock entry in Depot Tertiaire

jniles · 2022-01-25T13:24:24Z

@jmcameron I requested a review too early. There's some code I'm going to try and migrate out of this PR into the ODK Central API library. I'll ping you when I'm ready for a review.

jniles · 2022-01-26T13:19:46Z

@jmcameron this is ready for review.

jmcameron

Could not sync with the server. Tried logging manually and that worked. But when I carefully enter the ODK central server credentials and try "Sync Enterprise", I get 403 errors.

jniles · 2022-01-28T10:26:51Z

@jmcameron thanks for the review. I think I gave you the wrong credentials. I have sent you some new ones!

This commit implements the ODK Central link with BHIMA, developped during the `prosani-sprint`. The goal is to have a functional, optional link to ODK Central that can be merged into the BHIMA repository. Closes Third-Culture-Software#6235.

This commit skips users in the database without email addresses. Closes Third-Culture-Software#6322.

This commit disables the sync buttons when synchronisation is not finished yet.

This commit adds better loading and default text to the ODK Central configuration page.

This commit cleans up the ODK Central work, having moved some items out of the odk-central file to be put in the ODK Central API library.

This commit cleans up old code and gets the ODK portion totally ready for submission.

jmcameron

I found the term "ODK Central" a little vague. As I was trying to figure out ODK, it was not obvious if this was part of BHIMA or not. So I suggest renaming this to "BHIMA ODK Server" or something similar.

Obviously this is a bare-bones ODK server. However (in another PR), we need a registry for ODK forms, submissions, aggregated data, etc.

I did a basic review of the code. See the inline code comments.

I also tested this (per the procedure outlined in the PR description) with assistance from @jniles. Other than an online server database issue that @jniles fixed behind the scenes, it all worked nicely.

We found that the QR code for the ODK server settings works well. However, the BHIMA lot barcodes seem to be a little small for reliable scanning on my cell phone. So I suggest increasing the lot barcode display. If that is not done in this PR, I suggest creating a new issue for it.

In practice, I suspect the layout of this page will evolve. It seems like it should perhaps be a "ODK Campaign" registry and the Settings and sync actions might fall under the main Menu button?

jmcameron · 2022-01-28T17:58:58Z

server/models/bhima.sql

@@ -178,7 +178,8 @@ INSERT INTO unit VALUES
  (302, 'Cost Centers Accounts Report','TREE.COST_CENTER_ACCOUNTS_REPORT','Report of cc accounts values', 286,'/reports/cost_center_accounts'),
  (303, 'Cost Centers Balance Report','TREE.COST_CENTER_INCOME_EXPENSE_REPORT','Report of cc balance', 286,'/reports/cost_center_income_and_expense'),
  (304, '[SETTINGS] Settings', 'TREE.PAYROLL_SETTINGS', 'Payroll Settings', 57, '/payroll/setting'),
-  (305, 'Avg Medical Costs Per Patient', 'TREE.AVERAGE_MED_COST_REPORT', 'Report of avg med costs', 282, '/reports/avg_med_costs_per_patient');
+  (305, 'Avg Medical Costs Per Patient', 'TREE.AVERAGE_MED_COST_REPORT', 'Report of avg med costs', 282, '/reports/avg_med_costs_per_patient'),
+  (306, '[SETTINGS] ODK Settings', 'TREE.ODK_SETTINGS', 'ODK Settings', 1, '/admin/odk-settings');


While using the [Settings] option to add the gear icon for the ODK Settings looks nice, it a bit odd in the context of the other Administration menu items. Several of the items in that menu are for settings (eg Enterprise) and are not marked with the gear icon. So the ODK Settings is not consistent with the rest. So I suggest either removing [SETTINGS] or adding to other items in the Administration menu that are for settings. Also, in reality, the ODK Settings item is about more than settings. Only the left most panel is for settings. The rest are for actions, so this page is not ALL settings.

Yeah, this is a good point. Let me do that.

jmcameron · 2022-01-28T18:00:09Z

server/models/migrations/next/migrate.sql

- * @description: update migrate.sql file for
- * @date: 2022-01-24
-*/
-UPDATE report SET `report_key` = 'analysis_auxiliary_cashbox', `title_key` = 'REPORT.ANALYSIS_AUX_CASHBOX.TITLE'


It was not obvious why these got deleted.

Probably a failed merge. Let me fix it.

jniles · 2022-01-28T19:56:56Z

@jmcameron thanks for the review. ODK Central is the official name: https://docs.getodk.org/central-setup/. I do agree that it is confusing. They used to have a different server called ODK Aggregate, which also was a pretty non-googleable name.

This commit refactors code from the review.

jmcameron · 2022-01-28T20:04:01Z

@jmcameron thanks for the review. ODK Central is the official name: https://docs.getodk.org/central-setup/. I do agree that it is confusing. They used to have a different server called ODK Aggregate, which also was a pretty non-googleable name.

Got it. Somehow I thought "ODK Central" was a server that we actually set up ourselves.

This commit automatically assigns teh forms to the users on creation of the form.

jniles · 2022-01-28T20:58:10Z

@jmcameron got the assignment bug fixed. If you want to test it again, feel free. Otherwise, I think this is ready to go.

jmcameron · 2022-01-28T21:02:52Z

Bors r+

bors · 2022-01-28T21:02:55Z

Canceled.

jmcameron · 2022-01-28T21:04:41Z

@jniles It was not obvious why the merge attempt failed. I'll try again.

jmcameron · 2022-01-28T21:05:09Z

bors r+

bors · 2022-01-28T21:09:58Z

Build succeeded:

ci/semaphoreci/push: Integration Tests

jniles · 2022-01-28T21:37:41Z

Thanks!

jniles requested a review from jmcameron January 25, 2022 08:24

jniles force-pushed the feat-merge-odk-central-work branch 2 times, most recently from beee509 to 6aca5b0 Compare January 25, 2022 09:36

jniles added Feature Request Do Not Merge labels Jan 25, 2022

jniles removed the Do Not Merge label Jan 26, 2022

jniles force-pushed the feat-merge-odk-central-work branch from 41e32f2 to 484589d Compare January 26, 2022 12:08

jmcameron reviewed Jan 27, 2022

View reviewed changes

jniles force-pushed the feat-merge-odk-central-work branch from 484589d to 7b51ec6 Compare January 28, 2022 07:20

jniles requested a review from mbayopanda January 28, 2022 08:13

jniles added 7 commits January 28, 2022 17:23

feat(odk): implement ODK Central Link

774b12a

This commit implements the ODK Central link with BHIMA, developped during the `prosani-sprint`. The goal is to have a functional, optional link to ODK Central that can be merged into the BHIMA repository. Closes Third-Culture-Software#6235.

fix(users): skip users without email addresses

2fb4867

This commit skips users in the database without email addresses. Closes Third-Culture-Software#6322.

chore(odk): disable fields on loading

9da5f8e

This commit disables the sync buttons when synchronisation is not finished yet.

chore(odk): add better loading/default text

a0f5235

This commit adds better loading and default text to the ODK Central configuration page.

chore: final touches

a8b20a8

This commit cleans up the ODK Central work, having moved some items out of the odk-central file to be put in the ODK Central API library.

docs: add documentation on ODK Central

6273d31

chore: remove old code

3fcbeb2

This commit cleans up old code and gets the ODK portion totally ready for submission.

jniles force-pushed the feat-merge-odk-central-work branch from 5207504 to 3fcbeb2 Compare January 28, 2022 16:24

jmcameron self-requested a review January 28, 2022 17:46

jmcameron reviewed Jan 28, 2022

View reviewed changes

chore: refactor from review

33f3f2a

This commit refactors code from the review.

fix(odk): auto-assign form to user(s) on create

ca899a4

This commit automatically assigns teh forms to the users on creation of the form.

chore: bump deps

e6d9174

bors bot merged commit 37e0c07 into Third-Culture-Software:master Jan 28, 2022

jniles deleted the feat-merge-odk-central-work branch January 28, 2022 21:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat: merge ODK central work #6337

Feat: merge ODK central work #6337

jniles commented Jan 25, 2022 •

edited

Loading

jniles commented Jan 25, 2022

jniles commented Jan 26, 2022

jmcameron left a comment •

edited by jniles

Loading

jniles commented Jan 28, 2022

jmcameron left a comment •

edited

Loading

jmcameron Jan 28, 2022

jniles Jan 28, 2022

jmcameron Jan 28, 2022

jniles Jan 28, 2022

jniles commented Jan 28, 2022

jmcameron commented Jan 28, 2022

jniles commented Jan 28, 2022

jmcameron commented Jan 28, 2022

bors bot commented Jan 28, 2022

jmcameron commented Jan 28, 2022

jmcameron commented Jan 28, 2022

bors bot commented Jan 28, 2022

jniles commented Jan 28, 2022

Feat: merge ODK central work #6337

Feat: merge ODK central work #6337

Conversation

jniles commented Jan 25, 2022 • edited Loading

jniles commented Jan 25, 2022

jniles commented Jan 26, 2022

jmcameron left a comment • edited by jniles Loading

Choose a reason for hiding this comment

jniles commented Jan 28, 2022

jmcameron left a comment • edited Loading

Choose a reason for hiding this comment

jmcameron Jan 28, 2022

Choose a reason for hiding this comment

jniles Jan 28, 2022

Choose a reason for hiding this comment

jmcameron Jan 28, 2022

Choose a reason for hiding this comment

jniles Jan 28, 2022

Choose a reason for hiding this comment

jniles commented Jan 28, 2022

jmcameron commented Jan 28, 2022

jniles commented Jan 28, 2022

jmcameron commented Jan 28, 2022

bors bot commented Jan 28, 2022

jmcameron commented Jan 28, 2022

jmcameron commented Jan 28, 2022

bors bot commented Jan 28, 2022

jniles commented Jan 28, 2022

jniles commented Jan 25, 2022 •

edited

Loading

jmcameron left a comment •

edited by jniles

Loading

jmcameron left a comment •

edited

Loading