This article describes the software and hardware requirements for a SystemWeaver REST API server application. To obtain a delivery of the REST API Server, contact [email protected]..


Prerequisites

  • A SystemWeaver Server installation of release R32 or later

  • A delivery of the SystemWeaver REST API server that is compatible with the installed main or mirror server

  • The software and hardware requirements outlined below are fulfilled


Software Requirements

The SystemWeaver REST API Server runs on all 64-bit versions of Windows supported by Microsoft, both desktop and server OS without restrictions. With that being said, we recommend the following Windows editions:

  • Windows 10, Professional or Enterprise or later
  • Windows Server 2019 or later


In addition, if not already installed, the server requires:

  • .NET 6 or later


Hardware Requirements


Installation Disk Size

The actual software needs 10MB of disk space.


Data Disk Size

The SystemWeaver REST API can run on any modern disk. However, if it is located on the same machine as the main or mirror server, please read SystemWeaver Server - Software and Hardware Requirements.


Memory(RAM)

The required amount of RAM for the SystemWeaver REST API is highly dependent on the number of requests from concurrent users and the size of the data these requests result in. Unlike the SystemWeaver main or mirror server, the SystemWeaver REST API does not cache the complete database in memory, but only the current requests being processed. The general recommendation is to have memory allocated to the SystemWeaver REST API that amounts to 2 to 3 times the size of the database. For example, if the database is 10GB, you are recommended to have 20-30GB RAM for the SystemWeaver REST API Server. 


If too little RAM is available, the SystemWeaver REST API Server may start swapping memory to disk which will drastically reduce performance. We recommend regular monitoring of the resource utilization, e.g., by using monitoring functions in Windows like the Task Manager, etc. in order to detect the need for upgrades of the server platform.


CPU 

The SystemWeaver REST API server can run on any standard 64-bit computer. The minimum recommendation however is to use a standard performance computer with at least 8 cores. Just as for RAM, we recommend regular monitoring of the resource utilization, e.g., by using monitoring functions in Windows like the Task Manager, etc. in order to detect the need for upgrades of the server platform.

Installing the REST API

Place the installation directory on the designated server. To maximize performance, If there is enough available RAM, it is recommended to install the SystemWeaver REST API Server on the same machine as the SystemWeaver server or mirror server that it is connected to. 


For large installations and/or for heavy use, the REST API should not be installed on the main server machine and should not be configured to connect to the main server. Instead, the REST API should be installed on a mirror server machine and connect to a mirror server.


Running as a Service

We recommend the REST API be run as a Windows service. If interested, SystemWeaver offers an optional Monitor Service that allows you to run multiple SystemWeaver servers, e.g., mirror server, REST API, in one service. 


Example of Monitor Service running the main server, the notification server, and the REST API:

<SystemWeaverMonitor wcfServicePort="9090">
	<Servers>
		<Server restart="true">
			<exe>C:\work\SystemWeaver\bin\swDBServer.exe</exe>
			<ini>C:\work\SystemWeaver\bin\swServer.ini</ini>
			<propsC:\work\SystemWeaver\bin\swServer.props< props>
		</Server>
		<Server restart="true" startDelay="10000">
			<exe>C:\work\SystemWeaver\bin\swNotificationServer.exe</exe>
			<ini>C:\work\SystemWeaver\bin\swNotificationServer.ini</ini>
			<props>C:\work\SystemWeaver\bin\swNotificationServer.props</props>
		</Server>
		<Server restart="true" startDelay="10000">
			<exe>C:\Work\Restapi\SystemWeaver.RestApi.exe</exe>
		</Server>
	</Servers>
</SystemWeaverMonitor>

To make the Rest API server work in the Monitor Service, the user running the Monitor Service must be local administrator.

The Rest API needs to be started by an administrator so it can be accessed from outside the server.


Tip: If the REST API is run as part of the service, it can be stopped and restarted without disrupting users by using the optional SystemWeaver Monitor Service Status Tool


DLQ Logging During Initial Implementation

To troubleshoot any issues that arise during the initial implementation of the REST API, we recommend that you be sure to configure DLQ logging for the SystemWeaver server. See Maintaining TcpSubServer DLQ Logging. Once you are satisfied with the stability of the installation, you can deactivate the logging. 

What's Next?

To configure the REST API, see Configuring the SystemWeaver REST API Server.