Formula Linked Definitions & Schema Tree Enhancement #3408
Description
Problem description
The current schema tree doesn't directly correspond to methodological formula's, although methodologies are invoked via schema's and tools this could be improved from a definition alignment to the formula that exists in the PDF.
The objective is to enable users to view human readable mathematical representations of the calculation functionality of policies whenever they look at relevant schemas, policies or documents with data. Furthermore, they should be able to see how the values are calculated, i.e. which field in a schema or a document maps to what variable in the displayed math formula so they have an opportunity to manually check the result.
Schema tree view should display a hierarchy of formulas it represents, mapping variables in the formula to fields in schemas.
Requirements
- Introduce a UI component, or 2 separate but compatible components, into the Guardian which can display mathematical formulas in a format familiar to the user (like formulas in a LaTex documents of PDFs). These formulas should be interactive, i.e.:
- at the viewing time individual elements of the formulas should be clickable so users can drill into the variables and see corresponding schemas/documents.
- users should be able to input formulas (in a formula editor) of sufficient complexity to cover all VCM cases
- users should be able to copy/paste entire formulas or parts thereof
- Enable policy authors to map schema tree structures to formulas, linking the fields and variables so Guardian UI can display them as per point above
- Enhance Guardian schema, policy and VC/VPs views to display the formulas whenever they are available.
- Introduce the ability to attach a PDF file to the schemas/formulas at the policy/schema creation time, and specify the (external) 'origin' link so the original source of the math can be traced to the original paper.
- Enhance schema tree view to display the formulas alongside schemas.
Definition of done
- Policy authors can input a formula, link it to the existing schema tree structure, enhance it with additional properties (e.g. attach a 'source document' or add more fields).
- Users viewing policies, schemas, and documents can see the formulas are associated with them, explore the components of these formulas all the way down to the fundamental data level, and see the source document if available.
Acceptance criteria
Users can link formulas in paper documents/standards to the exact elements of policies that implement them.