Roadmap diagrams help you to map existing elements against a timeline. This is useful for visualizing how a system changes over time, planning a migration of responsibility between two teams, documenting the concurrent support for multiple platforms or representing just about any time based data. To ensure the modeler and viewer always have appropriate context, the timeline is always displayed on screen, on any saved images and when printed.
Changes of phase or state of each element can be represented in Roadmap diagrams using a dedicated notation of a bar divided into colored segments representing each state. The states available, the order they appear in and the colors used are controlled by a Diagram Legend. Each element displayed then shows the length of each segment (and hence duration of each state), and also provides the ability to hide individual segments on that element.
Creating a Roadmap Diagram
This diagram shows an example Roadmap that documents the planned lifecycle for two products through development, release, support and retirement, by quarter over a period of one and a half years.
You can develop this diagram as the example for the guided procedure in the Setting up a Roadmap Diagram table. To create the initial, basic diagram:
- Right-click on its parent Package and select the 'Add Diagram' option.
- On the 'New Diagram' dialog, in the 'Diagram' field type in the diagram name, such as 'Example Roadmap'.
- Click on the drop-down arrow in the 'Type' header and select the 'Construction > Project Management' Perspective group, and then click on 'Project Management' in the panel beneath the header.
- The 'Diagram Types' panel lists the diagram types - Project Management, Roadmap and Backlog. Click on the Roadmap diagram type.
- Click on the . The system opens the diagram in the central work area.
You can also generate one of the pre-designed Roadmap diagrams from the Patterns provided by Enterprise Architect, to tailor the Roadmap for any of a range of areas of work. To access these Patterns, select the 'Design > Package > Model Wizard' ribbon option, then on the 'Create from Pattern' tab (Model Wizard) select the 'Construction > Project Management' Perspective. If necessary, expand the 'Roadmaps' group.
Select the required Roadmap(s) and click on the. Each Roadmap is automatically created within its own Package.
To begin setting up the diagram you have just generated, on the open diagram display the 'Roadmap Options' dialog using one of the methods described here.
Design > Diagram > Manage > Roadmap
In the diagram, right-click on the background | Roadmap
Setting up a Roadmap Diagram
Starting with the 'Roadmap options' dialog, follow these steps to set up the Roadmap diagram. The fields are described in greater detail in the Roadmap Diagram Options topic. This procedure includes using a Diagram Legend to automatically divide an element into phase segments in different colors. The steps lead you to create the diagram shown at the start of this topic.
Select the 'Enabled' checkbox, to enable the timeline on the diagram.
In the 'Roadmap Title' field, type a title for the diagram such as 'Product Lifecycle'. (The title is optional, and you can leave the field blank if you prefer.)
In the 'Units' field, click on the drop-down arrow and select 'Quarterly'. The major sections are displayed in alternating light/dark shades to make it easy to distinguish between adjacent sections.
The 'Units' field offers a wide range of pre-defined units for the scale of the Timeline, and you can define your own customized units. You can also change the section display color using the 'Timeline color' field in the 'Timeline Appearance' panel.
|Roadmap Diagram Options
Click on the 'Tick Spacing' slider and drag it left or right to scale the timeline to a size that is appropriate for your diagram.
In the 'Timeline Start' field, click on the drop-down arrow and click on the date on which the Roadmap Timeline is to start. (For the example, select October 10th 2020; the exact value doesn't matter, as long as it is within the quarter you want to start in.)
The 'Timeline End' field is disabled for date unit scales (that is, years, quarterly, months and days).
Adjust the appearance settings:
Click on the to save the settings and close the dialog.
In the Diagram Toolbox, switch to the Class pages and drag two Class elements onto the diagram. Give them the names 'Pluto 1' and 'Pluto 2'.
Move and resize 'Pluto 1' so that its left edge is on the Q4'20 major marker line (the start of October 2020), and its right edge is just under the second Q1'22 minor marker (the end of February 2022).
Move and resize 'Pluto 2' so that its left edge is under the first Q4'20 minor marker (November 2020) and its right edge is under the first Q1'22 minor marker (the end of January 2022).
(Note: The diagram has been annotated to show the element positions; this text is not generated on the actual diagram.)
|Toolbox Appearance Options
(This step is a 'placeholder' to show where in the process you add a Diagram Legend and roughly what you do. The actual procedures are in the linked Help topics in the 'See also' column.)
From the 'Common' page of the Diagram Toolbox, drag a 'Diagram Legend' icon onto the diagram.
You will use this to add and format the phase segments on the two elements.
Double-click on the Diagram Legend to display its 'Properties' dialog, and define how the Legend element itself will be displayed and how the phase segments will be applied. In the example, you will define these four phases:
For each phase, type the name in the 'Value' field, select a display color in the 'Fill color' field and click on the to save the phase definition.
Select the 'Apply auto color' and 'Apply Fill' checkboxes, and then click on the to save the settings and close the dialog.
|Legend Key Legend Properties Create Legends
You now have two elements on the Timeline, each with four colored segments of equal length that represent the product lifecycle phases as indicated in the Diagram Legend.
To set the duration of each phase, click on the dividing line between two phases and drag it to the appropriate point relative to the scale on the Timeline.
You have now created a Roadmap diagram resembling the example shown at the start of this topic.
Hide and Show Segments
When you set up a Legend to apply segments to the elements on a Roadmap, every element on the Roadmap has all the defined segments. However, certain segments might not be relevant to particular elements, in which case you can hide those segments on those elements. Should a hidden segment be relevant to an element, you can show it.
A new element added to the diagram will show all the segments. However, if you add a new segment to an existing element, that segment is automatically hidden and - if it is to be displayed - should be set as described here.
To hide or redisplay segments on an element:
- Right-click on the element and select the 'Hide/Show Roadmap Segments' option. The 'Hide/Show Roadmap Segments' dialog displays, listing the segments defined in the Legend. Each segment has a checkbox.
- For each segment to show on the element, select the checkbox. For each segment to hide on the element, deselect the checkbox.
- Click on the . The selected segments on the element display on the diagram.
When a segment is hidden, the most directly-affected visible segment automatically occupies the space of the hidden segment. This is generally the segment immediately to the right (the chronologically later segment) except where the final segment in the element is hidden, when the segment to the left extends to fill the space. The overall length of the element does not change, and neither do the lengths of the remaining segments in the element; if they do need to be adjusted, drag the separator lines to the appropriate time line.
When a hidden segment is made visible, it occupies the first time unit of the next segment in the chronological sequence (or, if it has been added to the end of the element, the final time unit of the previous segment). Again, the total length of the element is not affected, not are the lengths of the other segments in the element. You can make manual adjustments to set the length of the new segment and any other segments that need to be adjusted to accommodate it.
- The Timeline and the text displayed on it are always shown, as you scroll the diagram up or down
- You can apply further grouping or categorization of the elements on the Roadmap, by defining horizontal Swimlanes for the diagram