Jump to: navigation, search

Difference between revisions of "Configure Comos for CUI"


(→‎See also)
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
To run or extend the Comos – {{UBIK}} – Interface => CUI you have to do some settings on Comos side or at least get some Data for Configuration from Comos.
+
[[File:Wiki_Under_Construction_Start.PNG|1000px]]<noinclude>
−
Because {{Comos}} is not a Product from Augmensys, please request all Comos changes or adaptions at your local Simens or Siemens Parter.
+
 
 +
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.
  
 
<!-- DO NOT REMOVE THIS -->{{Template:HowTo/Begin}}<!-- DO NOT REMOVE THIS -->
 
<!-- DO NOT REMOVE THIS -->{{Template:HowTo/Begin}}<!-- DO NOT REMOVE THIS -->
Line 6: Line 9:
 
= Idea and Concept =
 
= Idea and Concept =
 
<!-- DO NOT MODIFY THE NAME OF THIS SECTION, BUT REMOVE IT IF NOT REQUIRED -->
 
<!-- DO NOT MODIFY THE NAME OF THIS SECTION, BUT REMOVE IT IF NOT REQUIRED -->
−
The Interfaceing of Data is depending on 3 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 media, 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, cause the Comos side is writing a the Data to a fixed *.xml shema 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 hands over Data about Cdevices, Attributes, StandardTables, PhysicalUnits, and DocumentTypes form Comos to a .xml file.
+
 
−
When {{UBIK}} Smar Studio is Importing this, it will generate ComosMetaProxy's with Traget MetaClasse's, ComosMetaProxyProperty's with Target MetaProperty's, Selective Lists and Items, SI Units 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 Informations about the {{UBIK}} Classes 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]]
 
* [[MetaProxy]]
Line 26: Line 38:
 
<!-- DO NOT MODIFY THE NAME OF THIS SECTION, BUT REMOVE IT IF NOT REQUIRED -->
 
<!-- 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.
  
−
For Interfacing we need The ComosEvents, ComosGatewayServices and the ComosWebStartPage.
+
COMOS Web requires the following web services:
 +
 
 +
* ComosEvents
 +
* ComosGatewayServices
 +
* ComosWebStartPage
  
 
[[File:Screenshot 2026-08-13 091304.png]]
 
[[File:Screenshot 2026-08-13 091304.png]]
  
−
In the Comos® Project Settings in the Section: "Mobile Solutions" you have to care about that URL to you ComosWebStartPage (including port) is set and also the Comos Web database key is set.
+
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]]
 
[[File:Screenshot 2026-08-13 093803.png]]
  
−
NOTE: on One Domain the database key has to 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 setting 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]]
 
[[File:Screenshot 2026-08-13 094922.png|1000px]]
Line 44: Line 60:
 
= UBIK =
 
= UBIK =
 
<!-- DO NOT MODIFY THE NAME OF THIS SECTION, BUT REMOVE IT IF NOT REQUIRED -->
 
<!-- DO NOT MODIFY THE NAME OF THIS SECTION, BUT REMOVE IT IF NOT REQUIRED -->
−
<Give step-by-step instructions, use images, ...>
+
 
 +
[[HowTo:Set_Up_CUI_Rest_API]]
  
 
<!-- DO NOT REMOVE THIS -->{{Template:HowTo/End}}<!-- DO NOT REMOVE THIS -->
 
<!-- DO NOT REMOVE THIS -->{{Template:HowTo/End}}<!-- DO NOT REMOVE THIS -->
Line 51: Line 68:
 
<!-- DO NOT MODIFY THE NAME OF THIS SECTION, BUT REMOVE IT IF NOT REQUIRED -->
 
<!-- 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]
+
or ask Siemens: [https://www.siemens.com/en-us/products/comos/mobile-worker/ comos-mobile-worker]

Latest revision as of 14:31, 7 September 2026

Wiki Under Construction Start.PNG

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

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

Screenshot 2026-08-13 091304.png

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.

Screenshot 2026-08-13 093803.png

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.

Screenshot 2026-08-13 094922.png

See also

For more detailed information please check your COMOS® documentation for "Guide COMOS Mobile Worker"

or ask Siemens: comos-mobile-worker