UBIK Wiki Test / Augmensys - User contributions [en]

OFFLINE SYNC LEVEL CLASSIFICATION

2024-03-05T13:00:55Z

HYA: Created page with "{{ClassificationInfoBox | title = Offline Sync Level Classification | name = {{PAGENAMEE}} | inheritance = - | namespace = System.Classification.Content | purpose = Define the..."

{{ClassificationInfoBox
| title = Offline Sync Level Classification
| name = {{PAGENAMEE}}
| inheritance = -
| namespace = System.Classification.Content
| purpose = Define the depth of children levels
| version = 4.7+
| id = {D1E7055D-A967-42CB-A258-1DD503BDA865}
}}
An object classified by OFFLINE_SYNC_LEVEL_CLASSIFICATION can be used to download certain amount of children levels instead of infinite levels

== See also ==

[[Category:Client|OFFLINE SYNC LEVEL CLASSIFICATION]]

SYSCLS MIN MAX CLASSIFICATION

2024-02-06T13:52:09Z

HYA: HYA moved page SYSCLS MIN MAX CLASSIFICTION to SYSCLS MIN MAX CLASSIFICATION

{{ClassificationInfoBox
| title = Min/Max Classification Object
| name = {{PAGENAMEE}}
| inheritance = -
| namespace = System.Classification.Content
| purpose = Classify properties as Min/Max to extend the set of values.
| version = 4.7.0+
| id = {233C318B-45E0-4C4D-A37A-5547D2F83226}
}}

If a property is classified as Min/Max property, it will have 2 values (Min - Value and Max - Value)

