Jump to: navigation, search

Difference between revisions of "Setting Up UBIK for CUI"

(→‎Comos Project)
 
(20 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
Setting uo a UBIK Database fur CUI Data exchange
+
Setting up a UBIK Database for CUI Data Exchange
−
<!-- DO NOT REMOVE THIS -->{{Template:HowTo/Begin}}<!-- DO NOT REMOVE THIS -->
+
{{Template:HowTo/Begin}}
−
 
+
 
= Instructions =
 
= Instructions =
−
<!-- DO NOT MODIFY THE NAME OF THIS SECTION, BUT REMOVE IT IF NOT REQUIRED -->
+
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>
−
To set up Interfacing on UBIK Database you need Configurations \ Objects
+
  • (COMOS_PROJECT) Comos Project
−
 
+
  • (COMOS_LOGIN) Comos Login
−
* Comos Project  
+
  • (INTERFACE_ADMIN_COMOS) Interface Admin Comos
−
* Comos Login
+
  • (SYSREL_PROJECT_LANGUAGE) Comos Project &lt;-&gt; Language
−
* Interface Admin Comos
+
<br>
−
* Relation between Comos Project and Language
+
<br>
  
 
= Comos Project =
 
= Comos Project =
−
<!-- DO NOT MODIFY THE NAME OF THIS SECTION, BUT REMOVE IT IF NOT REQUIRED -->
+
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.
 +
<br>
  
−
Best approach is to go to Meta Class COMOS_PROJECT and derive a new Metaclass.
+
'''How to locate the MetaClass in UBIK®:'''
−
Reason is to get a Meta class that is cut off from this SystemMetaClass, witch could be changed on an Update of 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>
  
−
To find the MetaClass in {{UBIK}} See all goto -> SYSROOT -> SYSTEMOBJECT -> COMOS_PROJECT
+
[[File:ComosProject_ContentView.png|400px]]
 +
<br>
  
−
Or on Content View you find it below Namespaces; goto -> {}Comos -> {}Comos.Interface ->COMOS_PROJECT
+
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>
  
−
[[File:ComosProject_see_all.png|400px]][[File:ComosProject_ContentView.png|400px]]
+
You may choose any name and description, but it is recommended to use values that also exist in {{COMOS}}.
 +
<br>
  
−
After giving the new MetaClass a Name and Description, please Save; then you can generate you setting by opening the MetaClass in a Bulk Editor and create a new Instance.
+
The Database ID should match the value configured in {{COMOS}} under the project settings for Mobile Solutions.
−
You can name and Describe it at will, but it is a god Idea to use a Name or Description that is also in Comos.
+
The Enterprise Server should be the one from {{UBIK}}, configured in the same way as the Notification Endpoint.
 +
<br>
  
−
The Database ID is also the same as in Comos, on the Project settings for Mobile Solutions, the Enterprise Server here is that one from {{UBIK}} like you set up 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}}.
−
Project_ID, Working_Overlay_ID is again form Comos, Project_ID is Mandatory anyway, if you want to connect with an WorkingOverly from Comos this ID is also needed.
+
<br>
−
The Registration folder is only needet 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_Project_MC.png|400px]]
 
 
[[File:New_comos_project.png|400px]]
 
[[File:New_comos_project.png|400px]]
 +
<br>
 +
<br>
 +
  
 
= Comos Login =
 
= Comos Login =
−
<!-- DO NOT MODIFY THE NAME OF THIS SECTION, BUT REMOVE IT IF NOT REQUIRED -->
+
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.
 +
<br>
  
−
Similar to COMOS_PROJECT  go to MetaClass COMOS_LOGIN and derive a new Metaclass.
+
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>
  
−
Reason is to get a Metaclass that is cut off from this SystemMetaClass, wich could be changed on an Update of UBIK.
+
When the View is set to "Content", you can find it under Namespaces; go to ⇒ {} Comos ⇒ {} Comos.Interface ⇒ COMOS_LOGIN
 +
<br>
  
−
To find the MetaClass in {{UBIK}} See all goto -> SYSROOT -> SYSTEMOBJECT -> SERVICE_LOGIN -> BASICAUTH_SERVICE_LOGIN -> COMOS_LOGIN
+
[[File:ComosLogin_ContentView.png|400px]]
 +
<br>
  
−
Or on Content View you find it below Namespaces; goto -> {}Comos -> {}Comos.Interface -> COMOS_LOGIN
+
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>
  
−
[[File:ComosLogin_see_all.png|400px]][[File:ComosLogin_ContentView.png|400px]]
+
You may choose any name and description, but it is recommended to use values that also exist in {{COMOS}}.
 +
<br>
  
−
After giving the new MetaClass a Name and Description, please Save; then you can generate you setting by opening the MetaClass in a Bulk Editor and create a new Instance.
+
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.
−
You can name and Descripe it at will, but it is a god Idea to use a Name or Description that is also in Comos.
+
<br>
  
−
You have to Link a instance form COMOS_PROJECT or its children, so link here the Instance you created bevor in the new Created COMOS_PROJECT Childclass
+
The checkbox "RESTAPI_PRE_AUTHENTICATE" determines whether {{UBIK}} authenticates before sending data. Enable it according to your system security requirements.
−
with the checkbox you ask UBIK to Authenticate before sending data, could be that System security is asking for this.
+
<br>
−
In Service URL you have to give the Comos WebstartPage url, and User 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_MC.png|400px]]
 
 
[[File:New_Login.png|400px]]
 
