The Hit export plugin can be configured to create an XML file when you accept or enforce a permit hit in Genetec Patroller™. This section lets you view an example of the default XML template, learn what the fields in the template mean, and to view an example of what your final output should look like.
What you should know
- When data is not available from a hit, the field information is replaced by an empty string in the output file. For example, on a regular hit (no overtime) all the overtime fields are removed and no values are output.
- Date and time formats can be added between curly brackets ({}) to the following
time fields:
- TimeStamp
- TimeStampUTC
- OvertimeTimeStamp
- OvertimeTimeStampUTC
For example, if you want the TimeStamp field to output the date (Month, Day, Year) and a 24 hour time format, you would enter %TimeStamp%{MM/dd/yyyy HH:mm:ss}. For more information about supported date and time format strings, click here.
Hit export XML template example
Following is an example of the default HitExportTemplate.XML located at:
C:\Program Files (x86)\Genetec AutoVu 6.6\MobileClient\TemplateFiles.
<?xml version="1.0" encoding="utf-8" ?>
<!--
!!!!!!!!!!!!!!!!!!!!!!!!!!!! IMPORTANT !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
This file is a sample of the available tags that you can use when creating a
template. Do not create a dependency on this file for it is subject to change.
Instead, you must create a copy of this sample and use it for your own purposes.
!!!!!!!!!!!!!!!!!!!!!!!!!!!! IMPORTANT !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-->
<Enforce>
<!--
*************************************************************************
NEWER
The following section describe how to exploit the XML export to access
the read Analytics fields using the generic #Analytics()# token.
It can be used to access any Analytics field given its name.
*************************************************************************
-->
<GeometricDop>#Analytics(GeometricDop)#</GeometricDop>
<PositionDop>#Analytics(PositionDop)#</PositionDop>
<TimeDop>#Analytics(TimeDop)#</TimeDop>
<HorizontalDop>#Analytics(HorizontalDop)#</HorizontalDop>
<VerticalDop>#Analytics(VerticalDop)#</VerticalDop>
<EastingDop>#Analytics(EastingDop)#</EastingDop>
<NorthingDop>#Analytics(NorthingDop)#</NorthingDop>
<Speed>#Analytics(Speed)#</Speed>
<ConfidenceScore>#Analytics(Confidence Score)#</ConfidenceScore>
<ReadWithDash>#Analytics(ReadWithSeparators)#</ReadWithDash>
<ActualPlate>#ActualPlate#</ActualPlate>
<!--
*************************************************************************
NEW
The following section describes the supported tags using the new format.
*************************************************************************
-->
<IsPlateExpired>#ISPLATEEXPIRED#</IsPlateExpired>
<IsPayZone>#ISPAYZONE#</IsPayZone>
<PlateStatus>#PLATESTATUS#</PlateStatus>
<HitId>#HIT_ID#</HitId>
<HitType>#HIT_TYPE#</HitType>
<ReadId>#READ_ID#</ReadId>
<PlateRead>#PLATE_READ#</PlateRead>
<PlateState>#PLATE_STATE#</PlateState>
<ReadType>#READTYPE#</ReadType>
<PermitName>#PERMIT_NAME#</PermitName>
<RuleId>#RULE_ID#</RuleId>
<RuleName>#RULE_NAME#</RuleName>
<UnitName>#UNIT_NAME#</UnitName>
<UnitId>#UNIT_ID#</UnitId>
<UserName>#USER_NAME#</UserName>
<UserLogin>#USER_LOGIN#</UserLogin>
<UserId>#USERId#</UserId>
<PermitId>#PERMIT_ID#</PermitId>
<ParkingPermitId>#PARKING_PERMIT_ID#</ParkingPermitId>
<Longitude>#LONGITUDE#</Longitude>
<Latitude>#LATITUDE#</Latitude>
<LprImagePath>#PLATE_IMAGE#</LprImagePath>
<ContextImagePath>#CONTEXT_IMAGE#</ContextImagePath>
<TireImagePath>#TIRE_IMAGE#</TireImagePath>
<TimeStamp>#DATE_LOCAL#{yyyy-MM-dd} #TIME_LOCAL#{HH:mm:ss}</TimeStamp>
<TimeStampUTC>#DATE_UTC#{yyyy-MM-dd} #TIME_UTC#{HH:mm:ss}</TimeStampUTC>
<OvertimeVehicleId>#OVERTIME_READ_ID#</OvertimeVehicleId>
<OvertimePlateRead>#OVERTIME_PLATE_READ#</OvertimePlateRead>
<OvertimePlateState>#OVERTIME_PLATE_State#</OvertimePlateState>
<OvertimeReadType>#OVERTIME_READTYPE#</OvertimeReadType>
<OvertimePermitName>#OVERTIME_PERMIT_NAME#</OvertimePermitName>
<OvertimeRuleId>#OVERTIME_RULE_ID#</OvertimeRuleId>
<OvertimeRuleName>#OVERTIME_RULE_NAME#</OvertimeRuleName>
<OvertimeUnitName>#OVERTIME_UNIT_NAME#</OvertimeUnitName>
<OvertimeUnitId>#OVERTIME_UNIT_ID#</OvertimeUnitId>
<OvertimeUserName>#OVERTIME_USER_NAME#</OvertimeUserName>
<OvertimeUserLogin>#OVERTIME_USER_LOGIN#</OvertimeUserLogin>
<OvertimeUserId>#OVERTIME_USER_ID#</OvertimeUserId>
<OvertimePermitId>#OVERTIME_PERMIT_ID#</OvertimePermitId>
<OvertimeLongitude>#OVERTIME_LONGITUDE#</OvertimeLongitude>
<OvertimeLatitude>#OVERTIME_LATITUDE#</OvertimeLatitude>
<OvertimeLprImagePath>#OVERTIME_PLATE_IMAGE#</OvertimeLprImagePath>
<OvertimeContextImagePath>#OVERTIME_CONTEXT_IMAGE#</OvertimeContextImagePath>
<OvertimeTireImagePath>#OVERTIME_TIRE_IMAGE#</OvertimeTireImagePath>
<OvertimeTimeStamp>#OVERTIME_DATE_LOCAL#{yyyy-MM-dd} #OVERTIME_TIME_LOCAL#{HH:mm:ss}</OvertimeTimeStamp>
<OvertimeTimeStampUTC>#OVERTIME_DATE_UTC#{yyyy-MM-dd} #OVERTIME_TIME_UTC#{HH:mm:ss}</OvertimeTimeStampUTC>
<OvertimeElapseMinutes>#OVERTIME_ELAPSEMINUTES#</OvertimeElapseMinutes>
<OvertimeElapseSeconds>#OVERTIME_ELAPSESECONDS#</OvertimeElapseSeconds>
<OvertimeElapseHours>#OVERTIME_ELAPSEHOURS#</OvertimeElapseHours>
<!--
*************************************************************************
LEGACY
The following section describes the supported tags using the legacy format.
It can still be used but they have been deprecated since Patroller 6.2.
*************************************************************************
-->
<IsPlateExpired>%IsPlateExpired%</IsPlateExpired>
<IsPayZone>%IsPayZone%</IsPayZone>
<PlateStatus>%PlateStatus%</PlateStatus>
<HitId>%HitId%</HitId>
<HitType>%HitType%</HitType>
<UserAction>%UserAction%</UserAction>
<VehicleId>%VehicleId%</VehicleId>
<Plate>%Plate%</Plate>
<State>%State%</State>
<ReadType>%ReadType%</ReadType>
<PermitName>%PermitName%</PermitName>
<ZoneName>%ZoneName%</ZoneName>
<UnitName>%UnitName%</UnitName>
<UnitId>%UnitId%</UnitId>
<UserName>%UserName%</UserName>
<UserLogin>%UserLogin%</UserLogin>
<UserId>%UserId%</UserId>
<PermitId>%PermitId%</PermitId>
<ParkingPermitId>%ParkingPermitId%</ParkingPermitId>
<ZoneId>%ZoneId%</ZoneId>
<GpsX>%GpsX%</GpsX>
<GpsY>%GpsY%</GpsY>
<LprImagePath>%LprImagePath%</LprImagePath>
<ContextImagePath>%ContextImagePath%</ContextImagePath>
<TireImagePath>%TireImagePath%</TireImagePath>
<TimeStamp>%TimeStamp%</TimeStamp>
<TimeStampUTC>%TimeStampUTC%</TimeStampUTC>
<OvertimeVehicleId>%OvertimeVehicleId%</OvertimeVehicleId>
<OvertimePlate>%OvertimePlate%</OvertimePlate>
<OvertimeState>%OvertimeState%</OvertimeState>
<OvertimeReadType>%OvertimeReadType%</OvertimeReadType>
<OvertimePermitName>%OvertimePermitName%</OvertimePermitName>
<OvertimeZoneName>%OvertimeZoneName%</OvertimeZoneName>
<OvertimeUnitName>%OvertimeUnitName%</OvertimeUnitName>
<OvertimeUnitId>%OvertimeUnitId%</OvertimeUnitId>
<OvertimeUserName>%OvertimeUserName%</OvertimeUserName>
<OvertimeUserLogin>%OvertimeUserLogin%</OvertimeUserLogin>
<OvertimeUserId>%OvertimeUserId%</OvertimeUserId>
<OvertimePermitId>%OvertimePermitId%</OvertimePermitId>
<OvertimeZoneId>%OvertimeZoneId%</OvertimeZoneId>
<OvertimeGpsX>%OvertimeGpsX%</OvertimeGpsX>
<OvertimeGpsY>%OvertimeGpsY%</OvertimeGpsY>
<OvertimeLprImagePath>%OvertimeLprImagePath%</OvertimeLprImagePath>
<OvertimeContextImagePath>%OvertimeContextImagePath%</OvertimeContextImagePath>
<OvertimeTireImagePath>%OvertimeTireImagePath%</OvertimeTireImagePath>
<OvertimeTimeStamp>%OvertimeTimeStamp%</OvertimeTimeStamp>
<OvertimeTimeStampUTC>%OvertimeTimeStampUTC%</OvertimeTimeStampUTC>
<OvertimeElapseMinutes>%OvertimeElapseMinutes%</OvertimeElapseMinutes>
<OvertimeElapseSeconds>%OvertimeElapseSeconds%</OvertimeElapseSeconds>
<OvertimeElapseHours>%OvertimeElapseHours%</OvertimeElapseHours>
</Enforce>
Analytics fields
#Analytics()#
token. For
example, to access the GeometricDop analytic, use
<GeometricDop>#Analytics(GeometricDop)#</GeometricDop>
- Analytics are not available for plate reads that are entered manually. Existing analytics for a plate read are not modified if you edit the read.
- Dilution of precision (DOP) describes the temporary reduction of the ability of the system to precisely geocode your location due to the current position of the satellites. DOP analytics are only available with AutoVu™ base units that include the navigation option.
Field (Patroller 6.5 SR3 and later) | Description |
---|---|
GeometricDop | Geometric dilution of precision (GDOP) indicates accuracy
degradation in 3D position and time. NOTE: GDOP is the most
useful DOP to be aware of. The value includes all of the
available factors.
|
PositionDop | Position dilution of precision (PDOP) indicates accuracy degradation in 3D position. |
TimeDop | Time dilution of precision (TDOP) indicates the clock offset. |
HorizontalDop | Horizontal dilution of precision (HDOP) indicates accuracy degradation in the horizontal direction. |
VerticalDop | Vertical dilution of precision (VDOP) indicates accuracy degradation in the vertical direction. |
EastingDop | Easting dilution of precision (EDOP) indicates accuracy degradation in the east component of the horizontal direction interpretation. |
NorthingDop | Northing dilution of precision (NDOP) indicates accuracy degradation in the north component of the horizontal direction interpretation. |
Speed | Sharp cameras are
able to estimate a vehicle’s approximate speed. NOTE: For a mobile AutoVu™
installation, the Genetec
Patroller™ vehicle must be
stopped for this feature to work.
|
ConfidenceScore | Numerical value (from 0 to 100). This value tells you how confident the Sharp is in the accuracy of the read. A value of 100 indicates the highest confidence. |
ReadWithSeparators | Exports dash characters that appear in plate reads. NOTE: Analytics are not available for
plate reads that are entered manually. Existing
analytics for a plate read are not modified if you edit
the read. For this reason, we recommend that you
use the ActualPlate hashtag instead of the
ReadWithSeparators analytic.
|
General fields
Field Patroller 6.5 SR3 and later | Description |
---|---|
ActualPlate | To export the dash in license plate reads (for example
ABC-123), modify
<PlateRead>#PLATE_READ#</PlateRead
> to
<PlateRead>#ActualPlate#</PlateRead
> . |
General fields
Field (Patroller 6.1 and earlier) | Field (Patroller 6.2 and later) | Description |
---|---|---|
IsPlateExpired | IsPlateExpired | "True" or "False" boolean value that indicates if the license plate is expired or not. |
IsPayZone | IsPayZone | "True" or "False" boolean value indicating if the selected zone is a “pay by zone” parking area. |
PlateStatus | PlateStatus | Specifies the status of the plate. The possible values are: Expired, Valid, and NotChecked. |
HitId | Hit_Id | The hit ID output as a GUID. For example: 000000000-0000-0000-000000000000. |
HitType | Hit_Type | The type of hit. Possible values are: Hotlist, Overtime, Permit, and SharedPermit. |
VehicleId | Read_Id | The vehicle’s ID output as a GUID. For example: 000000000-0000-0000-000000000000. |
Plate | Plate_Read | The license plate number. For example, ABC123. |
State | Plate_State | The license plate’s issuing state or province. For example: QC. |
ReadType | ReadType | The type of read. Possible values are Standard, Permit, Overtime, SharedPermit. |
PermitName | Permit_Name | Permit entity name. |
ZoneName | Rule_Name | Permit zone name (parking lot, permit restriction, and so on). Used in University Parking Enforcement only. |
UnitName | Unit_Name | The name given to the Patroller unit in Patroller Config Tool. |
UnitId | Unit_Id | The Patroller unit’s GUID ID. For example: 000000000-0000-0000-000000000000. |
UserName | User_Name | The Patroller operator’s Security Center username. |
UserLogin | User_Login | The Patroller operator’s login name. |
UserId | UserId | The Patroller user’s GUID ID. For example: 000000000-0000-0000-000000000000. |
PermitId | Permit_Id | The selected permit’s GUID ID. For example: 000000000-0000-0000-000000000000. |
ParkingPermitId | Parking_Permit_Id | The selected shared permit’s GUID ID. For example: 000000000-0000-0000-000000000000. |
ZoneId | Rule_Id | The selected zone’s GUID ID. For example: 000000000-0000-0000-000000000000. |
GpsX | Longitude | The Patroller’s longitude in decimal degrees for when the hit
occurred. For example: -73.5878100. |
GpsY | Latitude | The Patroller’s latitude in decimal degrees for when the hit
occurred. For example: 45.5088400. |
LprImagePath | Plate_Image | The location of the ALPR image on the Patroller in-vehicle computer. |
ContextImagePath | Context_Image | The location of the context image on the Patroller in-vehicle computer. |
TireImagePath | Tire_Image | The location of the tire image on the Patroller in-vehicle computer. |
TimeStamp | Date_Local Time_Local | The plate read timestamp. For example: 8/15/2014 12:04:07. |
TimeStampUTC | Date_UTC Time_UTC | The plate time stamp in Coordinated Universal Time (UTC).
For example: 8/15/2014 4:04:07. |
Overtime fields
The remaining fields in the HitExportTemplate.xml are related to the first plate read captured during the first pass in an overtime enforcement scenario.
Field Patroller 6.1 and earlier | Field Patroller 6.2 and later | Description |
---|---|---|
OvertimeVehicleId | Overtime_Read_Id | The vehicle’s ID output as a GUID. For example: 000000000-0000-0000-000000000000. |
OvertimePlate | Overtime_Plate_Read | The license plate number. For example, ABC123. |
OvertimeState | Overtime_Plate_State | The license plate’s issuing state or province. For example: QC. |
OvertimeReadType | Overtime_ReadType | The type of read. Possible values are Standard, Permit, Overtime, SharedPermit. |
OvertimePermitName | Overtime_Permit_Name | Permit entity name. |
OvertimeZoneName | Overtime_Rule_Name | Permit zone name. For example, parking lot or permit restriction name. Used in University Parking Enforcement only. |
OvertimeUnitName | Overtime_Unit_Name | The name given to the Patroller unit in Patroller Config Tool. |
OvertimeUnitId | Overtime_Unit_Id | The Patroller unit’s GUID ID. For example: 000000000-0000-0000-000000000000. |
OvertimeUserName | Overtime_User_Name | The Patroller operator’s Security Center username. |
OvertimeUserLogin | Overtime_User_Login | The Patroller operator’s login name. |
OvertimeUserID | Overtime_User_ID | The Patroller user’s GUID ID. For example: 000000000-0000-0000-000000000000. |
OvertimePermitId | Overtime_Permit_Id | The selected permit’s GUID ID. For example: 000000000-0000-0000-000000000000. |
OvertimeZoneId | Overtime_Rule_Id | The selected zone’s GUID ID. For example: 000000000-0000-0000-000000000000. |
OvertimeGpsX | Overtime_Longitude | The Patroller’s longitude (x-coordinate) in decimal degrees for when
the hit occurred. For example: -73.5878100. |
OvertimeGpsY | Overtime_Latitude | The Patroller’s latitude (y-coordinate) in decimal degrees for when
the hit occurred. For example: 45.5088400. |
OvertimeLprImagePath | Overtime_Plate_Image | The location of the ALPR image on the Patroller in-vehicle computer. |
OvertimeContextImagePath | Overtime_Context_Image | The location of the context image on the Patroller in-vehicle computer. |
OvertimeTireImagePath | Overtime_Tire_Image | The location of the tire image on the Patroller in-vehicle computer. |
OvertimeTimeStamp | Overtime_Date_Local Overtime Time Local | The plate read timestamp. For example: 8/15/2014 12:04:07. |
OvertimeTimeStampUTC | Overtime_Date_UTC Overtime_Time_UTC | The plate time stamp in Coordinated Universal Time (UTC). For example: 8/15/2014 4:04:07. |
OvertimeElapseMinutes | Overtime_ElapseMinutes | The time (in minutes) between the first pass read plate read and second pass plate read. |
OvertimeElapseSeconds | Overtime_ElapseSeconds | The time (in seconds) between the first pass read plate read and second pass plate read. |
OvertimeElapseHours | Overtime_ElapseHours | The time (in hours) between the first pass read plate read and the second pass plate read. |