Spatialytics ETL – Cookbook is a powerful tool that automates the generation of ETL chains documentation. The produced documentation is composed of HTML files. So, it is easy to access and share on the network. Spatialytics ETL – Cookbook comprises different transformations and jobs which aims at retrieving the relevant meta-information in jobs and transformations stored in a repository or in a simple directory, at structuring it and at producing an interactive documentation based on it. It uses the meta-information stored in each step (resp. job entry) of each transformation (resp. job). In order for Spatialytics ETL – CookBook to work adequately, the user must then complete the following tasks:
Spatialytics ETL – Cookbook transformations and jobs allowing the generation of the documentation can be found in the pdi subdirectory of the cookbook directory in the Spatialytics ETL installation path.
To generate the documentation for ETL chains stored in a directory (as .ktr or .kjb files), do the followings:
The SAXON parameter of this job should not be modified. Therefore, keep the default value.
When jobs and transformations are stored in a repository, launch the generate_Documentation_ from_repository job. This job performs the following tasks:
To performs theses tasks, the main job uses the following parameters:
Once the documentation has been generated, the user can delete the folder pointed by the INPUT_DIR parameter, since it contains the same transformations and jobs as the repository.
The user can access the generated documentation in the directory defined by the OUTPUT_DIR parameter. This directory contains some HTML files. To access the documentation home page, the user has just to open the index.html file in his browser. This page comprises two parts (see Figure 1):
Figure 1: Home page of a documentation generated by Spatialytics ETL - Cookbook – Categories tab selected.
Figure 2: Details of an element selected in the left pane of the documentation generated by Spatialytics ETL - Cookbook.
Spatialytics ETL – Cookbook is a powerfull tool. It automates the generation of ETL jobs and transformations documentation. It uses meta information stored in each ETL object. In order to produce a better documentation, the user has to provide description and information for each transformation, job, step, job entry and database connection.