This file is available in the English language only.
The IBM® Rational® Department of Defense Architecture Framework (DoDAF) modeling feature provides systems architects with integrated modeling tools to describe the architecture of a complex system. The DoDAF feature uses the Unified Modeling Language (UML) as a base to represent a system's structure in visual, textual, and tabular formats. This release is a technical preview of the DoDAF modeling capabilities. Some of the generated work products are not complete and require additional changes to suit your architecture description requirements.
To view the latest version of this file, see the release notes at www3.software.ibm.com/ibmdl/pub/software/rationalsdp/rsa/60/html/dodaf/readme_601102.html.
(PK26681) DoDAF views are not generated correctly with non-generic workspace setup.
For information about installing the IBM Rational DoDAF modeling feature, installation prerequisites, installing from a command line, and setting up a local mirror of the update server, see the installation instructions at www3.software.ibm.com/ibmdl/pub/software/rationalsdp/rsa/60/install_instruction/dodaf/install_601102.html.
No additional hardware requirements are necessary to install this feature.
You can install this feature for use with IBM Rational Software Architect Version 6.0.1.1, IBM Rational Software Modeler Version 6.0.1.1, or IBM Rational Systems Developer Version 6.0.1.1. Before you install or update the feature, you must install Interim Fix 001 for IBM Rational Software Architect 6.0.1.1, Interim Fix 001 for IBM Rational Software Modeler 6.0.1.1, or Interim Fix 001 for IBM Rational Systems Developer 6.0.1.1.
This section provides information on problems and limitations with this release of the feature.
The DoDAF document products (AV-1, OV-6a, SV-9, SV-10a and the DoDAF report) use Microsoft® Word templates whose contents are supplied by using the COM interface of Microsoft Word. Document product generation is not supported in Linux® environments.
The DoDAF document products and the generated DoDAF report use Microsoft Word documents, but only Microsoft Office XP is supported. If you use Microsoft Office 2000, the J2SE Virtual Machine (JVM) that runs Eclipse stops responding when documents (AV-1, OV-6a, SV-9, SV-10a or the report) are generated and saved.
The DoDAF model, created from the template, is structured so that you can use one product to generate a subsequent product. The UML package names in the model are reserved and the package hierarchy is fixed. If the structure is changed or packages are renamed, various DoDAF commands might not work as expected.
The OV-2 and OV-3 products are generated by using the data from sequence diagrams of the OV-6c product. As such, creating OV-2 manually or modifying it directly does not cause changes to the OV-3 product.
The SV-3 and SV-6 products are generated by using the data from sequence diagrams of the SV-10c product. If no sequence diagrams exist, these products are empty.
The OV-3 window displays the operational information exchange matrix. The data presented in this matrix is a small subset of the OV-3 product and does not support the association of Information Exchange Requirement (IER) characteristics. However, the data column in the matrix displays the type property of the parameters that are defined by the corresponding operation of the receiving operational node.
The SV-6 window displays the systems data exchange matrix. The data in this matrix is a small subset of the SV-6 product and does not support the association of data exchange characteristics. However, the data description column in the matrix displays the type property of the parameters that are defined by the corresponding operation of the consumer systems node.
For many of the operational and systems view products, you must use the standard UML modeling techniques to create these products. The products affected are as follows: OV-1, OV-4, OV-5, OV-6b, OV-7, SV-1, SV-2, SV-4, SV-7, SV-8, SV-10b and SV-11.
The basic workflow that the DoDAF modeling feature supports is based on a bottom-up approach. Sequence diagrams (OV-6c) are manually created for communication between the operational nodes and other products (OV-2 and OV-3) are derived from the data defined in the sequence diagrams. Likewise, sequence diagrams (SV-10c) must be manually created for the data that is exchanged between systems nodes and other products (SV-3, SV-5 and SV-6) are derived from the sequence diagram data.
The CADM database is not supported by the DoDAF modeling feature.
The DoDAF modeling feature does not support existing UML design models that are created by using a different paradigm. You cannot import UML models and convert them into DoDAF models. The workflow requires you to start with new DoDAF models.
If you use the model publishing feature of the Rational Software Development Platform to publish a DoDAF model, the generated web report does not contain any of the DoDAF document products nor does it contain any of the matrices.
When you use the DoDAF pop-up menu in the Model Explorer view to create the AV-1, OV-6a, SV-9, or SV-10a products, a Microsoft Word document is created in the respective subfolder of the Documents folder in the DoDAF project. The Model Explorer view displays the document folders but not the document files themselves.
Workaround: Use the Package Explorer view or the Navigator view to access the generated document files.
After you create a DoDAF document product, if you open the generated document with the default Eclipse editor (by double-clicking the file in the Package Explorer view or Navigator view), you must edit the document to update the content. Because the default Eclipse editor uses an embedded version of Microsoft Word and a problem exists between Microsoft Word and Eclipse regarding the state of the document, the document is altered.
Workaround: Right-click the DOC file, then click Open With > System Editor. The document opens in an external Microsoft Word window, which works as expected. If you make changes to the document, you must select the corresponding project in the workspace and refresh the document with the repository, especially if you use CVS as the CM system.
When the AV-2 view is shown, the definition fields are blank unless you have added UML documentation to the corresponding elements.
Workaround: Select the element in the Model Explorer view or in a diagram and add the definition to the Documentation page in the Properties view.
If a DoDAF product is generated from other data in the model and that data is modified, the product is not updated. For example, the views that display the OV-3, SV-3, SV-5, or SV-6 products do not automatically update when the model is modified. Likewise, the OV-2 diagram that is generated does not automatically update if new messages are added to the OV-6c sequence diagrams.
Workaround: Each of the DoDAF views (OV-3, SV-3, SV-5, or SV-6 products) has a local menu item (and toolbar icon) for refreshing the view. Before you select this menu item, ensure that some DoDAF model elements (packages or nodes, but not a diagram) are selected in the Model Explorer view. When the OV-2 diagram is out of date, use the corresponding DoDAF pop-up menu item to regenerate the OV-2 product. You might need to fix the layout on the diagram.
When an operational node is realized, a collaboration is created for the node in the SV-10c package in the model. For each operation that is defined on that operational node, an interaction with a sequence diagram is created within the corresponding SV-10c collaboration. The name of the collaboration reflects the operational node and the contained interactions have the same names as the operations of that node. If the operational node or any of its operations are renamed or deleted, the collaborations and interactions in SV-10c are not automatically updated with the changes or deletions. Likewise if the collaborations or interactions in SV-10c are renamed or deleted, the operational nodes and their operations are not updated.
Workaround: If any of the operational nodes, operations, realized collaborations, or interactions are renamed, the DoDAF pop-up menu items for navigation (for example, Go To Realized Operation or Go To Operation Realization) should still work. However, if any elements are deleted, the navigation no longer works and you must manually delete the appropriate elements.
The product home page for Rational Software Architect is www.ibm.com/software/awdtools/architect/swarchitect/. For FAQs, lists of known problems and fixes, and other support information, visit the support page at www.ibm.com/software/awdtools/architect/swarchitect/support/index.html.
The product home page for Rational Software Modeler is www.ibm.com/software/awdtools/modeler/swmodeler/. For FAQs, lists of known problems and fixes, and other support information, visit the support page at www.ibm.com/software/awdtools/modeler/swmodeler/support/index.html.
The product home page for Rational Systems Developer is www.ibm.com/software/awdtools/developer/systemsdeveloper/. For FAQs, lists of known problems and fixes, and other support information, visit the product support page at www.ibm.com/software/awdtools/developer/systemsdeveloper/support/index.html.
IBM World Trade Asia Corporation
Licensing
2-31 Roppongi 3-chome, Minato-ku
Tokyo 106, Japan
The following paragraph does not apply to the United Kingdom or
any other country where such provisions are inconsistent with local law:
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION
"AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OR CONDITIONS OF
NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Some states do not allow disclaimer of express or implied warranties in
certain transactions, therefore, this statement may not apply to you.
This information could include technical inaccuracies or
typographical errors. Changes are periodically made to the information
herein; these changes will be incorporated in new editions of the
publication. IBM may make improvements and/or changes in the product(s)
and/or the program(s) described in this publication at any time without
notice.
Any references in this information to non-IBM Web sites are provided
for convenience only and do not in any manner serve as an endorsement
of those Web sites. The materials at those Web sites are not part of
the materials for this IBM product and use of those Web sites is at
your own risk.
IBM may use or distribute any of the information you supply in any
way it believes appropriate without incurring any obligation to you.
Licensees of this program who wish to have information about it for
the purpose of enabling: (i) the exchange of information between
independently created programs and other programs (including this one)
and (ii) the mutual use of the information which has been exchanged,
should contact:
Intellectual Property Dept. for Rational Software
IBM Corporation
20 Maguire Road
Lexington, MA
02421-3112
USA
Such information may be available, subject to appropriate terms and
conditions, including in some cases, payment of a fee.
The licensed program described in this documentation and all
licensed material available for it are provided by IBM under terms of
the IBM Customer Agreement, IBM International Program License Agreement
or any equivalent agreement between us.
Any performance data contained herein was determined in a controlled
environment. Therefore, the results obtained in other operating
environments may vary significantly. Some measurements may have been
made on development-level systems and there is no guarantee that these
measurements will be the same on generally available systems.
Furthermore, some measurements may have been estimated through
extrapolation. Actual results may vary. Users of this document should
verify the applicable data for their specific environment.
Information concerning non-IBM products was obtained from the
suppliers of those products, their published announcements or other
publicly available sources. IBM has not tested those products and
cannot confirm the accuracy of performance, compatibility or any other
claims related to non-IBM products. Questions on the capabilities of
non-IBM products should be addressed to the suppliers of those products.
All statements regarding IBM's future direction or intent are
subject to change or withdrawal without notice, and represent goals and
objectives only.
This information contains examples of data and reports used in daily
business operations. To illustrate them as completely as possible, the
examples may include the names of individuals, companies, brands, and
products. All of these names are fictitious and any similarity to the
names and addresses used by an actual business enterprise is entirely
coincidental.
COPYRIGHT LICENSE:
This information contains sample application programs in source language, which illustrates programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs.
Each copy or any portion of these sample programs or any derivative work, must include a copyright notice as follows:
© (your company name) (year). Portions of this code are derived from IBM Corp. Sample Programs. © Copyright IBM Corp. 2000, 2005. All rights reserved.
If you are viewing a soft copy of this information, the photographs and
color illustrations may not appear.
Programming interface information is intended to help you create application software using this program.
General-use programming interfaces allow you to write application software that obtain the services of this program's tools.
However, this information may also contain diagnosis, modification, and tuning information. Diagnosis, modification, and tuning information is provided to help you debug your application software.
Warning: Do not use this diagnosis, modification, and tuning information as a programming interface because it is subject to change.
The following terms are trademarks of International Business Machines Corporation in the United States, other countries, or both:
Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.
Microsoft, Windows and Windows NT are trademarks of Microsoft Corporation in the United States, other countries, or both.
Intel and Pentium are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States, other countries, or both.
UNIX is a registered trademark of The Open Group in the United States and other countries.
Linux is a trademark of Linus Torvalds in the United States, other countries, or both.
Other company, product or service names, may be trademarks or service marks of others.