Generating Project Documentation

image_pdfimage_print

Any Jedox Integrator project can generate documentation that contains an alphabetical list of all components with type, descriptions, and references. A graphic flow chart of a user-specified list of jobs for this project can be included in the documentation. It is possible to navigate within the generated documentation to the referenced components.

Project documentation can be easily generated in Jedox Web with the Integrator component or through the Command-Line Client.

Generating documentation in Jedox Web with Integrator
  1. Open Integrator and right-click on the name of the project to open a context menu. Click on Download project documentation and select the desired format (PDF or RTF).

  2. The report will download to your default download folder. Below is a sample report.

  

Generating documentation with the Command-Line Client (CLI)

Further details on using the CLI can be found in Integrator Command Line Client.

Notation

etlclient -pd <projectname> -j <jobname1> <jobname2> …. -o <directory>

Example:

  1. Create project documentation for project sampleBiker without flow graphs in directory C:\EtlDoku1:
    etlclient -pd sampleBiker -o C:\EtlDoku1
  2. Create project documentation for project sampleBiker with flow graphs of job Masterdata and Cubedata:
    etlclient -pd sampleBiker -j Masterdata Cubedata -o C:\EtlDoku2
  3. Create documentation for job Cubedata in project sampleBiker. It only contains the referenced components of this job and the flow graph of job Cubedata:
    etlclient -pd sampleBiker.jobs.Cubedata -o C:\EtlDoku3

The documentation can be displayed by opening file etldocumentation.html with a browser. Note that Internet Explorer 9 doesn’t display the graphical flow graph due to insufficient support for the SVG format.

The following files are generated in the output directory:

etldoc.xml Contains all project- and component-related information, SVG flow graphs, references, and all component fields (references etldoc.xslt).
etldoc.xslt The XSTL transformation of etldoc.xml. By adapting this file, the layout and content of the documentation can be modified (references etldoc.css).
etldoc.css A style sheet (references etldoc_bg.png).
etldoc_bg.png A background image.
etldocumentation.html The documentation file to be displayed in the browser. Technically, it is etldoc.xslt transformation applied to etldoc.xml (requires only files etldoc.css and etldoc_bg.png).
image_pdfimage_print