You are on page 1of 28

Kettle-Cookbook

Auto-documentation for Kettle jobs and transformations


Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/ 1

Thanks for attending!


Roland Bouman; eiden! "etherlands #$ %&'( )B! 'un %icros&stems *eb and B+ ,e-eloper Co-author o. /0entaho 'olutions1 ...and /0entaho Kettle 'olutions1 Blog: http://rpbouman.blogspot.com/ Twitter: @rolandbouman
Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/ 2

Agenda

,ocumentation +ntroducing Kettle-Cookbook ,emonstration Roadmap (uestions and answers inks and resources

Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/

Agenda

,ocumentation +ntroducing Kettle-Cookbook ,emonstration Roadmap (uestions and answers inks and resources

Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/

Documentation

Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/

Documentation

Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/

Documentation

Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/

Documentation

Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/

Documentation

Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/

Documentation

Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/

10

Documentation Benefits

)llows an #T solution to be -eri.ied against design documents +. done right! can help to train de-elopers Can be used to understand data lineage 3acilitate auditing processes

Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/

11

Documentation? Whaddya mean, documentation?

Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/

12

WT isn!t there any documentation?


Bene.its are not immediate "ot popular w/ de-elopers ,ocumentation %&ths


%& so.tware is sel.-e$planator& ,ocumentation is alwa&s outdated *ho reads documentation an&wa&4

Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/

13

Documentation "yths# "y $oft%are is self-e&'lanatory


+ alread& e$plained! it5s sel.-e$planator&. 'o.tware is onl& sel.-describing in the sense that it ma& be clear 6what6 it does. B& itsel.! so.tware cannot e$plain 6wh&6 it was built this wa&.

Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/

14

Documentation "yths# Docs are al%ays outdated

7eah! documentation is alwa&s outdated. et5s blame documentation ,ocumenting should be part o. the de-elopment process 7ou can test documentation like &ou can test so.tware

Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/

15

Documentation "yths# Who reads docs any%ay?


'tart

+s there documentation4

8. course not9 *ho reads that stu.. an&wa&4

3ind an e$cuse to not write an&

7es

*adda&a mean! /&es14 *ell! 6+6 am not going to read that

"o docs to read. sel.-.ul.illing prophec& pro-ed true *ell done9 ::


16

Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/

Agenda

,ocumentation +ntroducing Kettle-Cookbook ,emonstration Roadmap (uestions and answers inks and resources

Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/

17

Kettle-cookbook# What is it?

) documentation generator .or Kettle #T solutions Built in Kettle +nspired b& Ben2amin Kallman5s Kettle documentation generator ;%ain<! =>>?: 8pen 'ource ; @0 : )-ailable on google code

Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/

18

Kettle-cookbook# o% to use

*hile creating/designing! enter descriptions:

Aob and Trans.ormation 'ettings


,escription #$tended ,escription ,escription

Aob entr&! Trans.ormation 'tep:

Run kettle-cookbook. 0arameters:


+"0BTC,+R 8BT0BTC,+R
19

Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/

Kettle-cookbook# o% it %orks

Kettle 2ob scans a director& .or .ktr and .k2b .iles creating an D% inde$ D' T is applied to D% ! outputs ET%

Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/

20

Kettle-cookbook# (eatures

Table o. contents to na-igate docs #$poses -alue o. description .ields ,ata .low ,iagram Crosslinks 8-er-iews: Fariables! Connections! 3ields '&nta$ highlighting ;'( ! Aa-ascript:

Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/

21

Kettle-cookbook# acking and )&tending

+t5s built on Kettle. Change 2obs and trans.ormations in the pdi director& to add custom processing ,ocumentation generated with D' T. #dit the kettle-report.$slt .ile to add custom o-er-iews / ET% rendering ET% uses e$ternali<ed C'' and Aa-acript. Eint: &ou5ll .ind it in the css and 2s directories +cons in the images director&
Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/ 22

Agenda

,ocumentation +ntroducing Kettle-Cookbook ,emonstration Roadmap (uestions and answers inks and resources

Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/

23

Agenda

,ocumentation +ntroducing Kettle-Cookbook ,emonstration Roadmap (uestions and answers inks and resources

Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/

24

*oadma'

Eigh le-el data .low diagrams 8-er-iews ;-ariables! connections: across #T solution Replace Kettle Aob with Kettle )0+ ;Ben2amin Kallman: ,ependencies / where-used list "ot 2ust #T ! entire 0entaho 'olution ;)ction seGuences! %ondrian Cubes! Reports: ,ata lineage
Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/ 25

Agenda

,ocumentation +ntroducing Kettle-Cookbook ,emonstration Roadmap (uestions and answers inks and resources

Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/

26

Agenda

,ocumentation +ntroducing Kettle-Cookbook ,emonstration Roadmap (uestions and answers inks and resources

Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/

27

+inks and resources

0ro2ect: http://code.google.com/p/kettle-cookbook/ @etting 'tarted: see the pro2ect wiki +ssues: http://code.google.com/p/kettle-cookbook/issues/list ,ownloads: https://code.google.com/p/kettle-cookbook/downloads/list 'ource: http://code.google.com/p/kettle-cookbook/source/checkout

Roland Bouman: http://rpbouman.blogspot.com/ Twitter: @rolandbouman kettle-cookbook: http://code.google.com/p/kettle-cookbook/

28

You might also like