This article explains how to install a SystemWeaver Server on Microsoft Windows using the Windows installer (.msi).
During the installation, you will be asked where to put the software. The installation will automatically create a new empty SQLite database to store the data. If you want to use another database, or if you already have a database with data, you can set this up after the installation is completed and verified. The data and log files will be put in the %PROGRAMDATA% directory, usually C:\Program Data\SystemWeaver. If you later want to put the database and log files in different locations, we recommend that you configure this manually after you have successfully completed the installation.
This guide assumes that you will have only one SystemWeaver server running on the machine. For details about running several servers on one machine, please contact Systemite for support.
Hardware and Software Requirements
These are the minimum requirements for a SystemWeaver Server installation:
- 64-bit Windows OS (x64). Windows 10 or Windows Server 2012 or later.
- Physical memory 32 GB.
- 10 GB free disk space
- If you want to use the file repository feature, we recommend and additional 300 Gb free disk space.
More detailed requirements information can be found in SystemWeaver Server - Software and Hardware Requirements.
Downloading the Software
The software is delivered via the SystemiteNAS file server (https://systemite.myqnapcloud.com/) as a zipped file. If you have not already received your login information, contact firstname.lastname@example.org.
Installing the Software
After downloading and extracting, open the folder where you extracted the software. Right-click the install file SystemWeaverClient.msi and select Install or double-click the file.
Wait for the installer to initialize and direct you to the Welcome page. Click Next if you want to continue with the install.
Next, choose where you want the software to be installed. We recommend that you keep the suggested path. Make your choice, then click Next. The default install path for the SystemWeaverServer is %PROGRAMFILES%\Systemite\SystemWeaver\VersionNumber.
You are now ready to begin the installation. Click Install to begin.
Wait while the installer executes. Click Finish to complete the setup.
- After the installation is completed, the install directory will open in the file explorer.
Verifying the Installation
After a successful installation, your SystemWeaver Server will be up and running. To verify this, you can run the swConnectionTest.exe application. This simple application checks that you can connect to a SystemWeaver server.
- Enter the Server Location: localhost and the default listening Port: 1768.
- Then, click Connect.
If, after clicking Connect, the log indicates "SystemWeaver Server Verified" at the end, your installation was successful and the SystemWeaver server is up and running on the specified IP and port.
By default, it uses 1768 as the listening port. This can be changed in the swServer.ini file. If you edit the .ini file, remember to restart the service for the new settings to take effect.
We also recommend that you install and run the SystemWeaver client from another computer to make sure that no firewall is blocking the server.
Elements of an Installation
You have now completed the installation. If you are interested, details of the installation are described below. This information is helpful if you need to make adjustments to the installation. If you are not at this point interested in the details, please continue to the section entitled After the Installation.
The SystemWeaver server is started and stopped by a SystemWeaver Server Monitor service, swServerMonitorService.exe, which you can find in the windows services dialog:
Here you can start and stop the service manually or change which user it runs as. If you make any changes to any of the settings files, you should select restart here for the changes to take effect.
The Service .settings File
The .settings file tells the service where the server .exe is installed and where to find the associated .ini file and .props file. By default, these files are located right next to the swServer.exe file in the program directory. This is what a default settings file looks like:
You can specify where the executable is located and where the .ini file and .props files are. If the file is located in Program Files, you will have to run, for example, Notepad as administrator to be able to edit the file.
The .props File
This files contains details about where and how the logging is done.
# Create a file appender
log4d.appender.Fil1.layout.pattern=%d [%t] %-5p %-6c %x - %m%n
The line you might want to change is the line specifying the log fileName. The default location for log files is %PROGRAMDATA% \SystemWeaver\Logs.
The .ini File
The .ini file is the most important file. It specifies which port the server listens to, which database engine to use and where the database is located, where the (optional) file repository is located, and many other things. For more information about this file, please see SystemWeaver Server Installation Manual or the Help manual.
After the Installation
The default database is completely empty. For the installation to be usable, users have to be added, a meta model must be created and views will need to be configured. Many of these topics are covered in separate articles in the Support Portal Knowledge Base.
Loading an Existing sqlite Database
Most often you already have a database. If it is an sqlite database file, you can move it. If the database is of another type, e.g., SQL Server or Oracle, just enter the user login data in the .ini file.
Warning! Make sure that you do not have any previous server running against the same database. Running several servers at the same time against the same SystemWeaver database will corrupt it and you will have to revert to a backup.
Adding Users to a New Database
If it is a new database, you will need to run the swAdmin application to add users. Instructions on how to add users can be found in Managing User Accounts.
If you have many users you will need a license to add additional users. Please acquire one from Systemite and install using the swAdmin client.
TroubleShooting the Installation
Socket error #10060, Connection timed out.
You get the following error when trying to connect to the server.
- Make sure that you have entered the correct server IP and and port.
- Is the server up and running?
- A firewall may be blocking the server.
This is most often a Windows firewall problem. Make sure that the port specified in the swServer.ini file is open for incoming connections.
Refer to other articles in Requirements and Installation and/or the SystemWeaver Administration Manual in the Help.