Difference between revisions of "HowTo:Set Up CUI Rest API"
| Line 1: | Line 1: | ||
==Overview== | ==Overview== | ||
| − | The CUI -> "{{ | + | 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 {{ | + | 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) | 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) | ||
| Line 11: | Line 11: | ||
* [[Configure_Enterprise_Service_for_CUI]] | * [[Configure_Enterprise_Service_for_CUI]] | ||
| − | After that you have two possible ways to proceed, create a {{UBIK}} MetaClass structure manually or via Import from {{ | + | 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 {{ | + | 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]] | [[:File: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 {{ | + | 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, | 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, | ||
| Line 23: | Line 23: | ||
these templates are connected to Comos CDevices that have the Functional Classification C270 (iDB) (for cDB there is a C2 Classification available). | 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 | + | Befor, please make sure that the Project settings for CUI Interface exist and are active; you can find them in COMOSProject Settings, |
and make sure that the “Active” checkbox on COMOS Mobile Worker Interface is checked. | and make sure that the “Active” checkbox on COMOS Mobile Worker Interface is checked. | ||
Revision as of 07:21, 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)
- Install UBIK Studio
- Install UBIK Database
- Install UBIK Web Service
- Configure Enterprise Service for CUI
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 COMOSProject 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
