Skip to content

Software Requirements

Supported Operating Systems

The HyWorks Controller can be installed on the following Windows Server operating systems:

  • Windows Server 2022

  • Windows Server 2019

  • Windows Server 2016

  • Windows Server 2012 R2

  • Windows Server 2008 R2 - SP1

  • Windows 10 (Supported but not recommended)

Note

The installer can be run on other Windows platforms that meet the system configuration and software requirements. However, for better performance, it is recommended to install the software only on the server-class machines mentioned.

Other Software Requirements

To configure the Windows Server with the HyWorks Controller, the following software must be installed and configured on the system:

  1. Dot Net 4.7.2 (Refer to the Installing .Net 4.7.2 section for details)

  2. Microsoft SQL Server (Standard or Express Edition) (Refer to the Preparing Microsoft SQL Server for HyWorks Deployment section for details)

  3. Microsoft Sync Framework v2.1: Sync framework is needed for database syncing in HyWorks clusters (Active-passive and multi-node with HyWorks managed database high availability). It is not required to be installed explicitly for v3.4-SP1 or later.

    • Explicit installation is not needed for the following environment and version combinations:

      • English Environment: Installing any 3.4 series version of HyWorks Controller will not require a separate installation of the sync framework.

      • Japanese Environment: Installing v3.4-SP1 or higher will not require a separate installation of the sync framework.

        • If you use HyWorks Controller v3.4-GA or older in a Japanese environment, you can install the sync framework using the steps here.

  4. Microsoft SQL Server Compact Edition (Refer to the Microsoft SQL Server Compact Edition v4.0 SP1 section for details): Required only for installing the HyWorks Controller. This can be uninstalled later after the installation is completed. Session host server (v3.4.0.16805 or later does not require SQL CE; older version will need SQL CE 4.0-SP1.)

    • If not installed, the setup should prompt for download using the internet. However, it can also be installed before the setup is initiated.

    • Download link: https://www.microsoft.com/en-in/download/details.aspx?id=30709

Install Dotnet 4.7.2

The HyWorks Controller v3.2-GA (v8493) or later requires .Net 4.7.2, which should be installed on the Windows Servers before installing the HyWorks Controller.

Refer to the Microsoft article for .Net version compatibility with different Windows server versions: https://docs.microsoft.com/en-us/dotnet/framework/get-started/system-requirements

  • On Windows Server 2019 or above

Windows 2019 or later, servers come preinstalled with .Net 4.7.2 or greater and hence do not require explicit installation. If .Net 4.7.2 is not found, the standard Microsoft recommended process should be followed to install it.

  • On Windows Server 2016

Windows Server 2016 comes preinstalled with .Net v4.6. Download and install the required .Net installer from the Microsoft website - https://support.microsoft.com/en-us/help/4054530/microsoft-net-framework-4-7-2-offline-installer-for-windows.

Follow the steps to install the default options. Once installed, configure other prerequisites for the installation of the HyWorks Controller.

  • On the Windows Server 2012 R2

The Windows Server 2012 R2 requires the following Windows updates installed on the system before installing .Net 4.7.2. Installation must be done in the following sequence:

  1. Install update kb2919442, which is the prerequisite for the update kb2919355.

  2. Install update kb2919355.

  3. Install Dot Net 4.7.2.

Important

The HyWorks Controller deployment does not work on Windows 2012 or 2012-SP1.

  • On Windows Server 2008 R2

.Net 4.7.2 supports only Windows Server 2008 R2-SP1 as the minimum version of the Windows Server. Any existing Windows Server 2008 R2 must be upgraded to SP1 before installing .Net 4.7.2.

Follow the steps given below to install and register .Net with IIS:

  • Install the SP1 update of the Windows Server 2008 R2 (if required)
  • Install Dot Net 4.7.2

  • Once the installation process for Microsoft .Net 4.7.2 is complete, open the Command prompt with Administrator privileges and execute the following command:

    "C:\Windows\Microsoft.Net\Framework\v4.0.30319\aspnet_regiis.exe -iru"

Register ASP.Net 4.0 post Web Server Role Addition

The Accops HyWorks Controller Management Console requires an appropriate application .Net pool to be added to the IIS.

