Who is this article for?

Administrators who want guidance on setting up the Clipboard integration with Assurance for incident management.

Full user type with super user role is required.

This article contains guidance from Clipboard's support articles on how to automatically push Clipboard Incident reports to Assurance.

Got a configuration or usability question?
The Clipboard integration with Assurance is established in Clipboard. Any questions on configuration and usability should be directed to Clipboard's support team.

1. Overview

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

Ideagen Policy Logic is able to support to ensure your API key is made available in Assurance, which is necessary to begin the steps in this integration.

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

2. Benefits

Below are some of the main benefits that the Ideagen Policy Logic Assurance Integration provides:

• All Clipboard incident reports are automatically pushed to your Ideagen Policy Logic Assurance site.
• 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.

3. Viewing the integration in Clipboard

To access the integration:

1. Go to the Incidents section.
2. Look for the Integration column.
   It will show the status of a successful or unsuccessful push to the Ideagen Policy Logic for each incident reported.

4. Configuring the integration in Clipboard

To configure the integration:

1. Go to the Integration page.
2. Select Configure in the Ideagen Policy Logic row to redirect to the configuration page.

3. Enter the API key.
   This needs to be obtained from your Ideagen Policy Logic Assurance site.
4. Provide a Tenant name.
   This is the subdomain name of your Ideagen Policy Logic Assurance site.

5. To edit the mapping for a specific template, locate the Incident template and select Edit Mapping.
   This will redirect to the Ideagen Policy Logic integration mapping page.
6. Update the Ideagen Policy Logic Template ID if needed.
   This refers to which Ideagen Policy Logic register template this Clipboard incident report will map to.

All Ideagen Policy Logic fields are optional, however if a value is provided, that value must map exactly to a field name present in the selected Ideagen Policy Logic template - otherwise, syncing the incident will fail.

If a mapping is provided for the Clipboard Incident URL, ensure the mapped field in Ideagen Policy Logic has the Field Type set to URL.

Now Ideagen Policy Logic integration is set up and enabled. Any new incidents created will automatically attempt to push to Ideagen Policy Logic Assurance using its associated incident template.

5. Manually pushing existing incidents

To manually push existing records:

1. Open an incident report.
2. Select Push to Ideagen Policy Logic.

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.

6. Troubleshooting integration

If the sync fails, you will have the option to attempt the sync again or update template mapping to resolve the issue.

6.1. Try Again

Select Try Again to attempt to push the records again. If this doesn't work, try updating the template mapping.

6.2. Update Template Mapping

Select Update Template Mapping to be taken to a page where 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 Ideagen Policy Logic 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.

7. Limitations

7.1. Automatically submit for approval when the form enters the first stage

Symptom

Even though the first stage of the workflow may be set up to automatically submit for approval when the form enters the stage, forms must be submitted for approval.

Explanation

Forms pushed from Clipboard to Ideagen Policy Logic are assumed to be approved to enter the first stage of the workflow.

Resolution

After an incident form has been pushed from Clipboard to Ideagen Policy Logic, they must be submitted for approval to move to the second stage. Customers may set up custom notifications to be notified of new incident forms.