**caBIG™ Standard Templates**

**Complete, Semantically Annotated XMI File**

*Please Note: This is an example document, not a template document.
There is not standard "template"; however, this document walks the user
through the creation of and format of an XMI in the caBIG™ program.*

# XMI Overview

XMI[^1] (**X**ML **M**etadata **I**nterchange) is an Object Management
Group (<http://www.omg.org/>) standard for exchanging metadata
information via XML. The main purpose of XMI is to interchange metadata
between UML based modeling tools and a Meta-Object Facility. For the
purposes of the caBIG™ Program, XMI files are the main method of
interchange between UML Models[^2] and the caDSR.

# Complete, Semantically Annotated XMI Deliverables in caBIG™

There is no standard "template" for the submission of XMI files in
caBIG™. What is required is an XMI file compliant with the caBIG™
Semantic Integration Workbench. The caBIG™ program prefers the use of
Enterprise Architect (EA) (<http://www.sparxsystems.com.au/>) for
generating XMI diagrams (the program also prefers the use of EA for
creation of UML diagrams). With EA UML Diagrams can be exported to XMI
files.

Semantically annotated XMI file must describe the data system and be in
XMI 1.1 format with the Rose/Unisys extensions.

For complete details on generating XMI please review the caCORE Software
Development KIT Chapter 6: Creating the UML Models.
(<http://ncicb.nci.nih.gov/infrastructure/cacore_overview/cacoresdk>)

# Submitting XMI Deliverables for Review

The XMI is one of several deliverables submitted by developers to the
Crosscutting WS as part of the compatibility submission package. For
more details on compatibility reviews please see

<https://cabig.nci.nih.gov/workspaces/VCDE/VCDE_Compatibility_Review/Compatibility_Review>

<http://gforge.nci.nih.gov/projects/compat-rev/>

# Example

The following example is the first page of the XMI file from the caBIO
project. XMI files are computer generated and can comprise of multiple
megabytes of plain xml text.

\<XMI xmlns:UML=\"omg.org/UML1.3\" xmi.version=\"1.1\"
timestamp=\"2005-04-18 16:47:49\"\>

\<XMI.header\>

\<XMI.documentation\>

\<XMI.exporter\>Enterprise Architect\</XMI.exporter\>

\<XMI.exporterVersion\>4.1RR\</XMI.exporterVersion\>

\</XMI.documentation\>

\</XMI.header\>

\<XMI.content\>

\<UML:Model name=\"EA Model\"
xmi.id=\"MX_EAID_1E735967_2110_413a_84EE_B90EB4528FC9\"\>

\<UML:Namespace.ownedElement
xmi.id=\"MX_EAID_1E735967_2110_413a_84EE_B90EB4528FC9_fix_0\"\>

\<UML:Class name=\"EARootClass\"
xmi.id=\"EAID_11111111_5487_4080_A7F4_41526CB0AA00\" isRoot=\"true\"
isLeaf=\"false\" isAbstract=\"false\" /\>

\<UML:Package name=\"Logical View\"
xmi.id=\"EAPK_1E735967_2110_413a_84EE_B90EB4528FC9\" isRoot=\"true\"
isLeaf=\"false\" isAbstract=\"false\" visibility=\"public\"\>

\<UML:Namespace.ownedElement
xmi.id=\"EAPK_1E735967_2110_413a_84EE_B90EB4528FC9_fix_1\"\>

\<UML:Package name=\"Logical Model\"
xmi.id=\"EAPK_06616E15_C8B9_4355_AAD1_041471F089A7\" isRoot=\"true\"
isLeaf=\"false\" isAbstract=\"false\" visibility=\"public\"\>

\<UML:Namespace.ownedElement
xmi.id=\"EAPK_06616E15_C8B9_4355_AAD1_041471F089A7_fix_1\"\>

\<UML:Package name=\"gov\"
xmi.id=\"EAPK_D29DF262_FC77_40b7_9195_6B7244AADBDA\"
xmi.uuid=\"40574E6E03B7\" isRoot=\"true\" isLeaf=\"false\"
isAbstract=\"false\" visibility=\"public\"\>

\<UML:Namespace.ownedElement
xmi.id=\"EAPK_D29DF262_FC77_40b7_9195_6B7244AADBDA_fix_1\"\>

\<UML:Package name=\"nih\"
xmi.id=\"EAPK_4B2E88A5_8EDD_4fa3_A1D3_AADEE0EC2E55\"
xmi.uuid=\"40574E6E03B9\" isRoot=\"true\" isLeaf=\"false\"
isAbstract=\"false\" visibility=\"public\"\>

\<UML:Namespace.ownedElement
xmi.id=\"EAPK_4B2E88A5_8EDD_4fa3_A1D3_AADEE0EC2E55_fix_1\"\>

\<UML:Package name=\"nci\"
xmi.id=\"EAPK_988E3E1E_11E4_4e66_8984_B059262DE859\"
xmi.uuid=\"40574E6E03C0\" isRoot=\"true\" isLeaf=\"false\"
isAbstract=\"false\" visibility=\"public\"\>

\<UML:Namespace.ownedElement
xmi.id=\"EAPK_988E3E1E_11E4_4e66_8984_B059262DE859_fix_1\"\>

\<UML:Package name=\"cabio\"
xmi.id=\"EAPK_583D742D_D631_41a5_9B8B_9337169A8C01\"
xmi.uuid=\"40574E6F0082\" isRoot=\"true\" isLeaf=\"false\"
isAbstract=\"false\" visibility=\"public\"\>

\<UML:Namespace.ownedElement
xmi.id=\"EAPK_583D742D_D631_41a5_9B8B_9337169A8C01_fix_1\"\>

\<UML:Package name=\"domain\"
xmi.id=\"EAPK_939D9A0F_A2AC_4473_873C_66AE4C097A73\"
xmi.uuid=\"40574E6F0084\" isRoot=\"true\" isLeaf=\"false\"
isAbstract=\"false\" visibility=\"public\"\>

\<UML:Namespace.ownedElement
xmi.id=\"EAPK_939D9A0F_A2AC_4473_873C_66AE4C097A73_fix_1\"\>

\<UML:Class name=\"Vocabulary\"
xmi.id=\"EAID_6441DA5A_93A2_46fd_BFFF_58776660EC8E\"
xmi.uuid=\"40574E6F0086\" visibility=\"public\"
namespace=\"EAPK_939D9A0F_A2AC_4473_873C_66AE4C097A73\" isRoot=\"false\"
isLeaf=\"true\" isAbstract=\"false\" isActive=\"false\"\>

\<UML:Classifier.feature
xmi.id=\"EAID_6441DA5A_93A2_46fd_BFFF_58776660EC8E_fix_1\"\>

\<UML:Attribute name=\"id\" changeable=\"none\" visibility=\"public\"
ownerScope=\"instance\" targetScope=\"instance\"
xmi.id=\"EAID_6441DA5A_93A2_46fd_BFFF_58776660EC8E_fix_1_fix_0\"\>

\<UML:StructuralFeature.multiplicity
xmi.id=\"EAID_6441DA5A_93A2_46fd_BFFF_58776660EC8E_fix_1_fix_0_fix_0\"\>

\<UML:Multiplicity
xmi.id=\"EAID_6441DA5A_93A2_46fd_BFFF_58776660EC8E_fix_1_fix_0_fix_0_fix_0\"\>

\<UML:Multiplicity.range
xmi.id=\"EAID_6441DA5A_93A2_46fd_BFFF_58776660EC8E_fix_1_fix_0_fix_0_fix_0_fix_0\"\>

\<UML:MultiplicityRange lower=\"1\" upper=\"1\"
xmi.id=\"EAID_6441DA5A_93A2_46fd_BFFF_58776660EC8E_fix_1_fix_0_fix_0_fix_0_fix_0_fix_0\"
/\>

\</UML:Multiplicity.range\>

\</UML:Multiplicity\>

\</UML:StructuralFeature.multiplicity\>

\<UML:Attribute.initialValue
xmi.id=\"EAID_6441DA5A_93A2_46fd_BFFF_58776660EC8E_fix_1_fix_0_fix_1\"\>

[^1]: http://www.omg.org/technology/documents/formal/xmi.htm

[^2]: See caBIG Templates UML Model Document