Scai Installation & Running Instructions

Requirements

To run Scai, the following are needed:

  • a Java 8+ installation.To install Scai on-premise, the following additional tools are needed:
  • bash, grep, cat, unzip, sed
  • optionally, systemd, to install a systemd service that will take care of starting, stopping and starting the Scai platform after boot

On RHEL/Centos/Fedora, use the following command to install all dependencies:yum install java-1.8.0 bash grep cat sed unzip systemd

Quick Installation

Important! Make sure you have all requirements installed.

  1. Extract the provided package into a location of your choice, e.g.unzip scai.zip -d scai
  2. If you want to install Scai with default parameters, run:./scai/deploy.shThis will deploy the Scai platform in the default locations (/opt/scai for binaries and /opt/scai/data for metadata files). If you would like to use different locations, go to Proper Installation.
  3. To start the Scai platform with default parameters, run the following:./scai/start.sh
  4. Open up a browser and type in the address http://localhost:9009 or https://localhost:9010.

Proper Installation

Important! Make sure you have all requirements installed.

To install Scai, first decide:

(a) the locations where the binaries will be placed. By default these will be placed under /opt/scai.

(b) where Scai should place its metadata. Scai uses a thin SQL database (H2DB) to store its metadata (users, data sources, role) information. These database files are placed, by default, under /opt/scai/data, but this is also configurable.

(c) if you would like to also install a Systemd service that will take care of starting/restarting/stopping and starting after boot of Scai. By default, no such Systemd service will be installed.

Then:

  1. Extract the provided package into a location of your choice, e.g.unzip scai.zip -d scai

  2. Run the following command with your custom parameters (all parameters are optional, remove the brackets before running the command):[SCAI_PATH=/home/myuser/scai] [DATA_PATH=/home/myuser/scai/data] [SYSTEMD=true] [HTTP_PORT=80] [HTTPS_PORT=443] ./scai/deploy.shThese parameters are available:

    • SCAI_PATH=<location for Scai binaries>, .e.g. SCAI_PATH=/home/myuser/scai. By default, SCAI_PATH=/opt/scai
    • DATA_PATH=<location for Scai metadata>, e.g. DATA_PATH=/home/myusers/scai/data. By default, DATA_PATH=/opt/scai/data
    • SYSTEMD=<true/false>, SYSTEMD=true to install a Systemd sytem-wide service that will make starting, restarting, starting on boot easier. By default, SYSTEMD=false
    • HTTP_PORT=<http port for Scai>, e.g. HTTP_PORT=80. By default HTTP_PORT=9009.
    • HTTPS_PORT=<https port for Scai>, e.g. HTTPS_PORT=443. By default HTTPS_PORT=9010.
  3. Depending how the installation was made:

    • if the installation was made with SYSTEMD=true, then you can start Scai by running:

    sudo systemctl start scai

    To restart Scai, you can run sudo systemctl restart scai

    • Otherwise, run the start script using the same parameters specified in 2, e.g.:

    [SCAI_PATH=/home/myuser/scai] [DATA_PATH=/home/myuser/scai/data] [HTTP_PORT=80] [HTTPS_PORT=443] ./scai/start.sh

  4. Open up a browser and type in the address http://localhost:[HTTP_PORT] or https://localhost:[HTTPS_PORT].

Remember to save all the environment variables that were used during installation and use them each time you want to start Scai manually. It is recommended to use SYSTEMD=true or another daemon manager to take care of starting, stopping the Scai service and to capture these custom parameters.

Restart Scai

To restart Scai when needed (e.g. after a system reboot), re-run step 3, depending on how you installed it.

Connectors and other libraries

Scai comes bundled with most of the necessary connectors and libraries to enable you to easily connect to your data source and use all of Scai's functionality, without any additional configuration/installation. However, there are certain (JDBC) connectors and libraries that are licensed under terms that prohibit Scai to bundle those connectors and libraries with the default Scai installation.

To install any such additional connectors and libraries, place them under the lib/other directory of your Scai installation (by default /opt/scai/lib/other/) and restart your Scai server.

Connectors

For most of its supported database vendors, the default Scai installation includes a (JDBC) connector that enables you to easily connect to your data source. The following table describes which database vendors and versions need a manual installation of its JDBC connector.

Database versionConnectorInstructions
MySQL 8.0MySQL Connector/J download pageAfter agreeing to the terms of the GPL license (which allows you to use this connector as long as you don't plan to redistribute it) and downloading the .jar file, place it in the lib/other directory of your Scai installation, by default in /opt/scai/lib/other, and restart your Scai server

Libraries

The following table will describe which libraries need to be additionally installed, before using certain features of Scai.

FeatureLibraryInstructions
Using PDF templates within the Workflow moduleIf you use Scai as permitted by the Scai license (internal to your organization and do not re-sell it as a service), then first agree to the terms of the AGPL terms here and use this library itextpdfPlace the downloaded jar in the lib/other directory of your Scai installation, by default in /opt/scai/lib/other, and restart your Scai server