The discussion below has been updated to cover the current SOX V4 release. SOX versions 3.3 and earlier are now out of scope of this documentation. For any information relating to legacy releases, please refer to EnCo Support.
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
Please be aware that there is no direct migration path for legacy SOX projects that you wish to use under SOX 4.0. To work with projects created with SOX 3.3, you will need to export them first and then re- import them into the new SOX environment. To learn more about this subject, please refer to new Workspace and Repositories and SOX Projects (SOX 3.3 or before), in particular, |
...
| panelIconId | atlassian-note |
|---|---|
| panelIcon | :note: |
| bgColor | #ABF5D1 |
SOX 4.0 offers an unbelievable wealth of new functional features, as well as integration with a number of major third-party products. For further particulars, refer if you will to
https://enco-software.atlassian.net/wiki/spaces/SUD/pages/2902065153#Interfaces
...
. |
| Table of Contents | ||||
|---|---|---|---|---|
|
Local Process
If you expect to are planning work with locally stored repositories only, simply download the client application installer from https://www.enco-software.com/de/support/downloads/. Info
The recommended installation process then involves the following steps:
The SOX download package is likely to be in the form of a .zip archive. In this scenario, unzip (extract) Extract all files first.
Understand that extraction may take several minutes. - Outcome: Windows will display the extracted directory within your SOX the respective folder.
Run the
sox.exefile, 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.Outcome: you You will be asked to select your workspace, i.e., a folder in which to store your projects. SOX automatically creates a folder simply entitled named “workspace” and will offer to use this folder in the first instance. It is possible alternatively to click on Browse… and nominate select any other folder of your choice. Furthermore, SOX further offers to make your selection the default and not ask again at startup which folder you wish to use. To elect this option, check the box provided. You may alter your choice at any point from within the SOX workbench environment. When done, click the Launch button.
Next, SOX will prompt you for the kind of repository to use with your workspace. For our In the example scenario, the assumption is that you wish to below, we create a new local repository. (Also For more information on your workspace and respository, see: new Workspace and Repositories.) Use the associated radio button and click on Next.
Outcome: SOX will ask you to define the path to your repository directory. Accept the default or click on Browse… to store your repository somewhere elseselect a different folder. Enter a name for your new repository. This needs to name must be unique within your repository directory. Click Finish to apply your choices.
Supply your user credentials to sign into SOX. As the dialog indicates, the factory defaults are When starting SOX, the default user credentials “Administrator/0000” (user/password) are preselected. The defaults may be subject to change differ based on settings implemented by your system administrator. Check the box provided to have SOX remember your password, then click OKClick OK to finish the installation process and to start the SOX Client for the first time.
Outcome: this activity completes the The setup process is now finished. SOX will display the Welcome screen.
...
The following minimum requirements exist for the installation of the SOX server (more may be required depending on use)
Cores | 4 |
|---|---|
Memory | 16GB |
Disk Space | 40GB |
Operating System | Linux |
Required Software |
|
Other setups and operating systems may also work, please contact our support team for more information.
Login Credentials
to 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.
...
| Code Block |
|---|
curl -u <USERNAME>:<PASSWORD> https://gitlab.com/api/v4/projects/57826888/packages/generic/docker-compose/4.2.1.0/docker-compose.yaml > docker-compose.yaml |
your Your file will now automatically be downloaded and saved as docker-compose.yaml.
...
| Code Block |
|---|
docker login registry.githubgitlab.com |
You will be asked to enter your user name and password. Use the same credentials as before.
...
The Docker services will now be automatically loaded from the Docker hub. After downloading, the services will be started automatically.
Be aware that especially the first startup of the sox SOX service may take some time (some several minutes ) to set up the database and the . The backend will therefore be unreachable during this step of the setup. Later startups skip this initialization and will be faster.
Manual Installation
Instead of running the complete installation via the docker-compose up -d command, you can also install the relevant components on their own. This is especially useful in case you were experiencing challanges during your first installation attempt as this method allows you to check the docker logs after each step using the command
| Code Block |
|---|
docker ps |
Perform the following commands in order:
MySQL Service:
| Code Block |
|---|
docker-compose up -d mysql |
Respository Service:
| Code Block |
|---|
docker-compose up -d SOX |
You can now check the logs for messages indicating successful startup:
| Code Block |
|---|
docker logs -f sox |
The CDO server started and Starting SWT event loop messages indicate a successful installation.
C-SOX Frontend:
| Code Block |
|---|
docker-compose up -d c-sox |
Reverse Proxy to open C-SOX files from the desktop client:
| Code Block |
|---|
docker-compose up -d traefik |
Remote Process Client-Server Installation (old Server Installation process)
...
new Activating Your SOX License
Cross-Module Features (v4.0 and Better)
...