® ibm software group © 2011 ibm corporation ibm confidential last updated: april 1, 2011 dodaf 2...

®

IBM Software Group

© 2011 IBM Corporation

IBM ConfidentialIBM ConfidentialIBM ConfidentialIBM Confidential

Last Updated: April 1, 2011

DoDAF 2 Migration Toolkit Workshop

Chuck FarisSr. Enterprise Architecture SpecialistUnleash the Labs

IBM Software Group | Rational software

IBM ConfidentialIBM Confidential 2Last Updated: April 1, 2011

DISCLAIMER

IBM’s statements regarding its plans, directions, and intent are subject to change or withdrawal without notice at IBM’s sole discretion. Information regarding potential future products is intended to outline our general product direction and it should not be relied on in making a purchasing decision. The information mentioned regarding potential future products is not a commitment, promise, or legal obligation to deliver any material, code or functionality. Information about potential future products may not be incorporated into any contract. The development, release, and timing of any future features or functionality described for our products remains at our sole discretion.



DoDAF 2 Migration Toolkit Course Agenda

DoDAF 2 Migration Toolkit Advantages

Migration toolkit Contents

Preparation for the workshop

Working Environment Tools

DoDAF 2 Migration Toolkit Steps

DoDAF 2 Migration Toolkit Report Generator LABEL (LEGEND) Items

Workshop Examples

Example 1: Definition (1.5) to Definition (2.0) No reference properties

Example 2: Definition (1.5) to Definition (2.0) with reference properties

Example 3: Symbol (1.5) to Definition (2.0)

Service Offering – 5 day basic offering



DoDAF 2 Migration Toolkit Advantages

Enables customers to use their inventory of DoDAF model assets in DoDAF 2

Supports creation of DoDAF 2 data centric repository from DoDAF 1.5 diagrams, symbols and definitions by using the System Architect Report Generator to collect the needed DoDAF 1.5 information to create the DoDAF 2 definitions fundamental to data centricity

Allows customers to create a conversion that supports the way they used DoDAF 1.5 in converting to DoDAF 2 by using SA Report Generator to drive conversion

Provides sample Report Generator Reports and supporting items that can be used as-is or as a starting point for modifications to meet specific needs and use

Takes advantage of the data centric representational consistency features of System Architect’s DoDAF 2 implementation in diagram creation

Report Generator created XML is imported directly into DoDAF 2

Imported DoDAF 2 definitions are used in diagrams, matrices, reports and in other System Architect features.



DoDAF 2 Migration Toolkit Contents Needed for this workshop

Macro (DoDAF2Convertor.mac) to prime the DoDAF 1.5 Encyclopedia with Symbol GUIDS

Symbols use either unique GUID or underlying definition GUID

Stylesheet (Report2SAXML.XSL) to transform System Architect Report Generator output to System Architect XML

Includes TypeConv.XML template file for mapping DoDAF 1.5 symbols and definition to DoDAF 2 definition reference properties – including heterogeneous reference properties

Migration Toolkit Workshop Examples.RPT contains the System Architect Report Generator reports that are the examples used in the workshop

Samples provided for Example Report Generator reports and their descriptions for converting DoDAF 1.5 to DoDAF 2

Activity and Function Child selector Explorer Object Reports for populating DoDAF 2 diagram with a definition’s children

ActivityPerformedByPerformer Explorer Complex Report for generating ActivityPerformedByPerformer definitions from DoDAF 1.5

USRPROPS showing how to implement Information Exchange as a sub-type of Information (DM2) supporting it being referenced by Need Line (DM2rx), System Data Flow (DM2rx) and other definitions that reference Information (DM2) or its sub-types.

These items and others can be found in the “DoDAF 2 Migration Toolkit Supporting Items” file on http://w3.ibm.com/connections/files/app?lang=en_US#/file/b8a207c3-66ad-4754-8936-ffab84b7a42d



DoDF 2 Migration Toolkit Contents

DoDAF 1.5Encyclopedia

DoDAF 2Encyclopedia

Macro: DoDAF2ConvertorMacro: DoDAF2Convertor

Symbol GUID TableSymbol GUID Table

Table: TypeConv.XMLTable: TypeConv.XML

Extract/Create ReportExtract/Create Report

