Difference between revisions of "HowTo:Set Up CUI Rest API"
(→Overview) |
|||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
==Overview== | ==Overview== | ||
| − | |||
| − | + | The COMOS®-UBIK® Interface (CUI) is a standard data exchange function between the {{COMOS}} and {{UBIK}} systems. It provides bidirectional communication based on the COMOS Web REST API and the UBIK CUI Plugin (UBIK.Interface.CUI.dll). | |
| + | <br> | ||
| − | On UBIK side | + | For {{COMOS}}, make sure that 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". |
| + | <br> | ||
| + | |||
| + | On the UBIK side, start by installing {{UBIK}}, the UBIK database, its Web Services, and the Enterprise Server(s). | ||
| + | <br> | ||
* [[HowTo:Install_UBIK_Studio]] | * [[HowTo:Install_UBIK_Studio]] | ||
| Line 10: | Line 14: | ||
* [[HowTo:Install_UBIK_Web_Service]] | * [[HowTo:Install_UBIK_Web_Service]] | ||
* [[Configure_Enterprise_Service_for_CUI]] | * [[Configure_Enterprise_Service_for_CUI]] | ||
| + | <br> | ||
| − | After that you have | + | After that, you have two possible ways to proceed: |
| + | * Create a {{UBIK}} MetaClass structure manually | ||
| + | * Import it from {{COMOS}}. | ||
| + | <br> | ||
| + | If you want to export data from {{COMOS}}, the first step is to review, update, or create the required templates as described in the PDF document available for download below: | ||
| + | <br> | ||
| − | + | * [[:File:Admin_Comos_UBIK_Interface_2025_10_EN.pdf]] | |
| + | <br> | ||
| + | <br> | ||
| − | + | Once the template structure in COMOS includes all MetaClasses and properties required on the UBIK side, export these {{COMOS}} templates as meta information for {{UBIK}}. | |
| + | <br> | ||
| − | + | In the standard COMOS iDB, there is a module section called M67 for COMOS Mobile Worker (UBIK). For a standard MRO use case, predefined templates are available. | |
| + | <br> | ||
| − | + | These templates are connected to COMOS CDevices that use Functional Classification C270 (iDB). For cDB installations, Classification C2 is available. | |
| − | + | <br> | |
| − | + | ||
| − | + | Before proceeding, make sure that the project settings for the CUI interface exist and are active. You can find them in the COMOS Project Settings. | |
| + | <br> | ||
| + | |||
| + | Also, make sure that the "Active" checkbox for the COMOS Mobile Worker Interface is selected. | ||
| + | <br> | ||
| + | |||
| + | First, ensure that the interface is set to "Active" in the project settings of SO1 (or your selected working layer). | ||
| + | <br> | ||
[[File:Project_activation.png|400px]] | [[File:Project_activation.png|400px]] | ||
| + | <br> | ||
| − | Next | + | Next, open the ComosBaseObject in SO1. It can be found in the iDB databases at "@30|M67|A50|A20|A10". Please ensure that the file path for the XML file exists. |
| + | <br> | ||
[[File:Export_from_Comos.png|400px]] | [[File:Export_from_Comos.png|400px]] | ||
| + | <br> | ||
| − | To import | + | To import the data into a {{UBIK}} database, use {{UBIK}} Smart Studio. |
| + | <br> | ||
* [[Smart_Modelling]] | * [[Smart_Modelling]] | ||
| − | |||
* [[Setting_Up_UBIK_for_CUI]] | * [[Setting_Up_UBIK_for_CUI]] | ||
| + | <br> | ||
Latest revision as of 12:31, 22 September 2026
Overview
The COMOS®-UBIK® Interface (CUI) is a standard data exchange function between the COMOS® and UBIK® systems. It provides bidirectional communication based on the COMOS Web REST API and the UBIK CUI Plugin (UBIK.Interface.CUI.dll).
For COMOS®, make sure that 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, start by installing UBIK®, the UBIK database, its Web Services, and the 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
- Import it from COMOS®.
If you want to export data from COMOS®, the first step is to review, update, or create the required templates as described in the PDF document available for download below:
Once the template structure in COMOS includes all MetaClasses and properties required on the UBIK side, export these COMOS® templates as meta information for UBIK®.
In the standard COMOS iDB, there is a module section called M67 for COMOS Mobile Worker (UBIK). For a standard MRO use case, predefined templates are available.
These templates are connected to COMOS CDevices that use Functional Classification C270 (iDB). For cDB installations, Classification C2 is available.
Before proceeding, make sure that the project settings for the CUI interface exist and are active. You can find them in the COMOS Project Settings.
Also, make sure that the "Active" checkbox for the COMOS Mobile Worker Interface is selected.
First, ensure that the interface is set to "Active" in the project settings of SO1 (or your selected working layer).
Next, open the ComosBaseObject in SO1. It can be found in the iDB databases at "@30|M67|A50|A20|A10". Please ensure that the file path for the XML file exists.
To import the data into a UBIK® database, use UBIK® Smart Studio.
