Reports on Todo, Project issues and Model Glossary

[raymondsing]

A suggestion to have reports on Todo, Project issues and Model Glossary. After all the efforts to key them in, a pity if report cannot be generated.

[dknox]

I second this request.  A comprehensive defects report would be very nice as well.

--dk

[Anibal Rojas]

I agree on this point. Some time ago I initiated a thread about this lack of EA...

[Rene]

I have a suggestion which might help you get any report you want out of EA fairly easily: use the ReadOnly Automation feature. I've written (and am still writing) this totally useless report generator on EA Models that grabs stuff from an EA Model and puts it in a report the way we want it. So far, it does a nice job of functional specifications (writes a Word document on the fly - capturing only the explicitly speficied and implicited assumed, but glosses over implementation details), resource planning to an Excel spreadsheet (project to follow), API documentation for components (html + a HTML Help project file) and defect reports/overviews. Currently in the works are test-plans and manuals that you can hand out to test-people, etc.

A bit of understanding of XML and a decent XML DOM API are essential (MSXML3 or MSXML4 are what we use).

Note that I'm not handing out this software: it does documentation the way we want it and that fit our procedures which are rapidly evolving at moment.

[ronnie]

Rene,
Any chance of making what you've done available to other EA users?

Ronnie

[raymondsing]

Thanks for the suggestion. But using the automation interface is out of reach for me in the forseeable future.

[Tadd Stuart]

Well I can see how to print the Issues and Glossary from the Project Menu but not the ToDo list. I also see that the HTML documentation generates a glossary.htm file but no link to it nor does it contain any of my glossary terms. I have faked out the system by adding the following into an object Note.
<a href="file://d:\data\glossary.rtf">Glossary</a> but that seems a bit extreme.

[raymondsing]

Hi Tadd,

Thanks for that pointer on printing issues and glossary. I have missed that.

But I don't see how to print html version of the glossary. From the glossary dialog, clicking on the Report button only produces RTF file. How did u get html file?

Since we cannot print Todo, looks like Todos have to become Issues if we want to generate report, without writing automation.

[Rene]

Rene,
Any chance of making what you've done available to other EA users?

Ronnie

No, sorry As I said, it's a purely internal thing currently (besides I am slightly ashamed of the spaghetti-ness of the thing, it's a quickie we just cobbled together  ).

[Keith Bollwahn]

Here's a quick and dirty procedure I came up with on our project to get the Glossary into HTML.  Hope you find it useful.

A similar process can be used for the Project Issues although the output is a table that doesn't lend itself to a table of contents.

Purpose: Format and export the glossary report from Enterprise Architect to a browser-based document with a hyperlinked table of contents.

Tools used:
• Enterprise Architect
• MS Word XP

Step 1: Generate Glossary .RTF report
Tool: Enterprise Architect

• Open the Glossary applet
• Click the “Report” button
• On the “Glossary Report” dialog: 1) enter a filename and location for the report, 2) blank the Heading field, 3) include All sections, 4) Click "OK"

Step 2: Set terms to Heading 3
Tool: MS Word XP

• Open the RTF file created in step one.
• Select Format | Styles and Formatting from the menu
• Select (highlight) the first term in the document - EA formats these as Normal+Bold, New Times Roman, 10pt
• On the Styles and Formatting tool, click the "Select All" button - this should select all the terms
• On the Styles and Formatting tool, click "Heading 3" - this will convert all the terms to Heading 3
• Close the Styles and Formatting tool

Step 3: Create a Table of Contents
Tool: MS Word XP
• Insert a blank line and place the cursor at the top of the document - make sure the line is "normal" format
• Select Insert | Reference | Index and Tables from the menu
• On the Index and Tables applet, select the Table of Contents tab
• Uncheck "Show page numbers", Set "Show levels" to 3
• Click the "OK" button to insert the table of contents at the top of the report.

Step 4: Change document title
Tool: MS Word XP

• Select File | Properties from the menu to open the document properties applet
• Change the "Title" from Class Model to Glossary
• Click the "OK" button

Step 5: Save report as a HTML document
Tool: MS Word XP

• Select File | Save as from the menu
• On the Save As applet, 1) choose a file name and location, 2) Use the "Save as type" drop-down to select "Web Page" 3) click the "Save" button

[Steve_Straley]

Hi,

I'm back on line now and don't mean to jump in late with things but I added reports for TODO and things like that in the EAToolkiT.   Have you taken a look at this and seen whether or not it is what you are looking for?

HTH,

Steve