Difference between revisions of "HowTo:Set Up CUI Rest API"

Revision as of 07:20, 1 September 2026

Overview

The CUI -> "Comos UBIK^® Interface" is a Standard Data exchange function between the two systems Comos and UBIK^® it is a bidirectional communication based on COMOS Web Rest API and the UBIK CUI Plugin (UBIK.Interface.CUI.dll).

For Comos, make sure you have a working Installation of Comos and COMOS Web with access to its Comos Database, you also need the license called

“COMOS_Mobile_Worker_Server”

On the UBIK side, to set it up please start with the Installation of UBIK^®, UBIK Database and its Web Services and Enterprise Server(s)

After that you have two possible ways to proceed, create a UBIK^® MetaClass structure manually or via Import from Comos.

If you want to export from Comos the first step is to check, update, or create templates, like in this description PDF:

Admin Comos UBIK Interface 2025 10 EN.pdf

Once the template structure in COMOS includes all the MetaClasses and Properties that you need on UBIK side, export these Comos templates as Meta information for UBIK^®:

In the standard Comos iDB there is a new Module section M67 for Comos Mobile Worker (UBIK) For a standard MRO Use case there are predefined templates,

these templates are connected to Comos CDevices that have the Functional Classification C270 (iDB) (for cDB there is a C2 Classification available).

Befor, please make sure that the Project settings for CUI Interface exist and are active; you can find them in Comos Project Settings,

and make sure that the “Active” checkbox on COMOS Mobile Worker Interface is checked.

First make sure the Interface is "Active" in Project settings of SO1 (or your used Workinglayer)

Next, open the ComosBaseObject in SO1, it should be found in iDB Databases at "@30|M67|A50|A20|A10", please make sure that the file path for the XML file exists.

To import into a UBIK^® database you have to use UBIK^® Smart Studio Smart_Studio

Smart Modelling

Setting Up UBIK for CUI

@@ Line 1: / Line 1: @@
 ==Overview==
-The CUI -> "{{Comos}} {{UBIK}} Interface" is a Standard Data exchange function between the tow Systems {{Comos}} and {{UBIK}} it is a bidirectional Communication based on Comos WEB Rest API and a UBIK CUI Plugin.
+The CUI -> "{{Comos}} {{UBIK}} Interface" is a Standard Data exchange function between the two systems {{Comos}} and {{UBIK}} it is a bidirectional communication based on COMOS Web Rest API and the UBIK CUI Plugin (UBIK.Interface.CUI.dll).
-For Comos make sure you have a working Installation of {{Comos}} and {{Comos Web}} with access to its {{Comos}} Database, you also need the License called “COMOS_Mobile_Worker_Server”
+For {{Comos}}, make sure you have a working Installation of {{Comos}} and COMOS Web with access to its {{Comos}} Database, you also need the license called
+ “COMOS_Mobile_Worker_Server”
-On UBIK side to set it up please start with the Installation of UBIK, UBIK Database and its Web services and Enterprise Server(s)
+On the UBIK side, to set it up please start with the Installation of {{UBIK}}, UBIK Database and its Web Services and Enterprise Server(s)
 * [[HowTo:Install_UBIK_Studio]]
@@ Line 11: / Line 12: @@
 * [[Configure_Enterprise_Service_for_CUI]]
-After that you have to possible ways to go on, Create a {{UBIK}} MetaClass struct manually or via Import from {{Comos}}.
+After that you have two possible ways to proceed, create a {{UBIK}} MetaClass structure manually or via Import from {{Comos}}.
-If you want to export from {{Comos}} the first step is to check, update or Create Templates, like in this description PDF:
+If you want to export from {{Comos}} the first step is to check, update, or create templates, like in this description PDF:
 [[:File:Admin_Comos_UBIK_Interface_2025_10_EN.pdf]]
-After Template Structure in {{Comos}} includes all the MetaClasses and Properties that you need on UBIK side, export these {{Comos}} Template as Meta information for UBIK:
+Once the template structure in COMOS includes all the MetaClasses and Properties that you need on UBIK side, export these {{Comos}} templates as Meta information for {{UBIK}}:
-In Standard Comos iDB there is a new Module section M67 for Comos Mobile Worker (UBIK)
+In the standard Comos iDB there is a new Module section M67 for Comos Mobile Worker (UBIK) For a standard MRO Use case there are predefined templates,
-For a standard MRO Use case there are Templates Predefined, these Templates are connected to Comos CDevices that have the Functional Classification C270 (iDB) (for cDB there is a C2 Classification available).
-Bevor, please make sure that the Project settings for CUI Interface are there and Active; you find them in Project settings an make sure that the Active checkbox on COMOS Mobile Worker Interface is checked.
+these templates are connected to Comos CDevices that have the Functional Classification C270 (iDB) (for cDB there is a C2 Classification available).
+Befor, please make sure that the Project settings for CUI Interface exist and are active; you can find them in Comos Project Settings,
+and make sure that the “Active” checkbox on COMOS Mobile Worker Interface is checked.
 First make sure the Interface is "Active" in Project settings of SO1 (or your used Workinglayer)
@@ Line 27: / Line 32: @@
 [[File:Project_activation.png|400px]]
-Next is to oben the ComosBaseObject in SO1, it should be found in iDB Databases at "@30|M67|A50|A20|A10", please make sure that the file path for the xml is existing and accessible.
+Next, open the ComosBaseObject in SO1, it should be found in iDB Databases at "@30|M67|A50|A20|A10", please make sure that the file path for the XML file exists.
 [[File:Export_from_Comos.png|400px]]
-To import in a UBIK Database you have to use {{UBIK}} Smart Studio  [[Smart_Studio]]
+To import into a {{UBIK}} database you have to use {{UBIK}} Smart Studio  Smart_Studio
 * [[Smart_Modelling]]
 * [[Setting_Up_UBIK_for_CUI]]