The Profile page

Navigation:  Navigation > The eaDocX Control Panel >

The Profile page

Previous pageReturn to chapter overviewNext page

The Profile page shows which kinds of EA element will print in this document.

If eaDocX comes across EA elements which are not listed in this Profile, then they won't print. This is very deliberate. If we were to print everything in every document, then your documents would contain unnecessary detail. The sample profiles contain collections of EA Elements which are useful for different purposes, which you can import into the Profile for your document.

The Profile page shows how each EA element type will print:

Inline Inline - Documents each element as a paragraph, with each of the attributes of the element as sub-paragraphs. See Formatting Inline.

Table Table - Document each element as a line in a table, with each attribute as a column in the table. See Format in Tables.

You can control which kinds of elements appear in your document, and how they are formatted using the following options:

 

Option

Explanation

Properties

shows the current Profile details for the selected element or element+stereotype

Document as Table

toggles the current style from Inline to Table

Document Inline

toggles the current style from Table to Inline

Create New Stereotype

adds a new stereotype to the selected element

Delete All formatting for element

This will delete the element type from the list. When eaDocX comes across elements of this type when generating your document, those elements will be ignored. This is useful when you want to exclude every instance of the element type, for example, to omit all 'Attribute' element types because they are too detailed for the document.

Delete formatting for un-stereotyped elements

Where an element has some stereotypes defined, this will remove any formatting for those elements which don't have a stereotype, so they won't print. For example, you might have Requirements (with no stereotype), <High Level>Requirements and <Initial>Requirements. Selecting this option will allow the <High Level> and <Initial> Requirements to print, but not the simple un-stereotyped Requirements.

Delete formatting for stereotype

This will remove formatting for this stereotype. This means that instances of this stereotype will not print.

Delete stereotype.

This removes the stereotype completely. This means that eaDocX will use the formatting as defined for the parent element type, but the elements will still print.

 

graphic will add a new element type to the list, based on a list of the element types which exist in your EA model. If the Element type you want does not appear in the list, just create an instance of it somewhere in your model, and re-start eaDocX.

 

Examples

These options are best illustrated with some examples:

 

Profile Appearance

Explanation

graphic

All requirements, regardless of their stereotype, will print in tables, all Use cases, regardless of stereotype, will print Inline

graphic

<High Level> Use Cases will print in tables, but all other stereotypes of Use Case, and un-stereotyped use cases, will print Inline.

graphic

<High Level> Use Cases will print in tables, but no other use cases will print, with other stereotypes, or un-stereotyped

graphic

All use cases will print except <High Level>Use Cases, which will not print at all.

graphic

<High Level> use cases will not print

<Detailed> use cases will print inline

All other stereotypes of Use Case, and un-stereotyped use cases will print as tables.