Enterprise Architect offers extensive support for generating RTF documents that most of the time will meet your reporting needs.

For those who get stuck and are not afraid of some scripting, there is an alternative in the EA.DocumentGenerator API. The attached ZIP file contains the script and 2 RTF templates that show you how generate a document using this API and how to include variable content like the name of the user who created it.

To use this script

1) Download the attached file ACME.XML

2) Import this in EA

3)  Select the option from the element context menu in the project browser



  • The script uses a function i published earlier to query the database (ExecuteSQL; script is included in ACME.XML). If you are using a DBMS instead of .EAP check if the two SQL statements at the beginning of the script 'ACME_ContextDocumentGenerator' are suitable for your DBMS
  • The script uses the RTF templates 'ContextMaster' (main body) and 'ContextDiagram' (for each separate included diagram). The templates have been stripped down to the eassentials, you can easily extend them using the EA template editor.
  • If the element has a linked document then this document is used as the main body
  • Be aware that generated RTF documents can become very large due to the included images. You can reduce the size dramatically by converting the RTF document to Word format (i'll add automatic conversion in a future version)

The function ExecuteSQL will run a SQL select statement with a variable list of arguments and return a dictionary with the resulting rows. Each row contains itself a dictionary of columns.

To test this script create a new 'Normal' script (type VBScript) and replace the contents with the script below. The scripting output window displays a list of classes and usecases in your project with names starting with 'SSS'.

option explicit

!INC Local Scripts.EAConstants-VBScript

sub main
    Dim row, dict
    Set dict = ExecuteSQL("select * from t_object where name like '{0}' and Object_Type in ({1})", _
    if not dict is nothing then
        for each row in dict.Items
            Session.output("Found: " & _
                " | Name="&row.item("NAME")&_
                " | Notes='"&row.item("NOTES")&"'")
    end if
end sub

 ' ======================================================================================
 ' Executes a SQL query and returns the result in a dictionary of rows
 ' IN:
 '    sql  - the sql SELECT statement to run with optional arguments. Arguments must be
 '          denoted as {#} where # is the argument number, a specific value say {0} may occur
 '         multiple times
 '    args - a -string- of argument values, separated by the pipe symbol('|').
 ' OUT:
 '    a dictionary object storing for each row in the result set a dictionary of columns
 '    (name/value pairs) where name is the name of a column in the SQL result in UPPERCASE
 '    - if an error occurs the call returns the value 'nothing'
 ' - All references to an argument {i} are replaced by its value
 ' - Always use dict.item(<columname>) to obtain column values: empty columns
 '   are -not- included in the XML returned by the call to Repository.SQLQuery so
 '   the number of columns may differ for each row in the dictionary.
 '   Use the vbscript isEmpty function to check for empty values.
 ' - the dictionary keys are -case sensitive-. To prevent obvious mistakes keys use
 '    -uppercase- column names
 ' ======================================================================================
 Public Function ExecuteSQL(SQL, argList)
    set ExecuteSQL = Nothing

    Dim dict : set dict = CreateObject("Scripting.Dictionary")
    SQL = StrRep(SQL, argList)
    Session.output("INFO: executeSQL:  executing " + SQL)
    Dim xml : xml = SQLQuery(SQL)

    ' Parse the query result in a DOM tree
    Dim doc : set doc = CreateObject("MSXML2.DOMDocument")
    doc.validateOnParse = False
    doc.async = False

    ' Populate the dictionary
    Dim rowNum : rowNum = 0
    Dim row, rowSet : Set rowSet = doc.selectNodes("//EADATA//Dataset_0//Data//Row")
    For Each row In rowSet
        Dim rowDict : set rowDict = CreateObject("Scripting.Dictionary")
        Dim col, colSet : set colSet = row.childNodes
        For Each col In colSet
            rowDict.add UCase(col.nodeName), col.Text
        dict.add rowNum, rowDict
        rowNum = rowNum + 1

    If (dict.count = 1) Then
        Session.output("INFO: executeSQL: found 1 record")
        Session.output("INFO: executeSQL: found " + CStr(dict.count) + " records")
    End If
    set ExecuteSQL = dict
 End Function

Function StrRep(str, argList)
    StrRep = ""

    Dim apl: apl = "{0}"
    If argList <> "" Then
        Dim args : args = Split(argList,"|")
        Dim i
        For i = 0 To UBound(args)
            apl = "{" + CStr(i) + "}"
            If InStr(str, apl) = 0 Then
                Session.output("ERROR: missing argument " + apl + " in '" + str + "'")
                Exit Function
            End If
            str = Replace(str, apl, args(i))
        apl = "{" + CStr(UBound(args) + 1) + "}"
    End If

    ' Check for unassigned parameters
    If InStr(str, apl) <> 0 Then
        Session.output("ERROR: Value for argument " + apl + " not supplied ('" + str + "')")
        StrRep = str
    End If
 End Function

It is explained in an article by Kean Walmsley that can be found here: simply include the snippet

<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
    <StartProgram>C:\Program Files\Sparx Systems\EA\EA.exe</StartProgram>

in the <your project name>.vbproj.user file, restart MS express and you are good to go.

I've tested this for both MS VC# 2010 express and MS VB 2010 express and it works. 

Cudos to Kean and happy debugging!