|
|
| (14 intermediate revisions by 2 users not shown) |
| Line 2: |
Line 2: |
| | | | |
| | | | |
| − | The UBIK Notification Processing System is a WebEndoint and configurable Enterpriseservice that imports Notifications into the UBIK database, and hand them over to processing. It requires specific configuration files and settings to function efficiently. | + | The UBIK Notification Processing System is a WebEndoint and configurable Enterprise service that imports Notifications into the UBIK database, and hand them over to processing. It requires specific configuration files and settings to function efficiently. |
| | | | |
| − | The Notification EndPoint is a Webpage to set it up correctly first set up UBIK WEB Service
| + | |
| | + | |
| | + | == Set up UBIK WEB Service first == |
| | | | |
| | | | |
| Line 10: |
Line 12: |
| | * [[HowTo:Install Microsoft IIS]] | | * [[HowTo:Install Microsoft IIS]] |
| | * [[HowTo:Configure Microsoft IIS for UBIK]] | | * [[HowTo:Configure Microsoft IIS for UBIK]] |
| − | * [https://wiki.augmensys.com/index.php?title=Configure_UBIK_Archon_Service Configure UBIK Archon Service] | + | * [[Configure_UBIK_Archon_Service]] |
| − | * [https://wiki.augmensys.com/index.php?title=Configure_EventNotification_Endpoint_and_Enterprise_Service_for_CUI Configure EventNotification Endpoint and Enterprise Service for CUI]
| + | |
| | | | |
| | | | |
| − | There are some possible configurations here there are 2 of them:
| |
| − | 1st One Enterprise Server that does all the Work,
| |
| − | 2nd 3 Enterprise Services (Notification, Rest_Import, Rest_Export)
| |
| | | | |
| − | Configuration Overview | + | == Example Configuration 3 Enterprise Services : == |
| − | 1. Database Connection Setup
| + | |
| | | | |
| − | The configuration begins with setting up a database connection. This is defined in the ContentController.json file. The connection must be specified similarly to the main application configuration.
| |
| | | | |
| − | 2. Import and Export Services
| + | 1st the Enterprise Service for Notifications like defined |
| | | | |
| − | Depending on the setup, the system may require:
| + | * [[Configure_EventNotification_Endpoint_and_Enterprise_Service_for_CUI]] |
| | | | |
| − | 2 files for basic import/export operations.
| |
| | | | |
| − | 4 files if both import and export web services are deployed.
| + | 2nd the Enterprise Service for Import |
| | | | |
| − | The parameters must match the operation type (Import/Export) and its subtype.
| + | * [[Configure_Enterprise_Service_for_Import]] |
| | + | * [[EventNotificationScanOrchestrator]] |
| | | | |
| − | Import Configuration
| |
| − | Required Files:
| |
| | | | |
| − | CUIEventNotification.json
| + | 3rd the Enterprise Service for Export |
| | | | |
| − | Specifies the path to CUIOrchestrationParam.json.
| + | * [[Configure_Enterprise_Service_for_Export]] |
| | + | * [[BatchWriteOrchestrator]] |
| | | | |
| − | Contains the SQL database connection details.
| |
| | | | |
| − | Supports SSPI authentication (username and password set to null).
| |
| − |
| |
| − | CUIOrchestrationParam.json
| |
| − |
| |
| − | Defines performance parameters:
| |
| − |
| |
| − | Number of proxies
| |
| − |
| |
| − | Number of notifications per step
| |
| − |
| |
| − | Scan delay (in seconds)
| |
| − |
| |
| − | Sleep time (in minutes) before the next check
| |
| − |
| |
| − | Export Configuration
| |
| − |
| |
| − | There are two modes of export:
| |
| − |
| |
| − | Single Interface Admin (IA) object
| |
| − | ClassFullname:
| |
| − | "UBIK.CUI.Orchestration.BatchWriteOrchestrator"
| |
| − |
| |
| − | Tree of Interface Admins
| |
| − | ClassFullname:
| |
| − | "UBIK.CUI.Orchestration.MultiBatchWriteOrchestrator"
| |
| − |
| |
| − | Required Files:
| |
| − |
| |
| − | CuiExportOrchestrator.json
| |
| − |
| |
| − | Contains DB configuration
| |
| − |
| |
| − | Repeat interval (in minutes)
| |
| − |
| |
| − | Task definitions
| |
| − |
| |
| − | Export Parameters File
| |
| − |
| |
| − | Stores runtime parameters
| |
| − |
| |
| − | Key element: The GUID of the Interface Admin to export
| |
| − |
| |
| − | Web Service Hosting
| |
| − |
| |
| − | A website should be configured under Sites with:
| |
| − |
| |
| − | A unique, unused port
| |
| | | | |
| | No requirement for HTTPS or separate ports if both the UBIK Notification Endpoint and the Comos EventService are hosted locally | | No requirement for HTTPS or separate ports if both the UBIK Notification Endpoint and the Comos EventService are hosted locally |
| | | | |
| − | UBIK Enterprise Service Configuration
| + | [[Category:Pages with broken file links|Configure Enterprise Service for CUI]] |
| − | | + | |
| − | To run the Enterprise Service, two main configurations are needed:
| + | |
| − | | + | |
| − | UBIK.EnterpriseService.exe.config
| + | |
| − | | + | |
| − | WebInterfaceHost should be set to localhost
| + | |
| − | | + | |
| − | Enable the web interface:
| + | |
| − | <add key="ExecuteWebInterface" value="1" />
| + | |
| − | | + | |
| − | Define path to content controller config:
| + | |
| − | <add key="ContentControllerConfigPath" value="C:\Temp\UBIK.Studio.ES-4.8_NOT\JSON\ContentController.json"/>
| + | |
| − | | + | |
| − | Additional settings:
| + | |
| − | | + | |
| − | Default language
| + | |
| − | | + | |
| − | Plugin execution path:
| + | |
| − | <add key="PluginExecutionConfigPath" ... />
| + | |
| − | | + | |
| − | Enable task execution from JSON:
| + | |
| − | <add key="ExecuteTaskByJsonFile" value="1" />
| + | |
| − | | + | |
| − | Ensure the WebInterfacePort is different from other services
| + | |
| − | | + | |
| − | Service Deployment
| + | |
| − | | + | |
| − | The Enterprise Service can be created via command prompt or through a batch (.bat) script for repeated use.
| + | |
| − | | + | |
| − | Example deployment:
| + | |
| − | | + | |
| − | Server: \\10.230.16.12
| + | |
| − | | + | |
| − | Services Created:
| + | |
| − | | + | |
| − | "UBIK_ES_NOTIF" (for Notifications)
| + | |
| − | | + | |
| − | "UBIK_ES_REST" (for REST interface)
| + | |
| − | | + | |
| − | Notes
| + | |
| − | | + | |
| − | Configuration files must be correctly paired with the service types.
| + | |
| − | | + | |
| − | File paths and port configurations must not conflict across services.
| + | |
| − | | + | |
| − | Proper authentication and execution parameters are crucial for correct operation.
| + | |
The UBIK Notification Processing System is a WebEndoint and configurable Enterprise service that imports Notifications into the UBIK database, and hand them over to processing. It requires specific configuration files and settings to function efficiently.
No requirement for HTTPS or separate ports if both the UBIK Notification Endpoint and the Comos EventService are hosted locally
