Difference between revisions of "Configure EventNotification Endpoint and Enterprise Service for CUI"
(→Overview) |
|||
| Line 3: | Line 3: | ||
= Overview = | = Overview = | ||
| − | * Make sure [[HowTo:Install_UBIK_Enterprise_Service|Enterprise Service]] and [[HowTo:Install_UBIK_Web_Service#UBIK.C2.AE_Authentication_Web_Service_USAM.svc|USAM]] are installed on IIS Server. | + | * 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 Notification Endpoint | + | * Install the Notification Endpoint Webservice on the IIS Server |
| − | * Configure mandatory settings for Notification Endpoint Webservice | + | * Configure all mandatory settings for the Notification Endpoint Webservice |
| − | * Configure Notification Endpoint | + | * Configure the Notification Endpoint Webservice URL in COMOS and enable notifications |
Revision as of 14:39, 26 July 2023
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.
Contents
Overview
- Make sure the Enterprise Service and the 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
Install Notification Endpoint
- Download Notification Service from the release portal.
- Deploy the Notification Service to the designated web app folder on the IIS Server (web app folder needs to be created if necessary)
- IIS Manager setting check IIS Manager
- Make sure COMOS is configured to enable sending out notifications.
IIS Manager
- Add a new "Sites" in IIS Manager.
- Connect the new site to the corresponding physical folder by selecting "Settings" from the right side.
- Configure the "Binding" to identify the site with a URL.
- The URL can be used as a direct access target,
- or used as an internal target for URL redirection.
fill out the blanks with necessary information
Notification Endpoint
Adapt “Your/EventNotificationEndpoint/Folder/Configuration/config.json” file, configure at least the mandatory settings:
- "USAMUrl":
- "QueuePath": The folder contain all notifications, which will send to Enterprise Service for process, after processed by ES, the corresponding file will be deleted.
- "InComingLogPath": All received COMOS notifications will be stored here
- "ProcessUrl": The URL, which represent Enterprise Service access point
Enterprise Service
- Go to UBIK.EnterpriseService folder,
- Check if CUI plugin installed,
- Copy paste UBIK.Interface.CUI.dll to “Injection” folder.
- If Injection does not exist, create it.
- Open UBIK.EnterpriseService.exe.config:
- Find “appSettings” session, configure all necessary information, and add "ContentControllerConfigPath" to the end :
<appSettings>
<!-- System.Diagnostics.ProcessWindowStyle: Normal = 0, Hidden = 1, Minimized = 2, Maximized = 3 -->
<add key="ConsoleRunMode" value="1" />
<!-- Nothing = 0, Mark = 1, Delete = 2 -->
<add key="CommandFileAction" value="0" />
<add key="ClearWatchFolders" value="0" />
<!-- Path to json file. Pointing to EnterpriseServicePluginExecutionConfigHolder -->
<add key="PluginExecutionConfigPath" value="" />
<add key="ClientSettingsProvider.ServiceUri" value="" />
<!--TEST IF ONLINE USING BROWSER // GET http://localhost:9000/api/basicenterpriseservice/getuptimeinfo-->
<!-- switch on WebInterface: 1, switch off WebInterface : 0 -->
<add key="ExecuteWebInterface" value="1" />
<add key="ExecuteTaskByJsonFile" value="0" />
<!-- Notification Endpoint config ProcessUrl -->
<add key="WebInterfacePort" value="9000" />
<add key="WebInterfaceHost" value="http://localhost" />
<!-- Add this to the ES config file -->
<add key="ContentControllerConfigPath" value="C:\UBIK\CUI.ES.Config\ContentController.json" />
</appSettings>
<!-- System.Diagnostics.ProcessWindowStyle: Normal = 0, Hidden = 1, Minimized = 2, Maximized = 3 -->
<add key="ConsoleRunMode" value="1" />
<!-- Nothing = 0, Mark = 1, Delete = 2 -->
<add key="CommandFileAction" value="0" />
<add key="ClearWatchFolders" value="0" />
<!-- Path to json file. Pointing to EnterpriseServicePluginExecutionConfigHolder -->
<add key="PluginExecutionConfigPath" value="" />
<add key="ClientSettingsProvider.ServiceUri" value="" />
<!--TEST IF ONLINE USING BROWSER // GET http://localhost:9000/api/basicenterpriseservice/getuptimeinfo-->
<!-- switch on WebInterface: 1, switch off WebInterface : 0 -->
<add key="ExecuteWebInterface" value="1" />
<add key="ExecuteTaskByJsonFile" value="0" />
<!-- Notification Endpoint config ProcessUrl -->
<add key="WebInterfacePort" value="9000" />
<add key="WebInterfaceHost" value="http://localhost" />
<!-- Add this to the ES config file -->
<add key="ContentControllerConfigPath" value="C:\UBIK\CUI.ES.Config\ContentController.json" />
</appSettings>
Make sure ContentController.json exist.
- Open ContentController.json, change the content base on the requirement:
{
"SqlConnectionDefinition":
{
"SSPI": false (or true, based on your DB setting),
"SQLUser": "username",
"SQLPassword": "password",
"SQLServer": "your SQL Server",
"SQLInitialCatalog": "DB name"
}
}
"SqlConnectionDefinition":
{
"SSPI": false (or true, based on your DB setting),
"SQLUser": "username",
"SQLPassword": "password",
"SQLServer": "your SQL Server",
"SQLInitialCatalog": "DB name"
}
}
