Configure the AVEVA Batch Management Reporting Content

You can generate the AVEVA Batch Management reports using the shared datasource in SQL Server Reporting services named "ibReports". These reports are generated from the AVEVA Batch Management History Database and optionally the InTouch or Historian Traditional SQL Alarm Database (WWALMDB or A2ALMDB). In order to execute the reports, these databases must have data sources defined. The History Data Source is required, but the Alarm Data Source is optional (Foxboro DCS configurations will typically not use the Alarm Data Source).

The Configurator checks whether the following prerequisites are installed, before configuring the AVEVA Batch Management History 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.

• A supported version of SQL Server Reporting Services is installed, configured, and accessible. To verify this, you typically should be able to navigate to http://<hostname>/reports without error (or https).

When you configure the AVEVA Batch Management Reporting Content feature, the Configurator does the following:

• Loads the existing 'Production' Shared data sources in the Data source combo box

• Create Shared Data Source in SSRS named 'ibReports' for AVEVA Batch Management Reporting. AVEVA Batch Management Reports will fetch data from Batch History database using this shared data source.

• Set the AVEVA Batch Management Reporting service to the application pool account. This will enable the service to run under the same account. Restart the "BatchManagement_ReportQueReader" service.

• Deploys Foxboro DCS Alarm reporting content, if Foxboro DCS component support is enabled.

• Creates ibReportsUsers OS groups and assigns 'Browser' pre-defined SSRS role.

• Creates the environment variables.

• Starts the Report Queue Reader service.

• Creates the InBatchReportsAppPool and sets to run as the same user (identity) as ReportQueReader – so that it has read/write access to the BatchHistory database. The Application Pool user should have as few OS privileges as possible. For more information, see "Application Pool User Privileges".

• Copies the BatchTimeExtensions.dll from "C:\Program Files\AVEVA\Batch Management\Bin" to "C:\Program Files\Microsoft SQL Server\MSRS12.MSSQLSERVER\Reporting Services\ReportServer\bin" in Report Server computer. The SQL Server instance varies based on the SQL Server version and SQL Server instance.

  NOTE: In the case of the remote computer, you need to manually copy “BatchTimeExtensions.dll” file from "C:\Program Files\AVEVA\Batch Management\Bin" to "C:\Program Files\Microsoft SQL Server\MSRS12.MSSQLSERVER\Reporting Services\ReportServer\bin" location before configuring Reporting Content with remote computer for SSRS SQL Server.

• Creates the Reports folder in the Reporting service url (http:\<localhostname>\BatchManagement Reports), where the reports (.rdl) templates are deployed.

  IMPORTANT:
  - Ensure you verify that the SSRS home page is working correctly before you configure the AVEVA Batch Management Reporting feature.
  - If the AVEVA Batch Management Reporting Content Configuration times out for the first time, try the configuration again. Or refer to the SSRS documentation for more details.
  - When you perform a fresh install of Batch Management, the url is http:\<localhostname>\BatchManagementReports. However, if you upgrade to the latest version of Batch Management from any previous versions, the url is http:\<localhostname>\InBatchReports.
  - We recommend that you delete any existing "AVEVA Batch Management Reports" under SSRS, before you configure the AVEVA Batch Management Reports. 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".

To configure the Batch Management Reporting Content

1. Click Reporting Content in the left pane. The configuration options appear in the right pane.

   

2. In the System Configuration area, you can configure the following:

   1. 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.

   2. Enter the SQL Server instance name in the History Server SQL Instance Name box.

   3. Enter the name of the history server database in the History Database Name box.

3. In the History Database Modification - SQL Login Information (SQL sysadmin - installation only) area, you can configure the following:

   • Click Windows Authentication to use the interactive user’s account.

   • Click SQL Server Authentication and specify the User Name and the Password. This connection information is used only for completing the configuration.

4. In the SQL Server Reporting Service (SSRS) area, specify the named instance of SQL Server.

   NOTE: The specified credentials are used to establish a connection with the default instance of SQL Server on localhost or remote host. This connection is used to perform administrative tasks on the databases.

5. In the Service DB Access-Integrated SQL Login Information (HistoryDB read/write - Web & ReportQReader) area, you can configure the following:

   1. 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 ReportQueReader service. The ReportQueReader 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 Report Administration and Report Display web applications (AppPool user).

   2. Enter the password in the Password box.

   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 Batch Management Report Administration web site as a domain user, then this user also needs to be a domain user. It is typically the same user used for the History Server feature. If this user's credentials ever change, you will need to rerun Configurator.

6. In the History Data Source Configuration area, the History database name is displayed. This is the same database which is used while configuring the AVEVA Batch Management History Server. Click Details to view the History database server name and the History database name.

7. In the Alarm Data Source Configuration area, the alarm data source details are displayed. You can click Details to define a new one. For more information, see "Defining a New Alarm Data Source".

8. In the SSL Certificate section, select the existing self-signed certificate from the Name drop down box. In this manner, the History Server and Reporting Content websites can be set up to use the same certificate that was already configured.

9. Click Configure. A green check icon appears in the left pane when AVEVA Batch Management Reporting Content is successfully configured.

Define a New AVEVA Batch Management History Data Source

You can define a new history data source using the Configurator.

If SSRS is on a different node than the AVEVA Batch Management HistoryDB and if you want to configure a data source to use Windows authentication, you must set up delegation between the SSRS server and the back end AVEVA Batch Management History server. This is done on the domain controller.

For more information, refer to the Microsoft web site for "Configuring Linked Servers for Delegation".

To define a new history data source

10. In the History Data Source Configuration area, click Details. The History Data Source Details dialog box appears.

    

11. In the Data Source Details area, you can:

    1. Enter the IP address or the name of the computer that hosts the history database server, in the Database Server SQL Instance Name box. For more information on the computer naming conventions, refer to the Host Name Naming Convention topic.

    2. Enter BatchHistory in the Database Name box (or specify the name of your History database if it is different).

12. In the SQL Login Information area, you must specify the credentials to connect to the history database. Do one of the following:

    • Click Windows Authentication to use the interactive user’s account.

    • Click SQL Server Authentication and specify the User Name and the Password. This connection information is used only for completing the configuration.

13. Click Save.

Define a New Alarm Data Source

You can define a new alarm data source using the Configurator.

If the Alarm Database is on a different node than the AVEVA Batch Management History Database and if you want to configure a data source to use Windows authentication, you must set up delegation between the AVEVA Batch Management History server and the back end Alarm Database server. This is done on the domain controller.

For more information, refer to the Microsoft web site for "Configuring Linked Servers for Delegation".

To define a new alarm data source

14. In the Alarm Data Source Configuration area, click Details. The Alarm DataSource dialog box appears.

    

15. In the Data Source Details area, you can:

    1. Enter the IP address or the name of the computer that hosts the alarm database server, in the Database Server SQL Instance Name box.

    2. Enter WWALMDB or A2ALMDB in the Database Name box (or specify the name of your Alarm database if it is different). For more information on the computer naming conventions, refer to the Host Name Naming Convention topic.

16. In the SQL Login Information area, you must specify the credentials to connect to the alarm database. Do one of the following:

    • Click Windows Authentication to use the interactive user’s account.

    • Click SQL Server Authentication and specify the User Name and the Password. This connection information is stored securely in the SSRS data source.

17. Click Save.