This wiki has undergone a migration to Confluence found Here
<meta name="googlebot" content="noindex">

V3 PubProcess - Property Files

From HL7Wiki
Revision as of 19:56, 17 August 2010 by Gwbeeler (talk | contribs)
Jump to navigation Jump to search

Property File Specifics:

  • File "publish-environment.properties" - is found in the root directory of these tools. It defines the primary computing environment. Parameters of note within this file include:
    • domains.active and domains.support are two comma-separated lists of domain codes that are used to determine which domains shall be processed for publishing and generating. The former lists all the non-support domains of interest, while the latter lists those domains needed to support the publication (such as CMETs, control infrastructure, etc.). If left unset, the values will default to all non-support domains for the former property, and all support domains for the latter.
    • non.domains.general, non.domains.dams, non.domains.special.models and non.domains.special.other comma-separated lists of non-domain content "targets" codes that are used to determine which non-domains will be processed for publishing. If left unset, the values will default to items listed in the "publish-environment.properties" file. Specific contents of these lists include:
      • non.domains.general are all of the "infrastructure" and much of the "help" content that are neither domain analysis models whose MIF content is that of a free-hand document. (For contrast, see "special" types below).
      • non.domains.dams are the domain analysis models being balloted.
      • non.domains.special.models are the items like the RIM that require special processing because the are based on a specific MIF-pattern.
      • non.domains.special.other are items that have unique processing requirements (such as glossary alignment).
    • env.mifbasedpub asserts whether or not the environment is driven by the NEW MIF-based processes in which the raw PubDb xml and "free-hand" document XML are convereted to MIF 2.2 and then published to HTML from there. (Recommended setting is "yes".)
    • env.desktoppub asserts whether or not the environment is intended for desktop publishing. If set to yes, this enables selected functions such as Visio PNG extraction, and automatic xml expression from PUbDb. (The recommended setting is "no".)
    • set.dir.generator and set.dir.output allow the Generator, or the output directories to be located somewhere other than the root of this suite of tools. By default, both elements are co-located with the suite of tools. In order to relocate either, set these parameters to an alternate directory listing.
    • VisioVersion declares the version of Visio installed on this machine. Two values are acceptable: "V2002" and "V2003-7".this parameter must be correctly set in order to generate Visio graphics and "clickable" maps for static model designs. If it is not set, it will default to "V2002".
    • UsingVistaInstaller - HL7 Programs (RoseTree and PubDb extract) running under Vista are installed by default in directory "C:\HL7Programs\HL7..." while the same programs on Windows XP are installed in "C:\Program Files\HL7...". in order to perform automated extraction of content from publication databases, etc., the suite of tools needs to know the installation directory being used.this property should be set to "yes" if the "HL7ToolsVistaInstaller" was used to install the tools in the alternate directory. (Note this installer is also sometimes used with Windows 7.) (The default is "no" for all non-Vista OS, and "yes" for Vista installations).
  • File "publish-global.properties" - is found in directory input/support/ant, and includes both a few "configuration" properties, as well as many properties needed to define ANT scripts. Properties that provide "configuration" capability include:
    • id.publication provides an identifier that is included in the "header" material of each published specification. It should be set to the identifier for the current ballot cycle (assuming that one is publishing a ballot), such as "Ballot2010Sep".
    • logic.appenddomainqa determines whether or not to add a domain-specific quality assurance report to the table of contents and publication of each domain.(Preferred setting =yes).
    • copyQaSourceFromGen determines whether or not the source files are producing a quality assurance report are automatically copied from the Generator. (These files include MessageReferences.xml, and others.) (Preferred setting =true)