The Wonderware Collector

GE Data Collector for Wonderware® Data

The GE Data Collector for Schneider Electric Software’s Wonderware ® Historian gathers data samples from a Wonderware Historian 2014 R2 Server application and stores the corresponding data entries in the Historian Server.

Note: Wonderware is a registered trademark of Schneider Electric Software.

This collector supports collecting of analog, digital and string types of data from the Wonderware Historian Server. This collector supports a distributed model, where the Wonderware Historian Server, the Historian Data Collector, and GE Historian software are installed on different machines. Typically, however, the collector is installed on the same computer as the Wonderware Data Archiver and sends data to a remote GE Historian server.

The GE Data Collector for Wonderware uses unsolicited collection, whereby changes to the Wonderware tags are detected, and are forwarded to the Historian server. Raw samples from the Historian Data Collector for Wonderware are duplicated into the GE Historian data archive.

One GE Data Collector for Wonderware can collect data from a single Wonderware Historian server. To collect from multiple Wonderware Historian servers to an Historian archiver, you must install multiple collectors.

Note: The ODBC Driver for the SQL Server is required for the Historian Data Collector for Wonderware installation; however, the ODBC Driver for SQL does not ship with Historian. If the ODBC Driver for SQL is not installed, the Historian Data Collector for Wonderware will not connect to the Wonderware server. If you install the Historian Data Collector for Wonderware on a machine that does not contain the Wonderware server, be sure to install the ODBC Driver for SQL on the machine with the Historian Data Collector for Wonderware.
Limitations: If you want a domain user to use the Wonderware collector, after you add an instance of a collector, when you later configure it, do not provide values in the User Name and Password fields. This is because ODBC Driver uses Windows authentication.

Installation Prerequisites

The Historian Data Collector for Wonderware requires the installation of the SQL server native client (sqlncli.msi), which can be downloaded from the following link:

https://support.microsoft.com/en-us/kb/2726013

GE Data Collector for Wonderware Features

The following table outlines the features of the GE Data Collector for Wonderware.

FeatureCapability
Browse Source for TagsYes*(on a Wonderware server that supports browsing)
Browse Source for Tag AttributesYes
Polled CollectionNo
Minimum Poll Interval100 ms (milliseconds)
Unsolicited CollectionYes
Time stamp Resolution1 ms
Floating Point DataYes
Integer DataYes
String DataYes
Python Expression TagsNo
Time Assigned
Note: You must set this field to Source as the GE Data Collector for Wonderware only supports unsolicited tags.

Hierarchical Tags Available in Browse

The Schneider Electric Wonderware server supports the hierarchical organization of your tags in a tree structure. Historian uses the server's hierarchy allowing you to browse GE Data Collector for Wonderware in the Non-Web Administrator mode.

To browse for data collector tags in a hierarchy:

Procedure

  1. Browse your Wonderware data source for new Wonderware data tags.
  2. From the Collector list, select the GE Data Collector for Wonderware you wish to browse. A hierarchical tree appears in the Browse Results window.
  3. To limit the displayed tags to only those that are not collected, from the Show Only list select Source Tags Not Collected from the drop-down menu.
  4. To limit the displayed tags to match a tag name or tag description, enter the value to match in the Source Tag Name or Description text boxes.
  5. Navigate to the node in the tree you want to browse, and then select Browse. The tags within the selected portion of the Wonderware tag hierarchy will be displayed
  6. Select the tag(s) you want to add to Historian, and select Add Selected Tags. Collected tags appear in black text in the tag list.
    Note: If Wonderware collector encounters null value at the time of collecting data, it will be ignored and that specific sample will not be sent to the Historian server.

GE Data Collector for Wonderware Supported Data Types

The following table lists the data types recommended for use with Historian.

Data TypesRecommended Historian Data Types

Analog- EuroFloat

Double Float

Analog- MSFloat

Double Float

Analog- MSDouble

Double Float

Analog- Integer

Double Integer

Discrete

Single Integer

String

Variable String

Configuring GE Data Collector for Wonderware

To access the Configuration section for the GE Data Collector for Wonderware, select the Data Collector for Wonderware from the list on the left of the Administrator Tool Collectors section and then select Configuration. A page similar to the following appears:

Collector-Specific Configuration for the GE Data Collector for Wonderware

Enter the value for the GE Data Collector for Wonderware-specific field parameters:

FieldDescription

Server Name

Wonderware Server InSQL Database Server name.

User Name

Wonderware Server InSQL Database User name, for example, wwUser.

Password

Wonderware Server InSQL Database password, for example, XXXXXX.

Recovery Time (hours)

Recovery logic is activated when the GE Data Collector for Wonderware and Wonderware Historian re-establish a connection after a connection loss, or when the GE Data Collector for Wonderware is started.

The GE Data Collector for Wonderware attempts to recover all data samples between the current time and the last known write time, up to a maximum number of hours configured for the collector. Continuous collection resumes only after the previous data has been recovered.

Note: The default recovery time is 0 hours.

Refer to Configuring Recovery Time for the GE Data Collector for Wonderware.

Throttle (Milliseconds)

Frequency of Wonderware data polling.
To minimize the load on the Wonderware Server, the configurable throttling option is provided by the GE Wonderware Collector. By default, GE Wonderware Collector tries to query the tag data every 100 milliseconds based on the collection interval time. You can change this value to any time between 100 milliseconds to 16 hours.
Note: If Throttle field is blank, enter the required minimum value of 100 milliseconds.

