diff --git a/docs/how-to/import-cim-uml.md b/docs/how-to/import-cim-uml.md index b1ff194e..388ecce6 100644 --- a/docs/how-to/import-cim-uml.md +++ b/docs/how-to/import-cim-uml.md @@ -76,22 +76,22 @@ Format | Description | Pros | Cons `.qea` / `.qeax` | Native EA project files. Introduced in EA 16.x the internal format of these files is based on the [SQLLite](https://www.sqlite.org/) open source database and is stored as binaries. Both file types support basic replication with the `.qeax` extension indicating that file sharing is enabled. A `.qeax` file can simply be renamed back to `.qea` to disable file sharing. | _These formats are not yet supported in **CIMTool**._

These native project file formats will be able to be imported directly into **CIMTool** without the overhead of having to export an `.xmi` file.| | If hosting a CIMTool project on Github the use of one of these project files is not recommended (see: [About large files on GitHub](https://docs.github.com/en/repositories/working-with-files/managing-large-files/about-large-files-on-github) and [Git LFS](https://docs.github.com/en/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage)). Instead an `.xmi` file should be utilized. `.xmi` | The XMI (XML Metadata Interchange) format is an Object Management Group (OMG) standard for exchanging metadata information via Extensible Markup Language (XML). | Exporting the CIM as an `.xmi` schema file has added flexibility not available when using a native EA project file. Specifically, a subset of the CIM can be exported by simply selecting a specific package for export. This approach can be used to reduce the size of the schema file in a **CIMTool** project. Given that profiles are commonly defined for a particular domain (e.g. Transmission, Distribution, Market-related profiles) just a subset of the CIM can be exported and used within **CIMTool**. This is more suitable when hosting a **CIMTool** project in Github.

**CIMTool** supports the ability to import multiple `.xmi` schema files and for a user to assign a distinct namespace to each. This is useful when defining and exporting custom extensions as a separate `.xmi` file that coexists alongside an `.xmi` for the CIM model. | Exporting `.xmi` files can be time consuming and therefore inconvenient if quick iterative changes are needed to the CIM with a reimport into a **CIMTool** project. In this scenario it is suggested to use one of the native EA project files. The direct use of a project file eliminates the roundtrip time needed for the "make changes to the UML, export to XMI, import XMI into CIMTool" cycle. -## Importing a Schema File in CIMTool +## Importing a Schema File into a CIMTool Project -To import an `.xmi`, `.eap` or `.eapx` file into **CIMTool**, open the project you'd like to use the schema with and **Select File -> Import**. In the Import dialog, expand CIMTool folder and select Import Schema. +To import an `.xmi`, `.eap` or `.eapx` file into **CIMTool**, open the project you'd like to use the schema with and the navigation to the **Select File -> Import** menu. In the Import dialog, expand the CIMTool folder and select Import Schema and click the "Finish" button. ![Select Import Schema](../images/ImportSchema.png) Browse to find the `.xmi`, `.eap` or `.eapx` file then select the checkboxes next to the project(s) you want to import the schema file into. -At this point it is important to determine which namespace to specify. This will be the namespace associated with your imported CIM schema (i.e. the base canonical model). Various releases of the CIM are specified as radio buttons and provide the default namespace for the respective release. While the "Preference*" radio button just gives a generic namespace, most of the time you will want to customize it as needed. If importing an `.xmi` file containing your own custom extension packages you should provide a unique namespace to associate with this "extensions schema". (For more information on extensions visit the topic [CIMTool Support for Extension Namespaces](https://cimtool.ucaiug.io/how-to/cimtool-support-for-extension-namespaces/)). ote that if importing an `.eap` or `.eapx` file into a **CIMTool** project you must close the project in EA before importing it to **CIMTool**. Finally, if loading changes over an existing schema with the same name be sure to select the "Replace existig schema" checkbox. +Next specify the namespace to be associated with your imported CIM schema. The set of radio buttons provide the default namespaces for the most recent release of the CIM. The "Preference*" radio button option gives a generic namespace which commonly is edited as needed. If importing an `.xmi` file containing your own custom extension packages you should provide a unique namespace to associate with this "extensions schema". For more information on extensions visit the topic [CIMTool Support for Extension Namespaces](https://cimtool.ucaiug.io/how-to/cimtool-support-for-extension-namespaces/). + +Finally, if loading changes over an existing schema with the same name be sure to select the "Replace existig schema" checkbox. ![Import Schema Dialog](../images/ImportSchemaDialog.png "Import Schema Dailog") Once imported the CIM UML will be stored in the **Schema** folder of the project. -There is typically one schema per project, although there are cases where there may be more than one (e.g. if you have custom extensions or multiple CIM UML versions for a single Contextual Profile). - ## CIMTool Profiling Tutorial For further details on how to use CIMTool to create and edit profiles based on the CIM visit the **How To** section of [https://cimtool.ucaiug.io/](https://cimtool.ucaiug.io/).