Automatic generation of documentation

[vitmatejka]

I have a need to regularly generate HTML documentation from my model.
I think about some script (e.g. bat file) which could call EA from command line to generate HTML documentation.
Is it possible ?

Thanks,
Vit Matejka

[didier]

It works using the "autodoc.pl" from Thomas Kilian
http://sharepoint.knowledgerecovery.com/external/eaug/Lists/Announcements/DispForm.aspx?ID=8&Source=http%3A%2F%2Fsharepoint%2Eknowledgerecovery%2Ecom%2Fexternal%2Feaug%2Fdefault%2Easpx
But I've been unable to generate it from the highest level in tree ...  
Cfr. http://www.sparxsystems.com.au/cgi-bin/yabb/YaBB.pl?board=general;action=display;num=1113814187

[thomaskilian]

Hi,
by coincidence I found out that specifying a GUID of {} will do the job  

[didier]

Correct - Thank you

[vitmatejka]

Is it possible to generate HTML documentation using the pl script mentioned below as well ?

[didier]

Yes, using RunHTMLReport

Example :
Replace
   $pi->RunReport ($GUID, $template, $target)
by
   $pi->RunHTMLReport ($GUID, "C:\\Temp\\", "PNG", "", ".htm")

[vitmatejka]

That's great !

Thanks a lot.

[michael_rainwater]

This is very helpful.  I was looking for something very similar to this recently (and posted a query here).

I noticed you are using a method RunReport() in the EA API.  But I don't see this method when I search the help file.  I guess it just isn't documented. :-(

Does this method have any other options?  Can I use it to generate docs from a class that is stereotyped as "Model Document"?  See the Help file under Creating Documents --> Virtual Documents to see what I'm talking about.

If I can't do this, can I use the method to generate a document if it is defined in the Resource View (this saves the template info as well)?

Thanks for your help.  This is a great example because it's short and easy to understand.  I appreciate you posting this and making it available.

[thomaskilian]

Actually the method is documented (if you know where). Honestly speaking I'd expect an EA repository with all methods and attributes to be the documentation source for the automation interface. Once I had Rose I would have reverse engineered the DLL in order to get a handy documentation - but (I still have a key but don't like to go through reinstalling the whole stuff)...
Still waiting for the upcomming next release - reverse engineering EA's DLL to have the automation interface in EA.

Regarding the Model Document. Although this is a new nice feature I don't believe it will fit in the old documentation scheme. Try F8 with the Model Document and you'll see. It only works with the Menu.

I'd rather like EA to stop adding new features and work on the existing ones to be more consistent (Yes, Paolo, I'm in line with you)

Edit: Search for "getprojectinterface" in the help. The third hit will show you the methods you looked for. :-/

[mikewhit]

I'd rather like EA to stop adding new features and work on the existing ones to be more consistent

Seconded. (But sorting out DDL is good!)

[michael_rainwater]

I thought I would also point out... I took the GUID from my class which was stereotyped as "Model Document" and tried to use this in the script.

As suspected (and Thomas pointed out) this doesn't work.  I can't seem to pass the GUID of the model document class to the RunReport() method and get only the packages specified in that class included in the RTF.  In my case, it actually created the whole document.  This had the same effect as using "{}" as the GUID.

So, I still can't seem to generate the RTF from these model document classes using the API.  

[Jake]

Hi

I generate HTML report with autodoc.pl
It work fine when I run il interactively.
But, when It run via the scheduler (windows 2003 server, user with administrative rigths, logged off), there is no file generated.

Can someone help ?

Tks

[thomaskilian]

Maybe some Path issue? Try to add code that produces a log file in the beginning. So you see whether it's called at all. You can then add logging information to trace the problem.

[Jake]

Any idea ?
The perl script is launched by a bat file.
I have make a simple test :
- run a scheduled task while NOT logged on
- run a scheduled task while logged on

The logged off test fails (see the pl script below):
- Logged off :
+++ starting EA

- Logged on :
+++ starting EA
+++ opening model
+++ getting project interface
+++ Enumerating projects 1
+++ running HTML Report
+++ Atodoc ended


Here is the pl :

Open the model file
print "+++ starting EA\n";

my $ex = Win32::OLE->new('EA.Repository', \&OleQuit) or die "Can't start EA\n";

print "+++ opening model\n";
$ex->OpenFile($model);

# get the XML/Report interface

print "+++ getting project interface \n";

my $pi = $ex->GetProjectInterface();

# the next call is not necessary, but without it does not work :-/

print "+++ Enumerating projects 1\n";


$pi->EnumProjects(1);
# start the report

my $GUID = "{}"; # can be found in the properties window

print "+++ running HTML Report\n";

$pi->RunHTMLReport ($GUID, "$ContentDir", "PNG", "", ".htm") ;
#

print "+++ Atodoc ended\n";

[Jake]

i forget the sub of the pl :


sub OleQuit {
   my $self = shift;
   $self->Exit();
}