Crystal Reports Documentation Tool 4

[govmule]

Does anyone know of a tool that will document Crystal Reports including the syntax of the formula's?

Thanks,

Jack

 

[SurfingGecko]

You may want to try exporting your report to Report Definition format. If this does not do it for you, you could have a look at

http://www.kenhamady.com/bookmarks.htm

Ken has several 3rd party tools listed including some Documentation Tools that may help you out.

Cheers,

SurfingGecko

http://www.surfinggeckosoftware.com

Home of Crystal Ease

 

[govmule]

Thanks a million. This is just what I needed. I appreciate your help!

 

[Ngolem]

Another trick I use is to create a "READ ME" formula and place it suppressed in the report footer.

This formula is nothing more than a commented list of special features of the report that you would want to pass on to future developers...or yourself for that matter when you are required to do maintenance on the report a year from now

@ReadMe

// Here are the tricky parts of the report and Why I chose
// to do it this way:

// Trick 1 - ..........
// Reason 1 - ..........

// Trick 2 - ..........
// Reason 2 - ..........

// Trick 3 - ..........
// Reason 3 - ..........

.
.
.
.

//Report Maintance Log
//--------------------

//Date Developer Work done

//2003/05/02 JNB Fixed bug in rounding of subtotal
//2003/05/14 JNB Changed column format as per Mr. ED



You see the idea....I insert this formula (suppressed)in the report footer and conditionally color the field red

if 1=1 then crNoColor else crRed

This way it is visible in design.

Doing it this way your notes ALWAYS stay with the report making it easy for subsequent maintenance developers to enhance or debug your reports.




Jim Broadbent

 

[SurfingGecko]

Cheers,

SurfingGecko

http://www.surfinggeckosoftware.com

Home of Crystal Ease

 

[IdoMillet]

I use a suppressed "Report Header a" section and place my documentation comments as static text there.

This ensures the comments are visible to anyone who opens the report in design view.

Cheers,
- Ido

CUT, Visual CUT, and DataLink Viewer:
view, e-mail, export, burst, distribute, and schedule Crystal Reports.

http://www.MilletSoftware.com

 

[synapsevampire]

Ditto, Ido. I also colorize the background to make it stand out.

-k

 

[govmule]

Thanks Everyone. Both the exporting to Report Defenition and the tips on adding comments are awesome. I had not even thought to add comments for revision history. Good point.