CygNet data source configuration settings

Each CygNet data source can be added to the connection using the following configurations:

• Data source description

  Optional: Description of the data source configuration.

• Current Value Service (CVS)

  Required: The CVS associated with this data source from which to collect data.

  This list is populated from the default CygNet domain specified on the connector host machine. If the list is empty, verify connectivity to a CygNet domain using the CygNet Domain Administration Utility (CygConn), then restart the connector service.

  The CVS cannot be changed during connector operation. Any changes will be ignored. To modify this data source setting, stop the connector, select a new CVS, and start the connector for the new data source.

• Current Value Service (CVS) scan rate

  Required: The rate, in seconds, to scan the specified CVS. This field must be an integer value greater than 0.

  Note: Setting this value to a fast scan rate can impact system performance for large CygNet systems. We recommend selecting a slower scan rate, assessing system resource impact, and adjusting scan rate as needed.

  The scan rate can be updated without stopping the connector.

• Value History Service (VHS) scan rate

  Required: The rate, in seconds, to scan the associated VHS for the specified CVS. This field must be an integer value greater than 0.

  Note: Setting this value to a fast scan rate can impact system performance for large CygNet systems. We recommend selecting a slower scan rate, assessing system resource impact, and adjusting scan rate as needed.

  This configuration item only applies to those CygNet Points with Point Uniform Data Codes (UDCs) selected to collect from VHS. See the sections below for more information.

  The scan rate can be updated without stopping the connector.

• Query Selected Service (button)

  Populates the Facility Types to Filter or the Point Uniform Data Codes (UDCs) to Filter lists by querying the selected CVS.

  Click the button above the picklist to populate the picklist. The available picklists are: Facility Types to Filter, Point Uniform Data Codes (UDCs) to Filter or Point Uniform Data Codes (UDCs) to collect from VHS. A spinning icon displays while the query is executed. The picklist is updated with the query results after the query completes.

  Note: The query might run for more than 30 seconds on large systems. On large systems, the query might time out and display an error message when it is run for the first time. If the query times out, please retry the query again after a few minutes.

• Facility Types to Filter

  Optional: This setting identifies the CygNet facility types for which you do not want the connector to collect data. This list uses facility types from the CygNet facility service associated with the selected CVS. All facility types are collected by default.

  You can filter out one or more Facility Types. Any Facility Types selected for the Do Not Collect area are ignored, including any child CygNet Points belonging to the Facility, and not mapped to PI AF.

  This list can be updated without stopping the connector. Newly discovered items are mapped to PI AF. Mapped elements that are moved to the Do Not Collect area stop updating.

• Automatic UDCs recognition

  Optional: This marker activates the periodical process of searching for the newly created UDCs. After checked, each period (default is 600 seconds), the connector verifies if there were newly created UDCs that satisfy the logic defined by the regular expression (see the "Regular expression(s) for excluding UDCs"), creates the corresponding PI Points and begins to collect data from them.

  You can change the default by editing the Datasource.config.json file in the %PIHOME64%\Connectors\CygNet\Configuration folder; keyword: CygNetAssetUpdateRate. The minimum allowed value is 60 seconds.

• Prefer VHS for automatic UDC recognition

  Optional: This marker decides whether the newly created UDCs that the connector recognizes and accepts are collected from the VHS or CVS area. If the marker is checked, VHS is used; if not, UDCs are collected from CVS. Existing UDC configurations for CVS and VHS remain unchanged.

• Regular expression(s) for excluding UDCs (semicolon separated)

  Optional: This is a regular expressions filter in the .NET regular expression format. By clicking on the underlying Query Selected Service button, the regular expressions are applied on the existing UDCs in the CygNet system, and those UDCs which pass are then listed in the "Do not collect" picklist. A UDC black-list is created. Every other UDC is included in the "Collect" picklist, and from these the connector starts reading events. If no regular expression is specified (that is, the edit-box remains empty), the connector starts collecting data for all existing UDCs, including those newly created.

  The regular expressions used in this interface for excluding UDCs are in compliance with Microsoft's .NET specification. For example, the expressions shown here might be used for filtering UDCs that:

  • Start with D_ or SY_: ^D_*;^SY_*

  • Contain a string SYS: SYS

  • Contain a number: \d

    For additional information, see Microsoft's "Quick Reference" to the Regular Expression Language.

    Note: If the "Automatic UDCs recognition" marker is activated (checked), the regular expression is considered and is then periodically applied to the newly created UDCs. Consequently, if the configuration page is re-opened, all newly discovered UDCs are then listed in the corresponding picklist.

• Point Uniform Data Codes (UDCs) to Filter

  This selection allows you to manually modify the UDC division between "Collect" and "Do not collect" lists. UDCs from one list can be manually moved to the other list by selecting the UDCs and then pressing one of the arrows on either of the list-boxes. Lists can be updated without stopping the connector. Mapped elements moved to the "Do not collect" area stop updating. Similarly, non-mapped elements moved from the "Do not collect" area to the "Collect" area will be collected by the connector and associated PI AF element data will be sent to the PI System.

  Note: The manual modifications of the UDCs division, represented by the "Collect" and "Do not collect" lists, will only be persisted and applied if the "Automatic UDCs recognition" marker is NOT activated (checked). If this marker is activated, the division logic will only be defined through the regular expression. Even if the UDCs were manually moved from one list to the other, those changes will be ignored when saving the configuration.

• Point Uniform Data Codes (UDCs) to Collect from VHS

  Both picklists "CVS" and "VHS" are populated by pressing the Query selected service button. By default, those UDCs listed in the "Collect" picklist read events from the CVS area, and those newly created end-up in this picklist that is preferred by the "Prefer VHS for automatic UDCs recognition" marker.

  Manual movement of UDCs between both picklists can be performed, nevertheless, the same rule applies as is described in the "Point Uniform Data Codes (UDCs) to filter" paragraph: The changes will be persisted and applied only if the "Automatic UDCs recognition" marker is NOT activated (checked).

• Ignore unreliable data

  Optional: When activated, this marker makes sure those events that have the "Unreliable status" set will be ignored