Interactive Documents

Navigation:  »No topics above this level«

Interactive Documents

Previous pageReturn to chapter overviewNext page

This feature is only available in eaDocX Collaboration Edition.

With eaDocX Interactive Documents, you can take the revisions and comments which your readers make, combine them together in a single view, then quickly copy changes to the exact EA element and field which they refer to. And see where there are issues which you need to think about some more.

Interactive documents has two parts:

An enhanced document generator

This adds invisible text tags to your Word document. Provided readers don't switch-on Word invisible text, they should not be aware of any difference between a tagged and a regular eaDocX document.

Your readers can then review and comment on your document in whatever way they are used to:

oeach reader has their own copy of your document,

omultiple users collaborating on a single copy, using, for example, Microsoft Teams.
They MUST use Word 'Track Changes'.

A Revision Manager,

This parses the reviewed documents, and presents the author with a combined view of who has made which changes.

Working with Interactive Documents

To create, review and process some interactive documents:



Create some eaDocX documents in the normal way. These can contain any EA content, and use any eaDocX features. If you are going to create a family of documents for review, the documents should have overlapping contents (for example, the same set of Components or Processes) but they do not need to be formatted in the same way in the different documents.

see Making the most of Interactive Documents


Issue them to your reviewers. When you create an Interactive Document, eaDocX will automatically save the document with Word Track Changes enabled


Once your reviewers have added their revisions and comments, open Revision Manager from the main eaDocX menu: EA | Specialize | eaDocX | Revision Manager

Also accessed from the eaDocX Top menu


Open the documents, using Add Documents.
You can process a set of documents at the same time, or one-by-one. If you process documents together, then Revision Manager will group changes for each element/package/diagram, from all documents


Step through the revisions. You can either:

1 - Accept a revision from a user:

This copies the text 'Medium' which Fred wrote into the 'Priority' of the 'Get Quote' use case, and adds it to the Pending changes.

2- Copy Fred's change into the 'Get Quote' priority:

You can then edit the new value, and save it to the pending changes:



3 - Skip the revision, and select the next EA element, diagram or package, and look at the comments and revisions


Go through the comments.

Some comments can be associated with a specific EA element. diagram or package. Some cannot. Also, some revisions cannot be associated with a specific EA element field. These are both shown like this:


Here, Ian has added a comment or revision to the 'Use Cases' package, but we can't work out exactly which field of the EA package he has changed.


Here. Fred has made a comment which we can't associate with any EA content, so the comment is shown in the position in the source document where the comment was made.




Review the changes in Pending Changes.


This shows where the changes will be made, and what the old and new values are of the field which is being changed.

You can select:

clip0015will remove the individual change

'Save to model' will update all the EA elements / diagrams or Packages

''Save with details' will 'save to model' and also create an element which shows the changes made:


The 'Revision' element has a 'notes' field which looks like:



Re-Generate your document/s for review, or continue working on your model. As all the changes and revisions are saved directly into your repository there's no need to go through your model and make the changes yourself, so you can immediately send out updated document versions, or continue to develop your model.