Entity Resolution documentation and examples

[wwqrd]

This is a PR for outstanding feedback for the entity resolution feature, which was merged without the navigation elements or the screens being visible (they are commented out), until these other parts are ready. This was done to ensure that the code doesn't become unmergable due to future changes in master.

Once this feedback is complete the entry in workspace navigation and the screen can be uncommented.

Feedback

• We need to add user facing text to the interface generally.
  • Explain the feature and each of the items, and
    • link to the documentation
  • Not sure about the numbered sections here, since this isn't really a 'flow' in the same way as export.
  • Dialog when going back: "looks like you have set some attributes" - this needs to properly explain the situation to the user!
• Create a tutorial for the documentation website that outlines and demonstrates this feature
  • Create a simple entity resolution protocol for the tutorial
  • Make sure to document output data format _caseID and _parentID (these may be renamed - see below)
  • Document requirements of script itself in terms of IO
  • Provide helpful troubleshooting tips for common error cases
• Improve example entity resolution script repo. This was intended to be a template repository. Align with the tutorial
  • Needs a readme
  • File organisation
  • code cleanup and comments.
• BUG: "cannot resolve variables of undefined" -> when protocol has no ego stages
• BUG: removing all resolutions doesn't allow the user to change the alter type for casting ego
• BUG: removing the resolution and then running another resolution shows the old number of resolved nodes in the summary
• Improvements to resolution UI itself
  • pressing enter should go to the next match
  • high frequency responses from the resolution script still cause render thrashing and unresponsiveness. we need to throttle re-renders to every 2 seconds or so
  • "use all" -> Use all attributes from this node (maybe alt text?)
  • Button for matching rows shows even when number is '0'
  • Dialog doesn't use available vertical height. In general show as many attributes as possible
  • Improve the final summary UI by adding some explanatory text
• Data format issues/errors. Some of these could have been caught by validating the output against our schema.
  • session export time is the wrong format (correct format is xs:dateTime "2021-02-16T09:01:17.342Z")
  • case ID and session UUID aren't correct (nc:caseId="AsiZrUAiAP1H7KlW" nc:sessionUUID="entity_resolution"). Case ID should be "Entity Resolution", and session UUID should be a uuid.
  • Use the prefix "networkCanvas" rather than underscore for the caseID and parentID variables, and use better naming. So, networkCanvasOriginCaseIDs and networkCanvasOriginUUIDs.
  • Ego variables and alter type variables appear separately, although ego is 'cast' to an alter type
  • There is an orphan data node right after the graph element: <data key="networkCanvasUUID">undefined</data>. Suspect this is a network-exporters bug due to having no ego entity
• When importing a resolved network back into server "cannot read property variables of undefined" - separate bug assuming ego again? This is not a function we want to support (see below)
• Ensure resolved networks cant be imported back into Server. Perhaps we should re-establish the 'useNCGraphML' flag in network exporters, so that resolution can output 'vanilla' graphml?