XVault Data Collection

Configuring a Collection Template

A data collection template is assigned to a zone to detail the SIF objects to be requested and the schedule to carry out those requests.  A collection template also determines whether a zone will listen to any SIF data events created by the Groupcall Xporter SIF Agent.

Selecting the SIF Data Objects to Collect

Click on Agent in the Navigation pane of the XVault Web then scroll to the Collection Template you wish to configure.

All SIF Objects that are allowed on the XVault are listed in the Collection Template.  For each object tick both, either or neither of the two tick boxes accordingly:

  • Can Subscribe – this means that XVault will carry out request/response on this object in any zone where this template is applied.
  • Handle Events – this means that XVault will subscribe to events and process any events created by the Xporter SIF Agent in any zone where this template is applied. For Non-SIF zones, must be selected for SchoolInfo, but is not required for any other objects.

When completed click Save, this will reassign the template to all zones configured to use it.

Data Collection Schedules

Click on Agent in the Navigation pane of the XVault Web then scroll to the Collection Template you wish to configure.

The Sync Time column shows what time XVault will request each SIF object from each zone where this template is applied.  A number of options can be entered, by default XVault is set to request every 24 hours from the time the XVault application started.

  • Periodic collection – enter a number into the Sync Time column, this will be interpreted as the number of hours between queries.  E.g. enter 48 to have data collection every 48 hours.
  • Scheduled collection – enter a time to fire the request message at, e.g. enter 13:00 to have the request message sent to each zone at 1pm.
  • Scheduled randomised collection – enter two times to give a window for requests to happen within, e.g. enter 13:00-15:00 to have the request message sent at a random time between 1pm and 3pm in each zone.  Note the exact time is randomised per zone.
  • Day-specific – enter MONDAY:13:00 to have collection at 1pm on a Monday, or enter MONDAY:13:00-15:00 to have a random collection between 1pm and 3pm on a Monday
  • Monthly - Enter 1st to collect on the 1st day of the month. Comma separate for multiple days, e.g. 1st,5th,20th
  • Multi-day – Enter schedules separated by commas to have collection on multiple days, e.g. MONDAY:13:00-15:00,WEDNESDAY:13:00-15:00,FRIDAY:12:00-14:00

When completed click Save, this will reassign the template to all zones configured to use it.  Collection schedules will only apply where the Can Subscribe box is ticked; this is because it affects the time a request is sent.  XVault cannot determine the time that Xporter SIF Agents process requests and deliver responses, or the time that they generate events.

 

Learner Attendance Collection

The LearnerAttendance SIF data object in XVault collects only today and yesterday’s sessional attendance.  However it is also useful to collect sessional attendance twice a day, once in the morning and once in the afternoon.  For this reason the LearnerAttendance object is defined twice in the default configuration to allow you to set different collection schedules for the LearnerAttendance (e.g. 09:30-10:00) and LearnerAttendance.PM (e.g. 14:30-15:00) objects.

If you require LearnerAttendance to be collected only once a day then collect only LearnerAttendance and enter the schedule to suit your needs.  You can just untick the LearnerAttendance.PM object in this case.

Monitoring Data Collection

Groupcall XVault can report its data collection statistics to Groupcall Dashboard, which can then provide an aggregated view of all data collection zones.  The aggregated view highlights zones where data has not recently been received and allows you to drill in to get additional information about the number of records held and when they were last received.

If you would like to make use of this functionality please contact sales@groupcall.com.