Outlining Nexleaf Integration

Basic Conceptual Alignment Arch Diagram

Background: 

2017-08-29 NexLeaf Integration Meeting notes (includes Auth architecture such as service token approach)

2017-09-06 NexLeaf Integration Meeting notes

Task List

Software development regarding implementation to begin for both teams (OpenLMIS and Nexleaf) in November 2017

Originally created on 2017/10/12 check in call with: Josh Zamor, Brandon Bowersox-Johnson, Rachel Powers (Deactivated), Mary Jo Kochendorfer (Deactivated) , Chongsun Ahn (Unlicensed), Martin Lukac, Terence Honles

Notification API proposal

Notifications will take the following form and be expressed as JSON objects

• alert_id [string] - opaque identifier (UUID etc)
• equipment_id [string] - opaque identifier (UUID etc)
• start_ts [int] - microseconds since epoch
• end_ts [nullable] - microseconds since epoch
• status [string] - Human readable description of the alert
• alert_type [string] - pre defined set of alert types [temp out of range, uptime out of range, etc...]

They can be received through a webhook (HTTP POST), or listed (HTTP GET) per equipment through an API endpoint e.g. `/coldtrace/api/v2/alerts/<equipment_id>`

(webhook would be immediate, GET request would be on OpenLMIS schedule.)

Nexleaf would send trigger for Needs Attention, also sends end of alert once functionality is improved

What quantifies the notification? Is it only once a day? 

 Proposed timeline for integration

• MVP integration complete by March? 
• Slow burn over the next three months.
• Second week in February is demo to Gavi, so we will likely want to showcase part of the integration work and/or talk about it.
• Spread out level of effort

Check-in Meetings

Check-in Meeting 11 Jan 2018 

Martin: We can talk through the tasks on our end. We also wanted to review the fields/data model in openlmis that are available for the facilities/equipment/etc.

• paralells the OpenLMIS service accounts → called configuration management 
  • storing information on service account
  • Rules used for triggering notifications
• Syncing service (geo zones, facilities, equipment, etc.)
  • download, match, stored (manually triggered) 
  • Assumption: NexLeaf will assume it doesn't have any of the information
• Notifications themselves
  • Rules
  • Next step, define the status codes together. Will do something basic for the demo

Josh: Lets look at these two FHIR tickets relating to meta-data alignment around facilities: https://openlmis.atlassian.net/browse/OLMIS-3387 and the subsequent https://openlmis.atlassian.net/browse/OLMIS-3389 . These haven’t started yet, and only the first has made it into an active sprint, however you will see where some of our fields will map to in FHIR Location and we can discuss what won’t be delivered in these tickets (Searching, feeds, etc).

• Next: How do we want to find changes (difs)
• After we implement the first two, we should look into OLMIS-3915 and how we want to support it

Follow up

• Martin inquired about learning more about Data Warehousing. MJ shared Reporting and Data Warehouse Strategy and asked if Martin could let her know what areas he is interested in digging more into. MJ can schedule a meeting with Peter at Ona.
• Check in on scheduling for the week of Jan 22.

Check-in Meeting 24 Jan 2018 

In person check in

Agenda

• Updates
  • VR has started on the FHIR representation tickets.
  • Nexleaf added more detail the API notification and status
  • Date for the GAVI demo is the week of March 19
• Discuss the API proposal (are we ready for this conversation?) When does it need to be resolved by to meet the end of March deadline? https://docs.google.com/document/d/1cwdTIOtPbuf1O2_s5BPgEKEAps9HyU4A9TEbM6Owmk0/edit#
  • Decided to include a language dictionary of those requested using the ISO
  • Josh asked about performance implications but Terrance doesn't think there will any.
  • Josh: How do we interpret start and end time stamps? CT will send the status ID and when the alert started and will resend when the same alert ID ends.
  • Josh: For the first cut, we will wait for the POST. 
  • Terrance: We will want to decide a retry policy to make sure we had a OpenLMIS server awknowledgement. Terrance and Martin will determine what is reasonable for the retry policy.
  • Discussion on the cce or devide ID. Terrance and Martin will determine what is best.
• Review what key decisions need to be made by when to release by the end of March.
  • How will testing be handled?
  • What will the demo data look like?
  • Discuss the actual demo and what we want to show stakeholders.
  • Nexleaf
    • Define the web hooks with an appropriate retry policy
    • Implementing the API
  • VR
    • Define the OpenLMIS spec for the needs attention flag
    • Master data alignment implementation
• Learn more about the scope of issue tracking and managing the maintanence of equipment 
• Talk about future opportunities 

Check in Meeting 01 Feb 2018 

• Gavi demo is scheduled for 26 Mar 2018 
• Update on API: https://docs.google.com/document/d/1cwdTIOtPbuf1O2_s5BPgEKEAps9HyU4A9TEbM6Owmk0/edit
• Update on looking into the web hooks and appropriate retry policy
• FHIR resources completed
  • However, one minor correction  OLMIS-4064 - Getting issue details... STATUS
  • https://test.openlmis.org/referencedata/docs/#!/default/get_api_Location
  • http://docs.openlmis.org/en/latest/components/index.html