Sometimes, the successful installation and configuration of the Web Server role in the Windows 2008 R2-SP1 .Net 4.0 pool does not register in IIS.

Follow the steps given below to verify and configure appropriate .Net Pools:

Verify .Net Pool

  1. Go to Start > Administrative Tools > Internet Information Services (IIS) Manager.

  2. Click Application Pools displayed on the inventory list given on the left-hand side. It should display all the application pools added to the servers.

  3. Verify if the ASP.Net 4.0 pool is listed (See the screenshot below).

    If the ASP.Net 4.0 pool is not on the list, follow the steps given in the Configure ASP.Net 4.0 Pools section in the IIS.

Configure ASP.Net 4.0 Pools in IIS

  1. Open the Command prompt with Administrator privileges and execute the following command:

    "C:\Windows\Microsoft.Net\Framework\v4.0.30319\aspnet_regiis.exe -iru"

  2. If the command is executed successfully, it should display a success status, as shown in the screenshot below:

  3. Repeat the steps given in the Verify the .Net Pools section to verify pools.

Prepare Microsoft SQL Server for HyWorks Deployment

Configure the SQL Server as follows to support the HyWorks Controller and clustering:

  1. Enable remote connections on the SQL Server instance.

  2. Configure the SQL server to listen on the static port.

  3. Turn on the SQL Server Browser service.

Assumption: The SQL Server is already installed (with Windows authentication or mixed mode) and ready for configurations.

Enable Remote connections on the SQL Server Instance

Follow the steps given below to configure the SQL Server to allow remote connections:

  1. Open the SQL Management Studio and connect to the SQL Server configured as the HyWorks Controller's database server.

  2. Right-click on the server name in the left pane and select Properties.

  3. Select Connections.

  4. Under the Remote server connections section, select the Allow remote connections to this server.

Configure the SQL server to communicate on the static port

The HyWorks Controller supports communication with the SQL server over a static port. Using the dynamic port may result in database connectivity problems.

Verify whether the SQL Server is using a static TCP port

  1. Open the SQL Server Configuration Manager.

  2. Click the SQL Server Services.

  3. Note down the process ID of the SQL Server instance displayed in the right pane, for example, 116 in the above image.

  4. Open the command prompt and execute the following command:

Code

netstat -ano | find /i \<PID of SQL Server> e.g. netstat -ano | find /i "116"

The command will not show any output if the SQL Server does not use a static TCP port and should be configured to use one, as shown in the screenshot above.

Enable the SQL Server to communicate on a static port

  1. Go to the SQL Server Configuration Manager.

  2. Click SQL Server Network Configuration.

  3. Right-click and select Enable.

  4. Restart the SQL Server service and identify the Process ID assigned to the SQL service.

  5. To verify whether the SQL services are listening on a TCP port or not, execute the following command in the command prompt:

Code

netstat -ano | find /i \<PID of SQL Server\

  1. To configure a specific port:

    1. In the SQL Server Configuration Manager.

    2. Click SQL Server Network Configuration.

    3. Right-click TCP/IP protocol.

    4. Select Properties.

    5. Go to IP Address > IPAll.

    6. Remove the value configured in the TCP Dynamic Ports section. Do not configure it as 0 (zero).

    7. Configure 1433 or any other port as per the requirement for TCP Port.

  2. Restart the SQL Server service. Identify the new process ID assigned to the SQL service, and in the command prompt, execute the following command to verify whether the SQL Service is now listening on the configured TCP Port, i.e., 1433. !!!code netstat -ano | find /i "PID of SQL Server";

SQL Express should now be configured to listen on the standard port 1433. Check the SQL Server port reachability from the Controller Installer server.

Start the SQL Server browser service

  1. Open the SQL Server Configuration Manager.
  2. Click on SQL Server Services.

  3. Right-click SQL Server Browser service and select Properties.

  4. Go to the Service tab and select Automatic for Start Mode.

  5. Click Apply.

  6. Click Start to start the SQL Browser service.

  7. Confirm whether the SQL Server Browser service is up and running.

Database Configuration References

For details on enabling remote connections in the SQL Server 2008k2R2 and 2012KR2, refer to:

Microsoft Sync Framework v2.1 (KB2703853)

