The piclient.ini file contains configuration information for various PI clients and application (primarily PI API-based). It can contain information pertaining to buffering configuration (buffering parameters as well as buffered and replicated server lists), basic default PI server information (such as default server, daylight savings transition mismatch, and long process name support), network (TCP/IP) parameters (including port as well as connection and data timeout specifications).
The following listing delineates the sections of the piclient.ini that the PI API accesses directly in its function library.
Other PI clients (often PI API-based) can also access and place entries in the piclient.ini. See the documentation for those individual applications for their applicable entries.
The following table contains the parameters for the [PISERVER] and [TCP/IP] networking parameters that can be specified in the piclient.ini file.
|PIHOMENODE||String||Network path to the default PI server. It can be the machine name, FQDN, or an IP address.|
|DSTMISMATCH||0 to 2000000 (0)||The time that the server and client local time offset is allowed to jump. Typically, 3600 if the server and client nodes are in timezones whose DST transition rules differ (seconds).|
|LONGPROCNAME||0 or 1 (0)||Use up to 8 characters for the PI server procname identifier|
|PORT||1 to 9999 (5450)||Default port number used when instantiating connections to a PI server|
|TIMEOUT||1 to 2000000 (60)||Default wait time (in seconds) for instantiating PI server connection (or reconnection)|
|WRITETIMEOUT||1 to 2000000 (2)||Default wait time (in seconds) for data put calls on an established connection to a PI server|
For more detailed information on the parameters and sections that pertain to buffering (the [APIBUFFER], [BUFFEREDSERVERLIST], [REPLICATEDSERVERLIST], and [PIBUFSS] sections), see the help page entitled "Installing and Configuring of Buffering"
The piclient.ini is used to support buffering configuration and if a pilogin.ini file cannot be found, to define the default PI server. The piclient.ini file (below) indicates that a PI program under Windows will resolve remote PI function calls with the PI Server named MYVMSSERVER by default. Default connections are made if the PI program calls the piut_connect function, calls the function piut_setservernode with a NULL string or function calls made without calling for a connection first. Again, the piclient.ini file is only used for this purpose if the pilogin.ini file cannot be found or older versions of the PI-API are being used.
Other typical entries for a piclient.ini file are used to enable buffering (and change buffering parameters from their defaults), enable the use of long (eight-character) procnames, specify buffered server and replicated server lists, and to allow the PI-API client program to correctly adjust time offsets for PI servers and clients using different Daylight Savings time rules. For example:
In this example file, the DSTMISMATCH time jump allowed has been set to 3600 seconds (1 hour) and the use of the 8-character procname feature has been enabled in the [PISERVER] section (the fact that PIHOMENODE and DSTMISMATCH is in this file, connotates that this file is for a PIAPI node on a UNIX platform). The [APIBUFFER] section specifies that BUFFERING is on for the PIAPI node and the MAXTRANSFEROBJS entry is set to 1024 objects per tranfer. There are 3 buffered servers defined (in the [BUFFEREDSERVERLIST] section): MyNTServer1, MyNTServer2, and MyVMSServer. And two of those servers are replicated servers: MyNTServer1 and MyNTServer2 (as specfied in the [REPLICATEDSERVERLIST] section).
Do not use commas in the piclient.ini file.