Operation

This document describes how to run the LDDTool program.

Note: The command-line examples in this section have been broken into multiple lines for readability. The commands should be reassembled into a single line prior to execution.

Tool Execution

The execution steps are as follows:

  1. The input XML document is parsed and the contents are validated against the master database.
  2. The validated contents are integrated into the master database.
  3. The XML Schema and Schematron files are written.
  4. The process report and spreadsheet are written.

Command-Line Options

The following table describes the command-line options available.

Valid options are:

Command-Line Option Description
-p, --PDS4 Set the context to PDS4.
-l, --LDD Process a local data dictionary input file.
-a, --attribute Write definitions for attribute elements.
-c, --class Write definitions for class elements.
-J, --JASON Write the master data dictionary to a JASON formatted file.
-m, --merge Generate file to merge the local dictionary into the master dictionary.
-M, --Mission Indicates mission level governance (includes msn directory specification).
-n, --nuance Write nuance property maps to LDD schema annotation in JASON.
-s, --sync Use local namespace + information model version as output file names.
-1, --IM Spec Write the Information Model Specification with LDD.
-v, --version Returns the LDDTool version number.
-h, --help Print this message.

Execute LDDTool

If the host platform is a Mac or Unix system, type the following commands: 

cd  ./lddtool-8.0.0/bin

lddtool -lp [inputfilename] > lddtool.log

If the host platform is a Windows system, type the following commands: 

cd .\lddtool-8.0.0\bin

lddtool.bat -lp [inputfilename] > lddtool.log

Note:  The input file to LDDTool is an XML document that contains a completed
       local data dictionary template. This file must conform to the
       PDS4 Ingest_LDDTool schema.

       The output files written by LDDTool are:
                  - an XML Schema file (.xsd),
                  - a Schematron file (.sch),
                  - a process report file (.txt),
                  - a spreadsheet file (.csv) containing the local data dictionary information.
       All output files are generated in the current directory. 
       They bear the same name as the input file name unless the -s command option is used.  
       The -s option causes the local namespace + information model version to be used as the output file names.