Configuring General Logging Properties - Storage to Historian

You can set general logging properties that apply to the selected application.

To configure storage to Historian

1. If necessary, close the InTouch application running in WindowViewer.

2. Open WindowMaker.

3. On the File menu, click Configure, and then click Historical Logging.

   The Historical Logging configuration screen appears.

4. Select the Historian Logging tab.

   

   For more information about setting up trend printing, see Printing a Trend at Run Time.

5. Select the Enable storage to Historian check box.

6. In the Historian node name box, type the node name of the computer running the Historian server. You can also specify the IP address and if the server is installed on the same machine you can use ‘localhost’. Only the following special characters are allowed; full stop (.), underscore (_) and hyphen (-).

7. In the History store forward directory box, type the path to the local folder location where the files related to store forward are stored. The files will allow the historical data to stored temporarily if the connection to the Historian server is lost. After the connection is established, the Historian server will sync with the files from this store forward directory and preserve all information.

8. Update the Advanced Settings section to specify settings related to the Historian connection.

   1. Under the Connection section, you can specify the TCP Port. The TCP port on the Historian Server node to which history data will be sent. The TCP port is configured when the Historian Server is installed. The default port is 32568.

   2. Under the Bandwidth Optimization section, you can select the Enable compression checkbox. Once selected you can specify:

      • Throttling network bandwidth: Specifies limit of bandwidth usage, in kbps, for network communication used by HCAL when communicating with the Historian. A value of 0 disables this feature (default). For more information on estimating your bandwidth needs, see the performance and sizing recommendations for the Historian Server in the System Platform Installation Guide. The allowed values are 0 kbps to 65535 kbps.

      • Wait to send incomplete packets: Specifies the maximum time, in milliseconds, for keeping a partially-filled Historian Client Access Layer (HCAL) buffer before sending it to the Historian Server. If the buffer is full, then it is sent immediately, regardless of any value configured in this field. If you have fast-changing data, this setting is irrelevant. If you have slow-changing data and limited network bandwidth, you might want to increase this value so that you have less "chatter" on the network. The allowed values are 1000 milliseconds to 30000 milliseconds.

   3. Under the Data Management section, you can specify:

      • Pre-processing buffer size: The total size, in MB, of all buffers used by Historian Client Access Layer (HCAL). The default and minimum value is 8. If you have very high data bursts, then you should increase this value. If this is too low, data loss occurs and error messages related to buffer overflows appear in the Logger. Increase this value in increments of 10 MB. The allowed values are 8 MB to 65535 MB

      • Store forward threshold: The size, in MB, of free space to reserve on the HCAL store-and-forward disk. The space designated will not be used during store-and-forward. This value cannot be a negative number. The allowed values are 0 MB to 65535 MB

      • Store forward minimum duration: The minimum duration, in seconds, for HCAL to function in store-and-forward mode. HCAL will function in store-and-forward mode for this length of time even if the condition that caused HCAL to function in store-and-forward mode no longer exists. The allowed values are 30 seconds to 3600 seconds.

      • Select the Reconnect as soon as possible and do not mark disconnects checkbox: Specifies how trends appear during communication disconnects between Application Server and Historian. It does not affect how trends of history data appear after communications have been restored. If TRUE, no gap will appear in client-side trends for the disconnect interval. While disconnected, the interval is filled in with the last-received value before the disconnect. If FALSE, a gap will appear in client-side trends for the disconnect interval. NULL values are injected on disconnect to create the gap. In both cases, after reconnect, the interval will be filled in with store-and-forward data.

   4. Click Save.

9. Select Log Alarms and Events to enable logging alarms and events. Specify the alarm query in the Alarm Query text box.

   Note: If different InTouch applications store tag data to the same Historian server and use the same tag name, the InTouch applications will not detect such a scenario and may cause the Historian data to overlap. Use a unique prefix or suffix to differentiate between applications. For more information, see Configuring the Affix String.

10. Click OK to save your settings.

    The logging configuration changes become effective immediately. Logging begins the next time you run the application.