{"id":63636,"date":"2023-10-31T13:25:30","date_gmt":"2023-10-31T05:25:30","guid":{"rendered":"https:\/\/oihelp.corporate.ifs.com\/help\/?page_id=63636"},"modified":"2024-06-21T13:37:50","modified_gmt":"2024-06-21T05:37:50","slug":"cygnet-adaptor-features","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/primers\/datasources\/cygnet-adaptor-features\/","title":{"rendered":"CygNet Adaptor Features"},"content":{"rendered":"\n<p class=\"intro-text\">The CygNet Adaptor supports the GE CygNet Data Collector version 9.4 and later.\u00a0<\/p>\n<p class=\"intro-text\">The CygNet Adaptor provides standardised access to the GE CygNet Data Collector, hiding the complexity of obtaining data from CygNet.<\/p>\n<p class=\"intro-text\">The CygNet Adaptor requires the GE CygNet Data Collector API to be installed to access real-time and historical data from the GE CygNet Data Collector. This requires a license for the GE CygNet Data Collector API, which is a third party component.<\/p>\n<h2 class=\"page-subheading\">Adaptor Parameters<\/h2>\n<table>\n<tbody>\n<tr style=\"border: 1px solid #cccccc;\">\n<td width=\"170\"><strong>Parameter<\/strong><\/td>\n<td><strong>Description<\/strong><\/td>\n<td><strong>Name<\/strong><\/td>\n<td><strong>Type<\/strong><\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Point Service<\/td>\n<td>[DOMAIN]INSTANCE.<strong>PNT<\/strong><br \/>\nName of the CygNET Point Service to connect to for getting tag configurations.<\/td>\n<td>PointService<\/td>\n<td>String<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Table Reference Service<\/td>\n<td>[DOMAIN]INSTANCE.<strong>TRS<\/strong><br \/>\nName of the CygNET Table Reference Service to connect to for getting the configuration of enumerations (digital state sets).<\/td>\n<td>TableReferenceService<\/td>\n<td>String<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Universal Interface Service<\/td>\n<td>[DOMAIN]INSTANCE.<strong>UIS<\/strong><br \/>\nName of the CygNET Universal Interface Service to connect to for fetching the current value of tags.<\/td>\n<td>UniversalInterfaceService<\/td>\n<td>String<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Value History Service<\/td>\n<td>[DOMAIN]INSTANCE.<strong>VHS<\/strong><br \/>\nName of the CygNET Value History Service to connect to for fetching historical value of tags.<\/td>\n<td>ValueHistoryService<\/td>\n<td>String<\/td>\n<\/tr>\n<tr style=\"border: 1px solid #cccccc;\">\n<td>Tag Discovery Source<\/td>\n<td>The CygNET service or services to use for discovering tags. The 'All' option uses both the Point Service and the Value History Service.<\/td>\n<td>TagDiscoverySource<\/td>\n<td>String<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<hr \/>\n<h2 class=\"page-subheading\">Features<\/h2>\n<p class=\"intro-text\"><strong>Boolean Support<\/strong><\/p>\n<p class=\"intro-text\">The CygNet adaptor gets the true (DigitalOnString) and false (DigitalOffString) strings from the CygNet API and uses these to parse Boolean values. The fallback mechanism is as follows:<\/p>\n<ul class=\"intro-text\">\n<li>If a string starts with \"0\" then it's considered false.<\/li>\n<li>If it starts with \"1\" then it's true.<\/li>\n<li>If the string is \"true\" or \"false\" (case doesn't matter) then those will also be recognized.<\/li>\n<\/ul>\n<p>&nbsp;<\/p>\n<hr \/>\n<h2 class=\"page-subheading\">Prerequisites<\/h2>\n<p class=\"intro-text\">The Data Broker Service will need to run as a service account that has read-only permissions to the CygNet instances you intend to connect to, as the CygNet Adaptor runs inside the Data Broker Service. Ensure that this account has the required permissions.<\/p>\n<p class=\"intro-text\"><strong>Note<\/strong>: There are some per-user registry entries that are used by the Global Scripting API to connect to a given host server. Therefore, an administrator will need to login to the server with the service account, (will need to temporarily allow interactive logon is this is denied by default for service accounts) and use the <strong>CInstall<\/strong> utility to connect to CygNet system ARS.\u00a0<\/p>\n<p class=\"intro-text\">As part of the configuration, you will need the details of the four CygNet API services that the adaptor needs. These will be in the format of\u00a0 <strong>[DOMAIN]INSTANCE.SERVICE<\/strong>. The default domain for CygNet installs is 8300, you may pass this on when requesting the details of the services.<\/p>\n<p class=\"intro-text\">You will need the details for the following:<\/p>\n<ul class=\"intro-text\">\n<li class=\"intro-text\">[DOMAIN]INSTANCE.<strong>PNT<\/strong> \u2013 Provides tag configuration.<\/li>\n<li class=\"intro-text\">[DOMAIN]INSTANCE.<strong>TRS<\/strong> \u2013 Provides enumeration types (Digital State Sets).<\/li>\n<li class=\"intro-text\">[DOMAIN]INSTANCE.<strong>UIS<\/strong> \u2013 Used for fetching the current value tags (single point).<\/li>\n<li class=\"intro-text\">[DOMAIN]INSTANCE.<strong>VHS<\/strong> \u2013 Used for fetching historic data for tags.<\/li>\n<\/ul>\n<p>&nbsp;<\/p>\n<hr \/>\n<h2 class=\"page-subheading\">Installation and Upgrade<\/h2>\n<p class=\"intro-text\">1. Stop the Data Broker service (and everything that depends on it, such as Sentinel).<\/p>\n<p class=\"intro-text\">2. Extract the zip file to a location on the server.<\/p>\n<p class=\"intro-text\">3. Copy the entire Cygnet folder, including all files, to the Adaptors folder on the server (default path: <em>C:\\Program Files\\P2 Energy Solutions\\P2 Explorer\\Data Broker\\Adaptors<\/em>). <br \/>\n<strong>Note<\/strong>: If the adaptor does not appear in the list of adaptors, right click on each file and check that they are not marked as blocked by Windows.<\/p>\n<p class=\"intro-text\">4. The included <strong>Dclnd.dll<\/strong> libraries are COM libraries and must be registered. To do this, run the command prompt in Administrator mode, navigate to the folder location for the CygNet Adaptor, and run the following command to register the dll. <strong><em>regsvr32 Dclnd64.dll<\/em><\/strong><\/p>\n<p class=\"intro-text\">5. Start the Data Broker service (and everything that depends on it). <br \/>\n<strong>Note<\/strong>: The Data Broker Service needs to be run by an account which has permissions to access (read permissions) from CygNet so that it can interface with it.<\/p>\n<p class=\"intro-text\">The CygNet adaptor should now be available in the list of \u2018Tag\u2019 data source adaptors in IFS OI Server Management.<\/p>\n<p class=\"intro-text\">6. In Server Management, create a CygNet datasource and update the <strong>Data Object Discovery Timeout<\/strong> to 5 minutes.<\/p>\n<p class=\"intro-text\">7. Add the details of the four CygNet API services into the matching Adaptor Parameter fields.<\/p>\n<p class=\"intro-text\">8. If you are upgrading to the latest version of the adaptor, delete all existing CygNet datasource tags.<\/p>\n<p class=\"intro-text\">9. Click <strong>Discover Tags<\/strong> to fetch tags from CygNet.\u00a0<\/p>\n<p class=\"intro-text\">10. Click Save.<\/p>\n<p><a href=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2023\/10\/Snag_1a812495.png\" rel=\"lightbox-0\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone wp-image-63672 size-full\" src=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2023\/10\/Snag_1a812495.png\" alt=\"CygNet Adaptor Parameters\" width=\"1910\" height=\"885\" srcset=\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2023\/10\/Snag_1a812495.png 1910w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2023\/10\/Snag_1a812495-768x356.png 768w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2023\/10\/Snag_1a812495-1536x712.png 1536w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2023\/10\/Snag_1a812495-150x70.png 150w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2023\/10\/Snag_1a812495-600x278.png 600w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2023\/10\/Snag_1a812495-1080x500.png 1080w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2023\/10\/Snag_1a812495-1280x593.png 1280w, https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2023\/10\/Snag_1a812495-48x22.png 48w\" sizes=\"auto, (max-width: 1910px) 100vw, 1910px\" \/><\/a><\/p>\n<hr \/>\n<h2 class=\"page-subheading\">Troubleshooting<\/h2>\n<h3>Tag Discovery Error<\/h3>\n<p class=\"intro-text\"><strong>Problem<\/strong>: The following error appears during Tag Discovery:<\/p>\n<p class=\"intro-text\">9\/23\/2021 9:53:12 AM,Error,,Process(IDataBrokerRequest): request will be Failed; adaptor method leaked exception (CygNet.Data.Core.MessagingException: DCL error (-24)\u00a0'Requested DCL function was not found in Dclnd.dll or Dclnd64.dll.'),Adaptor.TimeSeries.CygNET Adaptor,P2 Server,(null),(16),fe80::a537:d294:ea94:baf6%4,pdcprocntprod,P2.Server.DataBroker.Service.exe,0,CygNet.Data.Core.MessagingException: DCL error (-24) 'Requested DCL function was not found in Dclnd.dll or Dclnd64.dll.' .\u00a0\u00a0 at CygNet.API.Points.InternalConfigClient.Connect(DomainSiteService domainSiteService) .\u00a0\u00a0 at CygNet.API.Points.ConfigClient..ctor(DomainSiteService serviceName) .\u00a0\u00a0 at P2.Server.Adaptors.CygNet.CygNetAdaptor.OnInitialize(AdaptorInitializationRequest initializationRequest) .\u00a0\u00a0 at P2.Server.DataBroker.Adaptors.TagAdaptor.Process(IDataBrokerRequest request).<\/p>\n<p class=\"intro-text\"><strong>Cause<\/strong>: COM libraries are not registered.<\/p>\n<p class=\"intro-text\"><strong>Resolution<\/strong>: Open the command prompt, navigate to the CygNet Adaptor folder, then run <strong>r<\/strong><strong>egsvr32 Dclnd64.dll<\/strong> to register the dll.\u00a0<\/p>\n<h3>Tag Discovery Timeout<\/h3>\n<p class=\"intro-text\"><strong>Problem<\/strong>: Tag Discovery times out.<\/p>\n<p class=\"intro-text\"><strong>Cause<\/strong>: The discovery process had not finished before the timeout period.\u00a0<\/p>\n<p class=\"intro-text\"><strong>Resolution<\/strong>: In the adaptor configuration page in IFS OI Server Management, set the <strong>Data Object Discovery Timeout<\/strong> to 5 minutes.\u00a0<\/p>\n<p>&nbsp;<\/p>\n","protected":false},"excerpt":{"rendered":"<p>The CygNet Adaptor provides standardised access to the GE CygNet Data Collector, hiding the complexity of obtaining data from CygNet. This article describes how to configure the adaptor and perform tag discovery.<\/p>\n<p class=\"continue-reading-button\"> <a class=\"continue-reading-link\" href=\"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/primers\/datasources\/cygnet-adaptor-features\/\">Read more<i class=\"crycon-right-dir\"><\/i><\/a><\/p>\n","protected":false},"author":1,"featured_media":63675,"parent":3668,"menu_order":3,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":"","_members_access_role":[],"_members_access_error":""},"categories":[9],"tags":[1140],"class_list":["post-63636","page","type-page","status-publish","has-post-thumbnail","hentry","category-tech-ref","tag-cygnet","Product-srv"],"_links":{"self":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/63636","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/comments?post=63636"}],"version-history":[{"count":39,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/63636\/revisions"}],"predecessor-version":[{"id":67497,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/63636\/revisions\/67497"}],"up":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/3668"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media\/63675"}],"wp:attachment":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media?parent=63636"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/categories?post=63636"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/tags?post=63636"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}