Refer to Configuring a Throttle Value.

Data Recovery

This topic explains auto and manual data recovery.
Note: It is recommended that the collector for which the data recovery is intended is in the same time zone as the server. If there is a mismatch, there is a possibility that data recovery will be incomplete.

Auto Data Recovery

When the auto recovery logic is executed, the collector first determines how long it has been since the last write. It compares the current time to data in the registry key LastSampleWriteTime, which stores the last time data was written to the archive. The collector compares this to the Max Recovery Time that is specified in the user settings and performs a raw data query on the shorter of these two periods. Then it takes the shorter of these two and do a raw data query for all tags. It then processes the returned samples in sequential order based on time.

For example, if the collector was shut down for 8 hours, but Max Recovery Time was 4 hours, only 4 hours of data would be recovered.

Recovery logic places an end-of-collection marker at the point in time where the collector was shut down. This end-of-collection marker may or may not be there once the recovery is complete. As part of recovery logic, if recovery data point time exactly at that timestamp where the end-of-collection marker is there, then it is overwritten with the recovered good data.

Initiating Manual Recovery

Manual recovery can be performed from Historian Administrator. Manual recalculate is done for filling the data gaps but not for filling old data.

It is advised to keep the Wonderware collector in the same time zone as the Wonderware server. If there is a mismatch, there is a possibility that auto recovery of data will be incomplete.

To initiate manual recovery:

Procedure

  1. In Historian Administrator, select the Wonderware collector.
  2. Select Recalculate. The Recalculate window appears.
  3. Enter the start and end time and choose all or selected tags based on the criteria from Recalculate window.
  4. Select Recalculate.
    Once manual recalculate starts, the collector recovers selected tags data from Wonderware server to GE Historian between start time and end time.

    It is advised to choose small time intervals, so that the load on Wonderware server/collector will be reduced.

    Note: At the time of recovery, if the connection to Wonderware Server is lost, and if the reconnect mechanism is enabled, the collector will try to connect to the server and pull the data once connection reestablishes.

    Example:

    Assume that the Collector connected to GE historian for the first time today and the archive was created at 10 am. The user initiates manual recalculation from 1am to 2am.

    For that time interval, the archives were not even created. With respect to Historian it is old unknown data and the data write fails.

    If there is a data gap between 1pm to 2 pm, manual recalculation successfully fills the data gap.

Configuring Recovery Time for the GE Data Collector for Wonderware

Procedure

  1. Start Historian Administrator.
  2. Select the Collectors page.
  3. Select the GE Data Collector for Wonderware.
  4. Select Configuration.
  5. In the Recovery Time field, enter a recovery time in hours.

Configuring a Throttle Value

Procedure

  1. Start Historian Administrator.
  2. Select the Collectors page.
  3. Select the Historian Data Collector for Wonderware.
  4. Select Configuration.
  5. In the Throttle (Milli Sec) field, enter the polled collection interval.
    Note: : If the Throttle field is blank, enter the required value if the value is not 100 milliseconds.

Reconnecting to the Wonderware Server

About this task

The GE Data Collector for Wonderware supports auto-reconnect to the Wonderware Server. If the connectivity between the Wonderware server and the collector is down due to network connectivity issues, the collector will auto-reconnect to the server when the server is back and running. The collector polls for the server connection for a set time of every 5 seconds. The collector shuts down when the reconnect functionality is disabled.

To enable Auto-Reconnect to the Wonderware Server:

Procedure

  1. From the Start menu, select Run and type Regedit, then, select OK.
    The Registry Editor appears.
  2. Open the key folder: HKEY_LOCAL_MACHINE\SOFTWARE\GE Digital\iHistorian\Services\ WonderwareCollector.
  3. Create a new DWORD labelled, EnableReconnect.
  4. Enter the decimal value 1.
  5. Select OK, then close the Registry Editor.
  6. Restart the Historian Data Collector for Wonderware for the change to take effect.
    Important: If this registry is not created and set to a value of 1, then the auto-reconnect functionality will not be enabled.
    To configure the timer:
    1. From the Start menu, select Run and type Regedit. Then, select OK. The Registry Editor appears.
    2. Open the key folder: HKEY_LOCAL_MACHINE\SOFTWARE\GE Digital\iHistorian\Services\ WonderwareCollector.
    3. Create a new DWORD labelled, ReconnectInterval.
    4. Enter a decimal value greater than 5. This value represents the number of seconds for the collector to wait before trying to re-connect to the Wonderware Server.
    5. Select OK, and then edit the Registry Editor. Min Value = 5 seconds (default) Max Value = 60 seconds
    6. Select OK, and then edit the Registry Editor.
    7. Restart the GE Data Collector for Wonderware for the change to take effect.

Troubleshooting GE Data Collector for Wonderware

The Data Collector for Wonderware generates logs during initialization, configuration, and general operation. These can be found in the general logging folder C:\Proficy Historian Data\LogFiles.

Troubleshooting Tips

  • Be sure to run the Wonderware server before the Historian Data Collector starts up.
  • If the Historian Data Collector for Wonderware does not start automatically, refer to the Historian log file to view log entries to determine the problem.