InstrumentTag (keyword/value pairs)
- Last UpdatedFeb 14, 2023
- 2 minute read
InstrumentTag length
Depending on the version of the PI API and the Data Archive, this interface supports an InstrumentTag attribute whose length is at most 32 or 1023 characters.
|
PI API |
Data Archive |
Maximum Length |
|---|---|---|
|
1.6.0.2 or later |
3.4.370.x or later |
1023 |
|
1.6.0.2 or later |
Earlier than 3.4.370.x |
32 |
|
Earlier than 1.6.0.2 |
3.4.370.x or later |
32 |
|
Earlier than 1.6.0.2 |
Earlier than 3.4.370.x |
32 |
Thus, in order to effectively run the Interface, the user most likely will need to have PI API v1.6 (or higher) and PI Server 3.4.370.x (or higher) installed. For example, DEVICE=192.168.10.100; PORT=2340; contains 34 characters. Alternatively, the user may enable the PI SDK by specifying -pisdk=1 on the startup command line. This allows the interface to use an InstrumentTag of length 1023.
InstrumentTag keywords for TCPResponse
The InstrumentTag attribute holds various keywords/value pairs that, together with Location2, uniquely define the operation that the interface performs. For example: AUTH=NTLM
The available keywords are:
-
INPUT=
-
DEVICE=
-
AUTH=
Note: The supported authentication types are BASIC and NTLM.
-
PORT=
-
REPLY=
A semicolon terminates a keyword/value pair. For example:
DEVICE=192.168.10.100; INPUT=www.somecompany.com;
The keywords themselves are not case sensitive; however, the values are. For example, REPLY=HTTP; is the same as Reply=HTTP;. However, it is not the same as REPLY=Http;
The operation of the TCPResponse interface is governed by the combination of InstrumentTag keyword/value pairs and Location2 value. Not every keyword is applicable or required for each Location2 value. The following table summarizes the keywords and their applicability:
|
Location2 |
Applicable keywords in InstrumentTag |
|---|---|
|
1 (name translation) |
INPUT=(required); DEVICE= supported for backwards compatibility |
|
2 (FTP) |
DEVICE= (required); PORT= (optional); REPLY= (optional); |
|
3 (HTTP) |
DEVICE= (required); PORT= (optional); REPLY= (optional); |
|
4 (SMTP) |
DEVICE= (required); PORT= (optional); REPLY= (optional); |
|
5 (Generic application) |
DEVICE= (required); PORT= (required); |
|
7 (POP3) |
DEVICE= (required); PORT= (optional); REPLY= (optional); |
|
8 (IMAP) |
DEVICE= (required); PORT= (optional); REPLY= (optional); |
|
9 (PI) |
DEVICE= (required); PORT= (optional); |
|
10 (DNS) |
DEVICE= (required, must be an IP address); INPUT= (required, cannot be an IP address); |
|
11 (Web page) |
DEVICE= (required); PORT= (optional); PROT= (optional); USER= (optional); AUTH= (required if USER= is used); REPLY= (required if USER= is used); |