/sicsdocs/technical/desktop/live_desktop_and_sns_server/ Recent content in SICS Live Desktop on Hugo -- gohugo.io /sicsdocs/technical/desktop/live_desktop_and_sns_server/introduction/ Mon, 01 Jan 0001 00:00:00 +0000 /sicsdocs/technical/desktop/live_desktop_and_sns_server/introduction/ Integration between ’external’ applications and SICS can be carried outat the functional level through SICS API Server and various batch interfaces (MTK, General Interface, etc). Integration can also be carried out at a User Interface (GUI) level through SICS Live Desktop. When SICS Live Desktop is enabled, external applications may use Web Service technology to “call into” a SICS Workstation in order to open specific screens (Business, Claim, eMessaging, etc.). This can facilitate a tighter integration between SICS and workflow or other supporting, client-specific, applications. /sicsdocs/technical/desktop/live_desktop_and_sns_server/overview/ Mon, 01 Jan 0001 00:00:00 +0000 /sicsdocs/technical/desktop/live_desktop_and_sns_server/overview/ SICS Live Desktop has six main parts: SICS Naming Service (SNS) web services SNS Administration web page SICS Live Desktop URL processing service (SUS) Auto-registration of SICS Workstation with SNS Automatic cleanup of dead sessions Web Service Endpoints (WSE) in SICS Workstation SICS Naming Service is a web application that exposes a set of Web Services. It is the main “hub” in SICS Live Desktop. SNS keeps a register of all running SICS Workstations. /sicsdocs/technical/desktop/live_desktop_and_sns_server/communication_overview/ Mon, 01 Jan 0001 00:00:00 +0000 /sicsdocs/technical/desktop/live_desktop_and_sns_server/communication_overview/ Communication Using Web Services # The following diagram shows how communication takes place between the external application, SNS and SICS Workstation. On startup, SICS Workstation starts listening for incoming Web Service calls and also registers itself with SNS. The end-user performs an action in an external web application. Assuming this is an action which is meant to open a screen in SICS, the external application will continue with step 3. /sicsdocs/technical/desktop/live_desktop_and_sns_server/sics_naming_service/ Mon, 01 Jan 0001 00:00:00 +0000 /sicsdocs/technical/desktop/live_desktop_and_sns_server/sics_naming_service/ Brief Description # The SICS Naming Service (SNS) is responsible for mapping users to SICS Workstations. The SNS is a JEE web application based on JAX-WS and the METRO web services stack.It must be run within a JEE application server. The list of registered users / workstations is persisted (stored) in a SICS database. The SNS connects to the database via a JNDI datasource. SNS is stateless. That is, each web service request will read data from the database. /sicsdocs/technical/desktop/live_desktop_and_sns_server/sics_live_desktop_url_service/ Mon, 01 Jan 0001 00:00:00 +0000 /sicsdocs/technical/desktop/live_desktop_and_sns_server/sics_live_desktop_url_service/ Brief Description # The SICS Live Desktop URL Service (SUS) is responsible for processing URL requests and transforming them into SICS Workstation web service calls and invoke the call on the correct SICS Workstation. The SUS is a JEE web application bundled together with the SNS. SUSConfiguration # Some properties of SUSare configurable. Enabling/disabling of SUS # The SUS is enabled by default but can be disabled by setting the context parameter enable. /sicsdocs/technical/desktop/live_desktop_and_sns_server/sns_administration_web_page/ Mon, 01 Jan 0001 00:00:00 +0000 /sicsdocs/technical/desktop/live_desktop_and_sns_server/sns_administration_web_page/ The SNS provides a simple web GUI for administration tasks. The following administration tasks are available. List registration entries (which desktops are currently registered) Force de-registration of a single, or selection of desktops Ping registered desktops (check if they are still alive) Remove / de-register desktops that do not respond to a ping call. In addition, the status of the automatic cleanup process is visible in the SNS administration web page, see Automatic cleanup of dead sessions for more details. /sicsdocs/technical/desktop/live_desktop_and_sns_server/install_sns_and_sus/ Mon, 01 Jan 0001 00:00:00 +0000 /sicsdocs/technical/desktop/live_desktop_and_sns_server/install_sns_and_sus/ The SNS, SNS Administration webpage and SUS is packaged as a single JEE application. The SNS is based on JAX-WS, the METRO web services stack, and JPA for persistency. The SNS Administration webpage and the SUS is based on JSP, Servlets and Javascript. The SNS, SNS Admin webpage and SUS is delivered as a war file to be installed in your JEE application server. 4 war files are delivered: War file Description sns. /sicsdocs/technical/desktop/live_desktop_and_sns_server/auto_reg_workstation_with_sns/ Mon, 01 Jan 0001 00:00:00 +0000 /sicsdocs/technical/desktop/live_desktop_and_sns_server/auto_reg_workstation_with_sns/ Registration # Upon startup (after login), the SICS Workstation will find an available TCP/IP port and start listening for incoming Web Service calls on this port. Then, it will register itself with SNS, providing the user’s login name (first level user in case of two-level login), database name, database schema and the user’s OS name. SNS will assign and reply a token, which SICS will remember. Note: If the user is logged in as the table owner (empty schema), then the registration will be done using an empty string for database schema, not Java null / database NULL. /sicsdocs/technical/desktop/live_desktop_and_sns_server/configuration_of_sics_workstation/ Mon, 01 Jan 0001 00:00:00 +0000 /sicsdocs/technical/desktop/live_desktop_and_sns_server/configuration_of_sics_workstation/ Configuration # Certain aspects of the SICS Live Desktop part of SICS workstation can be configured in the file /runtime/conf/sics.global.resource.registry.properties, as follows: # Base URL of the SICS Naming Service, with which this Workstation should register. # This is one of several requirements for activating SICS Live Desktop. # The format is # http[s]://<hostname>:<port>/<contextroot> # The SNS WSDL file will then be available at # <SicsNamingService>/webservice?wsdl # and the SNS web service methods (operations) will be available at # <SicsNamingService>/webservice #SicsNamingService=http://cscsvrosl023v. /sicsdocs/technical/desktop/live_desktop_and_sns_server/ws_endpoints_in_workstation/ Mon, 01 Jan 0001 00:00:00 +0000 /sicsdocs/technical/desktop/live_desktop_and_sns_server/ws_endpoints_in_workstation/ Public Web Services # These are the Web Service Endpoints published by SICS Workstation. These services are intended to be called by an external application. All parameters are mandatory unless otherwise indicated. All services will return immediately after processing the request (opening the requested screen). Response: The response data structure consists of 1 field: a textual message. If the request is valid (the correct token is provided, see security below), then the response will consist of an empty message. /sicsdocs/technical/desktop/live_desktop_and_sns_server/external_application_implementation/ Mon, 01 Jan 0001 00:00:00 +0000 /sicsdocs/technical/desktop/live_desktop_and_sns_server/external_application_implementation/ An external application that wants to utilize SICS Live Desktop (SLD) functionality, must be able to communicate with SICS Naming Service and SICS Workstation via Web Service requests according to the WSDL files published by the SICS Naming Service and SICS Workstation. The typical usage pattern is for the external application to use “client stubs” that are generated from the WSDL files. The SICS desktop runtime installation provides Java client stubs for SNS as well as SLD.