earth_america
user_standard Log on
action_search_stroke
earth_america
Log on to rate and give feedback 1 2 3 4 5 Log on to rate
0
How to

How to


Products: WebReports
Functionalities: Reports
Product version: 2.0, 2.1, 3.0, 3.1, 3.2, 3.3
12/16/2021

Changing Events and Historical Records Information

You change the number of event records to read and maximum total number of historical records to collect event and historical records. You also edit the file to change the information level. Before you edit the file, review the values that are acceptable.

Show More
action_close

The Reporting Agent configuration file contains values for the following settings:

  • The Reporting Agent failure retry interval

  • The Reporting Agent log file

  • The Reporting Agent event record

  • The Reporting Agent total historical records

The WebReports installation places the configuration file in the Program Files directory, C:\Program Files (x86)\Schneider Electric EcoStruxure\Building Operation WebReports\StruxureWare Reporting Agent. The file name is SE.WebReports.StruxureWareReportingAgent.exe.config. The following table shows the Reporting Agent, number of event records and historical records to read, and log file settings that are in the file.

Table: Reporting Agent Configuration File Settings

Settings

Description

HistoricalDataReadInterval

Indicates how often you want the Reporting Agent to perform Historical Read and send the retrieved data to the Reports Server. The default is recommended.

ASReadInterval

Indicates how often you want the Reporting Agent to read the Automation Server. The default is recommended.

ASReadCount

Indicates the number of data points to be read by the Reporting Agent. The default is recommended.

FailureRetryInterval

Indicates how often you want the Reporting Agent to retry reading the Enterprise Server following a failed attempt to read the Enterprise server. The default is recommended.

DefaultLogLevel

Indicates the information level for the log file. The default is Info. For more information, see Reporting Agent Log File .

FileSize

Indicates the size of the Reporting Agent log file that stores error and informational messages about the Reporting Agent. For more information, see Reporting Agent Log File .

Number of log files

Indicates the number of log files you want to keep. For more information, see Reporting Agent Log File .

numEventRecordToRead

Indicates the number of event records you want to read. The default is recommended.

maxTotalRecordsHistorical

Indicates the maximum number of historical records you want to read. The default is recommended.

During the installation, the WebReports Installer prompts you to enter a value, in seconds, for each Reporting Agent setting. The default values are recommended. The installation also prompts for the log file values. The default values are also recommended.

When you want to modify the Reporting Agent values or the log file values, you edit the Reporting Agent configuration file. You need to enter the Reporting Agent values in milliseconds. The following table shows the default, minimum, and maximum values that you can enter.

Table: Reporting Agent Values

Setting

Default

Minimum

Maximum

HistoricalDataReadInterval (milliseconds)

300000 (5 minutes)

300000 (5 minutes)

86400000 (1 day)

ASReadInterval (milliseconds)

600,000 (10 minutes)

300,000 (5 minutes)

86,400,000 (1 day)

ASReadCount

500

500 (recommended)

1000

numEventRecordToRead

50000

50000 (recommended)

150000

maxTotalRecordsHistorical

50000

50000 (recommended)

250000

FailureRetryInterval (milliseconds)

60000 (1 minute)

60000 (1 minute)

86400000 (1 day)

Log file size

10 MB

1 MB

100 MB

Log file count (Number of log files to save)

10

1

100

To change the events and historical records information
  1. Stop the Building Operation x.y WebReports Agent service from the Microsoft Management Console.

  2. In Windows, navigate to C:\Program Files (x86)\Schneider Electric EcoStruxure\Building Operation WebReports\StruxureWare Reporting Agent

  3. In the Folder Options dialog box, clear Hide extensions for known files option from the folder option for the StruxureWare Reporting Agent folder.

  4. In the StruxureWare Reporting Agent directory, open SE.WebReports.StruxureWareReportingAgent.exe .config in notepad.

  5. For the numEventRecordToRead parameter, type the number of event records that you want to read.

     
    action_zoom_plus_stroke

  6. For the maxTotalRecordsHistorical parameter, type the number of historical records that you want to read.

  7. Save the file.

  8. Start the Building Operation x.y WebReports Agent service.

  • Reporting Agent Configuration File
  • Changing Reporting Agent Logging Information