Collectors and data formats
OPC-UA collector
basic settings these settings are used by the collector to successfully connect to the opc ua server uaendpoint description the location of the opcua server required yes example opc tcp\ //localhost 1234 this configures the ip address and the port on which the opc ua server is listening uasecuritymode description security mode for the ua server required no default none options none | sign | signandencrypt none can only be selected if the uasecuritypolicy is none as well more information on the website of the opc foundation uasecuritypolicy description security policy for the ua server required no default none options none | basic128 | basic128rsa15 | basic192 | basic192rsa15 | basic256 | basic256rsa15 | basic256sha256 more information on the website of the opc foundation uausername description the username for basicauth required no uapassword description the password for basicauth required no opc ua certificates when the security mode is set to sign or signandencrypt , the collector will require a certificate to communicate with the opc ua server certificate files the certificate files cert pem and key pem are saved under the collector certificates folder in the configured working directory note that if these files do not exist yet, the collector will automatically generate them once the uaendpoint is correct and both the uasecuritymode and uasecuritypolicy are not none linux /var/opt/factry/\[collector uuid]/certificates windows c \\\programdata\\\factry\\\\\[collector uuid]\\\certificates measurement settings the measurement settings reflect the configuration possibilities for mapping a measurement to an opc ua tag nodeid description the opc ua nodeid where this measurement should be collected required yes example ns=1;s=saw 1 collectiontype description the way this measurement should be collected from the opc ua server required yes default polled options polled | monitored | events checkout the opc ua collector /#data collection methods section for more information collectioninterval description the interval in milliseconds at which this measurement should be collected required yes default 5000 collectionoffset description the offset in milliseconds, relative to the 0th second of a minute, at which this measurement should be collected only relevant for polled measurements required yes default 0 getvalueatindex description if true, the value of the array element at the specified index will be collected if false, the entire array will be collected only relevant for array type nodes default false arrayindex description the index of the array element to be collected only relevant for array type nodes default 0 eventtypefilter description only monitor events of the configured event type only relevant if collectiontype is ’event’ example ns=0;i=2041 eventfilterfield description the event field to filter on required yes if collectiontype is ’event’ and eventtypefilter is not empty example severity eventfilteroperator description the comparison operator to apply required yes if collectiontype is ’event’ and eventtypefilter is not empty options equal | greaterthan | greaterthanorequal | lessthan | lessthanorequal eventfiltervalue description the value to compare against required yes if collectiontype is ’event’ and eventtypefilter is not empty advanced settings readtimeout description the opc ua read request timeout in milliseconds required no default 5000 heartbeattimeout description the opc ua heartbeat timeout in milliseconds, minimum 5000 required no default 10000 minimum 5000 maxnodespermonitor description maximum amount of nodes that can be sent in one monitor request required no default 10000 minimum 1 maxnodesperread description maximum nodes that can be read in one request required no default 10000 minimum 1 maxnodesperregister description maximum nodes that can be registered in one request, set to 0 to skip node registration required no default 10000 maxreadrequest description maximum amount of running opc ua read requests required no default 5 minimum 1 data collection methods the opc ua collector has 3 methods to collect measurement data, which are referred to as the collection type of a measurement polling polled measurements are read every x milliseconds (minimum of 1000ms), which is the collection interval this data collection method should be used for measurements for which the value changes regularly over time configure the interval depending on how frequent you want to collect data points for this measurement monitoring monitored measurements collect data on every change of the measurements value this data collection method uses a subscription on the opc ua server that notifies the collector whenever a change occurs (note that this depends on the scanning frequency of the opc ua device) typically, monitored measurements are configured for boolean or string data types that indicate an equipments state, f e for a valve that opens and/or closes only a few times per hour more information events event measurements collect all opc ua alarms & conditions events from the opc ua server this data collection method uses a subscription on the opc ua server that notifies the collector of all events that occur under the configured node measurements of this collection method can set their datatype to raw this will store the event fields as separate fields in the historian and some exceptions as tags for other datatypes will all event fields be stored as tags and the activestate as the value fields saved as tags for the raw datatype are eventtype sourcename conditionname more information timestamps in case of polled measurements, the source of the timestamp is taken from the system where the collector is running on in case of monitored and event measurements, the timestamp is taken from the update message received from the opc ua server, in which case that is used we cannot take the timestamp of insertion, as in the case of buffering that can be days later than the actual sampling collector health opc ua specific collector health messages see collector state docid\ cuxtvhahq2yyjjjwatdh8 for all generic collector health messages you can find the collector health and the collector history in the detail view on the right, when selecting a collector in the historian admin webpage error initializing collector an error occurred when initializing the opc ua collector this indicates a collector setting hasn’t been configured correctly or the opc ua server isn’t reachable during initialization error connecting to opc ua server the opc ua server isn’t reachable for an initialized collector on a connection attempt disconnected timeout heartbeat the collector lost connection to the opc ua server common opc ua status codes when reading points for a measurement from the opc ua server, the collector can receive status codes that indicate the quality of the data point the collector uses these status codes to determine if the data point is valid or not statusok(0x00) is the only status code that indicates a valid data point by default however other status codes can be configured to be considered as valid data points in the collector’s base collector docid\ im 7bhp1lmte9wpvndn y a list of all opc ua status codes and their description can be found here in some cases we set custom status codes to indicate the quality of the data point these custom status codes are custom status code description badfactryopcuaregisternodesfailed the collector failed to register the nodes with the opc ua server badfactryopcuatoomanyopenreadrequests the collector has too many open read requests with the opc ua server badinvalidnodeid the nodeid specified in the measurement settings is invalid badnovalueatarrayindex the array index specified in the measurement settings is out of bounds unknownstatuscode 0xxxx the status code received from the opc ua server is unknown badfactrymonitorerror the collector failed to monitor the nodes with the opc ua server badnovalueatarrayindex the array received from the opc ua server has no value at the configured index