Skip to main content
Announcements
Qlik Connect 2024! Seize endless possibilities! LEARN MORE
cancel
Showing results for 
Search instead for 
Did you mean: 
Anonymous
Not applicable

Documentation for Qlikview Reports

Dear All,

Can you please help me on the tips and tricks in effectively documenting a Qlikview application. I donot refer to adding comments or Help commands. I am talking here about creating documents for applications that are normally handled to support teams after going live.

Also if you have some good  templates, please feel free to share.

Many Thanks in advance!

9 Replies
Anonymous
Not applicable
Author

Any updates on this friends ?

Not applicable
Author

I'm looking for this too...Can anyone share some information?

evan_kurowski
Specialist
Specialist

If you're expecting to turn over documentation regarding the technical design, one of the items you should have is the "chain of generation".

This would basically trace every component and sub-component as they are referenced throughout the progress of a reload script.  It should do so recursively for all referenced QVDs & QVSs.  QVDs resume the trail by evaluating the script of their <CreatorDoc>, and QVSs by examining the include script to see if more scripts or data sources are introduced within an include file.

Therefore it should mention all contributing data sources, and referenced external files.  This way there is documented path for where the QlikView process begins and can be traced back to originating source data.

Also, when you are inheriting an app your are unfamiliar with, performing this type of audit should reveal to you "where the trail went cold".  (meaning data sources, scripts, and apps lack any further evidence regarding their origins).

rwunderlich
Partner Ambassador/MVP
Partner Ambassador/MVP

If you want to document the data lineage of your app, you can do it with QlikView Components (http://qlikviewcomponents.org). This single line in script:

CALL Qvc.DataLineage

will build a lineage table of data sources and creators used in this QVW.

2015-09-20_14-20-06.jpg

-Rob

http://masterssummit.com

http://qlikviewcookbook.com

evan_kurowski
Specialist
Specialist

Hello Rob,

Yes, I definitely appreciate the convenience of pre-packaged functions/subs from qlikviewcomponents.  I've also seen similar lineage tracing in the 'Governance Dashboard', and have assembled the occasional custom lineage tracer from scratch.

 

What I was emphasizing in the case of "full chain of generation" is that identifying the later derivative components in a recursive manner is necessary, and not solely for data but for script includes as well.  For example, if I had a structure like the following, in order to create a "blueprint" of the app, the lineage has to cover not only direct & 1st derivative references, but also 2nd to N derivatives.

(*If I am understanding Qvc_DataLineage.qvs correctly, it will recursively collect the lineage info from all lineage detected <CreatorDoc>.  Does that mean that applying it as a scan of only the document 'Final_Application.qvw' below, will produce the full sub-component report shown?)

Direct application references

1st derivative lineage references

2nd derivative lineage references

 

Final_Application.qvw

                include_settings.qvs

                TopicCalendar.qvd

                                Make_Calendar.qvw   //1st derivative creator doc

                                                calendar_settings.qvs  //2nd derivative include or source

                ReportDimension.qvd

                                TopicReportDimensions.qvw   //1st derivative creator doc

                                                Divisions.qvd //2nd derivative include or source

                                                                ExtractDimns.qvw //2nd derivative creator doc

                                                                                ODBC: Oracle DB.OWNER.DIMN_TABLE //ultimate source

                                                ReportDivisions.xlsx  //2nd derivative include or source

                                                Branches.xls //2nd derivative include or source

                Transactions.qvd

                                ETL_Prepare_Trans_DataModel.qvw //1st derivative creator doc

                                                2015Report.qvd //2nd derivative include or source

                                                                ExtractTrans.qvw //2nd derivative creator doc

                                                                                OLE: SQL Server DB.SCHEMA.TRAN_TABLE //ultimate source

                LocalDimn.xlsx

                MyGroup - [INLINE]

 

 

 

rwunderlich
Partner Ambassador/MVP
Partner Ambassador/MVP

HI Evan,

Yes, Qvc.DataLineage will produce the full recursive list of qvw and qvd subcomponents as you have shown.  DataLineage reads the "Final_Application.qvw" from disk, then reads any qvws and qvds listed as lineage and recurses those if possible.

-Rob

Anonymous
Not applicable
Author

hi Evan,  Is there any why i can get that governance dashboard with the script you have mentioned above. any help would be great. I am looking to do documentation for our entire environment.

engishfaque
Specialist III
Specialist III

Dear Aushik,

I would suggest you to get an idea regarding documentation with the help of QlikView Developer checklist.

Kindly find attached QlikView Developer Checklist.

QV Developer Checklist.xls

Kind regards,

Ishfaque Ahmed