Configuring WindowViewer as a Service and Resolving Remote Historian Connectivity Issues

Description

This Tech Note provides comprehensive guidance for configuring WindowViewer to run as a Windows service along with several examples for troubleshooting common issues related to service configuration and connecting to a remote Historian in AVEVA environments.

Applies to: InTouch HMI Versions 2017 and Newer. The examples below are illustrated in InTouch HMI 2023 R2 SP1. 

Solution Details

Solution Steps:

Organizations often need to run WindowViewer as a service to support automated startup, improved reliability, and disaster recovery compliance. Running WindowViewer as a service offers the following benefits:

• In the event of a power outage, WindowViewer will start the configured InTouch application immediately when power is restored, even without user log on. This reduces downtime and offers 24/7 operation in mission critical environments.  
• WindowViewer continues to log historical data, act as an O/I Server, and process alarm information even as users log on and log off.
• Improves security by reducing the attack surface and preventing unauthorized access to critical systems.  When configured to run as a domain user or service account, it can be centrally managed via Group Policy. 

Limitations:

Windows services run in session 0, which does not have access to the desktop session. As a result, WindowViewer cannot be interacted with by users when running as a service, since there is no graphical user interface (GUI) available. Additionally,  you must specify which InTouch application should run as a service. This can be configured the Node Properties within Application Manager or entered manually into the WIN.INI file.

*If connecting WindowViewer to Historian, WindowViewer will need to be configured for historization before completing these steps. Please complete the Connecting WindowViewer to Historian steps below prior to configuring WindowViewer to start as a service.

Configuring WindowViewer to run as a Service: Step-by-Step Guide

1. Start AVEVA Application Manager and highlight the application you would like to run as a service. From the Tools menu select Node properties:

2. The Node properties dialog will open. Enter the path to the desired application folder and click OK. Alternatively, you can click the ellipsis to browse to the folder:

3. The Wonderware WindowViewer service will start automatically on the next reboot of the machine. To manually start the service, open the services console (services.msc) and search for Wonderware WindowViewer and right-click Wonderware WindowViewer → Start:

4. By default, the WindowViewer Service will run under the NT SERVICE\VIEW virtual service account. This account will automatically be granted “Log on as a service” rights and added to the Local Administrators group on the InTouch PC.

NT SERVICE\VIEW will automatically be added to the Local Administrators group:

NT SERVICE\VIEW will automatically be granted “Log on as a service” rights:

If desired, the service account can be changed to a local user account or a domain account. To change the log on account double click on the service or right-click it and select Properties. On the Log On tab, enter the credentials for the desired account:

Please note, the account entered in the service properties will need to be added to the Local Administrators group. Additionally, it must be removed from "Deny log on as a service" policy and granted the “Log on as a service” right, if these settings have been not applied automatically! 

These permissions can be configured in Local Security Policy → Local Policies → User Rights Assignment.

Configuring WindowViewer to Run as a Service by Modifying the WIN.INI file (InTouch Standalone Applications Only)

This method is useful for changing the application that runs as a service, even while WindowViewer is open

1. After enabling WindowViewer to start as a service in Node properties using the previous instructions, navigate to the InTouch WIN.INI file in the following directory:

C:\ProgramData\Wonderware\InTouch\Service\win.ini

2. Open the WIN.INI file in notepad and add/modify the application directory under the [InTouch] heading to reflect the desired application to be run as a service:

ApplicationDirectory= <Path to application directory>

Configuring an InTouch Application Running as a Service to Run as a Normal Application:

1. When WindowViewer is running as a service, you will no be able to open Application Manager until the service has been stopped. Stop the WindowViewer service by right clicking on the Wonderware WindowViewer service and selecting stop.

2. Once the service is stopped, highlight the application in and navigate to Tools → Node properties

3. On the App Development tab select the None option and click OK to save the changes:

3. WindowViewer will no longer run as a service on startup and can be started as a normal application from application manager or the WindowViewer shortcut!

Connecting WindowViewer to Historian

1. On the InTouch WindowViewer Machine, open the desired project in WindowMaker.  Navigate to File → Configure → Historical Logging → Historian Logging:

Make sure the “Enable storage to historian” box is checked. Enter the PC Name of the remote Historian computer in the “Historian node name” field:

In addition, each tag you would like to historize will need to have the “log data” box selected in the details section for the tag in the Tagname Dictionary:

Troubleshooting Common Issues When Running WindowViewer as a Service and Connecting to a Remote Historian

Problem # 1: The WindowViewer service shows as running but no data is being logged to the Historian. 

The following error is observed in the OCMC logger on the InTouch node:

The following 4625 Audit Failure is observed in Windows event logs on the Historian node:

The following error is observed in the OCMC logger on the Historian Node:

Solution: The AVEVA Network Account must exist on both the InTouch and Historian nodes and must be configured as the current AVEVA Network Account. To change/modify the Network Account:

1. Stop the Wonderware Windows Service from services.msc. Navigate to Windows Start → AVEVA → Change Network Account:

2. Run the Change Network Account utility on both the InTouch and Historian nodes using the same account/password. Click OK to confirm the changes:

3. You will be prompted to reboot. Select OK to restart the PC:

*If your Historian is version 17 or newer, and no other AVEVA applications are installed on the Historian Server PC, the AVEVA Network Account will not be present on the machine.  In this case, you will need to manually create and add the user to one of the Historian security groups (aaUsers, aaPowerUsers, aaAdministrators) and run the aahSecurity utility which can be found in the following directory:

C:\Program Files (x86)\Wonderware\Historian\x64\aahsecurity.exe

Problem # 2: The error "Error 1069:The service did not start due to a logon failure' when attempting to start the WindowViewer service:

Solution: The account used to run the WindowViewer service will need to be given Log on as a service rights and removed from Deny log on as a service. Deny log on as a service overrides Log on as a service so make sure to check both places.

1. Navigate to Local Security Policy → Local Policies → User Rights Assignment 

2. Add account to “Log on as a service” policy and ensure it is removed from “Deny log on as a service" policy:

Problem # 3: The error message "Error 1053: The service did not respond to start” is observed when attempting to start the WindowViewer service: 

Solution: The account running the service will need to be added to the local administrators group on the InTouch Node. 

Problem # 4: WindowViewer will not longer open as a normal application after configuring WindowViewer to start as a service. The following error is observed in the logger when launching application manager:

Solution: You cannot start application manager or run WindowViewer as a normal application when running WindowViewer as a Service. Please follow the steps above to run WindowViewer as a normal application and try again!

Problem # 5: Application Manager will not open after configuring WindowViewer to run as a service. We see the following error in the OCMC:

Solution: Application Manager cannot be opened when an InTouch WindowViewer session is running as a service. Please stop the service manually from the services console by right-clicking on Wonderware WindowViewer service → Stop. Once this service has stopped, Application Manager will open as normal:

Additional Facts and Considerations

• WindowViewer as a service will not use a subscription from CONNECT, and will use the traditional perpetual license.
• No UI Interaction. WindowViewer will run in session 0 and not display a GUI. 
• No pop-up dialogs or messages.  Scripts that rely on user interaction may fail silently. 
• Startup dependencies must be configured to start before WindowViewer launches.