Using the XVault Management Console

By default the XVault Web Management Interface is accessible via http://localhost:8080/Groupcall/.

The following sections are shown in the XVault Web Management Interface:

  • Agent – this is where you configure Agent-specific settings for XVault.
  • Zones – lists all configured zones, and the school name if detected.
  • Error log – shows any error messages received or generated by XVault.
  • SIF Log – shows the current SIF activities being carried out by XVault.

 Agent Configuration

The Agent configuration screen allows you to adjust the verbosity of the agent logging, configure Collection Templates and restart the XVault Embedded SIF Agent without restarting XVault entirely.

Adjusting Agent Logging Verbosity

To increase logging information select Debug, under Log Level.  Stop and Start the XVault Agent using the Stop Agent button then clicking again when it turns into the Start Agent button.

The additional logging output will be stored in C:\Program Files\Apache Software Foundation\Tomcat 7.0\Logs\stdout.log

This option generates extensive logging, you should revert to INFO or WARNING as soon as possible and restart the agent.

Restarting the XVault Embedded SIF Agent

The XVault Embedded SIF Agent is used for both SIF and Non-SIF zones.

Click the Stop Agent button and allow up to 30 seconds per configured zone for the embedded agent to stop.  When the button changes to say Start Agent, click Start Agent.

Configure Collection Templates

Please see the separate section entitled Configuring Data Collection.

Zones

Clicking on Zones will show you a list of all configured SIF zones.  Zones where the school name can be autodetected (i.e. where a SchoolInfo object has been collected) will have the school name shown beside them.

Adding a new SIF Zone

Click on Zones to add a new SIF Zone to XVault.  You will need to know the Zone ID and Zone URL from your ZIS operator, and you will need to install Xporter as a data provider in the zone using the same Zone ID and Zone URL.  The Xporter installation will need to be on the MIS server for the school that the zone serves.

  • Enter the Zone ID as the Zone Name
  • UK convention sets the Zone ID using the school LEA+Estab numbers, e.g. 1231234
  • Enter the Zone URL into the Zone URL box
  • Select a template to use the agent settings or custom to select the SIF objects
  • Click Save to save the zone entry

If this is the first zone you have created on XVault then click on Agent and select Start Agent.  If not then data collection on the zone will be automatically started.

Adding a new Non-SIF Zone

New Non-SIF zones are created automatically by XVault when an Xporter installation reports that it is a provider for the XVault agent.

Once the Xporter installation has registered as a provider to the XVault agent the XVault agent will detect this within an hour and automatically create a zone for it, assigning the DashNewProvider template and commence data collection.  If you have followed the recommended configuration then this will result in XVault requesting the SchoolInfo and LearnerSchoolEnrolment objects.  As a result the school name should be shown in XVault shortly after the zone is auto-created.

As part of the feedback loop on new installations you should manually migrate schools over to the correct template, using DashNewProvider as a safety net to detect misconfigured installations and/or accidental providers.

View Zone Status

In the Navigation pane click on the Zone you wish to enquire about.  The zone configuration page will load and show all SIF Objects configured in the assigned Collection Template.

For each SIF Data Object the page will show the Last Sync’d time, which is the last time XVault requested that object from the zone, and the Last Recv’d time, which is the last time data was received.

Update a SIF Data Object on demand

In the Navigation pane click on the Zone you wish to enquire about.  The zone configuration page will load and show all SIF Objects configured in the assigned Collection Template.

Click on the Sync icon for the object you wish to refresh.  XVault will request data from the zone and, hopefully(!), the data will be returned.  Note that depending on infrastructure and transport this can take up to 15 minutes, you can monitor the progress of the request by viewing the SIF Log.

Rebase a Zone

In the Navigation pane click on the Zone you wish to enquire about.  The zone configuration page will load and show all SIF Objects configured in the assigned Collection Template.

Click on the Resync button and confirm.  XVault will delete all data held for the zone and will request all data again from the zone.

Disable or Enable a Zone

In the Navigation pane click on the Zone you wish to enquire about.  The zone configuration page will load and show all SIF Objects configured in the assigned Collection Template.

Untick Is Zone Active to disable the zone and click Save.  This change will take immediate effect and XVault will disconnect from the zone and stop requesting data.  The data already in the XVault Database will be retained.

To re-enable a zone, tick Is Zone Active then click Save.

Delete a Zone

In the Navigation pane click on the Zone you wish to enquire about.  The zone configuration page will load and show all SIF Objects configured in the assigned Collection Template.

Click Delete and confirm.  XVault will delete all data held for the zone and permanently remove it.  If the zone is a Non-SIF zone and you wish to add it back again at a future date then you will need to add it manually.

Error Log

This will show you a collated view of all error messages received via SIF by XVault and any internal errors raised by XVault along with the date on which they occurred and details of the error.

You should check the Error Log periodically and address any issues that arise.  For example you may find error messages indicating that certain SIF objects are not available in a given zone, in which case you should investigate the ACL for that zone and ensure that the Xporter SIF Agent installation for that zone is correctly configured.

The error log is also surfaced in the SQL database so that automated processes can read and monitor it.

SIF Log

The SIF Log shows all current SIF actions along with their associated Zone, SIF Object and unique message identifier.

A message will either show Registration or Deregistration to a zone, or will show a data request being made.  Where a data request is made it will show Requested then Processing then Processed.  A statistic will show how many packets and records were returned.  If a request fails then the error message is shown and also logged to the Error Log.