Last modified on 22 September 2026, at 12:37

Difference between revisions of "Setting Up UBIK for CUI"
(→‎Comos Project)
 
(4 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
{{Template:HowTo/Begin}}
 
{{Template:HowTo/Begin}}
 
= Instructions =
 
= Instructions =
−
To set up interfacing in a UBIK database you need the following configuration MetaClasses:
+
To set up an interface between COMOS and a UBIK database, you need the COMOS®-UBIK® Interface (CUI) plugin, which generates the following configuration MetaClasses during installation:<br>
−
 
+
   • (COMOS_PROJECT) Comos Project
−
   • (COMOS_PROJECT) Comos Project
+
   • (COMOS_LOGIN) Comos Login
−
   • (COMOS_LOGIN) Comos Login
+
   • (INTERFACE_ADMIN_COMOS) Interface Admin Comos
−
   • (INTERFACE_ADMIN_COMOS) Interface Admin Comos
+
   • (SYSREL_PROJECT_LANGUAGE) Comos Project &lt;-&gt; Language
−
   • (SYSREL_PROJECT_LANGUAGE) Comos Project <-> Language
+
<br>
−
 
+
<br>
  
 
= Comos Project =
 
= Comos Project =
−
The best approach is to go to the MetaClass COMOS_PROJECT and derive a new Metaclass.
+
The recommended approach is to navigate to the MetaClass COMOS_PROJECT and derive a new MetaClass.
−
The reason is to create a MetaClass that is cut off from this SystemMetaClass, which could be changed during a UBIK update.
+
The reason for this is to create a MetaClass that is separated from the System MetaClass, which may be modified during an UBIK update.
−
 
+
<br>
−
To find the MetaClass in {{UBIK}} where View set to „See all“ go to -> SYSROOT -> SYSTEMOBJECT -> COMOS_PROJECT
+
  
−
when View is set to „Content“ you can find it under Namespaces; go to -> {} Comos -> {} Comos.Interface -> COMOS_PROJECT
+
'''How to locate the MetaClass in UBIK®:'''
 +
<br>
 +
* When the View is set to "See All", navigate to:
 +
SYSROOT → SYSTEMOBJECT → COMOS_PROJECT
 +
<br>
 +
* When the View is set to "Content", the MetaClass is located within the namespaces. Navigate to:
 +
{} Comos → {} Comos.Interface → COMOS_PROJECT
 +
<br>
  
 
[[File:ComosProject_ContentView.png|400px]]
 
[[File:ComosProject_ContentView.png|400px]]
 +
<br>
  
−
After assigning a name and description to the new MetaClass, please Save; then you can generate your setting
+
After assigning a name and description to the new MetaClass, click Save. You can then create your configuration by opening the MetaClass in the Bulk Editor and creating a new instance.
−
by opening the MetaClass in a Bulk Editor and create a new Instance. 
+
<br>
  
−
You can name and describe it as desired, but it is a good idea to use a name or description that is also in {{COMOS}}.
+
You may choose any name and description, but it is recommended to use values that also exist in {{COMOS}}.
 +
<br>
  
−
The Database ID is also the same as in {{COMOS}}, on the Project settings for Mobile Solutions,
+
The Database ID should match the value configured in {{COMOS}} under the project settings for Mobile Solutions.
−
the Enterprise Server here is that one from {{UBIK}} like you set up the Notification Endpoint. 
+
The Enterprise Server should be the one from {{UBIK}}, configured in the same way as the Notification Endpoint.
 +
<br>
  
−
DATABASE_ID Comos Database ID, PROJECT_ID Comos Project SystemUID, WORKING_OVERLAY_ID Comos Working Overlay SystemUID is again form {{COMOS}},
+
DATABASE_ID is the COMOS Database ID, PROJECT_ID is the COMOS Project SystemUID, and WORKING_OVERLAY_ID is the COMOS Working Overlay SystemUID from {{COMOS}}.
−
DATABASE_ID ad PROJECT_ID are Mandatory anyway, if you want to connect with an WorkingOverly from Comos this ID is also needed. 
+
<br>
  
−
The Registration folder is only needed when you want to use XML Files for Objects that are not Classified in {{COMOS}}.
+
DATABASE_ID and PROJECT_ID are mandatory. If you want to connect to a specific Working Overlay in COMOS, the WORKING_OVERLAY_ID is also required.
 +
<br>
 +
 
 +
The Registration Folder is required only if you want to use XML files for objects that are not classified in {{COMOS}}.
 +
<br>
  
 
[[File:New_comos_project.png|400px]]
 
[[File:New_comos_project.png|400px]]
 +
<br>
 +
<br>
  
  
 
= Comos Login =
 
= Comos Login =
−
Similar to COMOS_PROJECT go to MetaClass COMOS_LOGIN and derive a new Metaclass.
+
Similar to COMOS_PROJECT, navigate to the MetaClass COMOS_LOGIN and derive a new MetaClass.
−
The reason is to create a MetaClass that is cut off from this SystemMetaClass, which could be changed during a UBIK update.
+
The reason for this is to create a MetaClass that is separated from the System MetaClass, which may be modified during a UBIK update.
 +
<br>
  
−
To find the MetaClass in {{UBIK}} where View set to „See all“ go to -> SYSROOT -> SYSTEMOBJECT -> SERVICE_LOGIN -> BASICAUTH_SERVICE_LOGIN -> COMOS_LOGIN
+
To find the MetaClass in {{UBIK}} when the View is set to "See All", go to ⇒ SYSROOT ⇒ SYSTEMOBJECT ⇒ SERVICE_LOGIN ⇒ BASICAUTH_SERVICE_LOGIN ⇒ COMOS_LOGIN
 +
<br>
  
−
when View is set to „Content“ you can find it under Namespaces; go to -> {} Comos -> {} Comos.Interface -> COMOS_LOGIN
+
When the View is set to "Content", you can find it under Namespaces; go to ⇒ {} Comos ⇒ {} Comos.Interface ⇒ COMOS_LOGIN
 +
<br>
  
 
[[File:ComosLogin_ContentView.png|400px]]
 
[[File:ComosLogin_ContentView.png|400px]]
 +
<br>
  
−
After assigning a name and description to the new MetaClass, please Save; then you can generate you setting by opening the MetaClass in a Bulk Editor and create a new Instance. 
+
After assigning a name and description to the new MetaClass, click Save. You can then create your configuration by opening the MetaClass in the Bulk Editor and creating a new instance.
 +
<br>
  
−
You can name and describe it as desired, but it is a good idea to use a name or description that is also in {{COMOS}}.
+
You may choose any name and description, but it is recommended to use values that also exist in {{COMOS}}.
 +
<br>
  
−
You have to link an instance from COMOS_PROJECT or its children, so link here the Instance you created befor in the new Created COMOS_PROJECT Child Class, 
+
You must link an instance of COMOS_PROJECT or one of its derived classes. Link the instance that you previously created in your derived COMOS_PROJECT MetaClass.
 +
<br>
  
−
with the checkbox "RESTAPI_PRE_AUTHENTICATE" you ask {{UBIK}} authenticates before sending data, depending on your system security requirements. 
+
The checkbox "RESTAPI_PRE_AUTHENTICATE" determines whether {{UBIK}} authenticates before sending data. Enable it according to your system security requirements.
 +
<br>
  
−
In Service URL you musst set the ComosWebstartPage URL, and user name and password for COMOS login (mostly Domain user)
+
In the Service URL field, enter the ComosWebstartPage URL. Also provide the username and password used for COMOS login (typically a domain user account).
 +
<br>
  
 
[[File:New_Login.png|400px]]
 
[[File:New_Login.png|400px]]
 +
<br>
  
 
= Interface Admin Comos =
 
= Interface Admin Comos =
−
Similar to the previous steps go to MetaClass INTERFACE_ADMIN_COMOS and derive a new Metaclass. 
+
Similar to the previous steps, navigate to the MetaClass INTERFACE_ADMIN_COMOS and derive a new MetaClass.
−
The reason is to create a MetaClass that is cut off from this SystemMetaClass, which could be changed during a {{UBIK}} update.
+
The reason for this is to create a MetaClass that is separated from the System MetaClass, which may be modified during a {{UBIK}} update.
 +
<br>
  
−
To find the MetaClass in {{UBIK}} where View set to „See all“ go to -> SYSROOT -> INTERFACE_ADMIN_ROOT -> INTERFACE_ADMIN_COMOS
+
To find the MetaClass in {{UBIK}} when the View is set to "See All", go to ⇒ SYSROOT ⇒ INTERFACE_ADMIN_ROOT ⇒ INTERFACE_ADMIN_COMOS
 +
<br>
  
−
when View is set to „Content“ you can find it under Namespaces; go to -> {} Comos -> {} Comos.Interface -> {} Comos.Interface.Administration -> INTERFACE_ADMIN_COMOS
+
When the View is set to "Content", you can find it under Namespaces; go to ⇒ {} Comos ⇒ {} Comos.Interface ⇒ {} Comos.Interface.Administration ⇒ INTERFACE_ADMIN_COMOS
 +
<br>
  
 
[[File:IA_COMOS_ContentView.png|400px]]
 
[[File:IA_COMOS_ContentView.png|400px]]
 +
<br>
  
−
After assigning a name and description to the new MetaClass, don't forget to link the Login object, then save;
+
After assigning a name and description to the new MetaClass, do not forget to link the Login object and then save it.
 +
<br>
  
 
[[File:IA_CMW_LINK.png|400px]]
 
[[File:IA_CMW_LINK.png|400px]]
 +
<br>
  
−
To configure the Proxies that should be imported and exported please open the new InterfaceAdmin in a RelationEditor.  
+
To configure the proxies that should be imported and exported, open the new Interface Admin object in the Relation Editor.
 +
<br>
  
−
Then drag an drop all the relevant Proxy to the InterfaceAdmin MetaClass.
+
Then drag and drop all relevant proxies onto the Interface Admin MetaClass.
 +
<br>
  
 
[[File:IA_RELATIONS.png|800px]]
 
[[File:IA_RELATIONS.png|800px]]
−
 
+
<br>
 +
<br>
  
 
= Relation between Comos Project and Language =
 
= Relation between Comos Project and Language =
−
Different to before RelationalClass SYSREL_PROJECT_LANGUAGE stays the SystemMetaClass.
+
Unlike the previous examples, the RelationalClass SYSREL_PROJECT_LANGUAGE remains a System MetaClass and should not be derived.
 +
<br>
  
−
To find the MetaClass in {{UBIK}} where View set to „See all“ go to -> RELATIONDATA -> SYSREL_PROJECT_LANGUAGE
+
To find the MetaClass in {{UBIK}} when the View is set to "See All", go to ⇒ RELATIONDATA ⇒ SYSREL_PROJECT_LANGUAGE
 +
<br>
  
−
when View is set to „Content“ you can find it under Namespaces; go to -> {} Comos -> {} Comos.Interface -> SYSREL_PROJECT_LANGUAGE
+
When the View is set to "Content", you can find it under Namespaces; go to ⇒ {} Comos ⇒ {} Comos.Interface ⇒ SYSREL_PROJECT_LANGUAGE
 +
<br>
  
 
[[File:Lang_REL_ContentView.png|400px]]
 
[[File:Lang_REL_ContentView.png|400px]]
 +
<br>
  
−
Please open the Class in a Bulk Editor;
+
Please open the class in the Bulk Editor.
 +
<br>
  
 
[[File:REL_OVERVIEW.png|1200px]]
 
[[File:REL_OVERVIEW.png|1200px]]
 +
<br>
  
−
To Create a new Instance set a COMOS_PROJECT Instance to LEFTUID and a Language Object to the RIGHTUID.
+
To create a new instance, assign a COMOS_PROJECT instance to LEFTUID and a Language object to RIGHTUID.
 +
<br>
  
−
Add the Microsoft LCID number for your Language. And also the Comos settings witch Language is the current Project, and User Default. 
+
Add the Microsoft LCID number for the language. Also configure the COMOS language settings to specify whether the language is the current project language and the user's default language.
−
The languages from {{UBIK}} you find in 
+
<br>
  
−
To find the MetaClass in {{UBIK}} where View set to „See all“ go to -> SYSROOT -> INTERFACE_ADMIN_ROOT -> INTERFACE_ADMIN_COMOS 
+
The language objects in {{UBIK}} can be found as follows:
 +
<br>
  
−
when View is set to „Content“ you can find it under Namespaces; go to -> {} System -> {} System.Main -> {} System.Main.Language -> LANGUAGE -> {} System
+
When the View is set to "See All", go to ⇒ SYSROOT ⇒ SYSTEM ⇒ LANGUAGE
 +
<br>
  
 +
When the View is set to "Content", go to ⇒ {} System ⇒ {} System.Main ⇒ {} System.Main.Language ⇒ LANGUAGE ⇒ {} System
 +
<br>
 
{{Template:HowTo/End}}
 
{{Template:HowTo/End}}
  
 
==See also==
 
==See also==
−
Add_Languages_to_UBIK
+
* [[HowTo:Add_Languages_to_UBIK]]
−
[https://cldr.unicode.org/ Unicode CLDR Project]
+
* [https://cldr.unicode.org/ Unicode CLDR Project]
−
[https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-lcid/70feba9f-294e-491e-b6eb-56532684c37f Microsoft LCID]
+
* [https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-lcid/70feba9f-294e-491e-b6eb-56532684c37f Microsoft LCID]

Latest revision as of 12:37, 22 September 2026

Setting up a UBIK Database for CUI Data Exchange

[edit]

Instructions

To set up an interface between COMOS and a UBIK database, you need the COMOS®-UBIK® Interface (CUI) plugin, which generates the following configuration MetaClasses during installation:

  • (COMOS_PROJECT) Comos Project
  • (COMOS_LOGIN) Comos Login
  • (INTERFACE_ADMIN_COMOS) Interface Admin Comos
  • (SYSREL_PROJECT_LANGUAGE) Comos Project <-> Language



Comos Project

The recommended approach is to navigate to the MetaClass COMOS_PROJECT and derive a new MetaClass. The reason for this is to create a MetaClass that is separated from the System MetaClass, which may be modified during an UBIK update.

How to locate the MetaClass in UBIK®:

  • When the View is set to "See All", navigate to:
SYSROOT → SYSTEMOBJECT → COMOS_PROJECT


  • When the View is set to "Content", the MetaClass is located within the namespaces. Navigate to:
{} Comos → {} Comos.Interface → COMOS_PROJECT


ComosProject ContentView.png

After assigning a name and description to the new MetaClass, click Save. You can then create your configuration by opening the MetaClass in the Bulk Editor and creating a new instance.

You may choose any name and description, but it is recommended to use values that also exist in COMOS®.

The Database ID should match the value configured in COMOS® under the project settings for Mobile Solutions. The Enterprise Server should be the one from UBIK®, configured in the same way as the Notification Endpoint.

DATABASE_ID is the COMOS Database ID, PROJECT_ID is the COMOS Project SystemUID, and WORKING_OVERLAY_ID is the COMOS Working Overlay SystemUID from COMOS®.

DATABASE_ID and PROJECT_ID are mandatory. If you want to connect to a specific Working Overlay in COMOS, the WORKING_OVERLAY_ID is also required.

The Registration Folder is required only if you want to use XML files for objects that are not classified in COMOS®.

New comos project.png


Comos Login

Similar to COMOS_PROJECT, navigate to the MetaClass COMOS_LOGIN and derive a new MetaClass. The reason for this is to create a MetaClass that is separated from the System MetaClass, which may be modified during a UBIK update.

To find the MetaClass in UBIK® when the View is set to "See All", go to ⇒ SYSROOT ⇒ SYSTEMOBJECT ⇒ SERVICE_LOGIN ⇒ BASICAUTH_SERVICE_LOGIN ⇒ COMOS_LOGIN

When the View is set to "Content", you can find it under Namespaces; go to ⇒ {} Comos ⇒ {} Comos.Interface ⇒ COMOS_LOGIN

ComosLogin ContentView.png

After assigning a name and description to the new MetaClass, click Save. You can then create your configuration by opening the MetaClass in the Bulk Editor and creating a new instance.

You may choose any name and description, but it is recommended to use values that also exist in COMOS®.

You must link an instance of COMOS_PROJECT or one of its derived classes. Link the instance that you previously created in your derived COMOS_PROJECT MetaClass.

The checkbox "RESTAPI_PRE_AUTHENTICATE" determines whether UBIK® authenticates before sending data. Enable it according to your system security requirements.

In the Service URL field, enter the ComosWebstartPage URL. Also provide the username and password used for COMOS login (typically a domain user account).

New Login.png

Interface Admin Comos

Similar to the previous steps, navigate to the MetaClass INTERFACE_ADMIN_COMOS and derive a new MetaClass. The reason for this is to create a MetaClass that is separated from the System MetaClass, which may be modified during a UBIK® update.

To find the MetaClass in UBIK® when the View is set to "See All", go to ⇒ SYSROOT ⇒ INTERFACE_ADMIN_ROOT ⇒ INTERFACE_ADMIN_COMOS

When the View is set to "Content", you can find it under Namespaces; go to ⇒ {} Comos ⇒ {} Comos.Interface ⇒ {} Comos.Interface.Administration ⇒ INTERFACE_ADMIN_COMOS

IA COMOS ContentView.png

After assigning a name and description to the new MetaClass, do not forget to link the Login object and then save it.

IA CMW LINK.png

To configure the proxies that should be imported and exported, open the new Interface Admin object in the Relation Editor.

Then drag and drop all relevant proxies onto the Interface Admin MetaClass.

IA RELATIONS.png

Relation between Comos Project and Language

Unlike the previous examples, the RelationalClass SYSREL_PROJECT_LANGUAGE remains a System MetaClass and should not be derived.

To find the MetaClass in UBIK® when the View is set to "See All", go to ⇒ RELATIONDATA ⇒ SYSREL_PROJECT_LANGUAGE

When the View is set to "Content", you can find it under Namespaces; go to ⇒ {} Comos ⇒ {} Comos.Interface ⇒ SYSREL_PROJECT_LANGUAGE

Lang REL ContentView.png

Please open the class in the Bulk Editor.

REL OVERVIEW.png

To create a new instance, assign a COMOS_PROJECT instance to LEFTUID and a Language object to RIGHTUID.

Add the Microsoft LCID number for the language. Also configure the COMOS language settings to specify whether the language is the current project language and the user's default language.

The language objects in UBIK® can be found as follows:

When the View is set to "See All", go to ⇒ SYSROOT ⇒ SYSTEM ⇒ LANGUAGE

When the View is set to "Content", go to ⇒ {} System ⇒ {} System.Main ⇒ {} System.Main.Language ⇒ LANGUAGE ⇒ {} System

See also