Instance Status Communication Links

Document status

DRAFT

Document owner

@Joshua Lamos-Sweeney + @Luke Cook

Designer

@Luke Cook

Tech lead

@Joshua Lamos-Sweeney

Technical writers

TBD

QA

TBD

Objective

Development of a return-path communication for callers of the Process Layer to allow those callers to respond to changes in the process layer state, if desired. This forwards the goals of separating the file system and email statii from the up-to-the-minute reporting of the job’s state by allowing a communication channel back to the instantiating entity, be it the current UIs or automated systems.

This allows the Digest layer to be simplified in configuration to not rely on a specific caller.

 

Concept

This relies on the Instruction File Persistence Refactor, which makes a straight-call connection to the digest process that will be used to process the job. This allows for more flexibility on what the calling process is than the ‘ticket’ file system currently in use by the digest/extract process layers. By making that refactor, we’ve opened up the possibility of richer interprocess communication channels that can simplify the inner workings and reduce the interconnection between the ‘nodes’ of GDM.

Success metrics

 

Goal

Metric

Goal

Metric

Existing UI continues to function in all extant use cases, with minimal update

BERT and manual testing

Simplification of configuration required in gobii-web.xml and reduction of size of instruction files

via Counting

Assumptions

That this refactor will require minimal updates to the loader and extractor UI, as those entities will need simply a slightly different calling pattern to that required for the Persistence refactor.