Difference between revisions of "Setting Up UBIK for CUI"
| Line 2: | Line 2: | ||
{{Template:HowTo/Begin}} | {{Template:HowTo/Begin}} | ||
= Instructions = | = Instructions = | ||
| − | To set up an interface between COMOS and a UBIK database, you need the COMOS®-UBIK® Interface (CUI) plugin | + | 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> |
| − | <br> | + | |
• (COMOS_PROJECT) Comos Project | • (COMOS_PROJECT) Comos Project | ||
• (COMOS_LOGIN) Comos Login | • (COMOS_LOGIN) Comos Login | ||
Revision as of 10:47, 21 September 2026
Setting up a UBIK Database for CUI Data Exchange
- Instructions
- Comos Project
- Comos Login
- Interface Admin Comos
- Relation between Comos Project and Language
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 a UBIK update.
To find the MetaClass in UBIK® when the View is set to "See All", go to ⇒ SYSROOT ⇒ SYSTEMOBJECT ⇒ COMOS_PROJECT
When the View is set to "Content", you can find it under Namespaces; go to ⇒ {} 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.
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®.
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
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).
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
After assigning a name and description to the new MetaClass, do not forget to link the Login object and then save it.
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.
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
Please open the class in the Bulk Editor.
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
