Difference between revisions of "Configure Comos for CUI"

Latest revision as of 14:31, 7 September 2026

To run or extend the COMOS®-UBIK® Interface (CUI), you must configure certain settings on the COMOS^® side or, at a minimum, obtain configuration data from COMOS^®.

As COMOS^® is not an Augmensys product, please contact your local Siemens representative or Siemens partner for any COMOS^® changes or adaptations.

[edit]

Idea and Concept
Comos
UBIK

Idea and Concept

The integration of COMOS^® and UBIK^® depends on three key aspects:

The data structures available in COMOS^®
The mechanism used to exchange data between COMOS^® and UBIK^®, for example through XML files or a REST API
How the transferred data is processed within UBIK^®

To transfer the primary information required from COMOS^® to UBIK^®, only *.xml files can be used. This is because the COMOS^® side writes the data to a fixed *.xml schema that UBIK^® can read and import.

This process is called metadata transfer. It transfers information about CDevices, Attributes, StandardTables, PhysicalUnits, and DocumentTypes from COMOS^® to an *.xml file.

When imported into UBIK^® SmartStudio, the metadata is converted into the corresponding UBIK^® structures. These include:

ComosMetaProxies and their corresponding MetaClasses
ComosMetaProxyProperties and their corresponding MetaProperties
SelectiveLists and SelectiveItems
SIUnits and UnitItems
ComosDocumentTypeProxies

For detailed information about the UBIK^® MetaClass, please see:

Comos

Using or extending the COMOS®-UBIK® Interface (CUI) requires specific configuration information from COMOS®. This information must either be configured on the COMOS® side or made available by the COMOS® administrator.

COMOS Web requires the following web services:

ComosEvents
ComosGatewayServices
ComosWebStartPage

In the COMOS^® project settings, under the "Mobile Solutions" section, ensure that the URL of your ComosWebStartPage (including the port number) is configured correctly. Also, make sure that the COMOS Web database key is configured.

Note: Within a single domain, the database key must be unique.

In the "COMOS Mobile Worker Interface" section of the project settings, you will find the configuration values for the active COMOS project. If the WorkingLayer key is empty, the released area is connected. Otherwise, a specific WorkingLayer can be connected to UBIK® for each project.

UBIK

Set Up CUI Rest API

@@ Line 1: / Line 1: @@
 [[File:Wiki_Under_Construction_Start.PNG|1000px]]<noinclude>
-To run or extend the {{COMOS}} – {{UBIK}} – Interface => CUI you must make some settings on the {{COMOS}} side or at least get some data for configuration from {{COMOS}}.
+To run or extend the COMOS®-UBIK® Interface (CUI), you must configure certain settings on the {{COMOS}} side or, at a minimum, obtain configuration data from {{COMOS}}.
-Because {{COMOS}} is not a Product from Augmensys, please request all {{COMOS}} changes or adaptations at your local Siemens or Siemens Partner.
+As {{COMOS}} is not an Augmensys product, please contact your local Siemens representative or Siemens partner for any {{COMOS}} changes or adaptations.
 <!-- DO NOT REMOVE THIS -->{{Template:HowTo/Begin}}<!-- DO NOT REMOVE THIS -->
@@ Line 8: / Line 9: @@
 = Idea and Concept =
 <!-- DO NOT MODIFY THE NAME OF THIS SECTION, BUT REMOVE IT IF NOT REQUIRED -->
