ResourcePage/vms_main_banner.jpg

Help Index

Export Management

This page is only available to users with Administrator rights, and allows for the generation of Violation exports - either in the Standard (default) VMS Format or third part formats such as StarTraq or Cubic. The export format is a property of the 'Region' to which the site has been assigned. Put another way: each 'Region' is allocated a specific 'Exporter', so assigning a site to a region has the effect of defining the export format that will apply to the violations associated with that site. The following actions are available:

Initially, and depending on how the VMS instance has been configured, the display will look something like one of the following ...


This is the preferred configuration.

AdminExportsInitial2.png

Note that depending on how the system was configured, the available controls could also include a variation of the following:

AdminExportsCtl1.png

In this instance the user may define their own batch name (e.g. 'Batch9') prior to performing a manual export described below. The difficulty imposed by this option is that it's incompatible with Scheduled exports.


AdminExportsCtl2.png

In this instance the Administrator has the option to copy the selected export to a specific predefined system location. See Copy Batch for details.


Headings

Most of the table headings are self-explanatory:

Scheduled Batch Exports

Ideally, exports should be scheduled to occur automatically at one or more preset times throughout the day (usually at 02:30 AM each morning). Note that even if a system has been configured to perform scheduled exports it is still possible to force 'Manual' exports at any time.

Manual Batch Finalization

After pressing the Refresh button, the display will either remain unchanged or update to reflect the availability of exportable violations.

AdminExportsFinalize.png

In this instance the Batch Name control has been suppressed (hidden), and the user has selected violations for the 'Bedfordshire' region and Site 'KH1'.

ResourcePage/Important.png Be careful with temporary sites denoted by the 'X.' prefix. Usually such sites are not exported, however the VMS system can be configured to allow it.


To force a manually initiated export at any time, press the Finalize button, and select (or not) the applicable Region and/or Site. By default, all Adjudicated (and Supervisor-confirmed) violations for all region and site violations will be exported. Depending on how many offences are actually being exported, this may take anywhere between a few seconds and a minute. A Finalized message will be displayed once the export is complete.

Pressing the Refresh button again will produce a display something like the following ...

AdminExportsFinalized.png

Note that this panel attempts to automatically refresh upon completion of a manual export, but if no change is detected after 10 seconds, then you may have to manually refresh with the Refresh Button.

Copying a batch

Again, depending on how the system was configured, one of the following displays is possible.

AdminExportsCopy2.png

... or ...

AdminExportsCopy.png

It is not usually necessary for the user to use the 'copy button', and is normally only required if the batch must be copied to a predefined location such as a memory stick or shared NAS folder. Select the required batch from the list and press the displayed Copy button. Note that his button is only available if the ExporterFolder parameter has been correctly defined in the vms.locale database table. Speak to your technical support team for more details or run the 'System - Locate Details' report from the Reporter page.

Destination Folder

For security reasons, the destination 'copy' folder is pre-configured for each installation. To see the configured export folder, run the System - Locale Details report on the Reporter page.

Note

AdminExportsCopy.png

Once the batch has been successfully copied, the display should look something like the following ...

AdminExportsCopyDone.png

Note that the same batch may be copied multiple times, and original batch will remain unchanged.


Restrictions

It is important to appreciate that the VMS will not export violations that are associated with site codes that begin with the Reserved Prefix 'X.'. Consequently, such violations will not even be listed when the Refresh button is clicked. This is a safety precaution that ensures that violations have been properly allocated to valid Site Codes before export. Note for instance that StarTraq is not able to process violations that have sites codes that have not already been pre-configured on their systems.


2023-12-18 12:49