V3 PubProcess - Prepare Source Files

From HL7Wiki
Jump to navigation Jump to search


Primarytargets and documentation on this page

This page documents a number of named ANT "targets" (names like 00.10...REVIEW properties) that invoke specific tasks, and documents. The combined publishing tools include ten "primary" targets, and over 25 "supplemental" targets. These are distinguished as follows:
  • Primary targets are shown on this page in bold face; they correspond to "batch" files of the same name.
  • Supplemental targets are shown on this page indented and in normal font; they correspond to "batch" files named with the prefix "supp-" followed by the target name.

02...Prepare Source Files For Publication

The various content files repaired by the Work Groups must be preprocessed in order to make them useful in the publication. For example, the domain content must be extracted( as an XML file) from the publication database; the Visio "vsd" files from HL7's RMIM Designer must be processed to create appropriately sized graphics, and a hyper-linked HTML "map" to drive graphic navigation; etc. This section documents the processes used in preparing these files.

02.00...Manual Preparation of Freehand MIF Files

The link above leads to instructions for editors of freehand MIF files, that is, documents such as those in the Help and Infrastructure sections that are hand edited by someone familiar with XML, XHTML and using a program such as XMLSpy. These documents include a "template" that can be downloaded and processed by selecting the miftemplate in the non.domains.general subject list in the defined-environment.properties file. The template provides both an example and details of the implementation of certain MIF mark-up entries.

02.10...PubDb Extract

This is the process that exports "domain xml" from the HL7 Publication data base (PubDb). The process is a part of the RoseTree tools.

Defined Processes (Eclipse Target or BAT file):
  • 02.10...PUBDB Extract - Extracts the content from all PubDbs found in the databases sub-directory of all domains regardless of the date of extraction of any pre-exisitng Pub XML file. IT places the result in generator/InputFiles/DynamicModelFiles. It also copies (and over-writes) the extracted content for the domains in domains.active and domains.support back to the input/domains/uvnn directories.
  • 02.15...PUBDB Update - Extracts the content from all PubDbs found in the databases sub-directory of all domains if the data base has been edited since the prior Pub XML file was extracted. It places the result in generator/InputFiles/DynamicModelFiles. It also copies (and over-writes) the extracted content for the domains in domains.active and domains.support back to the input/domains/uvnn directories.

02.20...Extract Visio Graphics

This process provides for the extraction of "png" files for the static model designs and for "thumb-nail" graphics of same.

Defined Processes (Eclipse Target or BAT file):
  • 02.20...EXTRACT Visio Graphics and Maps Actually combines steps 02.20 and 02.30. It copies the RMIM Designer Visio (vsd) files to output/processable/hmdvsd/vsd directory and the corresponding Visio xml files to generator/InputFiles/VisioModelXmlFiles. Then it processes the vsd files to extract the graphics, thumbnails and an html overlay map. These outputs are stored in output/processable/hmdvsd/Editable and output/processable/hmdvsd/Editable/images.
    Warning: The Visio to PNG conversion process does not compare the time-stamps on its source and output files. Therefore invoking this process a second time will re-generate the whole set of files.
    Also, the Visio will occasionally fail to close, or throw an error at the end of a larget set of conversions. If this happens, compare the last few files in output/processable/hmdvsd/editable with the last few in output/processable/hmdvsd/vsd if the former are from the same designs as the latter, the process completed normally, despite the error.

02.30...HTML Overlay Maps

This process builds an html "map" (overlay) that works with the extracted PNG files to provide clickable-graphics for navigating to details of the static model designs. (This is performed as part of process 02.20...EXTRACT Visio Graphics and Maps, above.

02.40...Position all files

The final processes of this section take the variety of source files received from a Work Group (or created by preceding extraction steps) and places them in the directories in which the V3 Generator and Publishing processes expect to find them.

Defined Processes (Eclipse Target or BAT file):
  • 02.40...POSITION Domain Source - XML and Visio - Copies PubXML from input to the V3 Generator/InputFiles/DynamicModelFiles and domain Visio files to output/processable/hmdvsd/vsd. This process is redundant if both steps 02.10 and 02.20 have just been run. It is used when the Generator source has been cleared, and needs to be re-freshed from input, even as the original extraction remains valid.
    • 02.41...Position Domain XML Source - Is the subset of 02.40 that copies PubXML to generator/InputFiles/DynamicModelFiles (There is no bat file for this.)
    • 02.42...Position Domain Visio - Is the subset of 02.40 that copies Visio vsd files to output/processable/hmdvsd/vsd and Visio xmlfiles to generator/InputFiles/DynamicModelFiles. (There is no bat file for this.)
  • Note: The domain-build processes will also move each domain's files to its output directories just before the domain is built.


Jump to top of page

Jump to Publishing Process "Root" Page