Managing a Visualisation Website

The development of the Serval Maps Visualisation web site took a deliberate decision that all data, or at least as much as practicable, would be generated as files that could be served statically by the web server. Additionally there would be no need for a database.

For this reason when new data is added to a visualisation it must be cached so that it can be visualised on the map. This includes the addition of new forms, and new form instances (completed forms).

This section of the wiki outlines how to undertake these types of activities.

Accessing the Admin Control Panel

To access the admin control panel enter the following URL into the browser

http://maps.servalproject.org/{visualisation}/admin

Replace {visualisation} with the name of the website that you wish to administer. For example:

Using the Admin Control Panel

To use the admin control panel you need the API Key. This key is available from Romana Challans or is located towards the top of the following file.

webroot/admin/index.php

Enter the API key into the textfield labelled 'API Key' at the top of the admin panel. It is now possible to undertake one or more of the following actions.

Update the Form Cache

Updating the form cache will cache any new form definitions since the last time this task was undertaken. To undertake this task ensure the API key is entered into the 'API Key' text field and then click the 'Update Form Cache' button.

Update the Instance Cache

Updating the instance cache will cache any new form instances (completed forms) since the last time this task was undertaken. Additionally on the KiwiEx 2013 visualisation this will also update the thumbnails. The Marion Caltrop visualisation uses a separate process to update the thumbnails.

To undertake this task ensure the API key is entered into the 'API Key' text field and then click the 'Update Instance Cache' button.

Update the Thumbnails

Due to the large size of the images provided by some of the devices used during the trial the update of thumbnails in the cache for the Marion Caltrop visualisation is a separate process.

To undertake this task ensure the API key is entered into the 'API Key' text field and then click the 'Update Thumbnail Cache' button.

Depending on the number of thumbnails that need to be generated one of two things will happen.

  1. After approximately 5 minutes that script will end with a Internal Server 500 error. This is because the script has taken to long to finish and has been killed by the web server. If this occurs just refresh the page to start the process again to update the cache of any remaining files.
  2. A message will appear indicating the number of thumbnails that needed to be generated and that the process had completed successfully.

Reset the Form Cache

Resetting the form cache will delete all of the contents of the cache related to form definitions. To undertake this task ensure the API key is entered into the 'API Key' text field and then click the 'Reset Form Cache' button.

Reset the Instance Cache

Resetting the instance cache will delete all of the contents of the cache related to form instances (completed forms). To undertake this task ensure the API key is entered into the 'API Key' text field and then click the 'Reset Instance Cache' button.


Login