v4.9.2

Authentication

Technical Doc, Server
v4.9.2

If SICS API Server is started in secure mode, all normal Web Services calls must include an authentication token. The caller must obtain this token by sending an initial “login” message to SICS API Server. The Login service # Sample SOAP Request and Response # The SOAP request (input message) for the login service must follow one of these formats (see discussion on OS AUTHENTICATION and <sicsUserId> further down): <SOAP-ENV:Envelope . ...

Configure SICS API Server for Deployment in Tomcat

Technical Doc, Server
v4.9.2

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. ...

Determine Java Version

Technical Doc, Desktop
v4.9.2

The Java version being used can be determined as follows: In Help->About SICS, go to System Info. Select the Java tab The properties java.version and java.runtime.version specifies the Java version. The property sun.arch.data.model specifies if the SICS is 64 or 32 bit. Note that this version of SICS requires 64-bit Java 21+.

Features

Technical Doc, Server
v4.9.2

Stateless # SICS API Server is designed to operate in a stateless manner. In other words, each SOAP call must contain the data that is necessary for SICS API Server to fully process the SICS business function. Parts of the data may consist of references to data that already exist in the SICS operational database. Commit / Rollback / Unit of Work # Each SOAP call to the SICS API Server will either succeed 100% or fail completely. ...

Authorization

Technical Doc, Server
v4.9.2

Authorization is the process of ensuring that the caller invokes services that the caller is allowed to execute, according to the caller’s SICS user profile. When receiving a service call request, SICS API Server verifies whether the SICS user identified by the “User ID” (present in the Authentication Token) has Access Rights to execute the service, according to the (existing) security set-up defined via the SICS System Administration utility. See also SICS API Server - Installation Guide, on how to set up your own authorization policy. ...

Configure Tomcat for SICS API Server Deployment

Technical Doc, Server
v4.9.2

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. ...

Deployment

Technical Doc, Server
v4.9.2

This section briefly explains the hardware and software required for installing and running the SICS API Server component. It is assumed that there already exists a SICS database that the SICS API Server will work against. Hardware Requirements # The SICS API Server component runs inside a Java servlet container. Such containers are available for many operating systems. One instance of SICS API Server requires at least 1 GB of memory running on a 64-bit operating system. ...