Jump to: navigation, search

Difference between revisions of "Configure EventNotification Endpoint and Enterprise Service for CUI"

(→‎Notification Endpoint)
(→‎Enterprise Service)
Line 33: Line 33:
  
 
= Enterprise Service=
 
= Enterprise Service=
−
* Go to UBIK.EnterpriseService folder,
+
* Go to the UBIK.EnterpriseService folder,
−
* Check if CUI plugin installed,
+
* Check if the CUI plugin is installed,
−
** Copy paste UBIK.Interface.CUI.dll to “Injection” folder.
+
** Copy and paste UBIK.Interface.CUI.dll to the “Injection” folder (create it if it does not exist).
−
* If Injection does not exist, create it.
+
* Open UBIK.EnterpriseService.exe.config:
−
** Open UBIK.EnterpriseService.exe.config:
+
** Find the “appSettings” section, configure all necessary information, and add the "ContentControllerConfigPath" setting to the end:
−
* Find “appSettings” session, configure all necessary information, and add "ContentControllerConfigPath" to the end :
+
 
<source lang = "xml">
 
<source lang = "xml">
 
         <appSettings>
 
         <appSettings>
Line 60: Line 59:
 
</appSettings>
 
</appSettings>
 
</source>
 
</source>
−
'''Make sure ContentController.json exist.'''
+
'''Make sure ContentController.json exists.'''
−
* Open ContentController.json, change the content base on the requirement:
+
* Create or adapt ContentController.json according to your database connection:
 
<source lang = "yaml">
 
<source lang = "yaml">
 
{
 
{
Line 71: Line 70:
 
       "SQLServer": "your SQL Server",
 
       "SQLServer": "your SQL Server",
 
       "SQLInitialCatalog": "DB name"
 
       "SQLInitialCatalog": "DB name"
−
      }
+
    }
 
}
 
}
 
</source>
 
</source>
 
==See also==
 
==See also==
 
<!-- 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 -->

Revision as of 15:11, 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.

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 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)
  • Make sure COMOS is configured to send notifications.


IIS Manager

  • 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".
    WebsiteConfIIS.PNG
  • Configure a "Binding" for the website.
    BindingIISConf.PNG
    • The URL can be used as a direct access target,
    • or used as an internal target for URL redirection.


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


Enterprise Service

  • Go to the UBIK.EnterpriseService folder,
  • Check if the CUI plugin is installed,
    • 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:
        <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 exists.

  • Create or adapt ContentController.json according to your database connection:
{
   "SqlConnectionDefinition":
    {
      "SSPI": false (or true, based on your DB setting),
      "SQLUser": "username",
      "SQLPassword": "password",
      "SQLServer": "your SQL Server",
      "SQLInitialCatalog": "DB name"
     }
}

See also

Retrieved from "https://wiki.augmensys.com/index.php?title=Configure_EventNotification_Endpoint_and_Enterprise_Service_for_CUI&oldid=24977"