Configure the Batch Management History Server
- Last UpdatedOct 25, 2024
- 5 minute read
You can configure the AVEVA Batch Management History Server with the redundancy support enabled or disabled. The Configurator checks whether the following prerequisites are installed, before configuring the AVEVA Batch Management History Server:
-
A supported version of SQL Server
-
A supported version of IIS
NOTE: If any of the required IIS components are missing, a warning message appears in
the Configuration Messages area. You can install the missing prerequisites during configuration.
AVEVA Batch Management supports SQL Server Transport Encryption, and AVEVA recommends
turning it ON. For more information, refer to the documentation of the SQL Server
version you are using.
When you configure the AVEVA Batch Management History Server feature, the Configurator does the following:
-
Configures logins, system alarms, and system categories for the SQL Server.
-
Creates the environment variables.
-
Updates the Windows services file with AVEVA Batch Management TCP/IP application ports and exceptions.
-
Registers the AVEVA Batch Management History Server dll components.
-
Updates the Windows firewall settings for AVEVA Batch Management History Server node.
-
Creates a new IIS Application Pool “InBatchAppPool”.
-
Creates the virtual directory “BatchAdmin”.
-
Retrieves the AVEVA Batch Management site name and adds it to the trusted sites, if it is unsecure.
-
Starts the AVEVA Batch Management History Queue Reader service.
-
Creates AVEVA Batch Management History and AVEVA Batch Management Archive SQL databases.
-
Creates AVEVA Batch Management Archive Template for AVEVA Batch Management History Admin Archive/Purge/Restore functionality.
-
Adds a File Server role.
-
Adds an Application Server role.
-
Allows the Active Server Pages in the IIS Web Service Extensions.
-
Enables the Enable Parent Paths option in IIS for the AdminWeb and AVEVA Batch Management Reports websites.
When you perform a fresh install of Batch Management, the Reports folder name is displayed as "Batch Management Reports". However, if you upgrade to the latest version of Batch Management from any previous versions, the Reports folder name is displayed as "InBatch Reports".
-
Creates a shortcut for History Database Administration on the Start menu.
-
Drops the pre-defined users (BatchAdminUser, BatchUser, and BatchReportAdmin) from the BatchHistory and BatchArchive databases if a pre-11.0 upgrade is detected, and the new Service DB Access is assigned to BatchHistory and BatchArchive databases.
-
Creates the InBatchAppPool and set to run as the same user (identity) as HistQReader - so that it has read/write access to BatchHistory and BatchArchive databases. The Application Pool user should have as few OS privileges as possible. For more information, see "Application Pool User Privileges".
To configure the Batch Management History Server without Redundancy Support
-
Open the Configurator.
-
Click General in the left pane, clear the Enable Redundancy Support check box in the Settings area, and then click Configure.
-
Click History Server in the left pane. The configuration options appear in the right pane.

-
In the System Configuration area, you can configure the following:
NOTE: The System Configuration fields are automatically populated with the default values.
-
Enter the IP address or the name of the computer, on which you have installed the AVEVA Batch Management Server, in the Batch Server Node Name box. For more information on the computer naming conventions, see Host Name Naming Conventions.
-
Enter the name of the history database in the History Database Name box.
-
Enter the name of the archive database in the Archive Database Name box.
-
-
In the DB Creation/Upgrade - SQL Login Information (SQL sysadmin - installation only) area, you can configure one of the following:
-
In the SQL Server Instance Name box, specify the named instances of SQL for local host or the remote server.
-
Click Windows Authentication to use the interactive user’s account.
Or
Click SQL Server Authentication and specify the User Name and the Password. This connection information is used only for completing the configuration and is not stored.
NOTE: A connection with the default instance of SQL Server on local machine is established, using the specified credentials. This connection is used to perform administrative tasks on the databases.
IMPORTANT: The user specified in DB Creation/Upgrade - SQL login Information area must have privileges to add the Service DB Access user login to SQL Server and grant it read/write access to the BatchHistory and BatchArchive databases.
-
-
In the Service DB Access - Integrated SQL Login Information (HistoryDB read/write - Web & HistQReader) area, you can configure the following:
-
Enter the name of the Service DB access user name in the User Name box. The Service DB Access user is used to run the HistQReader service. The HistQReader service Log-On As account will be set to this user and connect to BatchHistory database using integrated authentication in SQL. This user is also used to run the History Administration web application (AppPool user).
NOTE: The Service DB Access User has to be a domain or a local user. This cannot be a standard SQL Server user. If you plan on accessing the AVEVA AVEVA Batch Management History Administration web site as a domain user, then this user also needs to be a domain user. If this user's credentials ever change, you will need to rerun Configurator.
-
Enter the password in the Password box.
-
-
In the Database Configuration area, you can configure the following:
-
Select the Use Existing History Database check box to use an existing history database. Clear the check box to create a new history database.
-
Select the Use Existing Archive Database check box to use an existing archive database. Clear the check box to create a new archive database.
NOTE: If the Configurator detects an older version of the database, you must select the above check boxes to upgrade the database to the latest version of AVEVA Batch Management.
If you want to use an existing database, the Configurator upgrades the following:
-
For History Database - Tables, Views, and StoredProcedures
-
For Archive Database - Tables
-
The Service DB access User (if it does not already exist)
If you want to configure a new database, the Configurator creates the following:
-
Database (BatchHistory/BatchArchive)
-
Users
-
Roles
-
Schema
-
Defaults
-
UserDefinedDataTypes
-
Tables
-
Views
-
StoredProcedures
-
-
In the SSL Certificate section, select the existing self-signed certificate from the Name drop down box.
-
Click Configure. A green check icon appears in the left pane when AVEVA Batch Management History Server is successfully configured.
To configure the Batch Management History Server with Redundancy Support
-
Open the Configurator.
-
Click General in the left pane, select the Enable Redundancy Support check box in the Settings pane, and then click Configure.
-
Click History Server on the left pane. The configuration options appear in the right pane.

-
In the Redundant System Configuration area, enter the IP address or the name of the computer, on which you have installed the other AVEVA Batch Management Server, in the Redundant Batch Server Node Name box.
For more information on the computer naming conventions, refer to the Host Name Naming Conventions topic.
For configuring other fields, see "To configure the AVEVA Batch Management History Server without Redundancy Support".
-
Click Configure. A green check icon appears in the left pane when AVEVA Batch Management History Server is successfully configured.