/sicsdocs/technical/server/api_server/installation_guide/ Recent content in Installation Guide on Hugo -- gohugo.io /sicsdocs/technical/server/api_server/installation_guide/introduction/ Mon, 01 Jan 0001 00:00:00 +0000 /sicsdocs/technical/server/api_server/installation_guide/introduction/ This document describes how to install and configure SICS API Server. SICS API Server can run on 64-bit versions of Windows and Linux. The instructions are based on installation on machines running Microsoft Windows 64 bit. There is also a section on installing SICS API Server on Linux. Main steps Install SICS software products Set up database Test database using GUI-based SICS Configure SICS Install a Java Servlet Container Deploy SICS API Server to the Java Servlet Container Configure the SICS API Server environment Verify correct startup of SICS API Server Steps 1 to 4 are not described in this document and may vary if you are using P&C or Life. /sicsdocs/technical/server/api_server/installation_guide/install_java_container/ Mon, 01 Jan 0001 00:00:00 +0000 /sicsdocs/technical/server/api_server/installation_guide/install_java_container/ SICS API Server is a web application running Java 17 or higher. It is designed to be run in any Servlet/JSP-Container compatible with Servlet specification 2.5 or higher and JSP Specification 2.0 or higher. See http://en.wikipedia.org/wiki/List_of_Servlet_containers for a list of Java Servlet Containers. The following description shows how to install Apache Tomcat 10.1 which is a free and commonly used Java Servlet Container from Apache using Java 17 or higher. This does not imply that we promote Tomcat 10. /sicsdocs/technical/server/api_server/installation_guide/configure_api_server_for_tomcat_deployment/ Mon, 01 Jan 0001 00:00:00 +0000 /sicsdocs/technical/server/api_server/installation_guide/configure_api_server_for_tomcat_deployment/ SICS API Server is delivered as a web application. Web applications are packaged as files with extension .war. The war file is in fact a zipped archive file. The contents may be viewed with a zip application such as WinZip. Any configuration setting done prior to deploying SICS API Server, must therefore be done in the war file. For instance, WinZip allows the user to edit text files from the archive with Notepad or another external editor. /sicsdocs/technical/server/api_server/installation_guide/configure_tomcat_for_api_server_deployment/ Mon, 01 Jan 0001 00:00:00 +0000 /sicsdocs/technical/server/api_server/installation_guide/configure_tomcat_for_api_server_deployment/ Memory Setting # SICS API Server is a memory intensive application and the standard Java VM settings are not sufficient. To avoid out of memory error messages like: java.lang.OutOfMemoryError. Do the following: Ensure Tomcat is not running Start (double-click) the %CATALINA_HOME%\bin\tomcat9w.exe program You will then see a window like this: Figure 1 - Apache Tomcat Windows Service Properties Go to the “Java” tab and at the bottom at the “Java Options:” field and add the following parameters: Set the Initial memory pool 512 MB and Maximum memory pool 1024 MB. /sicsdocs/technical/server/api_server/installation_guide/deploy_api_server_to_java_servlet_container/ Mon, 01 Jan 0001 00:00:00 +0000 /sicsdocs/technical/server/api_server/installation_guide/deploy_api_server_to_java_servlet_container/ The way to deploy war files differ from the various Java Servlet Containers. The following describe how to do it on Apache Tomcat 10.1.40. https://tomcat.apache.org/tomcat-10.1-doc/index.html Ensure Tomcat is running Open the Tomcat Web Application Manager in a browser. If you have installed it locally on port 8080 the address is: http://localhost:8080/manager/html (or click on the link Tomcat Manager in the Tomcat start page (http://localhost:8080): (You must log in with the username and password set when installed Tomcat) /sicsdocs/technical/server/api_server/installation_guide/configure_api_server_environment/ Mon, 01 Jan 0001 00:00:00 +0000 /sicsdocs/technical/server/api_server/installation_guide/configure_api_server_environment/ Required knowledge # Most SICS API Server configuration is specified using XML files. You should be familiar with syntax rules for well formed XML, and be able to comment and uncomment XML fragments. Suggested configuration order # Configure logging Configure security Configure system pool size Configure queue sizes Configure caching of data Configure xml files Configure HTTP return codes Configure logging # Turn on/off Separate Logging of SOAP Messages # The default installation of SICS API Server logs SOAP messages to a separate log. /sicsdocs/technical/server/api_server/installation_guide/verify/ Mon, 01 Jan 0001 00:00:00 +0000 /sicsdocs/technical/server/api_server/installation_guide/verify/ Verify SICS API Server startup using the SICS API Server Management console # SICS API Server comes with a rudimentary management console which can be found at: http://<Tomcat-installation:port>/SicsServer/SicsServerManagementConsole and looks like this: When SICS API Server is ready to process SOAP messages the status will be “Running and ready since date/time and the flag will be green: Figure 9 - SICS API Server Management Console Green Status Verify SICS API Server startup by inspecting the log files # SICS API Server writes important startup messages to the SicsServer. /sicsdocs/technical/server/api_server/installation_guide/monitoring_sics_server/ Mon, 01 Jan 0001 00:00:00 +0000 /sicsdocs/technical/server/api_server/installation_guide/monitoring_sics_server/ SICS API Server can process multiple messages concurrently. The SICS API Server management console is extended to show information of the SICS System pool: Figure 22 - SICS API Server Management Console Figure 23 - SICS API Server Management Console Status /sicsdocs/technical/server/api_server/installation_guide/multiple_instances/ Mon, 01 Jan 0001 00:00:00 +0000 /sicsdocs/technical/server/api_server/installation_guide/multiple_instances/ SICS API Server runs as a web application inside a Java Servlet Container (Tomcat, Websphere etc). How to scale SICS API Server capacity depends on the Java Servlet Container and other infrastructure constraints/possibilities. For different alternatives and guidelines on how to set this up, please refer to the Java Servlet Container provider documentation. For testing purposes, DXC has defined a setup using Tomcat and Apache. The description of this setup is provided below for information purposes, as an example of how Load Balancing can be achieved. /sicsdocs/technical/server/api_server/installation_guide/additional_information/ Mon, 01 Jan 0001 00:00:00 +0000 /sicsdocs/technical/server/api_server/installation_guide/additional_information/ Application managed database connection # Complete the following steps to set up application managed connections to the database. Define and test a database connection in the file sics-database-sources.xml used by SICS workstation. On success, copy the connection entry to file %CATALINA_HOME%/webapps/SicsServer/WEB-INF/classes/sics-database-sources.xml Copy the required JDBC jar(s) into %CATALINA_HOME%/webapps/SicsServer/WEB-INF/lib (similar to the same step for 3.1 “Configure database connection”) Uncomment and specify the following servlet init-parameters in %CATALINA_HOME%/webapps/SicsServer/WEB-INF/web.xml: Parameter Description Required DATABASE The name attribute of the connection specified in %CATALINA_HOME%/webapps/SicsServer/WEB-INF/classes/sics-database-sources. /sicsdocs/technical/server/api_server/installation_guide/appendix_a/ Mon, 01 Jan 0001 00:00:00 +0000 /sicsdocs/technical/server/api_server/installation_guide/appendix_a/ Required knowledge # This is not an introduction to IBM WebSphere Liberty administration, the user must as a minimum know how to: Open and log into the Admin Center. Create a JDBC data source and install JDBC drivers Create JDBC login credentials Install an Enterprise Application Refer to official IBM WebSphere Liberty documentation and support for assistance. WAS Liberty Memory Parameters # Default JVM memory parameters must be changed. This can be done by creating a file named jvm. /sicsdocs/technical/server/api_server/installation_guide/appendix_b/ Mon, 01 Jan 0001 00:00:00 +0000 /sicsdocs/technical/server/api_server/installation_guide/appendix_b/ Two-level login is supported when using ‘application managed’ database connection. This is how it works: The user name and password for the first-level ’technical user’ is provided in a configuration text file which is read by SICS SICS will connect to the database using the technical user name and password SICS reads the corresponding SICS User Object from the CNU_USER table SICS detects that the SICS User Object contains a second-level name and password SICS disconnects from the database SICS connects (once more) to the database using the second-level name and password from the SICS User Object This connection is used for all later access and updates to the database In other words, when using application managed login, the db connection is under control by the application, i. /sicsdocs/technical/server/api_server/installation_guide/appendix_c/ Mon, 01 Jan 0001 00:00:00 +0000 /sicsdocs/technical/server/api_server/installation_guide/appendix_c/ It is possible to run Tomcat without installing it as a Windows service. This section briefly explains a few differences from the ‘Tomcat installed as a Windows service’ procedure described above. Download and Unzip Tomcat # Download the Tomcat zip file and unzip to some folder. Hereafter, the alias TOMCAT refers to the folder where Tomcat is unzipped. Java setup # Install the 64-bit Java Development Kit 17 (JDK 17) or later as described above.