Installation

2 minute read

Installation of SICS DOCS

Installation on a static web server (i.e. Apache HTTPD server or Nginx)

Step 1. Unzip

Unzip the ZIP version of the SICS DOCS archives you want to install

File To do
sicsdocs_pc_Installation.zip Unzip to a folder named sicsdocs_pc_4211.
sicsdocs_life_4211.zip Unzip to a folder named sicsdocs_life_4211.
sicsdocs_cede_4211.zip Unzip to a folder named sicsdocs_cede_4211.
21.1/sysadmin.zip Unzip to a folder named 21.1/sysadmin.

Step 2. Copy unzipped folders to web server

Copy the folders sicsdocs_pc_4211, sicsdocs_life_4211, sicsdocs_cede_4211, and/or 21.1/sysadmin to the publishing root folder of your web server.

Step 3. Verify in browser

Once the folders are published, please open your browser of choice, and check the urls:

URL Description
http(s):<hostname>:<portnumber>://sicsdocs_pc_4211/index.html Click to verify that SICS DOCS site is available in the browser.
http(s):<hostname>:<portnumber>://sicsdocs_life_4211/index.html Click to verify that SICS DOCS site is available in the browser.
http(s):<hostname>:<portnumber>://sicsdocs_cede_4211/index.html Click to verify that SICS DOCS site is available in the browser.
http(s):<hostname>:<portnumber>://21.1/sysadmin/index.html Click to verify that SICS DOCS site is available in the browser.

Note 1:
The context path must be exactly like the example above.

Note 2:
Please make sure the web server is set up to transform pretty URLs. (specifically: The server must append index.html to URLs ending with a slash .../. This is usually enabled by default.

Installation on a Java Servlet Container (i.e. Apache Tomcat 8.5)

Step 1. Deploy WAR file

Deploy the WAR version of the SICS DOCS archive files you want to install into Tomcat’s webapps folder:

File Description
sicsdocs_pc_4211.war Drop WAR file in Tomcat’s webapps folder, or use Tomcat Manager GUI to deploy it.
sicsdocs_life_4211.war Drop WAR file in Tomcat’s webapps folder, or use Tomcat Manager GUI to deploy it.
sicsdocs_cede_4211.war Drop WAR file in Tomcat’s webapps folder, or use Tomcat Manager GUI to deploy it.
21.1/sysadmin.war Drop WAR file in Tomcat’s webapps folder, or use Tomcat Manager GUI to deploy it.

Step 2. Verify in browser.

Once deployed, please open your browser of choice, and check the urls:

URL Description
http(s):<hostname>:<portnumber>://sicsdocs_pc_4211/index.html Click to verify that SICS DOCS site is available in the browser.
http(s):<hostname>:<portnumber>://sicsdocs_life_4211/index.html Click to verify that SICS DOCS site is available in the browser.
http(s):<hostname>:<portnumber>://sicsdocs_cede_4211/index.html Click to verify that SICS DOCS site is available in the browser.
http(s):<hostname>:<portnumber>://21.1/sysadmin/index.html Click to verify that SICS DOCS site is available in the browser.

Note 1:
The context path must be exactly like the examples above.

Note 2:
The war files have a pretty-URL rewriting filter built in. So URLs ending with a slash .../ with automatically be translated to .../index.html. This is necessary for the documentation to work.

SICS Online Help-function

SICS configuration

File Description
sics.global.resource.registry.properties Contains settings for SICS DOCS, and many other SICS functions.

Configure SICS Online Help

Make SICS DOCS the preferred choice when opening the “Online Help”-function in SICS Workstation or SICS Sys Admin Utility:

Edit file sics.global.resource.registry.properties to activate SICS DOCS as Online Help from SICS Workstation and SICS SysAdmin Utility.

Product Configuration setting
SICS Sys Admin SystemAdminHelpURL=http://<host>:<port>/21.1/sysadmin/
SICS P&C Workstation SicsPcUserGuideHelpURL=http://<host>:<port>/sicsdocs_pc_4211/
SICS Life Workstation SicsLfUserGuideHelpURL=http://<host>:<port>/sicsdocs_life_4211/

If there are enabled, make sure the URL points to the installed SICS DOCS HTML files on your web server.

Configure “What’s New”-function

Make SICS DOCS the preferred choice when opening the “What’s new”-function in SICS Workstation or SICS Sys Admin Utility:

Product Configuration setting
SICS Sys Admin SystemAdminHelpURL=http://<host>:<port>/21.1/sysadmin/sicsdocs/releases/sics_4211/whats_new/whats_new_sys_admin/
SICS P&C Workstation SicsPcUserGuideHelpURL=http://<host>:<port>/sicsdocs_pc_4211/sicsdocs/releases/sics_4211/whats_new/whats_new_pc/
SICS Life Workstation SicsLfUserGuideHelpURL=http://<host>:<port>/sicsdocs_life_4211/sicsdocs/releases/sics_4211/whats_new/whats_new_sys_life/

If these are enabled, make sure the URL points to the installed SICS DOCS HTML files on your web server.