== See also ==
* [[HowTo:Create_a_new_MetaProperty#VALUE_TYPE|Value Type]]

{{Category/Version|4.7.0}}

[[Category:4.7.0|Min Max]]

SYSCLS MIN MAX CLASSIFICTION

2024-02-06T13:52:09Z

HYA: HYA moved page SYSCLS MIN MAX CLASSIFICTION to SYSCLS MIN MAX CLASSIFICATION

#REDIRECT [[SYSCLS MIN MAX CLASSIFICATION]]

SYSCLS MIN MAX CLASSIFICATION

2024-02-06T10:29:22Z

HYA: HYA moved page Min Max to SYSCLS MIN MAX CLASSIFICTION

Min Max

2024-02-06T10:29:22Z

HYA: HYA moved page Min Max to SYSCLS MIN MAX CLASSIFICTION

#REDIRECT [[SYSCLS MIN MAX CLASSIFICTION]]

SYSCLS MIN NORM MAX CLASSIFICATION

2024-02-06T10:28:10Z

HYA: HYA moved page SYSCLS MIN NORM MAX CLASSIFICATIOn to SYSCLS MIN NORM MAX CLASSIFICATION

{{ClassificationInfoBox
| title = Min/Norm/Max Classification Object
| name = {{PAGENAMEE}}
| inheritance = -
| namespace = System.Classification.Content
| purpose = Classify properties as Min/Norm/Max to extend the set of values.
| version = 4.7.0+
| id = {DCD66C9E-8B98-4535-A7A3-792B6A47FFDD}
}}

If a property is classified as Min/Norm/Max property, it will have three values (Min - Value, Normal - Value and Max - Value)

== See also ==
* [[HowTo:Create_a_new_MetaProperty#VALUE_TYPE|Value Type]]

{{Category/Version|4.7.0}}

[[Category:4.7.0|Min Value Max]]

SYSCLS MIN NORM MAX CLASSIFICATIOn

2024-02-06T10:28:10Z

HYA: HYA moved page SYSCLS MIN NORM MAX CLASSIFICATIOn to SYSCLS MIN NORM MAX CLASSIFICATION

#REDIRECT [[SYSCLS MIN NORM MAX CLASSIFICATION]]

SYSCLS MIN NORM MAX CLASSIFICATION

2024-02-06T10:27:58Z

HYA: HYA moved page Min Norm Max to SYSCLS MIN NORM MAX CLASSIFICATIOn

Min Norm Max

2024-02-06T10:27:58Z

HYA: HYA moved page Min Norm Max to SYSCLS MIN NORM MAX CLASSIFICATIOn

#REDIRECT [[SYSCLS MIN NORM MAX CLASSIFICATIOn]]

SYSCLS MIN NORM MAX CLASSIFICATION

2024-02-05T08:53:04Z

HYA:

{{ClassificationInfoBox
| title = Min/Norm/Max Classification Object
| name = {{PAGENAMEE}}
| inheritance = -
| namespace = System.Classification.Content
| purpose = Classify properties as Min/Norm/Max to extend the set of value types to synchronize corresponding COMOS values.
| version = 4.7.0+
| id = {DCD66C9E-8B98-4535-A7A3-792B6A47FFDD}
}}

If a property is classified as Min/Norm/Max classification, their value will be automatic extend another 2 slots for saving corresponding values from COMOS, which set by [[HowTo:Create_a_new_MetaProperty#VALUE_TYPE|Value Type]]

== See also ==
* [[HowTo:Create_a_new_MetaProperty#VALUE_TYPE|Value Type]]

{{Category/Version|4.7.0}}

[[Category:4.7.0|Min Value Max]]

SYSCLS MIN NORM MAX CLASSIFICATION

2024-02-05T08:52:13Z

HYA: HYA moved page Min Value Max to Min Norm Max

{{ClassificationInfoBox
| title = Min/Value/Max Classification Object
| name = {{PAGENAMEE}}
| inheritance = -
| namespace = System.Classification.Content
| purpose = Classify properties as Min/Value/Max to extend the set of value types to synchronize corresponding COMOS values.
| version = 4.7.0+
| id = {DCD66C9E-8B98-4535-A7A3-792B6A47FFDD}
}}

If a property is classified as Min/Value/Max classification, their value will be automatic extend another 2 slots for saving corresponding values from COMOS, which set by [[HowTo:Create_a_new_MetaProperty#VALUE_TYPE|Value Type]]

== See also ==
* [[HowTo:Create_a_new_MetaProperty#VALUE_TYPE|Value Type]]

{{Category/Version|4.7.0}}

[[Category:4.7.0|Min Value Max]]

Min Value Max

2024-02-05T08:52:13Z

HYA: HYA moved page Min Value Max to Min Norm Max

#REDIRECT [[Min Norm Max]]

HowTo:Create a new MetaProperty

2024-02-01T13:28:47Z

HYA: /* VALUE TYPE */

== Creation of a new MetaProperty ==
A new [[MetaProperty]] has to be created as an instance from [[CUSTOMMETAPROPERTY]] using the ''[[Bulk Editor]]'' control

# Navigate to the MetaClass [[CUSTOMMETAPROPERTY]]
# Create a new instance of CUSTOMMETACLASS by entering a name
# Set the [[MetaProperty#Data_Types|data type]] for the property [[File:IL_HowTo_CreateMetaProperty_01.png|220 px|border|alt=Create new MetaProperty|Create new MetaProperty]]
# It is recommenmded to set at least the description and namespace
# Save the changes with {{key press|Ctrl|S}} or the save command

== Optional Attributes ==
=== REFERENCE ===
[[File:IL_HowTo_CreateMetaProperty_AssignReference_01.png|thumb|alt=Assign a reference|Assign a reference]]
Assign a reference if the value of the property should link to an {{UBIK}} object. The data type of the MetaProperty has to be ''Guid'' that the data (guid) can hold a reference to an {{UBIK}} object.

# Locate an existing or [[HowTo:Create_a_new_Reference|create a new Reference]]
# Assign the reference to the '''REFERENCE''' property either by
#* dragging and dropping the reference object onto the cell
#* selecting the desired reference from the dialog appearing after double-clicking the cell

=== SELECTIVELIST ===
[[File:IL_HowTo_CreateMetaProperty_AssignSelectiveList_01.png|thumb|alt=Assign a selective list|Assign a selective list]]
Assign a selective list to a property, if the respective column should display a Combobox with all items of the list instead of the value field. The value can then only be selected from the list, but not be edited manually anymore.

# Locate an existing or [[HowTo:Create_a_new_Selective_List|create a new Selective List]]
# Assign the list to the '''SELECTIVELIST''' property either by
#* dragging and dropping the list object onto the cell
#* selecting the desired list from the dialog appearing after double-clicking the cell

=== UNITITEM ===
[[File:IL_HowTo_CreateMetaProperty_UnitItem_01.png|thumb|alt=Set a unit item|Set a unit item]]
If the property should consider a [[Unit]] (for example Ampere, Volt, etc.) the underlying [[MetaProperty]] has to incorporate a [[UNITITEM|Unit Item]] either by
* dragging and dropping the unit item object onto the cell
* selecting the desired unit item from the dialog appearing after double-clicking the cell

{{Hint|Only properties of type Double can posses measuring units!}}

=== FORMAT ===

=== INDEXCOUNT ===
Set the number of named index keys, for example to 4.

=== INDEXKEYS ===
Enter the index keys as a comma separated list of strings, for example "a,b,c,d" (INDEXCOUNT = 4).

=== DEFAULTVALUE ===
Set up to 10 [[MetaProperty#Default_value|default value(s)]] for the MetaProperty.

=== INITIALVALUE ===
Set up to 10 [[MetaProperty#Initial_value|initial value(s)]] for the MetaProperty.

=== CATEGORY ===
[[File:IL_HowTo_CreateMetaProperty_Category_01.png|thumb|alt=Change category|Change category]]
If desired change the category of the MetaProperty to a value of the list. The property will then be moved to a new tab if the object is viewed in the [[View Test Environment]] or using the [[Object Editor]].

=== NEEDSVALIDATION ===
Enable [[MetaProperty#Needs_Validation|validation]] by checking the '''NEEDSVALIDATION''' attribute of the MetaProperty and let the system explicitely store a validation time stamp information in the database. This is particularly used on the mobile client in combination with the [[SYSCLS_TASK]] and [[SYSCLS_MEASUREMENTTASK]] classification.

{{Attention|'''NEEDSVALIDATION''' is replaced by UBIK Attribute technique since Version 2.5!}}
Learn more about [[UBIK Attributes]].

=== VALUEVALIDATION ===
Assign a [[MetaProperty#Value_Validation|value validation]] object to the '''VALUEVALIDATION''' attribute of the MetaProperty either by
* dragging and dropping the validation object onto the cell
* selecting the desired validation object from the dialog appearing after double-clicking the cell

===VALUE TYPE===
Start Version 4.7 we support to define value type for special cases. It is a dropdown table, which contain:
* Standard (as default, INDEXCOUNT = 0)
* MinNormMax (INDEXCOUNT = 1)
* MinMax (INDEXCOUNT = 2)
for selecting. The setting is only for system types: string, double, int valid.

[[Category:How-To|Create a new MetaProperty]]
[[Category:Studio|Create a new MetaProperty]]

==See also==
* [[HowTo:Create a new MetaClass]]
* [[MetaProperty]]

[[Category:How-To|Create a new MetaProperty]]
[[Category:Studio|Create a new MetaProperty]]

HowTo:Create a new MetaProperty

2024-02-01T13:27:32Z

HYA: /* VALUE TYPE */

== Creation of a new MetaProperty ==
A new [[MetaProperty]] has to be created as an instance from [[CUSTOMMETAPROPERTY]] using the ''[[Bulk Editor]]'' control

# Navigate to the MetaClass [[CUSTOMMETAPROPERTY]]
# Create a new instance of CUSTOMMETACLASS by entering a name
# Set the [[MetaProperty#Data_Types|data type]] for the property [[File:IL_HowTo_CreateMetaProperty_01.png|220 px|border|alt=Create new MetaProperty|Create new MetaProperty]]
# It is recommenmded to set at least the description and namespace
# Save the changes with {{key press|Ctrl|S}} or the save command

== Optional Attributes ==
=== REFERENCE ===
[[File:IL_HowTo_CreateMetaProperty_AssignReference_01.png|thumb|alt=Assign a reference|Assign a reference]]
Assign a reference if the value of the property should link to an {{UBIK}} object. The data type of the MetaProperty has to be ''Guid'' that the data (guid) can hold a reference to an {{UBIK}} object.

# Locate an existing or [[HowTo:Create_a_new_Reference|create a new Reference]]
# Assign the reference to the '''REFERENCE''' property either by
#* dragging and dropping the reference object onto the cell
#* selecting the desired reference from the dialog appearing after double-clicking the cell

=== SELECTIVELIST ===
[[File:IL_HowTo_CreateMetaProperty_AssignSelectiveList_01.png|thumb|alt=Assign a selective list|Assign a selective list]]
Assign a selective list to a property, if the respective column should display a Combobox with all items of the list instead of the value field. The value can then only be selected from the list, but not be edited manually anymore.

# Locate an existing or [[HowTo:Create_a_new_Selective_List|create a new Selective List]]
# Assign the list to the '''SELECTIVELIST''' property either by
#* dragging and dropping the list object onto the cell
#* selecting the desired list from the dialog appearing after double-clicking the cell

=== UNITITEM ===
[[File:IL_HowTo_CreateMetaProperty_UnitItem_01.png|thumb|alt=Set a unit item|Set a unit item]]
If the property should consider a [[Unit]] (for example Ampere, Volt, etc.) the underlying [[MetaProperty]] has to incorporate a [[UNITITEM|Unit Item]] either by
* dragging and dropping the unit item object onto the cell
* selecting the desired unit item from the dialog appearing after double-clicking the cell

{{Hint|Only properties of type Double can posses measuring units!}}

=== FORMAT ===

=== INDEXCOUNT ===
Set the number of named index keys, for example to 4.

=== INDEXKEYS ===
Enter the index keys as a comma separated list of strings, for example "a,b,c,d" (INDEXCOUNT = 4).

=== DEFAULTVALUE ===
Set up to 10 [[MetaProperty#Default_value|default value(s)]] for the MetaProperty.

=== INITIALVALUE ===
Set up to 10 [[MetaProperty#Initial_value|initial value(s)]] for the MetaProperty.

=== CATEGORY ===
[[File:IL_HowTo_CreateMetaProperty_Category_01.png|thumb|alt=Change category|Change category]]
If desired change the category of the MetaProperty to a value of the list. The property will then be moved to a new tab if the object is viewed in the [[View Test Environment]] or using the [[Object Editor]].

=== NEEDSVALIDATION ===
Enable [[MetaProperty#Needs_Validation|validation]] by checking the '''NEEDSVALIDATION''' attribute of the MetaProperty and let the system explicitely store a validation time stamp information in the database. This is particularly used on the mobile client in combination with the [[SYSCLS_TASK]] and [[SYSCLS_MEASUREMENTTASK]] classification.

{{Attention|'''NEEDSVALIDATION''' is replaced by UBIK Attribute technique since Version 2.5!}}
Learn more about [[UBIK Attributes]].

=== VALUEVALIDATION ===
Assign a [[MetaProperty#Value_Validation|value validation]] object to the '''VALUEVALIDATION''' attribute of the MetaProperty either by
* dragging and dropping the validation object onto the cell
* selecting the desired validation object from the dialog appearing after double-clicking the cell

===VALUE TYPE===
Start Version 4.7 we support to define value type for special cases. It is a dropdown table, which contain:
* Standard (as default)
* MinNormMax
* MinMax
for selecting. The setting is only for system types: string, double, int valid.

[[Category:How-To|Create a new MetaProperty]]
[[Category:Studio|Create a new MetaProperty]]

==See also==
* [[HowTo:Create a new MetaClass]]
* [[MetaProperty]]

[[Category:How-To|Create a new MetaProperty]]
[[Category:Studio|Create a new MetaProperty]]

HowTo:Create a new MetaProperty

2024-02-01T13:26:37Z

HYA: /* VALUE TYPE */

== Creation of a new MetaProperty ==
A new [[MetaProperty]] has to be created as an instance from [[CUSTOMMETAPROPERTY]] using the ''[[Bulk Editor]]'' control

# Navigate to the MetaClass [[CUSTOMMETAPROPERTY]]
# Create a new instance of CUSTOMMETACLASS by entering a name
# Set the [[MetaProperty#Data_Types|data type]] for the property [[File:IL_HowTo_CreateMetaProperty_01.png|220 px|border|alt=Create new MetaProperty|Create new MetaProperty]]
# It is recommenmded to set at least the description and namespace
# Save the changes with {{key press|Ctrl|S}} or the save command

== Optional Attributes ==
=== REFERENCE ===
[[File:IL_HowTo_CreateMetaProperty_AssignReference_01.png|thumb|alt=Assign a reference|Assign a reference]]
Assign a reference if the value of the property should link to an {{UBIK}} object. The data type of the MetaProperty has to be ''Guid'' that the data (guid) can hold a reference to an {{UBIK}} object.

# Locate an existing or [[HowTo:Create_a_new_Reference|create a new Reference]]
# Assign the reference to the '''REFERENCE''' property either by
#* dragging and dropping the reference object onto the cell
#* selecting the desired reference from the dialog appearing after double-clicking the cell

=== SELECTIVELIST ===
[[File:IL_HowTo_CreateMetaProperty_AssignSelectiveList_01.png|thumb|alt=Assign a selective list|Assign a selective list]]
Assign a selective list to a property, if the respective column should display a Combobox with all items of the list instead of the value field. The value can then only be selected from the list, but not be edited manually anymore.

# Locate an existing or [[HowTo:Create_a_new_Selective_List|create a new Selective List]]
# Assign the list to the '''SELECTIVELIST''' property either by
#* dragging and dropping the list object onto the cell
#* selecting the desired list from the dialog appearing after double-clicking the cell

=== UNITITEM ===
[[File:IL_HowTo_CreateMetaProperty_UnitItem_01.png|thumb|alt=Set a unit item|Set a unit item]]
If the property should consider a [[Unit]] (for example Ampere, Volt, etc.) the underlying [[MetaProperty]] has to incorporate a [[UNITITEM|Unit Item]] either by
* dragging and dropping the unit item object onto the cell
* selecting the desired unit item from the dialog appearing after double-clicking the cell

{{Hint|Only properties of type Double can posses measuring units!}}

=== FORMAT ===

=== INDEXCOUNT ===
Set the number of named index keys, for example to 4.

=== INDEXKEYS ===
Enter the index keys as a comma separated list of strings, for example "a,b,c,d" (INDEXCOUNT = 4).

=== DEFAULTVALUE ===
Set up to 10 [[MetaProperty#Default_value|default value(s)]] for the MetaProperty.

=== INITIALVALUE ===
Set up to 10 [[MetaProperty#Initial_value|initial value(s)]] for the MetaProperty.

=== CATEGORY ===
[[File:IL_HowTo_CreateMetaProperty_Category_01.png|thumb|alt=Change category|Change category]]
If desired change the category of the MetaProperty to a value of the list. The property will then be moved to a new tab if the object is viewed in the [[View Test Environment]] or using the [[Object Editor]].

=== NEEDSVALIDATION ===
Enable [[MetaProperty#Needs_Validation|validation]] by checking the '''NEEDSVALIDATION''' attribute of the MetaProperty and let the system explicitely store a validation time stamp information in the database. This is particularly used on the mobile client in combination with the [[SYSCLS_TASK]] and [[SYSCLS_MEASUREMENTTASK]] classification.

{{Attention|'''NEEDSVALIDATION''' is replaced by UBIK Attribute technique since Version 2.5!}}
Learn more about [[UBIK Attributes]].

=== VALUEVALIDATION ===
Assign a [[MetaProperty#Value_Validation|value validation]] object to the '''VALUEVALIDATION''' attribute of the MetaProperty either by
* dragging and dropping the validation object onto the cell
* selecting the desired validation object from the dialog appearing after double-clicking the cell

===VALUE TYPE===
Start Version 4.7 we support to define value type for special cases. It is a dropdown table, which contain:
* Standard (as default)
* MinNormMax
* MinMax
for selecting.

[[Category:How-To|Create a new MetaProperty]]
[[Category:Studio|Create a new MetaProperty]]

==See also==
* [[HowTo:Create a new MetaClass]]
* [[MetaProperty]]

[[Category:How-To|Create a new MetaProperty]]
[[Category:Studio|Create a new MetaProperty]]

SYSCLS MIN NORM MAX CLASSIFICATION

HYA: /* URL redirection */

EventNotification Endpoint is a middleware which is responsible for receiving incoming COMOS event notifications, queuing them internally and forwarding them to the {{UBIK}} Enterprise Service for further processing.
This page describes how to setup the system.

= Overview =
* Make sure the [[HowTo:Install_UBIK_Enterprise_Service|Enterprise Service]] and the [[HowTo:Install_UBIK_Web_Service#UBIK.C2.AE_Authentication_Web_Service_USAM.svc|USAM]] are installed on the IIS Server.
* Install the Notification Endpoint Webservice on the IIS Server
* Configure all mandatory settings for the Notification Endpoint Webservice
* Configure the Notification Endpoint Webservice URL in COMOS and enable notifications
* Make sure all files are accessible

= Install Notification Endpoint =
* Download the Notification Endpoint Webservice from the release portal.
* Deploy the Notification Endpoint Webservice to the designated web app folder on the IIS Server (web app folder needs to be created if necessary)
** IIS Manager setting check: see [[Configure_EventNotification_Endpoint_and_Enterprise_Service_for_CUI#IIS_Manager|IIS Manager]]
* Make sure COMOS is configured to send notifications.

== IIS Manager ==

= Direct Access =
* Add a new website under the "Sites" folder in IIS Manager.
* Connect the new site to the corresponding physical folder via the website's "basic settings". [[Image:WebsiteConfIIS.PNG|300px]]
** "Site Name", "Application pool" and "Physical path" should be adapted by your setting, here are only example
* Configure a "Binding" for the website. [[Image:BindingIISConf.PNG|300px]]
** The URL can be used as a direct access target,
* '''or used as an internal target for [[Configure_EventNotification_Endpoint_and_Enterprise_Service_for_CUI#URL_redirection|URL redirection]].'''

=URL redirection=
* Install URL redirect feature by using "Server Manager", to "Add Roles and Features Wizard":
[[Image:Urlredirect.JPG|500px]]
* Click on the Web Site, which will be exposed to the outside
* Open "URL Rewrite" at "....Home"
* Add rule(s) as 'Inbound Rule' like the following:
[[Image:InboundRules.PNG|500px]]
[[Image:InboundRules2.PNG|500px]]

'''Rewrite URL is defined base on direct access'''

= Notification Endpoint=
Adapt “Your/EventNotificationEndpoint/Folder/Configuration/config.json” file, configure at least the mandatory settings:
* "USAMUrl": The URL of the USAM Service
* "QueuePath": The folder containing all files, which will be sent to Enterprise Service for processing. After having been processed by ES, the corresponding files will be deleted.
* "InComingLogPath": All received COMOS notifications will be stored here
* "ProcessUrl": The URL of the Enterprise Service web interface
 
Optional settings:
* "LogPath": Path to your log files folder
* "DeleteLogAfter": Maximum age (in days) to keep log files for
* "DBkeys": Json string array containing the white list of COMOS DBkeys (empty or delete for receiving all DBkeys)

= Enterprise Service=
* Go to the UBIK.EnterpriseService folder,
* Copy and paste UBIK.Interface.CUI.dll to the “Injection” folder (create it if it does not exist).
* Open UBIK.EnterpriseService.exe.config, find the “appSettings” section, configure all necessary information, and add the "ContentControllerConfigPath" setting to the end:
<source lang = "xml">
<appSettings>

<add key="ConsoleRunMode" value="1" />

<add key="CommandFileAction" value="0" />
<add key="ClearWatchFolders" value="0" />

<add key="PluginExecutionConfigPath" value="" />
<add key="ClientSettingsProvider.ServiceUri" value="" />


<add key="ExecuteWebInterface" value="1" />
<add key="ExecuteTaskByJsonFile" value="0" />

<add key="WebInterfacePort" value="9000" />
<add key="WebInterfaceHost" value="http://localhost" />

<add key="ContentControllerConfigPath" value="your\setting\path\ContentController.json" />
</appSettings>
</source>
'''Make sure ContentController.json exists.'''
* Create or adapt ContentController.json according to your database connection:
<source lang = "yaml">
{
"SqlConnectionDefinition":
{
"SSPI": false (or true, based on your DB setting),
"SQLUser": "username",
"SQLPassword": "password",
"SQLServer": "your SQL Server",
"SQLInitialCatalog": "DB name"
}
}
</source>
==See also==

* [[HowTo:Install_UBIK_Web_Service#UBIK.C2.AE_Authentication_Web_Service_USAM.svc]]
* [[HowTo:Install_UBIK_Enterprise_Service]]

2023-07-31T13:24:35Z

HYA:

Configure EventNotification Endpoint and Enterprise Service for CUI

2023-07-31T13:22:55Z

HYA: /* URL redirection */

EventNotification Endpoint is a middleware which is responsible for receiving incoming COMOS event notifications, queuing them internally and forwarding them to the {{UBIK}} Enterprise Service for further processing.
This page describes how to setup the system.

= Overview =
* Make sure the [[HowTo:Install_UBIK_Enterprise_Service|Enterprise Service]] and the [[HowTo:Install_UBIK_Web_Service#UBIK.C2.AE_Authentication_Web_Service_USAM.svc|USAM]] are installed on the IIS Server.
* Install the Notification Endpoint Webservice on the IIS Server
* Configure all mandatory settings for the Notification Endpoint Webservice
* Configure the Notification Endpoint Webservice URL in COMOS and enable notifications
* Make sure all files are accessible

= Install Notification Endpoint =
* Download the Notification Endpoint Webservice from the release portal.
* Deploy the Notification Endpoint Webservice to the designated web app folder on the IIS Server (web app folder needs to be created if necessary)
** IIS Manager setting check: see [[Configure_EventNotification_Endpoint_and_Enterprise_Service_for_CUI#IIS_Manager|IIS Manager]]
* Make sure COMOS is configured to send notifications.

== IIS Manager ==

= Direct Access =
* Add a new website under the "Sites" folder in IIS Manager.
* Connect the new site to the corresponding physical folder via the website's "basic settings". [[Image:WebsiteConfIIS.PNG|300px]]
* Configure a "Binding" for the website. [[Image:BindingIISConf.PNG|300px]]
** The URL can be used as a direct access target,
** or used as an internal target for [[Configure_EventNotification_Endpoint_and_Enterprise_Service_for_CUI#URL_redirection|URL redirection]].

=URL redirection=
* Click on the Web Site, which will be exposed to the outside
* Open "URL Rewrite" at "....Home"
* Add Rule(s) as "Inbound Rule" like following:
[[InboundRules.PNG]]

= Notification Endpoint=
Adapt “Your/EventNotificationEndpoint/Folder/Configuration/config.json” file, configure at least the mandatory settings:
* "USAMUrl": The URL of the USAM Service
* "QueuePath": The folder containing all files, which will be sent to Enterprise Service for processing. After having been processed by ES, the corresponding files will be deleted.
* "InComingLogPath": All received COMOS notifications will be stored here
* "ProcessUrl": The URL of the Enterprise Service web interface
 
Optional settings:
* "LogPath": Path to your log files folder
* "DeleteLogAfter": Maximum age (in days) to keep log files for
* "DBkeys": Json string array containing the white list of COMOS DBkeys (empty or delete for receiving all DBkeys)

= Enterprise Service=
* Go to the UBIK.EnterpriseService folder,
* Copy and paste UBIK.Interface.CUI.dll to the “Injection” folder (create it if it does not exist).
* Open UBIK.EnterpriseService.exe.config, find the “appSettings” section, configure all necessary information, and add the "ContentControllerConfigPath" setting to the end:
<source lang = "xml">
<appSettings>

<add key="ConsoleRunMode" value="1" />

<add key="CommandFileAction" value="0" />
<add key="ClearWatchFolders" value="0" />

<add key="PluginExecutionConfigPath" value="" />
<add key="ClientSettingsProvider.ServiceUri" value="" />


<add key="ExecuteWebInterface" value="1" />
<add key="ExecuteTaskByJsonFile" value="0" />

<add key="WebInterfacePort" value="9000" />
<add key="WebInterfaceHost" value="http://localhost" />

<add key="ContentControllerConfigPath" value="your\setting\path\ContentController.json" />
</appSettings>
</source>
'''Make sure ContentController.json exists.'''
* Create or adapt ContentController.json according to your database connection:
<source lang = "yaml">
{
"SqlConnectionDefinition":
{
"SSPI": false (or true, based on your DB setting),
"SQLUser": "username",
"SQLPassword": "password",
"SQLServer": "your SQL Server",
"SQLInitialCatalog": "DB name"
}
}
</source>
==See also==

* [[HowTo:Install_UBIK_Web_Service#UBIK.C2.AE_Authentication_Web_Service_USAM.svc]]
* [[HowTo:Install_UBIK_Enterprise_Service]]

File:InboundRules.PNG

2023-07-31T13:21:57Z

HYA:

Configure EventNotification Endpoint and Enterprise Service for CUI

2023-07-31T13:19:54Z

HYA: /* URL redirection */

EventNotification Endpoint is a middleware which is responsible for receiving incoming COMOS event notifications, queuing them internally and forwarding them to the {{UBIK}} Enterprise Service for further processing.
This page describes how to setup the system.

= Overview =
* Make sure the [[HowTo:Install_UBIK_Enterprise_Service|Enterprise Service]] and the [[HowTo:Install_UBIK_Web_Service#UBIK.C2.AE_Authentication_Web_Service_USAM.svc|USAM]] are installed on the IIS Server.
* Install the Notification Endpoint Webservice on the IIS Server
* Configure all mandatory settings for the Notification Endpoint Webservice
* Configure the Notification Endpoint Webservice URL in COMOS and enable notifications
* Make sure all files are accessible

= Install Notification Endpoint =
* Download the Notification Endpoint Webservice from the release portal.
* Deploy the Notification Endpoint Webservice to the designated web app folder on the IIS Server (web app folder needs to be created if necessary)
** IIS Manager setting check: see [[Configure_EventNotification_Endpoint_and_Enterprise_Service_for_CUI#IIS_Manager|IIS Manager]]
* Make sure COMOS is configured to send notifications.

== IIS Manager ==

= Direct Access =
* Add a new website under the "Sites" folder in IIS Manager.
* Connect the new site to the corresponding physical folder via the website's "basic settings". [[Image:WebsiteConfIIS.PNG|300px]]
* Configure a "Binding" for the website. [[Image:BindingIISConf.PNG|300px]]
** The URL can be used as a direct access target,
** or used as an internal target for [[Configure_EventNotification_Endpoint_and_Enterprise_Service_for_CUI#URL_redirection|URL redirection]].

=URL redirection=
* Click on the Web Site, which will be exposed to the outside
* Open "URL Rewrite" at "....Home"
* Add Rule(s)

= Notification Endpoint=
Adapt “Your/EventNotificationEndpoint/Folder/Configuration/config.json” file, configure at least the mandatory settings:
* "USAMUrl": The URL of the USAM Service
* "QueuePath": The folder containing all files, which will be sent to Enterprise Service for processing. After having been processed by ES, the corresponding files will be deleted.
* "InComingLogPath": All received COMOS notifications will be stored here
* "ProcessUrl": The URL of the Enterprise Service web interface
 
Optional settings:
* "LogPath": Path to your log files folder
* "DeleteLogAfter": Maximum age (in days) to keep log files for
* "DBkeys": Json string array containing the white list of COMOS DBkeys (empty or delete for receiving all DBkeys)

= Enterprise Service=
* Go to the UBIK.EnterpriseService folder,
* Copy and paste UBIK.Interface.CUI.dll to the “Injection” folder (create it if it does not exist).
* Open UBIK.EnterpriseService.exe.config, find the “appSettings” section, configure all necessary information, and add the "ContentControllerConfigPath" setting to the end:
<source lang = "xml">
<appSettings>

<add key="ConsoleRunMode" value="1" />

<add key="CommandFileAction" value="0" />
<add key="ClearWatchFolders" value="0" />

<add key="PluginExecutionConfigPath" value="" />
<add key="ClientSettingsProvider.ServiceUri" value="" />


<add key="ExecuteWebInterface" value="1" />
<add key="ExecuteTaskByJsonFile" value="0" />

<add key="WebInterfacePort" value="9000" />
<add key="WebInterfaceHost" value="http://localhost" />

<add key="ContentControllerConfigPath" value="your\setting\path\ContentController.json" />
</appSettings>
</source>
'''Make sure ContentController.json exists.'''
* Create or adapt ContentController.json according to your database connection:
<source lang = "yaml">
{
"SqlConnectionDefinition":
{
"SSPI": false (or true, based on your DB setting),
"SQLUser": "username",
"SQLPassword": "password",
"SQLServer": "your SQL Server",
"SQLInitialCatalog": "DB name"
}
}
</source>
==See also==

* [[HowTo:Install_UBIK_Web_Service#UBIK.C2.AE_Authentication_Web_Service_USAM.svc]]
* [[HowTo:Install_UBIK_Enterprise_Service]]