This page defines conventions applied to architecture and design modeling of the OOI Cyberinfrastructure

Diagram Use

General

• Name the diagram according to OOI Configuration Plan convention, e.g. "2650-00001 OV2 CI Diagram". While in draft mode and the actual CC identifier is not yet assigned, use "2650-xxxxx OV2 CI Diagram". For a list of CC categories, see HERE.
• Put a diagram properties box in the upper center of the diagram (except sequence diagrams where this space is blocked, use the lower left corner instead)
• Diagrams are views on model elements. They may choose to hide certain nodes and associations, but make the purpose of the diagram clear in the diagram notes
• State the purpose of the diagram in the notes section for the diagram.
• One diagram should be the designated primary for an element. Other diagrams
• If multiple diagrams exist for an element, insert a "See Also" text box and references to diagram elements at the lower left corner of the diagram
• Use call-out comment boxes for specific comments about parts of the model

OV2 (Operational Nodes and Needlines)

• Make sure the diagram is created as an "DoDAF/MoDAF Operational View OV-2 Class" type
• Use only Operational Node elements
• Use only needline and "RealizedOperationalSpecification" associations
• Make composite operational nodes composite
• Visualizing the nesting of elements in a diagram is possible

OV6 (Sequence Diagrams)

• Use only operational nodes (system internal and external) within OV6 diagrams. Drag them in from the OV2 part
• Arrange flow from upper left to lower right, if possible
• Use fragment areas for ALT, LOOP etc
• When editing sequence diagrams and adding messages, you need to get a lock on the OV2 package of message originating nodes

Model Elements

• Provide brief descriptions in element notes
• When editing a model element, a check out lock on the surrounding version control packet in the model tree is required. Associations are kept with the originating node.

Formatting

Color Use

• Use color cautiously. Do not use colors without definition
• Use 25% gray in diagrams (such as OV2) for all elements external to the current element scope

Layout

• Keep diagrams simple 
• Avoid crossing lines
• Keep lines straight if possible without bend
• Use similar dimensions for boxes of same "group". Make use of the EA formatting functions.
• Align boxes vertically and/or horizontally

Export

• HTML Export from EA