Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Option

Definition

Step name

Defines the name of the step as it will appear in the transformation graph.

File name field

Select the input field containing the name of the file you are generating documentation for.

File type field

Select the input field containing the type of file (transformation or job)

Target filename

Specify the target location and filename for the generated documentation.

Output type

Select the output type for the generated documentation (PDF, HTML, DOC, Excel, CSV, or METADATA)

Include the name?

Define whether or not to include the file name in the generated documentation.

Include the description?

Choose to include the description in the generated documentation (description can be modified by going to Edit->Settings).

Include the extended description?

Choose to include the extended description in the generated documentation (extended description can be modified by going to Edit->Settings).

Include the creation date and user?

Choose to include the creation date and user name for the creator in the generated documentation.

Include the modification date and user?

Choose to include the date of the last modification made to the file and user who modified it.

Include the image?

Choose to include the job or transformation graph in the generated documentation.

Include logging configuration details?

Choose to include a summary of the connections used for logging in the transformation or job.

Include the last execution result?

Choose to include a summary of the last execution results such as whether it completed successfully or ended in failure.

Notes

?