[[File:New_Login.png|400px]]
 +
<br>
  
 
= Interface Admin Comos =
 
= Interface Admin Comos =
−
<!-- DO NOT MODIFY THE NAME OF THIS SECTION, BUT REMOVE IT IF NOT REQUIRED -->
+
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.
 +
<br>
  
−
Similar like before go to MetaClass INTERFACE_ADMIN_COMOS and derive a new Metaclass.
+
To find the MetaClass in {{UBIK}} when the View is set to "See All", go to ⇒ SYSROOT ⇒ INTERFACE_ADMIN_ROOT ⇒ INTERFACE_ADMIN_COMOS
 +
<br>
  
−
Reason is to get a Metaclass that is cut off from this SystemMetaClass, witch could be changed on an Update of UBIK.
+
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>
  
−
To find the MetaClass in {{UBIK}} See all goto -> SYSROOT -> INTERFACE_ADMIN_ROOT -> INTERFACE_ADMIN_COMOS
+
[[File:IA_COMOS_ContentView.png|400px]]
 +
<br>
  
−
Or on Content View you find it below Namespaces; goto -> {}Comos -> {}Comos.Interface -> {}Comos.Interface.Administration -> INTERFACE_ADMIN_COMOS
+
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_COMOS_see_all.png|400px]][[File:IA_COMOS_ContentView.png|400px]]
+
[[File:IA_CMW_LINK.png|400px]]
 +
<br>
  
−
After giving the new MetaClass a Name and Description, don't forget to link to the Login Object please Save;
+
To configure the proxies that should be imported and exported, open the new Interface Admin object in the Relation Editor.
 +
<br>
  
−
[[File:IA_CMW_LINK.png|400px]]
+
Then drag and drop all relevant proxies onto the Interface Admin MetaClass.
−
 
+
<br>
−
To Configure the Proxys that should be Imported and Exported please open the New InterfaceAdmin in a RelationEditor. Than drag an drop all the relevant Proxy to the Interface admin Object.
+
  
 
[[File:IA_RELATIONS.png|800px]]
 
[[File:IA_RELATIONS.png|800px]]
 +
<br>
 +
<br>
  
 
= Relation between Comos Project and Language =
 
= Relation between Comos Project and Language =
−
<!-- DO NOT MODIFY THE NAME OF THIS SECTION, BUT REMOVE IT IF NOT REQUIRED -->
+
Unlike the previous examples, the RelationalClass SYSREL_PROJECT_LANGUAGE remains a System MetaClass and should not be derived.
 +
<br>
  
−
Different to bevore RelationalClass SYSREL_PROJECT_LANGUAGE stays the SystemMetaClass.
+
To find the MetaClass in {{UBIK}} when the View is set to "See All", go to ⇒ RELATIONDATA ⇒ SYSREL_PROJECT_LANGUAGE
 +
<br>
  
−
To find the MetaClass in {{UBIK}} See all goto -> 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
 +
<br>
  
−
Or on Content View you find it below Namespaces; goto -> {}Comos -> {}Comos.Interface -> SYSREL_PROJECT_LANGUAGE
+
[[File:Lang_REL_ContentView.png|400px]]
 +
<br>
  
−
[[File:Lang_REL_see_all.png|400px]][[File:Lang_REL_ContentView.png|400px]]
+
Please open the class in the Bulk Editor.
−
 
+
<br>
−
Please open the Class in a Bulk Editor;
+
  
 
[[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.
+
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.
 +
<br>
  
−
And also the Comos settings witch Language is the current Project, and User Default.
+
The language objects in {{UBIK}} can be found as follows:
 +
<br>
  
−
The Languages from UBIK u find in
+
When the View is set to "See All", go to ⇒ SYSROOT ⇒ SYSTEM ⇒ LANGUAGE
 +
<br>
  
−
To find the MetaClass in {{UBIK}} See all goto -> SYSROOT -> INTERFACE_ADMIN_ROOT -> INTERFACE_ADMIN_COMOS
+
When the View is set to "Content", go to ⇒ {} System ⇒ {} System.Main ⇒ {} System.Main.Language ⇒ LANGUAGE ⇒ {} System
−
 
+
<br>
−
Or on Content View you find it below Namespaces; goto -> {}System -> {}System.Main -> {}System.Main.Language -> LANGUAGE -> {}System  
+
{{Template:HowTo/End}}
−
 
+
−
<!-- DO NOT REMOVE THIS -->{{Template:HowTo/End}}<!-- DO NOT REMOVE THIS -->
+
  
 
==See also==
 
==See also==
−
<!-- DO NOT MODIFY THE NAME OF THIS SECTION, BUT REMOVE IT IF NOT REQUIRED -->
+
* [[HowTo:Add_Languages_to_UBIK]]
−
 
+
* [https://cldr.unicode.org/ Unicode CLDR Project]
−
[[Add_Languages_to_UBIK]]
+
* [https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-lcid/70feba9f-294e-491e-b6eb-56532684c37f Microsoft LCID]
−
 
+
−
[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]
+

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

Retrieved from "https://wiki.augmensys.com/index.php?title=Setting_Up_UBIK_for_CUI&oldid=30603"