HowTo:Import Meta Data from Comos - Revision history

NWE at 16:06, 26 June 2023

2023-06-26T16:06:02Z

NWE at 16:00, 26 June 2023

2023-06-26T16:00:51Z

NWE at 15:55, 26 June 2023

2023-06-26T15:55:58Z

NWE: Created page with "{{Attention|This page is under construction.}} Using Smart_Studio, meta data from Comos can be imported into {{UBIK}}. This includes Meta Classes and their..."

2023-06-26T15:55:49Z

Created page with "{{Attention|This page is under construction.}} Using Smart Studio, meta data from Comos can be imported into {{UBIK}}. This includes Meta Classes and their..."

New page

{{Attention|This page is under construction.}}

Using [[Smart_Studio]], meta data from Comos can be imported into {{UBIK}}. This includes [[MetaClass|Meta Classes]] and their [[MetaProperty|Meta Properties]], [[MetaProxy|Meta Proxies]], [[SelectiveList|Selective Lists]] and [[Unit|Units]].

{{Template:HowTo/Begin}}

= Instructions =


== Preconditions ==
As a precondition, a '''meta data XML file''' exported from Comos for {{UBIK}} is required. The Comos specialists in our Service department are capable of setting up such an export.
Further, a [[Smart_Studio#Smart_Projects|Smart Project]] and a [[Smart_Studio#UBIK.C2.AE_Environment|UBIK Environment]] should be available to import into.

== Basic idea ==
The Smart Import basically consists of the following steps:
* Select import file
* Plan your import
* Show meta classes from import file
* Merge with existing meta data
* Save to {{UBIK}}
* Generate a Handshake file

== 1. Select the file to import ==
* Open Smart Studio.
* Open a Smart Project or create a new one.
* Connect to your {{UBIK}} Environment using the plug symbol.
* Open the Smart Import view using the '''Import/Export''' menu's '''Import into Graph''' menu item.
* Use the '''Pick File''' button to select your file.


[[File:SmartImport_EntryPoint.png]]
[[File:SmartImport_PickFile.png]]

== 2. Plan your import ==
There are multiple ways you can go from here, depending on what you need.
Mostly, the best way depends on the following questions you must answer for yourself:
* Do I want to use the {{UBIK}} Environment as a basis for the import result?
* Is there already something in the {{UBIK}} Environment the imported meta data has to be combined with?
* Do I want to save the import result into my {{UBIK}} Environment?
* Do I want to use my Smart Project file to share the imported model with other people or {{UBIK}} Environments?

Most likely, your use-case is that you want to import meta data into an existing Environment, and maybe you have some of the classes that are specified in the import file already in your Environment, perhaps you have even edited them previously. There's a good chance you won't need the Smart Project at all, but you need one in order to use the necessary features in Smart Studio.

In any case, using the '''Plan Import''' button to configure your workflow is recommended.

[[File:SmartImport_PlanImport.png]]

You can change the order of steps and some details if you know what you want to achieve. If your use-case is as described above, you probably just want to select the following steps:
* Merge with Environment
* Save to Environment
There's no harm if you also select the other steps.

To start the import, press '''Execute Plan'''.


[[File:SmartImport_ExecutePlan.png]]

== 3. Check the meta data to be imported ==
The first thing you will see then is an [[Smart_Studio#Inheritance_Graph|Inheritance Graph]] presenting the MetaClasses from your Comos export file.
It's a good idea to check whether what you have here is what you want to import, because a wrong or faulty Comos export file can lead to an undesired result later.


[[File:SmartImport_MergeEnvironment.png]]
== 4. Merge ==
As described in [[Smart_Studio#Merging_Worksheets|this article]], merging is the process of combining the situation of a current worksheet with what is already there in the Environment or the Project. By default, the already existing models are extended by new aspects coming from the current worksheet, with the existing models "winning" in case of a conflict. For example, if you are importing a set of MetaClasses where some of them are new and others are already in your Environment or Project, the new MetaClasses are added and the existing ones aren't changed except for new meta properties, which are added. This is especially useful if you have already changed the inheritance structure of previously imported MetaClasses and don't want to override it with the new import.
After merging, your worksheet will be updated with the result of the combination, but nothing is saved yet.


[[File:SmartImport_MergeEnvironment.png]]
== 5. Save ==
When you're sure the current state of the worksheet is what you want, it can be saved either to the Environment or the Project, or to both.


[[File:SmartImport_SaveToEnvironment.png]]
== 6. Create a Handshake file ==
Using the context menu (right-click on the worksheet), you can generate a Comos-UBIK Handshake file. It contains a mapping of the UBIK IDs to the Comos IDs, and can be used to update the Comos-UBIK Interface.


[[File:SmartImport_CreateHandshake.png]]
[[File:SmartImport_HandshakeFile.png]]

{{Template:HowTo/End}}

==See also==
* [[Smart_Studio]]

[[Category:Smart Modelling|Import Meta Data from Comos]]
[[Category:How-To|Import Meta Data from Comos]]
[[Category:XML|Import Meta Data from Comos]]

@@ Line 27: / Line 27: @@
 <!--Insert smart import screenshot-->
-[[File:SmartImport_EntryPoint.png|border|500px]]
+[[File:SmartImport_EntryPoint.png|border|500px|Smart import]]
-[[File:SmartImport_PickFile.png|border|500px]]
+[[File:SmartImport_PickFile.png|border|500px|Pick a file]]
 == 2. Plan your import ==
@@ Line 42: / Line 42: @@
 In any case, using the '''Plan Import''' button to configure your workflow is recommended.
 <!--Insert import plan screenshot-->
-[[File:SmartImport_PlanImport.png|border|500px]]
+[[File:SmartImport_PlanImport.png|border|500px|Plan the import]]
 You can change the order of steps and some details if you know what you want to achieve. If your use-case is as described above, you probably just want to select the following steps:
@@ Line 52: / Line 52: @@
 <!--Insert execute plan screenshot-->
-[[File:SmartImport_ExecutePlan.png|border|500px]]
+[[File:SmartImport_ExecutePlan.png|border|500px|Execute plan]]
 == 3. Check the meta data to be imported ==
@@ Line 59: / Line 59: @@
 <!--Insert Preview screenshot-->
-[[File:SmartImport_MergeEnvironment.png|border|500px]]
+[[File:SmartImport_MergeEnvironment.png|border|500px|Merge with Environment]]
 == 4. Merge ==
 As described in [[Smart_Studio#Merging_Worksheets|this article]], merging is the process of combining the situation of a current worksheet with what is already there in the Environment or the Project. By default, the already existing models are extended by new aspects coming from the current worksheet, with the existing models "winning" in case of a conflict. For example, if you are importing a set of MetaClasses where some of them are new and others are already in your Environment or Project, the new MetaClasses are added and the existing ones aren't changed except for new meta properties, which are added. This is especially useful if you have already changed the inheritance structure of previously imported MetaClasses and don't want to override it with the new import.
@@ Line 65: / Line 65: @@
 <!--Insert Merge screenshot-->
-[[File:SmartImport_MergeEnvironment.png|border|500px]]
+[[File:SmartImport_MergeEnvironment.png|border|500px|Merge with Environment]]
 == 5. Save ==
 When you're sure the current state of the worksheet is what you want, it can be saved either to the Environment or the Project, or to both.
 <!--Insert Save screenshot-->
-[[File:SmartImport_SaveToEnvironment.png|border|500px]]
+[[File:SmartImport_SaveToEnvironment.png|border|500px|Save to Environment]]
 == 6. Create a Handshake file ==
 Using the context menu (right-click on the worksheet), you can generate a Comos-UBIK Handshake file. It contains a mapping of the UBIK IDs to the Comos IDs, and can be used to update the Comos-UBIK Interface.
 <!--Insert Handshake screenshot-->
-[[File:SmartImport_CreateHandshake.png|border|500px]]
+[[File:SmartImport_CreateHandshake.png|border|500px|Create handshake file]]
-[[File:SmartImport_HandshakeFile.png|border|500px]]
+[[File:SmartImport_HandshakeFile.png|border|500px|A handshake file]]
 <!-- DO NOT REMOVE THIS -->{{Template:HowTo/End}}<!-- DO NOT REMOVE THIS -->

@@ Line 1: / Line 1: @@
 Using [[Smart_Studio]], meta data from Comos can be imported into {{UBIK}}. This includes [[MetaClass|Meta Classes]] and their [[MetaProperty|Meta Properties]], [[MetaProxy|Meta Proxies]], [[SelectiveList|Selective Lists]] and [[Unit|Units]].
@@ Line 85: / Line 83: @@
 * [[Smart_Studio]]
 [[Category:How-To|Import Meta Data from Comos]]
 [[Category:XML|Import Meta Data from Comos]]