Local Process

If you expect to work with locally stored repositories only, simply download the client application installer from https://www.enco-software.com/de/support/downloads/.

The recommended installation process involves the following steps:

1. The SOX download package is likely to be in the form of a .zip archive. In this scenario, extract all files first.

   

2. Windows will display the extracted directory within your SOX folder.

   

3. Run the sox.exe file, ensuring that you have sufficient user privileges to install the software. Depending on your system configuration, Windows may issue a warning at this point. If this happens, confirm that you wish to proceed with the installation.

4. You will be asked to select your workspace, i.e., a folder in which to store your projects. SOX automatically creates a folder named “workspace” and will offer to use this folder. It is possible to click on Browse… and select any other folder. Furthermore, SOX offers to make your selection the default and not ask again at startup which folder you wish to use. You may alter your choice at any point from within the SOX workbench environment. When done, click the Launch button.

   

5. Next, SOX will prompt you for the repository to use with your workspace. In the example below, we create a new local repository. (Also see: Workspace and Repositories.)

   

6. SOX will ask you to define the path to your repository directory. Accept the default or click on Browse… to store your repository somewhere else. Enter a name for your repository. This name must be unique within your repository directory. Click Finish to apply your choices.

   

7. When starting SOX, the default user credentials “Administrator/0000” (user/password) are preselected. The defaults may later be subject to change by your system administrator. Click OK to finish the installation process and to start the SOX Client for the first time.

   

8. The setup process is now finished. SOX will display the Welcome screen.

   

Docker Server Installation

Requirements

The following minimum requirements exist for the installation of the SOX server

Other setups and operating systems may also work, please contact our support team for more information.

Login Credentials

To start the installation process, you first need your personal login-credentials to download and install the docker file. Our support team will gladly provide you with those credentials.

Download Docker-Composed.yaml

To download the docker-composed.yaml file, enter the following ine in the Linux-shell. Replace the <USERNAME> and <PASSWORD> with the credentials you have previously received from our support team.

curl -u <USERNAME>:<PASSWORD> https://gitlab.com/api/v4/projects/57826888/packages/generic/docker-compose/4.2.1/docker-compose.yaml > docker-compose.yaml

your file will now automatically be downloaded and saved as docker-compose.yaml.

Editing the Docker-Composed.yaml

Within the docker-composed-yaml, you will find two lines refering to LocalHost. This can remain as is for a local test installation. To install the docker image on your server enviromant, change the LocalHost entries to your server’s DNS Name/IP-Address.

Login to registry

To be able to pull the docker images, you fist need to log into the docker registry. You can do so via the command

docker login registry.gitlab.com

You will be asked to enter your user name and password. Use the same credentials as before.

Initiate the Installation

You can now start the installation via the command

docker-compose up -d

The Docker services will now be automatically loaded from the Docker hub. After downloading services will be started automatically.

Be aware that especially the first startup of the SOX service may take some time (some minutes) to set up the database and the backend will therefore be unreachable during this setup. Later startups skip this initialization and will be faster.

Remote Process Client-Server Installation (old Server Installation process)

In order to access remote repositories, a database server needs to be installed in addition to the client software. The SOX Server is, technically speaking, a CDO (Connected Data Objects) Server. In the following, we make the stipulation that the database and the SOX Server are installed on the same machine.

Prerequisites

• Existing MySQL installation (5.7 or better)

• Root privileges on the server machine

MySQL Installation

