Documentation Automation
The Background
The content of PDI files (jobs and transformations) and Mondrian files is in XML format. These can be parsed to extract the text specified between the defined tags and use this for documentation. This should allow for example, to get the names of all transformations included in the job, all the dimensions referred to in a cube etc. Note that a similar project has been specified to also look at documenting and analysing files.Instructions
The xsl templates are attached to this page as well as the scripts required to use them. These scripts are configured to work in the following structure-${ProjectFolder}
|-etl
--|-JOBS
--|-TRANSFORMATIONS
--|-DOCUMENTATION- Download the attached templates and scripts and save them in a convenient location.
- To create a xslt documentation for a specific project:
- Open the command line
- cd into the folder where you downloaded the scripts to
- run ./createxsltdocumentation.sh ${ProjectFolder}/etl
Note: the ${ProjectFolder} is an input parameter required for the script, that defines which project where the documentation scripts will be applied. - Open either:
- the DOCUMENTATION/index.html or
- the DOCUMENTATION/.kjb or DOCUMENTATION/.ktr files in a web-browser to view the HTML documentation
Resources
Further on XSLT.
on 21/07/2010 at 16:08