-The interfacing of data depends on three parts
+The integration of {{COMOS}} and {{UBIK}} depends on three key aspects:
-* the possible representation of data from {{COMOS}}
+* The data structures available in {{COMOS}}
-* the transfer mechanisms, like *.xml file or REST API INTERFACE
+* The mechanism used to exchange data between {{COMOS}} and {{UBIK}}, for example through XML files or a REST API
-* the processing of the given information in {{UBIK}}
+* How the transferred data is processed within {{UBIK}}
-To hand over the primary needed information from {{COMOS}} to {{UBIK}} there are only *.xml files to use, because the {{COMOS}} side is writing a the data to a fixed *.xml scheme witch {{UBIK}} is able to read in.
+To transfer the primary information required from {{COMOS}} to {{UBIK}}, only *.xml files can be used. This is because the {{COMOS}} side writes the data to a fixed *.xml schema that {{UBIK}} can read and import.
-This is called Metadata transfer, and transfers data about CDevices, Attributes, StandardTables, PhysicalUnits, and DocumentTypes from Comos to a .xml file.
-When {{UBIK}} SmartStudio imports this, it will generate ComosMetaProxy's with target MetaClasse's, ComosMetaProxyProperty's with target MetaProperty's, SelectiveLists and SelectiveItems, SIUnits and UnitItems, and some ComosDocumentTypeProxy's.
+This process is called metadata transfer. It transfers information about CDevices, Attributes, StandardTables, PhysicalUnits, and DocumentTypes from {{COMOS}} to an *.xml file.
-For detailed information about the {{UBIK}} MetaClass please see
+When imported into {{UBIK}} SmartStudio, the metadata is converted into the corresponding {{UBIK}} structures. These include:
+* ComosMetaProxies and their corresponding MetaClasses
+* ComosMetaProxyProperties and their corresponding MetaProperties
+* SelectiveLists and SelectiveItems
+* SIUnits and UnitItems
+* ComosDocumentTypeProxies
+For detailed information about the {{UBIK}} MetaClass, please see:
+<br>
 * [[MetaProxy]]
@@ Line 28: / Line 38: @@
 <!-- DO NOT MODIFY THE NAME OF THIS SECTION, BUT REMOVE IT IF NOT REQUIRED -->
-For connection between {{COMOS}} and {{UBIK}} via REST API please make sure that COMOS Web is installed and the license called “COMOS_Mobile_Worker_Server” is available on {{COMOS}}.
+Using or extending the COMOS®-UBIK® Interface (CUI) requires specific configuration information from COMOS®. This information must either be configured on the COMOS® side or made available by the COMOS® administrator.
+COMOS Web requires the following web services:
-COMOS Web will need the Web services:  ComosEvents, ComosGatewayServices and the ComosWebStartPage.
+* ComosEvents
+* ComosGatewayServices
+* ComosWebStartPage
 [[File:Screenshot 2026-08-13 091304.png]]
-In the {{COMOS}} project settings in the section: "Mobile Solutions" you have ensure that the URL to your ComosWebStartPage (including port) is configured and that the COMOS Web database key is also configured.
+In the {{COMOS}} project settings, under the "Mobile Solutions" section, ensure that the URL of your ComosWebStartPage (including the port number) is configured correctly. Also, make sure that the COMOS Web database key is configured.
 [[File:Screenshot 2026-08-13 093803.png]]
-NOTE: within one domain the database key must be unique!
+Note: Within a single domain, the database key must be unique.
-Also in the project settings in the section: "COMOS Mobile Worker Interface" you will find the settings and the values for the active "Comos Project" and if the "Workinglayer" key is empty the released area is connected if not one Workinglayer per project can be connected to UBIK®.
+In the "COMOS Mobile Worker Interface" section of the project settings, you will find the configuration values for the active COMOS project. If the WorkingLayer key is empty, the released area is connected. Otherwise, a specific WorkingLayer can be connected to UBIK® for each project.
 [[File:Screenshot 2026-08-13 094922.png|1000px]]
@@ Line 54: / Line 68: @@
 <!-- DO NOT MODIFY THE NAME OF THIS SECTION, BUT REMOVE IT IF NOT REQUIRED -->
-For more detailed information please check you {{COMOS}} documentation for "Guide COMOS Mobile Worker"
+For more detailed information please check your {{COMOS}} documentation for "Guide COMOS Mobile Worker"
 or ask Siemens: [https://www.siemens.com/en-us/products/comos/mobile-worker/ comos-mobile-worker]

Difference between revisions of "Configure Comos for CUI"

Latest revision as of 14:31, 7 September 2026

Idea and Concept

Comos

UBIK

See also