• Needs Attention functionality to be defined this sprint
• Demo Data
  • Facility/location (example, Dep—sito Distrital Cuamba) https://github.com/OpenLMIS/openlmis-referencedata/tree/master/demo-data
  • Equipment - https://github.com/OpenLMIS/openlmis-cce/tree/master/demo-data

Next week discuss

• Status
• Testing?

Check in Meeting 08 Feb 2018 

• Update on ColdTrace API development, retry logic, etc
  • Facility sync is done
  • Martin Lukac and Terence Honles will come up with a proposal for how to pass along the conditions
• Update on needs attention design for OpenLMIS
  • Needs Attention RTM Alert has the mock ups for what we plan to build
  • OLMIS-4064 - Getting issue details... STATUS
• Next, OpenLMIS needs to consume API
• Demo data
  • Data is from october/september 2017
  • OpenLMIS has zones, devices
  • Will wait till VR gives the go ahead on which places

Testing - next time

Check in Meeting 15 Feb 2018 

• Update on ColdTrace API development and OpenLMIS development:
  • Two OpenLMIS bugs are fixed
• Question from VR: Date/time question, any resolution?
  • Nexleaf is still discussing the standard
• Question from VR: When will Nexleaf be ready to start sending alerts?
  • Nexleaf will specify the post API
• OpenLMIS update
  • OLMIS-4106 - Getting issue details... STATUS  is the epic of all of our work
  • code review: https://review.openlmis.org/cru/FEOLMIS-2532#CFR-35570
  • Terence Honles raised a good point around grouping alerts by device
  • Chongsun Ahn (Unlicensed) and Mary Jo Kochendorfer (Deactivated) to follow up and discuss how the dismissing will work when multiple alerts come through (DONE)

Contracting testing - Next week

Demo data - Next week

• Data is from october/september 2017
• OpenLMIS has zones, devices
• Will wait till VR gives the go ahead on which places

Current thinking for the demo (DRAFT)

• Facility: Dep—sito Distrital Cuamba (still need to define the HF but I think it is Matias, Cuamba)

• Devices: 

Check in Meeting 22 Feb 2018 

Reminder that Demo is in 26 Mar 2018. Martin Lukac will let us know if he is in town and can join in Geneva.

• Update on ColdTrace API development and OpenLMIS development. 
  • Still chatting with Ashraf and the date/time.
  • Chongsun: PUT API is in review and in the test server
• Question from Terence Honles: Are there cases where there are sibilings (regarding areas and sites)? 
  • The depth of the model goes to Facility level
  • VillageReach will let Nexleaf know when we update our facility model (start supporting locations within locations)
• Contract testing - let's discuss and address once we get message from ColdTrace

Demo data - let’s target devices at:

• Health Facility: Lurio, Cuamba and
• District Facility: Dep—sito Distrital Cuamba

Check in Meeting 01 Mar 2018 

• Update from Nexleaf
  • By next check in the API should be done
  • Terence will QA  OLMIS-4105 - Getting issue details... STATUS
• Update from VR
  • In QA  OLMIS-4105 - Getting issue details... STATUS
  • In progress  OLMIS-4127 - Getting issue details... STATUS
  • Will put it in  OLMIS-4196 - Getting issue details... STATUS

Next meeting:

• Contract testing - let's discuss and address once we get message from ColdTrace
• Mary Jo Kochendorfer (Deactivated) would like to discuss access to ColdTrace demo in case there are questions from Gavi stakeholders

Check in Meeting 08 Mar 2018 

• Update from Nexleaf
  • Terence tested  OLMIS-4105 - Getting issue details... STATUS  and have a couple things to work through.
  • Next week you'll be working on the demo data
• Update from VR
  • Updated the resource and demo data based on back and forth on  OLMIS-4105 - Getting issue details... STATUS .
  • Service Accounts uncovered a bug (when we restart the application) OLMIS-4257 and demo data OLMIS-4249
  • Serial number OLMIS-4196, Josh is working on it this sprint

Demo data questions

• Should we sync up the demo data so they are aligned?
• On the coldtrace side, how can we 'send an alert'?
• Version 3 Demo: Supporting Documentation : Martin Lukac to update
  • One piece of equipment will have an active alert
  • One piece of equipment will have an old alert
  • user: divo1, password: password
• Martin Lukac would you help me with a slide on ColdTrace and brief summary of the blog we did? Thanks!

Check in Meeting 15 Mar 2018 

Update from NexLeaf

• tested the serializtion numbers, works good

Update from VR

• View the historical alerts
• Planning to wrap up  OLMIS-4257 - Getting issue details... STATUS  and  OLMIS-4249 - Getting issue details... STATUS  shortly

Check in Meeting 05 Apr 2018 

Mary Jo to give an update on what happened. Indicated that we'd like to do the demo again in the upcoming 3.3 webinar.

Automatic dismissing of alerts

Outstanding item which could be changed updated in the future. It might be problematic if OpenLMIS dismisses the alert (makes it inactive) when there is an end date in the message. Unclear what the best behavior is given that OpenLMIS isn't currently in used. 

Webinar

• Need to alert to Terence when we restart and before the webinar

Josh, Mary Jo, Martin talked about PQS standards.

Out of Scope:

• Synchronizing user accounts & permissions across platforms
• Achieving a shared, standardized PQS catalog (this is a long term goal that is not covered by this)

Open Questions: