{{ transformations:GenerateDocumentationAction.png}}
====== GENERATE PROJECT DOCUMENTATION ======
Category: Workflow / External \\

\\ 
=====Description=====
This action generates HTML documentation for an EasyMorph project.

\\
=====Use cases=====
The documentation created by this action is useful for troubleshooting workflow issues as well as providing evidence of data sources being used, transformations that occur to the data during processing, and the final destination(s) of the data. 

\\ 
=====Action settings=====
^Setting^Description^
|Project<sup>*</sup>|Enter (or browse to) the fully-qualified path and filename of an EasyMoprh project file (.morph).|
|Output file|Options:  //As per project configuration// (an .html file is created in the same folder as the selected project file, with the same\\ filename) or //Custom//<sup>*</sup> (and enter/browse to a fully-qualified path and filename for the .html file).|
<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\

\\ 
=====Remarks=====
//Generate project documentation// creates an .html file in the location chosen and does not generate dataset output (this action merely passes along the dataset being passed into it).

If you require the metadata of a project to be incorporated into a workflow, refer to the [[transformations:projectmetadata|Project metadata]] action, instead.

The resultant .html file contains information regarding the structure of the selected project including, but not limited to: connector information, module information, parameters used, and table information including actions and action settings.


\\ 
=====See also=====
  * [[transformations:projectmetadata|Project metadata]]