XML Output and Viewer Utility

XML

Specifying the -xml option on the command line will generate an xml description of the register set. The xml format is unique to ordt. XML output options are here.

Register viewer utility

A web app for storing, displaying, and sharing register info generated by ordt is provided starting with release 170915.01. The utility reads ordt xml files and stores their info in a persistent db where they can be accessed via a web browser. This utility has proved useful during register development, but has not been deployed in a larger and/or production environments - it is provided as-is.

Setting up ordt-viewer

To install and run the viewer server (shown for linux)...

• download the ordt-viewer*.zip file to the server machine (latest in the 170915.01 release area)

• unzip the file...

  unzip ordt-viewer-170905-2-SNAPSHOT.zip
  

• go to bin directory in unzipped files...

  cd ordt-viewer-*/bin
  

• insure JAVA_HOME environment variable points to a 1.8 jre, eg...

  setenv JAVA_HOME /my_java/jre1.8.0_144
  

• activate the viewer...

  ordt-viewer -Dhttp.port=<myPort> -DviewerHost=<myHostName> -Dplay.evolutions.db.default.autoApply=true -Dplay.crypto.secret='<someString>'
  

• To access the viewer browse to <myHostName>:<myPort> or localhost:<myPort> (if on the server machine)

By default, a database will be set up at ~/ordt_viewer on the server. This can be overriden by specifying -DviewerDBdir=<myDBDirectory>. Xml files accessible by the server machine can be loaded into the database via the ->Data menu item and viewed via the ->Root menu item. Selecting ->Filter allows searching of the database (search scope will be set to the last viewed register/register set).