The Microsoft Sync Framework is required only for HyWorks Controller clustering.

Synchronizing data between a cluster's primary and secondary HyWorks Controller servers is required. The following synchronization tools must be installed on both the HyWorks Controller servers. Download synchronization tools from:

Important

  • The latest HyWorks Controller installs MS Sync Framework 2.1-KB2703853 by default and thus does not need to be installed again after a fresh installation or upgrade.

  • The HyWorks Controller will require explicit installation of MS Sync Framework 2.1-KB2703853 on the Japanese Windows server.

Server Compatibility and Synchronization Tools:

The setup of the Synchronization tools must be chosen based on the server OS. This means that if the HyWorks Controller is being installed on the 64bit Windows Server 2012 R2, then the Synchronization tools x64 should be used, whereas if the Controller is being installed on the 32-bit Windows Server 2008 R2, then the Synchronization tools x86 should be installed.

Download the setup from the URL specified above to install the Microsoft Sync Framework and follow the Installation wizard. The detailed steps are provided in the section Prerequisite-Install Microsoft Sync Framework 2.1(KB2703853).

Install Microsoft Sync Framework 2.1

  1. Download the Microsoft Sync Framework v2.1 Setup from https://www.microsoft.com/en-us/download/details.aspx?id=19502.

  2. Double-click the setup file or right-click and select the Open/Run as Administrator option.

  3. In the Synchronization-v2.1-x64-ENU section, click Next.

  4. On the License Agreement screen, select the I Agree option and click Next.

  5. Click Next on the Confirm Installation screen.

  6. Wait for the installation process to complete

  7. Click Close to close the Setup wizard once the installation is successful.

Important

  • Installation of the Microsoft Synchronization Framework is required on both the HyWorks Controller Servers.

  • The Synchronization Framework must be installed before configuring the controllers in a cluster but can be installed before or after the HyWorks Controller.

Install the Microsoft SQL Server Compact 4.0 SP1

The SQL Server Compact 4.0 SP1 is required to install the HyWorks Controller. The HyWorks session host agent and monitoring services use SSCE to temporarily store data.

To install the SQL Server Compact 4.0 tools, follow the latest HyWorks Controller installs MS Sync Framework 2.1-KB2703853 by default. HyWorks Controller will require explicit installation of MS Sync Framework 2.1-KB2703853 on the Japanese Windows server steps given below:

  1. Download the Microsoft SQL Server Compact 4.0 Setup from https://www.microsoft.com/en-US/Download/confirmation.aspx?id=30709

  2. Double-click or right-click the setup file (SSCERuntime_x64-ENU.exe) and select the option to Open/Run as Administrator.

  3. In the Microsoft SQL Server Compact section, click Next.

  4. Select the I accept option on the License Agreement screen and click Next.

  5. Click Install on the Confirm Installation screen.

  6. Wait for the installation process to complete.

  7. Click Close to close the Setup wizard after successful installation.

Server Configuration

For some specific deployment types, the following configurations may require:

Provide User Logon as a Service Rights on Windows Server

The HyWorks Controller service must be configured to run with the specific user account for deployments where SQL database configuration needs to be done with Windows authentication. The provided user account must have logon as a service privileges on the system; otherwise, the HyWorks Controller service may fail to start after the installation.

Follow the steps given below to configure users’ accounts with logon as a service privilege:

  1. Click Start > Run, type mmc, and click OK.

  2. Click Add/Remove Snap-in > Add on the File menu, and double-click Group Policy Object Editor.

  3. In Group Policy Object, click Browse to the Group Policy object (GPO) that you want to modify, click OK, and then Finish.

  4. Click Close, followed by OK.

  5. In the console tree, click User Rights Assignment; this is available at the following location: Group Policy Object\ [\Computer Name] Policy >> Computer Configuration >> Windows Settings >> Security Settings >> Local Policies >> User Rights Assignment.

  6. In the details pane, double click Log on as a service.

  7. If the security setting has not been defined yet, select the Define these policy settings.

  8. Click Add User or Group. Add the appropriate account to the list of accounts with Log on as a service.

  9. Open the command prompt as administrator, and execute the below command to push the changes to take effect:

       -    gpupdate /force

  10. The added user account can now run the HyWorks Controller service.