System Architect Report Generator

System Architect Report Generator

Stylesheet: Report2SAXML.XSLStylesheet: Report2SAXML.XSL

Set Symbols GUIDSet Symbols GUID

SA XMLSA XML



Preparation for the workshop Prerequisites …

System Architect, DoDAF 1.5 and DoDAF 2 knowledge

System Architect Report Generator knowledge

Check that … you have System Architect version 11.4.1 or higher installed

you have the DoDAF Samples encyclopedia installed

you have a text editor installed

Install … Report2SAXML.XSL and the TypeConv.XML template file in the StyleSht sub-directory in the Reports

directory of the System Architect root by copying them.

DoDAF2Convertor.mac (which includes UseDefnGUID and UseUniqueGUID case statement tables) in the Macro directory of the System Architect root directory. Create a Macro directory if needed. Copy the macro and activate using SA Tools > Macro Projects.

Copy the Migration Toolkit Workshop Examples.RPT file to the Reports directory of the System Architect root

Create … Report Output directory in the System Architect root directory

System Architect DoDAF Samples Converted encyclopedia specifying DoDAF2 as the framework in the configuration dialog of a new encyclopedia.



Working Environment Tools

System Architect and System Architect Report Generator Create, modify and test Report Generator reports

System Architect VBA Editor used to update UseDefnGUID case statements in DoDAF2Convertor.mac – identifies symbol types as using the same

GUID as the definition that defines them

UseUniqueGUID case statements in DoDAF2Convertor.mac – identifies symbol types as using unique GUIDS

Text Editor used to reference DODAF2.CFG – SA implementation of the DoDAF2 metamodel, DM2

DODAF.CFG – SA implementation of the DoDAF Classic metamodel

DEFNS.BAS – SA definition type numbers

Text Editor used to update TypeConv.XML is the stylesheet file included with Report2SAXML.XSL stylesheet. TypeConv.XML

contains the DoDAF 1.5 type numbers mapped to DoDAF2 definition type names. Used for creation of heterogeneous references.



DoDAF 2 Migration Toolkit Steps

DoDAF 1.5Encyclopedia

ReportGenerator

Output XML

DoDAF 2Encyclopedia

Step 1 - Prepare DoDAF 1.5 Encyclopedia

Step 2 – Create and Run Report Generator Reports

Step 1 - Prepare DoDAF 1.5 Encyclopedia

Step 2 – Create and Run Report Generator Reports

Step 3 - Import Generated XML into DoDAF2 Encyclopedia

Step 4 – Use Definitions to Create Diagrams, etc.

Step 3 - Import Generated XML into DoDAF2 Encyclopedia

Step 4 – Use Definitions to Create Diagrams, etc.



DoDAF 2 Migration Toolkit Report Generator LABEL (LEGEND) Keywords and Identifiers

These keywords and identifiers will be used throughout the examples and in working with the Toolkit “SADefName” – Identifies the source (DoDAF 1.5) property containing the name of the resultant

definitions. Often the Name of the source object.

“SADefGUID” - Identifies the source property containing the GUID of the resultant definitions. Usually the GUID of the source object.

<DM2 type number> - The DoDAF2 type number of the resultant definitions.

<DM2 property name> - The DoDAF2 property name in the resultant definitions.

“SAPrpGUID” – Identifies the source property containing the GUID of an object that will be referenced with a heterogeneous reference property. Usually the GUID of the referred to object.



Workshop Examples

There are three examples in the workshop Example 1: Definition (1.5) to Definition (2.0) no reference properties

Operational Activity to Activity (DM2) definition

Example 2: Definition (1.5) to Definition (2.0) with reference properties

Operational Activity to Activity (DM2) with System Function (DM2x) heterogeneous reference


ICOM Output/Input Arrows symbols to ActivityResourceOverlap (DM2r) definition with producingActivity and consumingActivity heterogeneous reference properties

This is a “one report at a time” (or one group at a time) process We will go through each example from creating the report, stylesheet table and macro table to running

the report and importing the generated XML and checking the results



Example 1: Definition (1.5) to Definition (2.0)No reference properties

Create the report to convert Operational Activity in DoDAF Classic to Activity (DM2) Open the DoDAF Sample encyclopedia

