How to Set Up Clipboard Integration With Assurance For Incident Management – Support Hub

Learn how to automatically push Incident reports to CompliSpace.

Please Note: The following information is from Clipboard's support articles. The Clipboard integration with Assurance is established in Clipboard. Any questions on set up and use should be directed to Clipboard's support team.

In this article, you will learn about:

Clipboard Integration With Assurance

After reporting an incident, the incident report can be automatically pushed to CompliSpace. This is achieved through a one-way sync of incident reports to a third-party API.

CompliSpace is able to support to ensure your API key is made available in Assurance, which is necessary to begin the steps in this integration. See this article for more information.

Please Note: This feature is only accessible to IT Admins. Only IT Admins can enable the configuration and modify the field mappings in the templates.

Why Is It Useful

Here are some of the main benefits that the CompliSpace Integration provides:

All incident reports are automatically pushed to your CompliSpace Portal.
No double-handling or duplication of incident data.
All incidents are recorded, and the school will meet the legal and ethical duty of care for its students.

Where Is the Integration Visible on Clipboard

1. In Incidents, you will find a column called Integration. It will show the status of a successful or unsuccessful push to the CompliSpace for each incident reported (see the first image).

2. In the Incident Report itself, the push status to CompliSpace will also be visible (see the second image).

How to Set Up the CompliSpace Integration

1. Go to the integration page and click the Configure button in the CompliSpace row to redirect to the configuration page. See the image below.

2. On the configuration page, enter the API key, Tenant name, and Enabled status of the integration, then click Save. See the image below.

The Tenant name field refers to the subdomain name of your CompliSpace Assurance site.

The API key field refers to the CompliSpace Assurance API Key.

3. To edit the mapping for a specific template, locate the Incident template in the list and click Edit Mapping. This will redirect to the CompliSpace mapping page. See the image below.

The CompliSpace Template ID field refers to which CompliSpace template this incident report will map to. All compliSpace fields are optional, however if a value is provided, that value must map exactly to a field name present in the selected CompliSpace template - otherwise, syncing the incident will fail.

a. If a mapping is provided for the Clipboard Incident URL, ensure the mapped field in CompliSpace has the data set to URL.

b. All CompliSpace fields are stored in the clipboard.incidentreporttemplates table. All default mapped fields are stored in the clipboard_integration_mappings column, while any custom mapped fields are stored within the fields column.

Now CompliSpace is set up and enabled.
Any new incidents created will automatically attempt to push to CompliSpace using its associated incident template.

How to Manually Push an Existing Incident to CompliSpace

Go to the incident report and click the button Push to CompliSpace.

The status of the push will be displayed at the bottom of the incident page. The details of this sync will be included in the updates section of the incident page. Which can be helpful for defining the mapping fields in the incident templates.

What if the Sync Fails

If the sync fails, the user is presented with a button to attempt the sync again. When clicking this button, you will be redirected to the CompliSpace configuration page for this incident template. Here you can update the mappings along with log messages in the updates section.

In the example image below, The failed log message explains: we are sending the year group as
Year 10 when the CompliSpace template is expecting 10. This field in practice, should match Clipboard and the SIS.

Upon updating the field mappings to the correct value, the sync can be attempted again, this time succeeding. See the successful CompliSpace message in the image below.

Basic Video Run-Through on How to Set up the Clipboard/CompliSpace Integration

Basic Video Run-Through of the Integration Once It Has Been Set Up