Edit the PIOASyS.json file
- Last UpdatedApr 24, 2025
- 3 minute read
Note: For information on overriding default configuration settings, refer to Modify configuration settings.
This file contains the parameters that are passed to piuniint.exe to start the PI-OASyS interface.
To edit the PIOASyS.json file
-
In the %DNADataRoot%\RealTime\config\Settings directory, either create or open the PIOASyS.json file to edit the command line parameters for the PI-OASyS interface.
Note: If you configure an invalid key value, then, during runtime, the value defaults to the one specified in the %DNAInstallRoot%\RealTime\config\Settings\PIOASyS.json file.
-
Save the file.
-
Restart the RealTime service.
The command line parameters of the PI-OASyS Interface session are printed to the %DNADataRoot%\RealTime\log\PIUniint_<pid>.log file.
-
Start the PI-OASyS Interface interactively:
-
Run the script PI.run_processes.csc under <%DNAInstallRoot%>\RealTime\scripts\REALTIME.
-
To verify that the PI-OASyS Interface can connect to the PI Server successfully, check the <%DNAInstallRoot%>\RealTime\log\PIInterface.log file and the C:\Program Files\PIPC\dat\PIPC.LOG Location\pipc.log file. Make sure that the connection to the PI Server is successful. If not, go to the PI Server computer and check the server logs displayed in the Message Logs window of the System Management Tool (SMT) for the error.
-
Fix the error.
-
PIOASYS.json File Example
{
"PIOASYS": {
"ProductVer": "7.5.0",
"PIServerName": "ESPISERVER",
"PIPort": 5450,
"PIPointSource": "O",
"PIInterfceNum": 1,
"ScanFreq1": 1,
"ScanFreq2": 10,
"ScanFreq3": "00:01:00",
"EventCounter": 1,
"CriticalTask": 1,
"UniintDLL": "%DNAInstallRoot%\\%DNASiloName%\\bin\\libpioasys.dll",
"CacheSynch": 500,
"PIUniintPath": "%PIHOME64%\\PIUniInt",
"PIOASyS_Buffer_Fill_Factor": 20,
"PIOASyS_Main_Thread_Sleep": 50,
"PIOASyS_Decoder_Thread_Sleep": 50,
"PIOASyS_Checkin_Period_Seconds": 900,
"PISySAlias": null,
"DatasetOption": false,
"PubSubMode" : false,
"UseSystemTime": true,
"PIOASyS_Unsolicited_Max_Flush_Time": 60,
"PIOASyS_Maximum_Tags_In_Same_Subscription": 5,
"PIOASyS_Min_Main_Sleep_Time": 20
}
}
Key Descriptions
|
Key |
Description |
|---|---|
|
ProductVer |
The PI-OASyS interface version number. |
|
PIServerName |
The IP address of the PI Server node or the domain name of the PI Server node. Replace ESPISERVER with the actual name of the PI Server node in the system. If you already have a PI Collective configured for the system and the PI Collective contains more than one PI Server, use the primary PI Server name in the Collective. Do not use the name of the PI Collective. Example: If the domain name of the PI Server node is mainpi1, and the IP address is 128.2.25.91, then the valid PIServerName would be: mainpi1 or 128.2.25.91 |
|
PIPort |
The port number for TCP/IP communication. The port is always 5450 for a PI Server. |
|
PIPointSource |
The identifier of a PI Interface instance. This is used to associate and organize groups of PI tags. |
|
ScanFreq1, ScanFreq2 and ScanFreq3 |
These are the scan frequencies that the PI-OASyS interface uses for scanning data. The order of the frequencies corresponds to the scan class number. The default settings for these three frequencies are: ScanFreq1 = 1, ScanFreq2 = 10, ScanFreq3 = 00:01:00. This indicates 3 scan classes, with scan class 1 scanned at 1-second intervals, scan class 2 scanned at 10-second intervals, and scan class 3 scanned at 1-minute interval. You can add a new scan class here or modify the default settings to meet customer requirements. |
|
EventCounter |
The event counter number that is used for configuring I/O rate tag (add the link to Configuring I/O Rate tag). |
|
CriticalTask |
Indicates that the interface is a critical process of the RealTime database (RTDB) service. |
|
CacheSynch |
The time in milliseconds allowed for syncing the local point database cache. |
|
PIUniintPath |
The path to the PIUniint executable. |
|
PIOASyS_Buffer_Fill_Factor |
The percentage of space for a data buffer to be filled before flushing. For example, if the value is 100, the buffer is flushed only when completely filled. If the value is 0, the buffer is flushed any time it isn't empty. |
|
PIOASyS_Main_Thread_Sleep |
The sleep time (in ms) between main thread batches. The value should not be less than 20. |
|
PIOASyS_Decoder_Thread_Sleep |
The sleep time (in ms) between decoder thread batches. The value should not be less than 20. |
|
PISySAlias |
The system alias of the owning system (For example, ls1pdc). This is specified when the PI server is connected to a non-owning system such as lspdcdss. The alias makes PI register the non-owning system as the owning system to ensure that it buffers data correctly. |
|
DataSetOption |
Set this option to true to make the PI Interface dataset aware. Default: false. |
|
PubSubMode |
Set this option to true to have all the PI tags get their values from RealTime through PubSub. Default: false. |
|
UseSystemTime |
Use system time. If set to false, the system uses Lastkrunchtime. Default: true. |
|
PIOASyS_Min_Main_Sleep_Time |
The minimum sleep time (in milliseconds) of the main control loop (in the dev_hibernate() function). |
|
PIOASyS_Unsolicited_Max_Flush_Time - |
The maximum time in seconds before the system flushes the buffer. |
|
PIOASyS_Maximum_Tags_In_Same_Subscription |
The maximum number of tags that can subscribe to the same topic. |