Difference between revisions of "OSIPI (Plugin)"
(→Configuration in Ubik) |
|||
| Line 3: | Line 3: | ||
== Features == | == Features == | ||
* Supports multiple value types | * Supports multiple value types | ||
| − | * | + | * |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
== Prerequesites == | == Prerequesites == | ||
| Line 17: | Line 11: | ||
Live value servers get added to instances of the '''OSIPI_SERVER''' metaclass, whereas the data points are objects of the '''OSIPI_DATAPOINT''' metaclass. <br/> | Live value servers get added to instances of the '''OSIPI_SERVER''' metaclass, whereas the data points are objects of the '''OSIPI_DATAPOINT''' metaclass. <br/> | ||
With that difference in mind, follow this guide: [[HowTo:Implementing_Live_Values]]. | With that difference in mind, follow this guide: [[HowTo:Implementing_Live_Values]]. | ||
| + | |||
| + | Not all data types of OSIPI are available to be configured in Ubik. The following table shows the matches: | ||
| + | {| class="wikitable" | ||
| + | |'''OSIPI Data Type''' | ||
| + | |'''Ubik Data Type''' | ||
| + | |- | ||
| + | |<code>Digital</code> | ||
| + | |<code>Integer</code> (0 or 1) | ||
| + | |- | ||
| + | |<code>String</code> | ||
| + | |<code>String</code> | ||
| + | |- | ||
| + | |<code>Int16</code> | ||
| + | |<code>Integer</code> | ||
| + | |- | ||
| + | |<code>Int32</code> | ||
| + | |<code>Integer</code> | ||
| + | |- | ||
| + | |<code>Float16</code> | ||
| + | |<code>Float</code> | ||
| + | |- | ||
| + | |<code>Float32</code> | ||
| + | |<code>Float</code> | ||
| + | |- | ||
| + | |<code>Float64</code> | ||
| + | |<code>Float</code> | ||
| + | |} | ||
=== Authentication === | === Authentication === | ||
| Line 23: | Line 44: | ||
* Current User | * Current User | ||
| − | In the case of '''Basic authentication''', put the credentials in the respective fields <code>LOGINNAME</code> and <code>PASSWORD</code>. Be aware that domain backslashes might need to be doubled, thanks to their escaping nature: <code> | + | In the case of '''Basic authentication''', put the credentials in the respective fields <code>LOGINNAME</code> and <code>PASSWORD</code>. Be aware that domain backslashes might need to be doubled, thanks to their escaping nature: <code>DOMAIN\\USER</code> |
If you leave the <code>LOGINNAME</code> field empty, the client tries to authenticate against the OSIPI server with <code>[https://docs.microsoft.com/en-us/dotnet/api/system.net.webclient.usedefaultcredentials| WebClient.UseDefaultCredentials]</code>. Should this be the authentication of your choice, be aware that the Ubik Studio/Enterprise Service/Web Service needs to be started as that user that has access to the PI system. | If you leave the <code>LOGINNAME</code> field empty, the client tries to authenticate against the OSIPI server with <code>[https://docs.microsoft.com/en-us/dotnet/api/system.net.webclient.usedefaultcredentials| WebClient.UseDefaultCredentials]</code>. Should this be the authentication of your choice, be aware that the Ubik Studio/Enterprise Service/Web Service needs to be started as that user that has access to the PI system. | ||
Revision as of 10:40, 4 November 2020
The OSIPI interface module enables support for reading data from PI systems.
Features
- Supports multiple value types
Prerequesites
To be able to successfully set up the system, the Ubik server/development machine needs access to the OSIPI instance. This can be easily checked in the web browser by navigating to the provided URL. PiWebAPI is a REST API, from which the plugin reads data.
Configuration in Ubik
Live value servers get added to instances of the OSIPI_SERVER metaclass, whereas the data points are objects of the OSIPI_DATAPOINT metaclass.
With that difference in mind, follow this guide: Implementing Live Values.
Not all data types of OSIPI are available to be configured in Ubik. The following table shows the matches:
| OSIPI Data Type | Ubik Data Type |
Digital
|
Integer (0 or 1)
|
String
|
String
|
Int16
|
Integer
|
Int32
|
Integer
|
Float16
|
Float
|
Float32
|
Float
|
Float64
|
Float
|
Authentication
The OSIPI plugin supports two types of authentication:
- Basic
- Current User
In the case of Basic authentication, put the credentials in the respective fields LOGINNAME and PASSWORD. Be aware that domain backslashes might need to be doubled, thanks to their escaping nature: DOMAIN\\USER
If you leave the LOGINNAME field empty, the client tries to authenticate against the OSIPI server with WebClient.UseDefaultCredentials. Should this be the authentication of your choice, be aware that the Ubik Studio/Enterprise Service/Web Service needs to be started as that user that has access to the PI system.
