Who is this article for?

Userswho are looking to automate record some activity in Feedback and PI modules.

PI_Update data, PI_Activate, PI_Targets Edit, Feedback_Create, Create_Contact permissions are required for some of the steps.

Web service integration allows you to pull data from external system to create or update Feedback records and Performance Indicator (PI) data. This article will answer some of the most asked questions about the service. 

In this article:

1. How does it work?
2. What can I use it for?
3. What do I need to configure?
4. What data can we update using it?
5. Further reading

1. How does it work?

To take advantage of the integration, you need to POST the data to Ideagen Risk Management in an XML format.

Implementations will be via webforms or a database source, but how this connection is constructed is the responsibility of the customer.  

Once you have POSTed the import, the integration can continue to poll the service, using the Import ID response to ensure the data transfer completes successfully. Your data will then be imported into Ideagen Risk Management and will be immediately accessible.  

As the web service accesses your Ideagen Risk Management instance via a User login, its actions fall under the same Permissions and Ownerships as regular Users. This means that you can track its activity in the Audit Trail.

Looking for a pre-built implementation?
We offer a Middleware integration which provides a PI data import service from an SQL query on a data source. For more information on the Middleware integration please contact Support.

2. What can I use it for?

As the service can be ran automatically, it is well suited to data entered via webforms (e.g.: complaints, FOI data) or for items that need to be regularly updated from a source (e.g.: monthly PI data).

The web service accesses your Ideagen Risk Management via a User login, so all its actions are controlled by the same permissions and ownership systems as standard Users and can be tracked in the Audit Trail.  

3. What do I need to configure?

To ensure the integration works as intended, set up a new User account for the service. We recommend setting the password for this account to never expire to avoid disruptions.

Once created, please give the account the following permissions (at minimum):

• Performance Indicator imports: PI_Update data, PI_Activate, PI_Targets Edit
• Feedback imports:  Feedback_Create, Create_Contact

4. What data can we update using it?

Performance Indicators (PIs)

PI integration is limited to updating PI values and PI value targets for a specific PI and period.  

The following fields are used in the value import: 

• PI Code.
• Period for the data that is being imported.
  This data combines the period, frequency, and year elements of your PI collection to ensure the correct collection and period is updated.  
• Value for this period.  
• Target for this period.

Feedback

Feedback Integration allows new Feedback items to be created (with contact details attached if needed).  

The following fields can be included in the import: 

• Feedback Code.
• Title.
• Description.
• Feedback Type.
• Contact Details. 
• Time/Date values (Opened, Due, Closed).
• Customer Fields.
• Ownerships.

5. Further reading

• Formatting requirements for Feedback data
• Formatting requirements for Performance Indicator data
• Troubleshooting XML import issues