Create new report with Report Type set to “Grid” for testing

Select Definitions where type = Operational Activity

Select Properties to Print: Name, GUID, Type Number, Glossary Text and Reference Documents




Insert DoDAF 2 items in the Label (Legend) property formatting fields Set Name to SADefName to make the definition name the same in DoDAF 2

Set GUID to SADefGUID to make the definition GUID the same in DoDAF 2

Find the type number of Activity (DM2) in DEFNS.BAS and set the Type number label to the number

SADefNameSADefName

SADefGUIDSADefGUID

Type Number

Type Number

SADefNameSADefName

SADefGUIDSADefGUID




Run the report and check the results in the grid

The report should look like the one below SADefName is the label for the name column

SADefGUID is the label for the GUID column

1326 is the label for the type column

Description and Reference Documents columns are unchanged



The output file must type must

be .XML

The output file must type must

be .XML


Use the Report2SAXML.XSL stylesheet with its TypeConv.XML table to generate SA XML Change the Report Type to HTML

Set the Output File to the Report Output folder and name the file Activity (DM2) from Operational Activity.XML

Set the Stylesheet to point to the Report2SAXML.XSL stylesheet in the StyleSht sub-directory in the Reports directory

Check the Raw data box



Example 1: Definition (1.5) to Definition (2.0)No reference properties Create the XML output file

Run the report

Your windows explorer will start and display the output – opening the file will also display this output

Note the SAObjName, GUID and SAMinorTypeNum are set per your report




Import the generated XML into the DoDAF 2 encyclopedia Open the DoDAF Samples Converted encyclopedia

Open the SA Explorer

Right click on the Explorer and select Import XML

Set the File to import by navigating to the XML file your report created

Set the “If definitions are identical” drop down to “Update single fields when data supplied”

This allows you to run the reports in any sequence

Click OK

Use “Update single field when data

supplied” supports the addition of data from several reports

Use “Update single field when data

supplied” supports the addition of data from several reports




Check the results in the DoDAF Samples Converted encyclopedia

Check the SA Explorer

Open the definitions and check the properties



Example 2: Definition (1.5) to Definition (2.0)with reference properties Modify the existing Activity (DM2) report to include the System Function (DM2x) reference

porperty Step 1: Open the DoDAF Samples encyclopedia and open the report you created in Example 1

Step 2: Add the “System Functions” property to Properties to print. This will extract System Function definitions named in the property.

Step 3: Find the “System Function” reference property in the Activity (DM2) definition in the DoDAF2 metamodel and put its name (“Functions”) in the Label field. This will name the target property.

Step 4: Find the definition type number for System Function in DoDAF 1.5 by using the SA Properties Window and find the type name for System Functions in the DoDAF2.CFG file

Step 5: Check the TypeConv.XML file for the entry <SAType SrcPropTypeNum="3" TrgPropTypeName=""System Function (DM2x)""/> or add it if needed. This will convert objects of type 3 to System Function (DM2x).

Step 3: Add the DoDAF 2 Property Name “Functions”

Step 3: Add the DoDAF 2 Property Name “Functions”

Step 2: Add the “System

Function” property

Step 2: Add the “System

Function” property



Example 2: Definition (1.5) to Definition (2.0)with reference properties

Step 3: Functions reference

property in Activity (DM2)

from DODAF2.CFG

Step 3: Functions reference

property in Activity (DM2)

from DODAF2.CFG

Step 2: DoDAF 1.5 Property

Name in Report

Generator

Step 2: DoDAF 1.5 Property

Name in Report

Generator

Step 5: DM2 Definition

Type Name

Step 5: DM2 Definition

Type Name

Step 5 : DoDAF 1.5 Definition

Type Number

Step 5 : DoDAF 1.5 Definition

Type Number

Step 5: System

Function (DM2x) or a

sub-type

Step 5: System

Function (DM2x) or a

sub-type

Step 4: DODAF2.CFG

Activity (DM2) Definition

Step 4: DODAF2.CFG

Activity (DM2) Definition




Create the XML output file by running the report

Note the Functions heterogeneous reference property in the generated XML

Property Name

“Functions”

Property Name

“Functions”

Names of the System

Functions (DM2)

Names of the System

