This guide will outline the syntax and format required to import Feedback data 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 Feedback Integration only allows for new Feedback items to be imported.
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/feedback-2.3.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 |
Feedback integrations: ‘FEEDB’ |
Feedback XML Structure
Feedback imports must follow a specific structure and format.
….
<data>
<contact>
/* Contact information goes here */
</contact>
<detail>
/* Feedback item detail goes here */
</detail>
<udfs>
/* Customer Field information goes here */
</udfs>
<owners>
/* Ownership information goes here */
</owners>
</data>
Contact Details
These are the details for the contact associated with the feedback item. These can be recorded against any Feedback type which uses contacts.
Key |
Contents/Data Type |
Notes |
<title> |
Text |
Contacts Title/Salutation |
<fullName> |
Text |
Compulsory |
<forename> |
Text |
Contacts forename |
<initial> |
Text |
Contacts initial |
<surname> |
Text |
Contacts surname |
<address1> |
Text |
1st Line of the address |
<address2> |
Text |
2nd Line of the address |
<city> |
Text |
City of address |
<county> |
Text |
County of address |
<country> |
Text |
Country of address |
<postcode> |
Text |
Post code of address |
<telephone> |
Number |
Contacts phone number |
<email> |
Text |
Contacts email address |
<ctypeKey> |
Webservice key for the appropriate contact type. |
This can be accessed in the ‘Webservice Keys’ section in the ‘Site Admin’ browser menu. |
<gender> |
Number |
Pre-set values in Pentana Risk:
|
<ethnicityKey> |
Webservice key for the appropriate ethnicity. |
This can be accessed in the ‘Webservice Keys’ section in the ‘Site Admin’ browser menu. |
<agegroupKey> |
Webservice key for the appropriate age group. |
This can be accessed in the ‘Webservice Keys’ section in the ‘Site Admin’ browser menu. |
<religionKey> |
Webservice key for the appropriate religion. |
This can be accessed in the ‘Webservice Keys’ section in the ‘Site Admin’ browser menu. |
<disabilityKey> |
Webservice key for the appropriate disability. |
This can be accessed in the ‘Webservice Keys’ section in the ‘Site Admin’ browser menu. |
<sexualityKey> |
Webservice key for the appropriate sexuality. |
This can be accessed in the ‘Webservice Keys’ section in the ‘Site Admin’ browser menu. |
A full example of Contact details may look like this:
<contact>
<title>Mr</title>
<fullName>Mr John R Smith</fullName>
<forename>John</forename>
<initial>R</initial>
<surname>Smith</surname>
<address1>The Cottage</address1>
<address2>Something Street</address2>
<city>Anytown</city>
<county>Anycounty</county>
<country>UK</country>
<postcode>AA1 1AA</postcode>
<telephone>01234 567890</telephone>
<email>john.smith@anydomain.co.uk</email>
<ctypeKey>266</ctypeKey>
<gender>1</gender>
<ethnicityKey>1</ethnicityKey>
<agegroupKey>29</agegroupKey>
<religionKey>19</religionKey>
<disabilityKey>92</disabilityKey>
<sexualityKey>13</sexualityKey>
<maritalStatus>1</maritalStatus>
</contact>
Feedback Item Details
This contains the main detail for each feedback item, including dates.
Key |
Contents/Data Type |
Notes |
<id>/<discriminator> |
Text |
Unique feedback reference, if using automatically generated references then use the discriminator tag. |
<title> |
Text |
Name of the feedback record. Compulsory. |
<description> |
Text |
Further details for the record. |
<duedate> |
Date (YYYY-MM-DD) |
The date by which the first stage should be completed. Compulsory. |
<openeddate> |
Date (YYYY-MM-DD) |
The date the record was opened. |
<openedtime> |
Time (HH:MM:SS) |
If times are enabled, the time the record was opened. |
<closeddate> |
Date (YYYY-MM-DD) |
The date the record was closed. |
<closedtime> |
Time (HH:MM:SS) |
If time is enabled, the time the record was closed. |
<feedbackTypeKey> |
Webservice Key for the appropriate type. |
This can be accessed in the ‘Webservice Keys’ section in the ‘Site Admin’ browser menu. Compulsory. |
<sourcetypeKey> |
Webservice Key for the appropriate type. |
This can be accessed in the ‘Webservice Keys’ section in the ‘Site Admin’ browser menu. |
<typefields> |
<typefield key = “field key”> </typefield> (where “field key” is the webservice key of the customer field) |
This is used for any Customer Fields specific to a certain Feedback Type. General customer fields available across all Feedback types should be included in the <udfs> section. |
A full example of Feedback Item details may look like this:
<detail>
<id>WEB001</id>
<title> Supplier has found error with printed materials</title>
<description> The phone number supplied to suppliers is incorrect on printed materials.</description>
<duedate>2013-04-25</duedate>
<openeddate>2013-04-11</openeddate>
<openedtime>11:09:00</openedtime>
<closeddate>2013-04-18</closeddate>
<closedtime>23:15:30</closedtime>
<feedbackTypeKey>C</feedbackTypeKey>
<sourcetypeKey>18</sourcetypeKey>
<typefields>
<typefield key="dtypeKey">Resources</typefield>
</typefields>
</detail>
Non-Specific Customer Fields
For customer fields which aren’t specific to a particular Feedback type, data must be imported in a separate section of the feedback import.
Key |
Contents/Data Type |
Notes |
<udf key=”field key”> |
Field data/dropdown item webservice key |
The datatype here is dependent on the field type. For more information see the help documentation. |
Ownerships
The final section of the import determines which application Users will have ownership of the item once it’s created.
Key |
Contents/Data Type |
Notes |
<owner> |
<type = “” entity= “”> |
|
<type= “”> |
Text |
|
<entity = “”> (User/Role) </entity> |
Text |
If referencing a User, use the login ID which is visible at the top of their User record. |
A full example of the Ownerships section may look like this:
<owners>
<owner type="R" entity="role">HoS</owner>
<owner type="A" entity="user">Lily.Atkinson</owner>
</owners>
XML Sample
Once all of the sections have been created, a full import may look something like this:
<?xml version="1.0" encoding="utf-8"?>
<feedback xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation=" https://www.pentanarpm.uk/schema/feedback-2.3.xsd">
<data>
<contact>
<title>Mr</title>
<fullName>Mr John R Smith</fullName>
<forename>John</forename>
<initial>R</initial>
<surname>Smith</surname>
<address1>The Cottage</address1>
<address2>Something Street</address2>
<city>Anytown</city>
<county>Anycounty</county>
<country>UK</country>
<postcode>AA1 1AA</postcode>
<telephone>01234 567890</telephone>
<email>john.smith@anydomain.co.uk</email> <ctypeKey>266</ctypeKey>
<gender>1</gender>
<ethnicityKey>1</ethnicityKey>
<agegroupKey>29</agegroupKey>
<religionKey>19</religionKey>
<disabilityKey>92</disabilityKey>
<sexualityKey>13</sexualityKey>
<maritalStatus>1</maritalStatus>
</contact>
<detail>
<id>WEB001</id>
<title> Supplier has found error with printed materials</title>
<description> The phone number supplied to suppliers is incorrect on printed materials.</description>
<duedate>2013-04-25</duedate>
<openeddate>2013-04-11</openeddate>
<openedtime>11:09:00</openedtime>
<closeddate>2013-04-18</closeddate>
<closedtime>23:15:30</closedtime>
<feedbackTypeKey>C</feedbackTypeKey>
<sourcetypeKey>18</sourcetypeKey>
<typefields>
<typefield key="dtypeKey">Resources</typefield>
</typefields>
</detail>
<udfs>
<udf key="RACTION">Please arrange for documentation to be corrected.</udf>
</udfs>
<owners>
<owner type="R" entity="role">HoS</owner>
<owner type="A" entity="user">Lily.Atkinson</owner>
</owners>
</data>
</feedback>
Comments
0 comments
Please sign in to leave a comment.