V3 PubProcess - Establish Environment

From HL7Wiki
Jump to navigation Jump to search

Primary Targets documented 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.

00...Establish Environment

This section deals with the process of completing the installation process in Eclipse (if that is the environment), setting various configuration properties that characterize your computing environment to the publishing scripts (written and executed in ANT), and selected processes that can be invoked to reset the environment.

00.10...Configure Tools for Local Environment

The first step after installation is to configure the software environment for your use. This suite of tools relies upon two property files:

  • defined-environment.properties is located in the root directory. In this file you establish which documents wish to publish as you use the tools, and you further define the computing environment that is hosting the tool suite.
  • publish-global.properties is located under "input/support/ant). It establishes default behavior for the publishing and "generation" processes themselves, and is of less importance to the normal user.

Specifics of the contents, purpose, default settings, etc. for the property files is on the page V3 PubProcess - Property Files. Following the steps on that page be sure to consider whether you need to assert non-default values for the following eight properties:

Recommended Settings for Properties (rows) in defined-environment.properties by User Objectives (columns)
Property Name Users Publishing Domain Content Users Publishing Non-domain Content
domains.active Select your domain(s) Set to empty
domains.support Accept default Set to empty
non.domains.special.models Accept default Set to empty
non.domains.special.other Set to empty Set to empty
non.domains.general Set to empty Select your content only
non.domains.dams Set to empty Select your content only
VisioVersion Accept default, unless is wrong Accept default
UsingVistaInstaller Accept default, unless is wrong Accept default

Once the properties have been set, they can be verified with the target below.

Defined Processes (Eclipse Target or BAT file:
  • 00.10...REVIEW properties displays or lists every property that is defined for this environment. (The list produced in Eclipse is sorted, while the list produced in the log of the BAT file is not.)

00.2x...Configure for Eclipse Environment or Command Line (BAT files)

This tool suite is designed to be run in either an "Eclipse" framework, or from the command line using batch files. (These are fully equivalent ways of invoking the same ANT scripts.) If one decides to use the "Eclipse" environment, it is necessary to configure Eclipse to recognize ANT "extensions" used in these scripts. If one intends to use the batch (BAT) files, they were extracted upon installation. If you Wish to use Eclipse to run these tools ee V3 PubProcess - Configuration for installation instructions.

Defined Processes (Eclipse Target or BAT file includes the following. The first of these has been executed by the installation process and the others are not needed for general use.
  • 00.20...Extract Simple BAT files - Extract all disguised Simple Bat files and rename them.
  • 00.21...Extract Publishing BAT files - Extract all disguised Publishing Bat files and rename them.
  • 00.22...Extract Generator BAT files - Extract all disguised Generator Bat files and rename them.

00.3x...Reset Generator Environment and Clear Selected generator Input

In order to create a generator environment which will reliably construct the full set of MIF files, it is often necessary to delete existing "temporary", "output", and selected "input" files from the Generator. (The latter step is necessary because the processes that copy files from the domain source do not remove "old" files that are not being replaced.) This section of the tool provides two processes to accomplish resetting and clearing.

Defined Processes (Eclipse Target or BAT file:
  • 00.30...RESET Generator Environment - Deletes all Temporary and OutputFiles from the Generator, except for OutputFiles/Reports and .log files.
  • 00.40...CLEAR Selected Generator InputFiles - Deletes selected Generator input files from InputFiles/DynamicModelFiles and InputFiles/VisioModelXmlFiles.

00.50...Clear Publishing output Directory

In general, each of the output sub-directories is deleted prior to re-building that domain or other file. However selected sub-directories, notably those under output/processable are not cleared, and thus may accumulate extraneous or erroneous files. This target will delete the output directory and all of its children.

Defined Processes (Eclipse Target or BAT file:
  • 00.50...CLEAR Publishing output directory - Deletes (scorched earth) the publishing /output directory

00.60...Export Selected Content From SVN

The tool is distributed empty of any source content in the /input directory tree. Such content is required for the tools to function. This target provides for the direct "export" of content from the HL7 SVN repository maintained under the "XML Publication Process" project on Gforge for all content that supports the publications selected in the "domain" lists and "non-domain" lists in step 00.10...Configure Tools for Local Environment above.

Defined Processes (Eclipse Target or BAT file:
  • 00.60...Export Selected Content From SVN - Export from the SVN server for the "xmlpublishing" project any missing content directories for all subjects (domains and non-domains) selected in the defined-environment.properites file. The process will:
    1. Determine whether the root directory for this subject exists. If it does, it will do nothing further. (In order to "refresh" content, you will need to delete the subject root directory in order to export it from SVN.)
    2. If the subject root directory is absent, it will export the content for the subject root directory and all of its sub-directories. This can take over three minutes for a large domain, and the process provides no indication of activity other than "starting" and "finished".


The publishing tool suite provides for "automated" changing of the "core" source files used as source for the Publishing and "generator" environment. Each such package represents one particular different RIM and Vocabulary releases. The packages are created and distributed along with the previous "RIM repository" archives, but they are also being distributed with the releases of this tool suite in the input/support/basisfiles directory.

Defined Processes (Eclipse Target or BAT file:
  • 00.70...Update_Core_Source_Packages Interrogates the available RIM and data types packages, offers a selection list and updates. Used for changing base RIM and/or data types release. The process will:
    1. Analyze the available packages in "basisfiles", and offer a set of choices. Functionally, the primary choices are to do nothing; change the "intended" data type release but retain the same RIM and vocabulary release; or to switch do a different RIM, and vocabulary release (also, perhaps changing the data types release within that).
  • See instruction page: Publishing Process to Update Core Source Packages

00.99...Reset for Fresh Start

Does "scorched earth" removal of content from Generator /TemporaryFiles and /OutputFiles (00.30), and publishing /output (00.50) and clears selected Generator /InputFiles sub-directories (00.40).

Defined Processes (Eclipse Target or BAT file:
  • 00.99...Reset for Fresh Start Complete reset combines 00.30, 00.40 and 00.50 from above.

Jump to top of page

Jump to Publishing Process "Root" Page