Functions (DM2)

List of System Function (DM2) and their GUIDs

List of System Function (DM2) and their GUIDs




Open the DoDAF Samples Converted encyclopedia and import the generated XML file as you did in Example 1

Open the same Activity (DM2) and note that the previously imported properties survived this import

Go to the page containing the System Functions property and note the heterogeneous System Function (DM2x) definitions. Click the define button on one of the definitions and note that Activities mirror property contains a reference back to the Activity (DM2)




When is this needed? DoDAF 2 relationships are contained in definitions

Some relationships in DoDAF 1.5 are implemented in symbol relationships

Examples of symbol relationships in DoDAF 1.5 are:

ICOM Arrow on OV-05 Activity Model diagram

Systems Data Exchange on SV-04 Data Flow diagram

Hierarchical relationships on OV-05 Node Tree diagram

Hierarchical relationships on SV-04 Functional Decomposition diagram




Create a report to convert ICOM Arrow Symbols in DoDAF Classic to ActivityResourceOverlap (DM2r) definitions ICOM Output/Input Arrows symbols in DoDAF 1.5 result in ActivityResourceOverlap (DM2r) definitions

in DoDAF 2. ActivityResourceOverlap (DM2r) definitions contain heterogeneousoneof reference properties which must be completed to take advantage of System Architect’s DoDAF 2 referential consistency:

producingActivity

consumingActivity

The Report Generator report must product one and only one producingActivity and one and only one consumingActivity for each ActivityResourceOverlap (DM2r) definition

Each ICOM arrow symbol must result in a single definition in DoDAF 2

Definitions that define ICOM arrow symbols are often reused in DoDAF 1.5 which leads to multiple reference properties for each resultant definition being generated

This example will use symbols to generate ActivityResourceOverlap (DM2r) definitions containing producingActivity and consumingActivity which are generated from the producing and consuming Operational Activity symbols in DoDAF 1.5

Using symbols gives you more text editing reports but limits the producing and consuming activity to one of each for generated ActivityResourceOverlap (DM2r) definitions




DoDAF 1.5 Encyclopedia Preparation for ICOM Arrows

Open System Architect and the DoDAF Sample encyclopedia Modify the two OV-05 Activity Model diagrams

Add a Boundary-Left and Boundary-Right Operational Activity to each diagram

Connect the ICOM Output/Input arrows emanating from the left boundary to the Boundary-Left Operational Activity and the ICOM Output/Input arrows going to the right boundary to the Boundary-Right Operational Activity

– This supports the resultant explicit relationship definitions in DoDAF 2 which must have source and destination nodes

– There is no need to connect the ICOM Control and ICOM Mechanism arrows as they will not result in explicit relationship definitions in DoDAF 2

Remove splits and joins from all ICOM arrows replacing with single ICOM arrows using the same name if needed




