Jump to: navigation, search

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


(Overview)
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
==Overview==
 
==Overview==
The CUI -> "{{Comos}} {{UBIK}} Interface" is a Standard Dataexchange function betwen the tow Systems {{Comos}} and {{UBIK}} it is a bidirektional Communikation baesd on Comos WEB Rest API and a UBIK CUI Plugin.
+
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.
  
For Comos make sure you have a working Installation of {{Comos}} and {{Comos Web}} with acces 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 Webservices and EnterpriseServer(s)
+
On 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]]
 
* [[HowTo:Install_UBIK_Studio]]
Line 11: Line 11:
 
* [[Configure_Enterprise_Service_for_CUI]]
 
* [[Configure_Enterprise_Service_for_CUI]]
  
After that you have to possible ways to go on, Create a {{UBIK}} MetaClass strukte manually or via Import from Comos.
+
After that you have to possible ways to go on, Create a {{UBIK}} MetaClass struct 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:
 +
 
 +
[[: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:
 +
 
 +
In Standard Comos iDB there is a new Module section M67 for Comos Mobile Worker (UBIK)
 +
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.
 +
 
 +
First make sure the Interface is "Active" in Project settings of SO1 (or your used Workinglayer)
 +
 
 +
[[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.
 +
 
 +
[[File:Export_from_Comos.png|400px]]
 +
 
 +
To import in a UBIK Database you have to use {{UBIK}} Smart Studio  [[Smart_Studio]]
  
 
* [[Smart_Modelling]]
 
* [[Smart_Modelling]]
  
[[Category:Smart Modelling|Set Up CUI Rest API]]
+
* [[Setting_Up_UBIK_for_CUI]]

Latest revision as of 08:08, 13 August 2026

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.

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)

After that you have to possible ways to go on, Create a UBIK® MetaClass struct 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

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:

In Standard Comos iDB there is a new Module section M67 for Comos Mobile Worker (UBIK) 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.

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

Project activation.png

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.

Export from Comos.png

To import in a UBIK Database you have to use UBIK® Smart Studio Smart Studio