Symology Insight
The Symology Insight integration allows Highway and Traffic Management requests to be raised in Symology Insight using data from Jadu Connect cases. At the point a Symology Insight Request is created or updated via Jadu Connect, information from the Request can also be pulled back and stored in fields on the associated Jadu Connect Case. It also allows images associated with the case to be uploaded to a Symology Image Storage server.
General settings
On the General tab, you can enable/disable the integration with Symology Insight, and configure its settings.
When you save the settings, with the integration enabled, Jadu Connect will attempt to connect to the Symology Insight SOAP server and the provided Image Storage server to verify the settings.
If the connection fails, the settings will not be saved, and an error message detailing the reason for the failed connection will be displayed.
- Insight WSDL URL - the URL to the Symology Insight SOAP service definition document.
- Username - the username of the account that you wish for Jadu Connect to transact as.
- Password - the password of the account that you wish for Jadu Connect to transact as.
- Timezone - the timezone set for your Symology Insight instance in "Location/Area" format (list of supported timezones). Defaults to
Europe/London. - Image Storage SFTP Server Host - the SFTP URL to the Symology Image Storage server.
- SFTP Port - the port with which to connect to the Symology Image Storage server.
- SFTP Username - the username of the SFTP account with which to connect to the Symology Image Storage server.
- SFTP Password - the password of the SFTP account with which to connect to the Symology Image Storage server.
- SFTP Timeout - the number of seconds to await a response from the Symology Image Storage server.
References
A Reference is a special type of field used to store a reference number against a case. When creating a mapping template, the reference to which the template applies must be selected.
Mapping templates
A Mapping template is a set of mappings which define the data to be passed between Jadu Connect and Symology when creating and updating requests.
After giving your mapping template a name, you must select the type. 3 types of mapping template can be created:
- Create request (outgoing) - defines the fields to be populated when creating a Symology Insight request.
- Update request (outgoing) - defines the fields to be updated when updating a Symology Insight request.
- Request (incoming) - defines the request data which should be pulled back from Symology Insight and stored on the Jadu Connect case, following a create/update action instigated by Jadu Connect.
Finally, you must complete the mappings.
In the first row of the mappings you must select which Reference the template applies to. For Create request templates, this means that the reference number for the new request will be stored in this Reference. For Update request templates, this means that the reference number of the request to be updated is held in this Reference. For Request templates, this means that the template would be applied following a create/update action linked to this Reference.
The subsequent rows are field mappings. Each of the 3 templates has required fields that must be mapped. You can then add as many additional mappings as you wish by clicking the Add Another button.
The following type of data can be used from the Jadu Connect case:
- Case field values
- Case dates
- Linked Person details
- Linked Address details
You can also configure a manual text mapping if the value of the request field should be the same each time that mapping template is used.
You should not rely on the integration to ensure that data is removed from the Jadu Connect case or the Request automatically when clearing down personal data in either system. The specific tools provided in each system should be used directly to ensure that no personal data is left unnecessarily.
Additional fields
Symology Insight has an Additional fields section of a request. These fields can be populated in Connect by setting the Symology Insight field text input value to the associated additional field reference:
The FieldLine|ValueType value can be entered as static text based on which value type/field the additional field has.
For instance 10|2 means Field Line 10 (ie the 10th additional field), Value Type 2 (Integer).
Value types
| ID | Value type | Notes |
|---|---|---|
| 1 | Text | Any value mapped will be sent as is. |
| 2 | Integer | Any value mapped will be sent as is. |
| 3 | Numeric | Any value mapped will be sent as is. |
| 4 | Date | Can be mapped to a Date field, a Date Time field or a Case Date. |
| 5 | Time | Can be mapped to a Date Time field, or a Case Date, and the time value will be extracted from it. |
| 6 | Checkbox | The values 1, true, yes or y will tick the checkbox, 0, false, no or n will untick it. |
| 7 | Codes | Any value mapped will be sent as is. |
| 8 | Object | This is used to reference images sent to the SFTP server. See Image uploads for more details. |
| 9 | Heading | Any value mapped will be sent as is. |
| 10 | Heading | Any value mapped will be sent as is. |
Outgoing mapping templates are applied via rules, using the Apply integration action.
Incoming mapping templates are applied as a result of a Create or Update Request mapping template being applied. All incoming mapping templates for the applicable Reference will be applied.
Since integrations are run as background tasks and will be retried in the case of any connectivity failure, it is likely that any subsequent rule actions (e.g. sending an email) will be performed before the Request has been created/updated in Symology. This should therefore be accounted for when designing workflows.
Image uploads
For case attachment images to be uploaded to the SFTP server, the request action must be run after the files have been attached to the case. Also, for each image, an additional field mapping must be set up with its value set to the image name.
As an example, a Connect case could be submitted by filling out a form in Jadu Central. When the end user attaches images to the XFP form, all image names can be set to a single field value in Jadu Central. E.g:
image1.jpg, image2.jpg, image3.jpg.
In the Connect mapping template, this value can be used in all object fields set in Symology to link to an image:
| Additional Connect field | Actual value | Symology Insight field |
|---|---|---|
| ImageNames | image1.jpg, image2.jpg, image3.jpg | 1|8 |
| ImageNames | image1.jpg, image2.jpg, image3.jpg | 2|8 |
| ImageNames | image1.jpg, image2.jpg, image3.jpg | 3|8 |
| ImageNames | image1.jpg, image2.jpg, image3.jpg | 4|8 |
As a result of this mapping, field 1 will be populated with a link to image1.jpg, 2 with image2.jpg and 3 with image3.jpg. Though a mapping exists for field 4, the user in this scenario only uploaded 3 images, so the 4th field will be left empty.
Central Forms will attach files from the form submission after the case has been created, so to avoid the integration creating the Request before all files have been attached, the time in status or date triggers can be used within the workflow setup:
Any files uploaded to the Jadu Connect case after the Request has been created do not get added to the Request in Insight.
This functionality was built to facilitate uploading images, but any attached file will be uploaded to the SFTP server if its file name is populated in the mapping template, and any desired restrictions on the file type would be expected in the configuration of the associated XForm.
Log
The integration log provides a summary of case integration actions that have occurred; including where requests have been successfully created or updated, and where requests have failed to be created (including the reason for the failure, if known). The log also details any validation failures when creating or updating the request, or when updating the case with values from the request. Reviewing the integration log can help to identify incorrect mappings or areas where validation during data capture is insufficient.
Where an action has failed due to a connection issue or other intermittent error, it will be retried up to a maximum of ten times over a seven hour period. If integration has failed due to a validation error (e.g. due to an invalid mapping value), it will not be retried.
