Microsoft Windows timeout session allocation (KeepAlive) configuration guidelines for Sage X3 Environments

These values are based on the environmental testing of a single tier environment utilizing Windows Server 2019, Windows SQL Server 2019, and Sage X3 Runtime R94.1.X versions. All recommended values above are estimates and should be used as a base configuration. All environments are unique (treated as such), and adjustments of these values will need to be vetted in a test environment.

CAUTION: This solution needs advanced Operating System knowledge. Consult your system administrator for help. Sage isn't liable for issues caused by improper changes to the Windows Registry. Always back up your data before applying advanced solutions.

CAUTION: Sage Customer Support cannot assist with issues related to third-party products or enhancements, hardware, report customizations, state or federal tax-related questions, or specific accounting questions. Refer to our Scope of Support document for details. For assistance, contact your Sage business partner, network administrator, or accountant. 

Microsoft Windows timeout session allocation (KeepAlive) configuration guidelines for Sage X3 Environments.

The chart below shows estimated values for configuring the timeout session allocation (KeepAlive) as it pertains to Sage X3 active Convergence Sessions (AKA Classic Sessions) generated by the Runtime Server component. These changes are made to the Microsoft Windows Registry. See further down the article on how to change or create these Windows Registry values.

Changing the Registry Value:

Before you begin:

WARNING: This is a Windows registry change. The proper precautions should be followed (i.e., backup or restore points) before attempting to change Windows Registry configurations.

1. Load Windows Regedit (registry editor),
   1. This can be done by right clicking Start, select Run, then typing regedit (in the box) and hitting Enter.
2. In the Registry Editor, Navigate to the following directory:
   1. HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters
   2. Locate the three entries listed above in the chart. If they exist, continue to the next step. If they do not exist, you will have to create them. See “Steps for Creating the entries in Windows Registry” at the end of the steps.
3. Right click on the first DWORD entry and select Modify
4. Change the value to match the chart above (i.e., if its KeepAliveTime set the value to 600000)
5. Click the OK button to save the change.
6. Repeat steps for the other two entries.
7. Once finished, reboot machine.
8. Repeat these entry changes on all Windows Servers associated to the Sage X3 Environment.
   1. Note: These changes require a machine restart for the changes to take effect.

Steps for Creating the entries in Windows Registry:

1. Load Windows Regedit (registry editor),
   1. This can be done by right clicking on Start, select Run, then typing regedit (in the box) and hitting enter.
2. In the Registry Editor, Navigate to the following directory:
   1. HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters
3. Right click in the right side of the editor (where other records are seen), select New, select DWORD.
4. Name the DWORD record KeepAliveTime (case sensitive)
5. Click away to change the name,
6. Right click the new DWORD record and select Modify.
7. Type in 600000 and tab away.
8. Click OK to close and save the record.
9. Repeat steps for the other two entries.
10. Once finished, close the Registry Editor and reboot the machine.
11. Repeat these entry changes on all Windows Servers associated to the Sage X3 Environment.
    1. Note: These changes require a machine restart for the changes to take effect.

DocLink: KeepAlive Timeout Issues
DocLink: ECONNRESET error - Web Sessions stuck in User Monitor
DocLink: Batch Server Tasks increasingly failing with ECONNRESET errors