DH Historian Agent

note this driver is available for litmus edge version 3 11 0 and later review the following information for setting up and configuring the osi agent driver v2 3 0 before you begin verify that the windows environment runs at least net 4 8 or higher install an osi server and osi agent on a windows system download the osi agent and required files in a zip file from the litmus portal https //portal litmus io/accelerators/dh historian agent make sure the osi client dll is on the same system running the osi agent open port 443 and 4777 between windows and litmus edge otherwise, the osi agent won't work configure windows authentication so that the osi pi server can work prerequisites prerequisites for device hub agent deployment a machine with at least 16 gb memory windows workstation os version 10 or greater or windows server os version 2012 or grater piserver 2012 version 3 4 375 or greater available “pi user login credentials” or “windows user login credentials” of a user that is permitted to connect to pi system and read data there are 2 different options to deploy the device hub agent on the pi server itself on a “pi node” – a separate machine that is connected to pi server option1 deploy agent on same windows machine as pi server ensure that net framework 4 8 is installed on the server (download url https //dotnet microsoft com/en us/download/dotnet framework/thank you/net48 web installer https //dotnet microsoft com/en us/download/dotnet framework/thank you/net48 web installer ) unzip the deployed package into a separate folder run device hub agent ui exe as administrator fill in all the fields of the configuration tabs start device hub agent controller option2 deploy agent on a node machine ensure that net framework 4 8 is installed on the machine (download url https //dotnet microsoft com/en us/download/dotnet framework/thank you/net48 web installer https //dotnet microsoft com/en us/download/dotnet framework/thank you/net48 web installer ) open add/remove programs and make sure that the “pi af client” is installed otherwise, ask the customer to install it for you click on “start” > “pi system” > “about pi sdk” make sure that there is an entry for the pi server in the connections list or else, just add one with the parameters that you have click the “checkbox” to test the connection unzip the deployed package into a separate folder run device hub agent ui exe as administrator fill in all the fields of the configuration tabs start device hub agent controller tested platforms the device hub agent is tested # using pi afclient 2018 sp2 patch 2, ver 2 10 99 593 pi system management tools 2018 sp3 patch 1, ver 3 6 3 65 # using pi afclient 2018 sp3 patch 4, ver 2 10 10 2593 pi system management tools 2018 sp3 patch 1, ver 3 6 3 65 step 1 install osi agent install the zip file with the osi agent and all required files on a windows system step description 1 add an osi agent advanced device in litmus edge devicehub network port, user and password, nats connection name fields are required 2 unzip the downloaded file 3 go to the unzipped folder from the root folder, open the dh historian agent folder, then right click dh historian agent ui and select run as administrator a devicehub historian agent application will open step 2 run and configure the dh historian agent use the dh historian agent app to configure the dh historian agent and devicehubagentcontroller on the first page, press next the page for theme/skin/menus configuration will open press save , then next the pi server/operation mode page will open press load pi servers wait for the servers to load, then select the host name of the server you want to connect to select between pi user authentication or windows authentication select polling on tags intervals or events based once you have made your selections, press save , then next the dh historian agent/ webapi page will open here is some help regarding the terms used pi user open the pi system management tool and navigate to security > pi users and groups enter the correct username and password windows the pi server needs to be properly configured to use windows authentication in the host field, enter the ip address of our litmus edge instance enter any text in the user and password and conn name fields and they need to be the same with configuration of osi agent advanced device in litmus edge sample site settings are as follows host enter the ip address for the litmus edge instance port enter 4777 user enter the username to connect to the server in devicehub password enter the password to connect to the server in devicehub check validate against server certificate (optional) click button and select certificate file from host windows machine (optional, if previous option is checked) keepalive packet interval every minute the agent and controller will send keepalive messages when 3 consecutive messages fail, then the connection with le will be discarded the keepalive packet interval can be changed from the default value, which is 60 seconds if put "0 secs" interval, then the agent/controller will not send keep alive messages and in such a case it is up to the server side (l e ) to decide if to keep the opened connection or to drop it click test connection button to validate configuration press save , then next the logs page will open check log file folder and enter any name for the log folder, which will be generated automatically in the same directory press save , then next the agent service and agent controller service page will open create and start both services to make them running press exit to leave dh historian agent ui go to litmus edge devicehub and confirm the device is connected osi agent driver settings in litmus edge if you review or edit the settings of the osi agent device, refer to the following parameters parameter value type osi driver osi agent advanced network port the port configured in the dh historian agent the default value is 4777 interface you have the option of selecting the interface for accepting client connections the default value is 0 0 0 0, which means using all network interfaces for accepting connections from clients user the username configured in the dh historian agent password the password configured in the dh historian agent release notes v2 4 1 set following defualt paramter settings so that the test system & the overloaded system will work fast pisendinitialvalues to false maxeventsperbulk value 500 bulkeventswriteinterval to 1000 mili secs bug fix for the ui freeze catching main form's events added tray icon's functionality to the main form of the app v2 4 0 initial changes for writing event values as bulks using settings bulkeventswriteinterval and maxeventsperbulk added behavior description treatment of null values, if they ever come from pi server code review private class property v2 3 2 fix for agent tool ui freeze issue adding bulk operations capabilities allows the start of the agent, even when pi connectivity is not reliable unhandled content type v2 3 0 keepalive feature installed services should be with automatic start agent starts even when tagslist is empty and finding tag name in the tags list v2 2 0 new feature added to the ui running on pi events (visual part) bringing back events based version sending of initial values currently it will only send initial values when the agent is manually restarted, not on dh driver restart when the driver restarts, the agent and controller notice that the tcp connection was dropped, and they will re establish it again all the operations will work as they did before the only thing that will not happen, is the re sending of the initial values, and that is simply because if there was no request to do that, the agent can't tell if this disconnection happened due to a slow network or a cable disconnection or any other infrastructural issue removed test project from the compilation in release fixed the issue of timestamp was less than the minimum new icons in ui removing certificate page and loading the certificate as a file which support pem, crt and txt format