This guide will outline the syntax and format required to update PI values via the Web Service Integration. For more information on Web Service Integration please see our What is Pentana Risk Webservice Integration? guide.
For help troubleshooting Webservice Integration please see our Troubleshooting: Pentana Risk Web Service Integration.
The PI Integration only allows for values to be added or updated in existing PIs.
This guide covers:
POST Structure
The integration must POST the data to the Web Services endpoint: https://www.pentanarpm.uk/CovalentWebServices/SendData
The XML Schema can be found here: https://www.pentanarpm.uk/schema/pivalues-1.0.xsd
This POST should also include the following parameters:
|
Key |
Contents |
Notes |
|
<user> |
Login ID of the Integration User. |
This must correspond to an Active user with the appropriate permissions to create/update the imported data. |
|
<pass> |
Password of the Integration User. |
This must be a valid password for the Active User. We would suggest setting the password to not expire for this User. |
|
<id>/<cust> |
Pentana Risk Customer ID/Site Name |
This enables the import service to update the correct site. Cust Name is the first portion of your site URL (<sitename>.pentanarpm.uk). Your Cust ID can be provided by Support. |
|
<data> |
XML Data |
|
|
<service> |
Text |
PI Values integrations: ‘PIVAL’ |
PI XML Syntax
The data contained within the PI Values update must follow the following format:
|
Key |
Attributes |
Contents/Data Type |
Notes |
|
<pis> |
|
<pi> |
|
|
<pi> |
code=”PI Code” |
<values>+ |
This targets the specific PI to be updated. |
|
<values> |
|
<period> <year> <frequency> <target> <numerator> <numeratorTrgt> <denominator> denominatorTrgt> |
Each set of these values is nested under a <pi code = “PI Code”> identifier. |
|
<value> |
|
(text) |
The PI data value. For nonapplicable pass the String “NA”. |
|
<period> |
|
(text) |
The PI data period. For daily and weekly needs to be the date or date of start of week. (see period table for more information) |
|
<year> |
|
(number) |
The year of this PI data. |
|
<frequency> |
|
“D”, “W”, “M”, “Q” or “Y” |
The PI data collection frequency. D – Daily W – Weekly M – Monthly Q – Quarterly Y – Yearly |
|
<target> |
|
(number) |
The PI value target. |
|
<numerator> |
|
(number) |
The Numerator value. |
|
<numeratorTrgt> |
|
(number) |
The Numerator target value. |
|
<denominator> |
|
(number) |
The Denominator value. |
|
<denominatorTrgt> |
|
(number) |
The Denominator target value. |
The <period> element format is dependent on the value of the <frequency> element:
|
<frequency> Value |
<period> Format |
|
D |
Date of the day in the format ddmm (e.g. 1110 for 11th October) |
|
W |
Start date of the week in the format ddmm |
|
M |
Three letter representation of the month. Accepted values: JAN, FEB, MAR, APR, MAY, JUN, JUL, AUG, SEP, OCT, NOV, DEC Q |
|
Q |
Numerical value of the quarter (1-4) |
|
Y |
The year for this value (e.g. 2008) |
For more information and guidance on the format of PI Value imports please see the help documentation or contact Support.
XML Sample
Once constructed, your XML should follow this format:
<?xml version="1.0" encoding="ISO-8859-1"?>
<pis xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://www.pentanarpm.uk/schema/pivalues-1.0.xsd">
<pi code="HSA03">
<values>
<value>89.9</value>
<period>JUL</period>
<year>2006</year>
<frequency>M</frequency>
<target>100</target>
</values>
<values>
<value>81.9</value>
<period>AUG</period>
<year>2006</year>
<frequency>M</frequency>
<target>97</target>
</values>
</pi>
<pi code="HSA04">
<values>
<value>null</value>
<period>2005</period>
<year>2005</year>
<frequency>Y</frequency>
<target>100</target>
<numerator>20</numerator>
<numeratorTrgt>30</numeratorTrgt>
<denominator>20</denominator>
<denominatorTrgt>20</denominatorTrgt>
</values>
</pi>
<pi code="HSA05">
<values>
<value>na</value>
<period>0106</period>
<year>2005</year>
<frequency>W</frequency>
<target>100</target>
</values>
</pi>
</pis>
Comments
0 comments
Please sign in to leave a comment.