How do I get the PI tag names from the PI Web Server?

[#1]

Dear JMP user community, 

me an my colleague are currently working on an JMP add-in that would allow our internal users to query PI tags as they want and have them all in one table with a few scripts attached and some data manipulation steps done in advance. 

So essentially, we want to reproduce and utilise the "Import from OSIsoft PI server" feature in JMP but with some adjustments to our needs.

We are currently stuck in dynamically retrieving the desired PI tag names from the PI Web server which we then want to store in a list to run the PI Client on. For now, we have a hard-coded list of some PI tags, but since the naming may change or new Pi tags might be added, that is not an ideal solution.

Using a wildcard like % would help us create finer categories of pitags - those categories will depend on prior user selection of e.g. process step, production line - but we did not have any luck finding a counterpart in jsl for lists.

Also, we cannot use SQL to query the PI web server.

This is our AF path:

Asset_DB and Stat_DB are lists, whose content is based on user selection. Pitags is currently a hard-coded list of a few pi tags, but we want it to be based on user selection too.

My question: How did you (JMP developers) retrieve the pi tag names from the web server based on user selection?

Thanks a lot in advance!

Theresa 

[#2]

I haven't done this in a while... I recall that there was a way to get an excel table of all the pi tags. Once you have that, then open it in JMP and transpose it so the tag names are in the first column. From there you can parse and filter the names to generate lists that you can use in your scripts.  

..sorry I couldn't be more specific. 

[#3]

Hi Byron, 

thank you very much for you reply!

I also had that option in the back of my head but I was hoping there is an easier way.

Best,

Theresa 

[#4 · Accepted solution]

Theresa,

To get the child elements at a particular level of the AF hierarchy, JMP uses the "Element - Get Elements" web API method, which is documented here: https://docs.aveva.com/bundle/pi-web-api-reference/page/help/controllers/element/actions/getelements...

JMP makes a request that looks something like this:
GET elements/{webId}/elements?webidtype=idonly&selectedfields=items.webid;items.name;items.description;items.path;items.haschildren;items.templatename

The {webId} is replaced by the webId of the path hierarchy for which you want the children. This returns a JSON description of the child elements including their names, descriptions, webIds, whether they have children, and what template they belong to, if any. You might not need all those attributes so you could trim down the 'selectedfields' query parameter to just what you need. You should be able to send a request like this using JSL's 'HTTP Request' methods. You could then parse the result using JSL's 'Parse JSON' function.

Hope this helps!

--Michael

[#5]

Hi Michael, 

thank you very much for this neat solution!

We will go ahead and try implementing that method.  

Best wishes,

Theresa 

[#6]

Hello Michael,

we have tried the "New HTTP Request" function to retrieve the pi tags from the AF hierarchy. 

Like this: 

The script is being executed, but we get the following error message. Are you familiar with that error?

Since we can query PI tags with the "New PI Client" function, missing authorization does not seem to be the problem. Our PI systems manager confirmed our access rights and could not find an issue with missing access rights. 

Thanks a lot in advance!

Theresa 

[#7 · Accepted solution]

Does your Pi Server require say, Basic authorization? if so then you'd want to use:

PI_web = New HTTP Request(
URL([your url]),
Method("GET"),
Secure(0),
Username([your username]),
Password([your password]),
Authentication Method("BASIC"),
QueryString(qrry)
) << Send

[#8]

Thank you Bryan, we implemented you solution using Kerberos.

[#9]

Was it something like:

PI_web = New HTTP Request(
URL([your url]),
Method("GET"),
Secure(0),Authentication Method("KERBEROS"),
QueryString(qrry)
) << Send