External Linked Data

The linked data feature enables you to add data from external sources into fields on your Calm records. By default, the following data sources are available in Calm: AIM25, British Library and Wikipedia. Please note: You will need an internet connection to access external data sources and this connection will be subject to environmental conditions such as your network speed and performance, which are not under Axiell's control.

This page details how to add new data sources, how to configure them so that Calm can request data and recognise the format it is returned in and how to test a data source that you have configured, as well as how to edit or delete existing data sources.

If you are using the default external data or have already configured some data sources, see the following page 'Linking Data' for an explanation of linking data to your Calm records.

Configuring or Modifying Data Sources

Before you configure a data source, you will need to research it. You need to find out the formats that the search service will accept and the format that the response will be delivered in. You will also need knowledge of XSLT, this is a standard technology for processing XML and you will need it to transform responses from external data sources into a standard XML format that Calm can understand, so data can be linked to your Calm records.

To add a new data source:

From the main menu in Calm, click on the button.
Click on the button.
You will see a list of existing data sources (including the defaults supplied with Calm). Click the button on the right hand side.
Enter a name for the new data source. This name will appear in the list of data sources to select when linking data.
Click the button.

Next you need to define the query format, so that Calm knows how to construct and submit a query to the external data service. There are 2 HTTP methods generally in use, so either define a 'Get' where the search text is passed as part of the URL or, a 'Post' where the data is posted to the web server. Which method you use will be determined by the data source you are adding. Both are detailed below. Use the placeholder {0} to insert the text to be submitted.

To define a Get method - select Get from the drop-down box and enter the URL including the search text.

To define a Post method - select Post from the drop-down box and enter the query in the box below. You also need to enter the URL.
Click the button.

The next step is to define the XSLT transform code. The external data source may return its response in any XML format. You need to define XSLT transform code to process the XML into a standard format that Calm can understand.

You will see a default template in the XSLT transform box, use this to build your XSLT transform code.
Once you have written your XSLT transform, we recommend testing it. To do this, press the Test button under the XSLT box and see the 'Testing a Data Source' section below. Once you are happy with your XSLT transform code, continue to follow these instructions which take you through the remaining page of the wizard.
Select one or more Calm databases that this data service is relevant for.
Click the button. It will now be possible to link data from this new data source to your Calm records.

To edit an existing data source:

Editing a data source is a similar process to adding a data source as described above.

From the main menu in Calm, click on the button.
Click on the button.
You will see a list of existing data sources. Click on the data source you wish to edit, this will highlight it.
Click the button on the right hand side.
If you wish to edit the name of the data source, change it in the Name box. This name will appear in the list of data sources to select when linking data.
Click the button.
If you wish to edit the query format, change it on this page using the URL, HTTP Method and optionally Query boxes.
Click the button.
If you wish to edit the XSLT transform code, change it in the XSLT Transform box.
If you have edited your XSLT transform, we recommend testing it. To do this, press the Test button under the XSLT box and see the 'Testing a Data Source' section below. Once you are happy with your XSLT transform code, continue to follow these instructions which take you through the remaining page of the wizard.
If you wish to amend which database/s this data source pertains to, select more databases in the list, or click on the tick boxes of previously chosen databases to remove their selection.
Click the button.

To delete an existing data source:

From the main menu in Calm, click on the button.
Click on the button.
You will see a list of existing data sources. Highlight the data source you wish to delete.
Click on the button on the right hand side.
The data source has now been deleted, you will notice its name has been removed from the list.

Testing a Data Source

This feature in Calm helps you to diagnose any problems you may encounter whilst configuring a data source. The process takes you through a step-by-step examination of results at each stage of a data query and response. The 'Test Linked Data Source' dialogue box appears during your configuration of a data source, as described in the adding and editing processes above.

From the XSLT Transform dialogue box, press the button.
In the search text box, enter some text that you know will return results from the external data source.
Click the button.
The next page will show the 'raw' response from the server. Check this is what you expected.
Click the button.
The next page will show the response after it has been processed through your XSLT transform code. Check this is what you expected.
Click the button.
If the transformed data is valid for Calm, the next page will show the processed results. This means that the XSLT transform is working and the data is in the correct format for Calm. If this is not the case, you will need to amend your XSLT transform code (see 'Configuring or Modifying Data Sources' above).
Click the button.

Linking Data

By default, it is possible to link external data to the Catalog, Persons and Places databases in Calm. To add or configure data sources for other Calm databases, see the 'Configuring or Modifying Data Sources' section above. For details on linking data, see the following page 'Linking Data'.