White Papers and Scripts

White papers providing deeper insights into using eaTeamworks. Plus scripts for even more advanced formatting of eaDocX documents.

White Papers

Document Management with EA and eaDocX

This document illustrates how the document management features of eaDocX make it easy to support configuration control of the information produced from your EA models.

Business Rules with EA and eaDocX

This paper discusses how with EA and eaDocX business rules can be managed as a strategic resource and integrated into your project documentation. Enterprise Architect allows you to

Enterprise Architect allows you to capture Business Rules in a range of styles, from simple statements which are just special kinds of Requirement, all the way to executable, verifiable logical statements.

Traceability Sample

This document shows an annotated example of how an eaDocX document can show the traceability modelled in EA..

Traceability with EA and eaDocX

This document illustrates how traceability between different elements of a project can be modelled with Enterprise Architect and then how eaDocX

makes it easy to document all the richness of that modelling.
This should be read in conjunction with the "Traceability Sample" document.

Business Processes Sample

This document shows an annotated example of EA Business Processes documented using eaDocX.

Business Processes with EA and eaDocX

This document illustrates how business processes can be modelled with Enterprise Architect and then how eaDocX makes it easy to document all the richness of that modelling.
This should be read in

conjunction with the "Business Processes Sample" document.

Use Cases Sample

This document shows an annotated example of EA use cases documented using eaDocX.

Use Cases with EA and eaDocX

This document illustrates how use cases can be modelled with Enterprise Architect and then how eaDocX makes it easy to document all the richness of that modelling.
It should be read in conjunction

with the "Use Cases sample" document - also available as an eaTeamWorks downoad.

Project Automation

This document describes how Enterprise Architect and eaDocX can deliver project automation.
Instead of rework, duplication and errors in a world of project silos, project automation delivers

reuse of knowledge and consistency of information.
As a result project quality is improved, leading to faster delivery and lower costs.

Single Version of the Truth

The presentation describes how Ian used EA in a large multi national project , and in the process "did less work, had more fun and became (a bit) famous".

This is the second presentation given by Ian at the European EA User Group event in London on Wednesday May 15th 2013. He also presented it in Ottawa at the North American/Canadian EA User Group meeting on May 1st 2013.

Writing Use Cases with EA

This is the presentation given by Ian at the European EA User Group event in London on 15th May 2013.
It describes how to use the EA structured Scenario editor to model "fully dressed" use cases.

Why You Need Excellent Documents

This White Paper looks at ways to transform our project documents, helping readers to find and use information that is relevant to them.
In both Waterfall and Agile developments,

excellent documents can improve project quality and give new insights. New document capabilities allow authors to create high quality, accurate and targeted documents, and allow readers to navigate their way through them in an intuitive way.
By storing information in EA, and using eaDocX, approaches are described that can bring our project communications into the 21st Century. Documents which:

- contain only content which is relevant to the reader
- provide a range of presentation styles
- engage and hold the reader's attention
- guide the reader as to where they should concentrate their attention
- give the reader freedom to navigate the document’s contents as they wish

Making your model eaDocX friendly

When you are creating your models, there are nearly always several ways in which you can do any given task - that's the beauty of EA, and why we use it.

Some choices will help you to

produce readable, useable models, and readable documents, and some which will make those things harder. This article has a few tips to make it easier...

EA: What's in it for the Project Manager?

This is the presentation given by Jackie at the European EA User Group event held in London on Wedensday May 15th 2013.

It describes ways in which EA data can be made avaiable to Proejct Managers to improve communications for everyone on the project.

Risk and Issue Management with EA and eaDocX

This paper describes an approach to project risk and issue management using Enterprise Architect and the reporting options provided by eaDocX.

Smarter Meetings with Enterprise Architect

Do some of your meetings end without the result you need? Or with no result at all? Having the right information available at the right time in the right format would make everything so much easier.

Everyone better prepared
Less confusion over what's required
Fewer poor decisions made
Less time wasted
A clear direction mapped out.

EA gives users access to the all the right information at the right time, and it's simple to use documents to format it all and make meetings really productive.

So here are ten top tips for EA users to make your project meetings smarter.

Different Documents for Different People

How can we create personalised documents? Not only that, but also create documents that speed up the work we do, that improve the quality of the work we do, and

that deliver real business benefits?

This White Paper discusses how to use EA and eaDocX to create good quality documents that our readers and organisations need, and will want to read.

White Paper: Color Your Knowledge

Here are some thoughts on how to make best use of the EA and eaDocX color features, to make your models and documents clearer and easier to understand.

The paper looks at
- Using color to show Structure or status, or both.
- Or using it to highlight items for particular users in document.

eaDocX scripts

API check

This very simple script just shows what the parameters are which eaDocX will send to your Script.
It formats them a little bit, then just sends the result back to eaDocX. Use this just to make sure

that the API is working, and that eaDocX can call a script.

Show all Styles

This sample just shows you what the various kinds of Word paragraph style are which are defined for this document.
It will show:

- Table header, text, bullet and number list styles
- Inline normal, bullet and numbered bullet styles
It shows how you can make use of these Word paragraph styles to improve the appearance and readabilty of your documents.

Bullet list

The BulletList script takes each Element which is passed from eaDocX, and creates a simple bulleted list of the names of the elements. It will work for

any kind of element, so you might use this multiple times, for all the element types which you'd like to print as bullets.
It doesn't make use of any Word paragraph styles, for the formatted output might look a bit strange.

Bullet list 2

This builds on the BulletList sample, and prints both the Name - in bold - followed by the Notes.

Bullet list with Styles

This final Bullet List example uses a Word Paragraph style: the one which you have chosen in you document for the Inline Bullet style. You can

specify this in the eaDocX Options and Settings, Under Inline Settings.
This means the output will look more like other bullet lists which eaDocX generates, those which appear in the 'Notes' field of any element.

Table 1

This example just prints the names, notes and author of an element, in a simple table.
The width of the table is hard-coded into the script. It doesn't use any Word paragraph styles.

Table 2

This example shows how Scripting can deliver one of the most common feature requests which we have for eaDocX: more complex tables.
This example prints some simple attributes of

an element, in a table which has a more complex structure than is possible with regular eaDocX formatting.
Here, we have used HTML RowSpan tags to create a more compact structure to the table.

Table with Styles

This example shows how you can use the Word paragraph styles, as used by the rest of eaDocX, to create great-looking tables.

Important Requirements

This is an example of the type of complexity for which you might use an eaDocX Script.
What we want to do is calculate the 'importance' of a Requirement, based on how many people want it, and how

much they want it. We have decided to link Requirements to Actors using a stereotyped Dependency, with a stereotype of "High", "Medium", "Low" or nothing.
The importance is then calculated - by the script - as (3 x Number of 'High' Dependencies) + (1 x number of 'Medium' Dependencies).
This is then printed in a table, with Importance values of > 10 being highlighted in red, 5-10 in yellow.

This script shows how you can use Scripting to both apply calculations to your eaDocX documents, and control the output formatting as well.

Compare licence prices

Choose the licence that’s right for you and your team


Download a free trial

Download eaTeamWorks today for several free for life features, plus no obligation, 30-day trials of all the products: eaDocX, ea Revision Manager, eaSheets, Model Expert and PortfolioManager. Discover for yourself why we sell the world’s best-selling Enterprise Architect extension.