Please refer to the MySQL product page (https://www.mysql.com/) for downloads and detailed instructions.

MySQL Initialization (Linux Only)

Some editing of the configuration file, normally found at /etc/my.cnf or /etc/mysql/my.cnf, is required. Locate the mysqld section and add the following two lines:

lower_case_table_names=1
sql-mode="STRICT_TRANS_TABLES,NO_AUTO_CREATE_USER,NO_AUTO_VALUE_ON_ZERO,NO_ENGINE_SUBSTITUTION,ONLY_FULL_GROUP_BY" ...

SOX Server Installation

The SOX Server application package will normally come as a .zip archive available from https://www.enco-software.com/de/support/downloads/. The file should be saved to your server machine, and can be extracted to any directory. Recommended locations are: c:\sox2server (Windows) or /opt/sox2server (Linux). In either scenario, this directory shall be referred to as INSTALL_FOLDER hereinafter. Under Linux, the following executable flags need to be added:

$ chmod +x $TARGET_DIR/sox2server
$ chmod +x $TARGET_DIR/features/enco.sox2.releng.jre.linux.gtk.x86_64*/jre/bin/*.

Database Setup

It is necessary to create a new user with appropriate access privileges. Your previously downloaded and unzipped server file contains the required scripts in the <INSTALL_FOLDER>/scripts folder. The file that needs to be executed is mysql-init.sql.

Open the command line for MySQL and execute this file as root user on the database:
$ mysql -u root -p -v < mysql-init.sql.

This script will create the database SOX_REPO and the user SOX_REPO_USER, who has all privileges for the new database.

Note that the database user SOX_REPO_USER can only access the database from the same server. If you want to have the SOX Server on a different machine than the database, please also execute the file mysqlinitremote.sql. This script will create another user, who is allowed to connect to the database from another server than localhost.

Setting up the Database Connection for SOX Server

In the installation folder of the SOX Server, certain files must be modified to allow the SOX Server to talk to the MySQL database.

First of all, you need to download the driver which allows the SOX Server to connect to the MySQL database. You can download the driver here: MySQL :: Download Connector/J.

The download page lets you choose your operating system (Windows or various Linux distributions). For Windows, you have a further choice of downloading a g-zipped TAR file or an .msi installer (the latter file is much bigger). As you will need to identify the executable JAR file noted below, you should download and uncompress the archive file.

Find within the archive the file mysql-connector-java-5.1.48-bin.jar. Copy this file to <INSTALL_FOLDER>/db-driver.
Now open the file <INSTALL_FOLDER>/sox2server.ini (please do not open this file with WordPad on
Windows -- use a text editor like Windows Editor or Notepad++). At the end of the file you find the line
-Dnet4j.config=configuration/config-h2-embedded.

Replace this line with the following lines:
-Dnet4j.config=configuration/config-mysql
-Xbootclasspath/a:db-driver/mysql-connector-java-5.1.48-bin.jar.

• Mysql 5.1.48 for SOX3

• MySQL 8.0.32 for SOX4

Save the changed file. Next, open the file <INSTALL_FOLDER>/configuration/config-mysql/cdo-server.xml (again, be sure to use a text editor like the Windows Editor or Notepad++). At the end of the file, you will find lines like these
<dataSource class="com.mysql.jdbc.jdbc2.optional.MysqlConnectionPoolDataSource"
URL="jdbc:mysql://localhost:3306/SOX_REPO" user="SOX_REPO_USER"
password="Enco9182" />.
If you installed the MySQL database and SOX Server on the same machine and proceeded as described in this document, no changes to the cdo-server.xml file are necessary. However, if you were adventurous and changed any settings for your database, like user name or password, please provide here the right values for your system.
If you also renamed the database (which is not recommended at all), you have need to change the database name not only in the connection settings but also at the beginning of the file on this line:

<repository name="SOX_REPO" type="sox">.
This completes the configuration setup. We still need to install SOX Server as a system service.

Installing SOX Server as a Service, Under Linux

To create a service on Linux to start/stop the SOX Server like other services on your Linux server do the following steps -

1. Create a file named sox.service in folder <INSTALL_FOLDER>.

2. Add this content to the newly created file:
   [Unit]
Description=SOX Server
[Service]
WorkingDirectory=/opt/sox2server
Type=simple
ExecStart=/opt/sox2server/sox2server
[Install]
WantedBy=multi-user.target

3. Install the service on your system as a system service:
   systemctl enable <INSTALL_DIR>/sox.service.
   To start your new service, type
   systemctl start sox.service.
   To stop the service, type
   systemctl stop sox.service.
   To display the current status of your new service, type
   systemctl status sox.service.

Installing SOX Server as a Service, Under Windows

To install the SOX Server as a Windows service, open a command line with admin privileges and navigate to <INSTALL_FOLDER>/scripts. Here you will find a file named service_install.exe. Execute this file. The
file will then execute for a short period of time. Installation was successful if you see output like this:

If now you open the service control center on Windows you will find a new service called sox2server.

First Run of SOX Server

This completes setting up SOX Server. You are now ready for its first run. As explained above, start the service by entering systemctl start sox.service.

You should shortly see in the log file of the server the line
CDO Server started.

The first start of the SOX Server will take a few minutes as the first startup will create all the tables needed, and will also add content to these tables.

On Windows you will find the log in the file log.txt in the install folder; on Linux you will find the log output in /var/log/syslog.

Memory Configuration

There is a default maximum memory setting for the Java VM that runs the server. This setting
depends on the operating system and the total amount of memory available on the hardware. For example, a system having 16 GB of memory will provide approx. 8 GB per default. You can change the value manually in the sox2server.ini inside the installation directory of the server.

To illustrate, the memory value is set to 8GB with the following example setting. Please note that it is mandatory to specify the setting below the -vmargs attribute:
-Xmx8192m
or alternatively
-Xmx8g.

Connect the Client to the Server

https://enco-software.atlassian.net/wiki/pages/resumedraft.action?draftId=2805170179

new SOX System Requirements

Activating Your SOX License

SOX License Management

Cross-Module Features (v4.0 and Better)

Integrations