Show historical alarms and/or events

You can set the Alarm Control to show one of the following:

• Historical alarms from the Alarm Database

• Historical events from the Alarm Database

• Historical alarms and events from the Alarm Database

• Historical events from History Blocks

• Historical alarms from History Blocks

• Historical alarms and events from History Blocks

When you configure the Alarm Control to show historical alarms and/or events, you also configure the following:

• Server name hosting the Alarm Database

• Authentication information to connect to the Alarm Database

• Maximum number of records to retrieve from the Alarm Database

• Time range or duration to show in the Alarm Control

• If the Alarm Control should update to the current client time

Alarm Control works with both the ArchestrA Database (A2ALMDB) and with History Blocks.

Use the following properties in scripting to switch the client mode and configure the database connection, such as:

• ClientMode property

• Database.Authentication property

• Database.Name property

• Database.Password property

• Database.ServerName property

• Database.UserID property

• Domain property

To show historical alarms and/or events

1. Double-click the Alarm Control on the canvas. The Edit Animations dialog box appears.

2. Click Alarm Mode. The Alarm Mode page appears.

3. In the Client Mode list, click:

   • Historical Alarms to only show alarms from the Alarm Database. No events are shown

   • Historical Events to only show events from the Alarm Database. No alarms are shown

   • Historical Alarms and Events to show both alarms and events from the Alarm Database

     

4. In the Authentication Mode list, click one of the following:

   • Windows Integrated to use the authentication of the currently logged-on Windows user

   • Windows Account to use a given Windows user authentication

   • SQL Server to use SQL Server authentication mode

5. In the Server Name list, either select or type the name of the server hosting the Alarm Database.

   Provide the port number with the server name when connecting to a non-default port. For example: <servername>,23646. The port number can be changed in the Configurator.

6. In the Database Name box, type the name of the Alarm Database. For the ArchestrA Database, enter A2ALMDB, and for Historian block storage enter History Blocks.

   For the History Blocks option to function correctly, the REST Details > HTTP port (Default 32569) and HTTPS port (Default 32573) on the Historian Server needs to be opened in the firewall, and configured for both inbound and outbound traffic. For more information, see the Configuring Databases and Data File Locations in the System Platform Installation Guide.

   Note: For History Blocks, select Windows Integrated or Windows Account as the authentication mode.

7. From the Credentials drop-down, select the credentials for authentication.The Credentials field is enabled only when you select Windows account or SQL Server authentication type. The Windows Integrated authentication method uses the credentials of the user currently logged in, and disables the Credentials field.

   Note: For standalone InTouch applications, the credentials are retrieved from the Application Manager. For managed InTouch applications, the credentials are retrieved from the Credential Manager of the Application Server. For more information, see Work with Credential Manager in the AVEVA™ InTouch HMI Application Development Guide.

   You can also select Use username and password to enter the credentials.

   1. If you are using Windows Account authentication mode, type the domain, user name, and password in the Domain, User Name and Password boxes.

   2. If you are using SQL Server authentication mode, type user name and password in the User Name and Password boxes.

8. Click Test Connection. The connection to the Alarm Database is tested and a result message appears. If necessary, check your authentication information.

   If the Historian requires a secure connection and the client is not configured with the correct certificates, then an error message is displayed.

9. Click OK.

To set maximum records and time range

10. Double-click the Alarm Control on the canvas. The Edit Animations dialog box appears.

11. Click Alarm Mode. The Alarm Mode page appears.

12. Make sure the Client Mode is set to Historical Alarms, Historical Events, or Historical Alarms and Events.

13. In the Maximum Records box, type the number of records to view from the control at one instance. The valid range of maximum records is from 1 to 32766.

    You can also use the MaxDatabaseRecords Property in scripting to set the maximum records at run time.

14. To use a pre-defined time interval, select an interval from the middle list of the Time Range pickers.

    

15. To use a specific start time and end time, clear Update to Current Time, and select the start time from the list at the left and the end time from the list at the right of the Time Range pickers.

    

    You can also use the TimeSelector.* methods and properties in scripting to set the start date, end date, or duration at run time. For more information, see TimeSelector property.

16. Click OK.