A Day in the Life of a Data Integration Developer: How to Self-Document Any Data Integration Job: [Part 6]

This installment of A Day in the Life of a Data Integration Developer will show you how to self-document any data integration Job that you develop within the Studio. The self-documentation can be done in an HTML output using a custom CSS file to meet your enterprise documentation standards, or you can modify it after it's been generated.

I'm on the dimension load table process that loads three dimensions:

talend studio screen shot

Generate the file for the HTML output. It puts it in a zip file that documents all of the content within this data integration Job.

Studio will then load it out to the file system on my local system. If I want to see what it generated, I can right click on the Job and click View documentation, and that will bring up the HTML output of the first step. It will generate the process and show the HTML, as well as save the file in the studio in the documentation directory so that you don't have to regenerate every time if you don't change the Job.

This gives you a general overview of the Job. It shows you any stats and logs that you have set up for AMC, as well as the context variables, the configuration of those contexts variables, and then the component list. And then below the component list, it dives into the greater detail of each component.

talend studio screen shot

This is very useful for speedy documentation of your process.

In the last tutorial for the A Day in the Life of a Data Integration Developer series you’ll learn how to quickly import license files.

     

| Last Updated: March 14th, 2019