{"id":64183,"date":"2023-11-24T10:25:37","date_gmt":"2023-11-24T02:25:37","guid":{"rendered":"https:\/\/oihelp.corporate.ifs.com\/help\/?page_id=64183"},"modified":"2025-10-28T18:35:34","modified_gmt":"2025-10-28T10:35:34","slug":"canary-adaptor","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/primers\/datasources\/canary-adaptor\/","title":{"rendered":"Canary Adaptor"},"content":{"rendered":"\n

The Canary Adaptor supports versions 22.0 and later of the Canary Historian.\u00a0<\/p>\n

The Canary Adaptor requires the Canary Historian to be installed to access real-time and historical data from Canary. This requires a license, which is a third party component.<\/p>\n

\n

Adaptor Settings<\/h2>\n

The following tables list the adaptor's parameters, along with the name<\/em> and type<\/em> to be used in the Import\/Export spreadsheet.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Parameter<\/strong><\/td>\nDescription<\/strong><\/td>\nName<\/strong><\/td>\nType<\/strong><\/td>\n<\/tr>\n
Host Name<\/strong><\/span><\/td>\nFully-qualified domain name of the host.<\/td>\nHostName<\/td>\nString<\/td>\n<\/tr>\n
Port Number<\/strong><\/span><\/td>\nPort number of the Views Service on the host.<\/td>\nPortNumber<\/td>\nInteger<\/td>\n<\/tr>\n
User Name<\/strong><\/span><\/td>\nUser name to use to connect to the host.<\/td>\nUserName<\/td>\nString<\/td>\n<\/tr>\n
Password<\/strong><\/span><\/td>\nPassword to use to connect to the host.<\/td>\nPassword<\/td>\nEncryptedString<\/td>\n<\/tr>\n
Use Native Sampling<\/strong><\/span><\/td>\nDetermines whether the historian's built-in native sampling should be used or IFS OI Server's own fallback sampling.<\/td>\nUseNativeSampling<\/td>\nBoolean<\/td>\n<\/tr>\n
Tag Name<\/strong><\/span><\/td>\nName of the tag property to use as tag name when fetching data. If this value is not specified then the adaptor will use the original tag name. Also, if this value is configured but the tag property is not found during tag discovery then the adaptor will log a warning and use the original tag name. E.g. Historian ItemId<\/em><\/td>\nTagName<\/td>\nString<\/td>\n<\/tr>\n
Tag Description<\/strong><\/span><\/td>\nName of the tag property which contains the tag descriptions.<\/td>\nTagDescription<\/td>\nString<\/td>\n<\/tr>\n
Tag Minimum<\/strong><\/span><\/td>\nName of the tag property which contains the display range minimum values of tags.<\/td>\nTagMinimum<\/td>\nString<\/td>\n<\/tr>\n
Tag Maximum<\/strong><\/span><\/td>\nName of the tag property which contains the display range maximum values of tags.<\/td>\nTagMaximum<\/td>\nString<\/td>\n<\/tr>\n
Tag Scan Rate<\/strong><\/span><\/td>\nName of the tag property which contains the tag scan rates (the values will be treated as milliseconds).<\/td>\nTagScanRate<\/td>\nString<\/td>\n<\/tr>\n
Tag Units<\/strong><\/span><\/td>\nName of the tag property which contains the tag unit names.<\/td>\nTagUnits<\/td>\nString<\/td>\n<\/tr>\n
Good Qualities<\/strong><\/span><\/td>\nCanary returns a status flag with each data point explaining the data quality of that point.\u00a0The config here is a comma separated list of flags, represented in decimal (these flags may be represented in Hexadecimal when viewed in Canary). As a customer can add there own configuration, we allow this list to be customized to suit there needs. A good starting point is:\u00a0 192, 1088, 1216, 2112, 2240, 32768. If a status being returned from Canary is in this list, it will return 100% confidence to Explorer.\u00a0 If the status is not in this list, it will return 0% confidence to Explorer.<\/td>\n\u00a0<\/td>\nString<\/td>\n<\/tr>\n
Ignored Qualities<\/strong><\/span><\/td>\nSimilar to 'Good Qualities' above, we also scan for data point that should be completely ignored by Explorer.\u00a0If the returned status for a data point matches any status in this list, then the data point will be be treated as per the setting below 'Incompatible Value Behavior'.\u00a0By default this is set to Remove Incompatible Values and so will completely remove the data point from being returned to Explorer.<\/td>\n\u00a0<\/td>\nString<\/td>\n<\/tr>\n
Incompatible Value Behavior<\/strong><\/span><\/td>\nThis setting determines how data is treated when a data point is detected as being in the Ignored Qualities list, and will determine what happens to the data point if its status list is in the Ignored Qualities field.
\nYou have some options to remove it completely, set the confidence to zero, or return a data point with a value of Null etc. A good starting point is: 33024, 57344.<\/td>\n		\u00a0<\/td>\n\u00a0<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
\n

Installation<\/h2>\n

This adaptor is included in the Explorer installer.<\/p>\n

 <\/p>\n

\n

Release History<\/h2>\n