Open the DoDAF2Converter.MAC macro with the System Architect VBA Editor and add Operational Activity symbol to the UseDefnGUID case statements. This will insert the underlying definition’s GUID into each Operational Activity symbol. See Case 232 (symbol number for Operational Activity in DoDAF 1.5

Case 232Case 232




With the DoDAF2Converter.MAC macro open in the System Architect VBA Editor, add case 363 (ICOM Arrow symbol in DoDAF 1.5) to the UseUniqueGUID case statements and save your changes

Click the Run button in the VBA Editor

Then click the Convert button in the GUIDizer dialog shown below

This will add appropriate GUIDs to the symbols identified in the case statements

Case 363Case 363




Create the report to convert ICOM Arrow symbols to ActivityResourceOverlap (DM2r) Create a new report with the Report Type set to “Grid” for testing

Level 1 - Select Symbols where Type = Operational Activity, Print: Name

Level 2 – connect Symbols where Type = ICOM Arrow and ICOMDest = Input, Print: Name and Type Number

Level 3 – connect Symbols where Type = Operation Activity, Print: Name

We will adjust the relationships and add GUID references using by text editing the report later




Insert DoDAF 2 items in the Label (Legend) property formatting fields

Set Level 1 Name to producingActivity, the producing activity reference property name

Set Level 2 Name to SADefName to use the same name

Set Level 2 Type Number to 1383, the type number for ActivityResourceOverlap (DM2r)

Set Level 3 Name to consumingActivity, the consuming activity reference property name




Run the report and check the results in the grid

There are more items generated that there are ICOM Arrows because the Connection Number is needed to specify directionality – see text edited changes later




Use the Report2SAXML.XSL stylesheet with its TypeConv.XML table to generate SA XML Change the Report Type to HTML

Set the Output File to a folder and file name you want to use.

Change the file name suffix to .XML

Set the Stylesheet to point to the Report2SAXML.XSL stylesheet

Check the Raw data box




From System Architect Help

There are four connects/connects pairs. Although these relations each have the same name ("connects"), their relation numbers are different. If the relation name is used in a report, all of the relationships that conform to the remainder of the extraction criteria are included in the report. If Relation Numbers are used, the output can be defined more precisely. These numbers (6-9) are described in the following figure:




Text edit the report changing the report as below

Relationship 6 limits producing activities to source nodes and 9 limits to target nodes

GUID statements can not be added to symbols in Report Generator GUI

Add this Field “GUID”

statement

Add this Field “GUID”

statementAdd this GUID

LEGEND statement

Add this GUID LEGEND

statement

Change Relation Number to 6





statement


statement


statement


statement




Create the XML output by running the report

Note that each ActivityResourceOverlap (DM2r) definition has one producing activity and one consuming activity




Import the generated XML flie into the DoDAF Samples Converted encyclopedia

Open the ActivityResourceOverlap definitions and check that they are correctly formatted




In the DoDAF Samples Converted encyclopedia, open a new OV-05b Operational Activity Model and select-and-drag the Activity (DM2) node from the System Architect Explorer to the diagram. The Activity (DM2) nodes and the ActivityResourceOverlap connecting lines will appear.

Check that the definitions under the line symbols are correct and that the nodes are those imported in Examples 1 and 2

Send Orders toSupport Units

Send Orders toField Division

Receive - ValidateUnit Orders

Receive - ValidateField Orders

Disseminate andProcess Mission

Orders

Boundary - RightactivityPartOfActivity

Boundary - LeftactivityPartOfActivity

Unit Order

Validated Field Order

Intelligence Data

Field Order

Processed Orders

Intelligence Data

Processed Orders



Service Offering – 5 day basic offering

One day workshop that migrates the key models in the SA DoDAF Samples encyclopedia to DoDAF 2. Overview of DoDAF 2 contents and implementation in System Architect

Typical mapping of key elements in DoDAF 1.5 to DoDAF 2

SA encyclopedia data structure - diagrams, symbols, definitions and relationships

How to use the System Architect Report Generator in DoDAF 1.5 to generate DoDAF 2 definitions

Importing XML

Creating diagram views from definitions and other uses in DoDAF 2

Four day focus on migrating selected customer's models to DoDAF 2 Identify customer's most important model types

Confirm and adjust the mappings based on the customer’s use

Modify or create Report Generator reports to generate DoDAF 2 XML from DoDAF 1.5

Import into DoDAF 2 encyclopedia

Create DoDAF 2 diagram and matrix views from the imported definitions

®

IBM Software Group

© 2011 IBM Corporation

IBM ConfidentialIBM ConfidentialIBM ConfidentialIBM Confidential

16

© Copyright IBM Corporation 2010. All rights reserved. The information contained in these materials is provided for informational purposes only, and is provided AS IS without warranty of any kind, express or implied. IBM shall not be responsible for any damages arising out of the use of, or otherwise related to, these materials. Nothing contained in these materials is intended to, nor shall have

the effect of, creating any warranties or representations from IBM or its suppliers or licensors, or altering the terms and conditions of the applicable license agreement governing the use of IBM software. References in these materials to IBM products, programs, or services do not imply that they will be available in all countries in which IBM operates. Product release dates and/or capabilities

referenced in these materials may change at any time at IBM’s sole discretion based on market opportunities or other factors, and are not intended to be a commitment to future product or feature availability in any way. IBM, the IBM logo, Rational, the Rational logo, Telelogic, the Telelogic logo, and other IBM products and services

are trademarks of the International Business Machines Corporation, in the United States, other countries or both. Other company, product, or service names may be trademarks or service marks of others.

www.ibm.com/software/rational