Documentation > Admin >

Notification Types

The following notification types are supported. The type is specified in the Condition field on the Notifications admin screen.

Notification Type	Abbreviation
After hours cancellation transmission	after.hours.cancel
After hours emergency transmission	after.hours.emerg
After hours short notice transmission	after.hours.short
After hours transmission parse error	after.hours.parse.error
Audit transmission	audit
Damage transmission	damage
Design transmission	design
Email report failed	postponed.report.error
Email report timed out	report.timeout
Emergency locate routed to a bucket	bucket.emergency
Emergency locate routed to a bucket after hours	bucket.emergency.afterhours
Feed volume alarm (automatic thresholds)	low.volume.auto
Feed volume alarm (manual thresholds)	low.volume.man
High-profile locate	high.profile
Investigation closed	risk.close
Locate automatically closed	auto.close
Locate due date changed	due.date.change
Locate routed to a bucket	bucket.delivery
Locate routed to a bucket after hours	bucket.afterhours
Normal hours cancellation transmission	normal.hours.cancel
Normal hours emergency transmission	normal.hours.emerg
Normal hours short notice transmission	normal.hours.short
Photo missing	photo.missing
Problem fetching email transmissions	fetch.problem
RAID storage problem	raid.problem
Responder problem	responder.problem
Responder status	response.status
Responder volume	response.volume
System usage	system.usage
Ticket reprocessing	reprocess.tickets
Time approved in advance	time.approve.advance
Transmission parse error	parse.error
Transmission received	receive
Transmissions with no locates	no.locates

Email report failed

Notification sent for email reports that fail to run. A notification is sent each time a report fails because of a timeout or internal error. The same report may fail repeatedly before TicketRx stops trying to run it. The notification includes error details that may be used to diagnose the problem.

Only email notifications can be sent for this notification type. Entries with a fax destination are ignored.

Photo missing

Used for utility statuses marked as "Requires photo" in the Utility configuration. When a locate is statused with such status codes, TicketRx expects a photo to be present on the ticket within 1 hour from sync. If after this period of time a photo is still missing, the notification is sent.

Only email notifications can be sent for this notification type. Entries with a fax destination are ignored. The notification can be assigned to a particular feed or utility, in which case only messages are only sent concerning locates for that feed or utility. If no feed is specified, then messages will be sent for all feeds. Additional restrictions can be put in the restriction field.

Samples:

Destination	Message
Email	The following tickets do not have photo attachments: A090123 A090125
SMS	Ticket A090123 does not have photo attachments.

Locate due date changed

This notification is sent when a new transmission is received for a ticket and the new transmission has an earlier due datefor some locates that are already in the system. Note the due date values on the locates themselves are not changed in this case, but the notification is sent.

Samples:

Destination	Message
Email	Ticket A123560 Feed CEN3 The following locates received a transmission with an earlier due date: Water WTR1 is due on 2009-09-17 12:30:00 EST, the due date/time from the new transmission is 2009-09-17 10:55:00 EST
SMS	Due date warning: ticket A123560, due date on transmission: 2009-09-17 10:55:00 EST

Problem fetching email transmissions

Notifications about problems that occur when email for a feed is being retrieved. For example, problems with connecting to the email server. The message includes brief information about the feed and POP server for which the error occurred.

Only email notifications can be sent for this notification type. Entries with a fax destination are ignored. The notification can be assigned to a particular feed, in which case only messages concerning email receivers for that feed will be sent. If no feed is specified, then messages will be sent for all feeds. The restriction field is ignored for this notification type.

Responder problem

Notifications sent for positive responses which could not be sent because of an error. It includes problems with connecting to the remote service and situations when that service replies with a failure code. If the service replies with an error then the notification includes the affected ticket numbers. In the SMS format, up to five ticket numbers are included. In the email format up to 200 ticket numbers are included.

The notification can be configured for all feeds or for a specific feed. When the notification is configured for all feeds then the restriction field can be used to define a comma separated list of states.

Responder volume

The notification has the following fields:

Feed - This field shows what feed the associated row of information pertains to.
Responses in queue - The number of responses that are queued to be sent for the feed.
Oldest response - The date/time when the oldest, not-yet-sent response was queued for the feed.
Age of last sent response - The age of the most recent response in HH:MM:SS (no more than 1 month old).
Responded (2 hours) - The number of responses that were sent during the 2 hours prior to the last hour for the feed.
Responded (a week ago) - The number of responses that were sent during this same timeframe one week ago for the feed.
Queued (2 hours) - The number of responses that were queued during the 3 hours prior to the last hour for the feed.

There are circumstances where there may have been activity on a feed in the 30 minutes prior to this notification being sent but it will not show up on this notification. One such situation is if all responses for a feed have been sent and there are zero queued responses for the feed at the time this notification is sent. This notification only includes feeds with queued responses at the time it is sent.

Time approved in advance

Notification sent when a manager approves a timesheet with ending dates in the future.

The table below provides more information about how the notification types are used.

Notification Type	Transmissions	Restrictions	Feed	Utility
After hours cancellation transmission	X*	X	X*	X*
After hours emergency transmission	X*	X	X*	X*
After hours short notice transmission	X*	X	X*	X*
After hours transmission parse error	X		O
Audit transmission	X	X	X*	X*
Damage transmission	X	X	X*	X*
Design transmission	X	X	X*	X*
Email report failed
Email report timed out
Emergency locate routed to a bucket		X
Emergency locate routed to a bucket after hours		X
Feed volume alarm (automatic thresholds)
Feed volume alarm (manual thresholds)
High-profile locate	X*	X*		X
Investigation closed
Locate automatically closed	X*			X
Locate due date changed	X*		O	O
Locate routed to a bucket		X
Locate routed to a bucket after hours		X
Normal hours cancellation transmission	X*	X	X*	X*
Normal hours emergency transmission	X*	X	X*	X*
Normal hours short notice transmission	X*	X	X*	X*
Photo missing		X*	O	O
Problem fetching email transmissions			O
RAID storage problem
Responder problem
Responder status
Responder volume
System usage
Ticket reprocessing
Time approved in advance
Transmission parse error	X		O
Transmission received	X	X	X*	X*
Transmissions with no locates	X	X	X*	X*

These columns have the following meanings:

Transmission

X - Indicates that a notification applies to incoming ticket transmissions.

X* - Indicates that a notification only applies to transmissions that have locates.
Restrictions

X - Indicates that a notification can be further restricted via the Restrictions field. See below for details.

X* - Fields that can be used for restrictions are exactly the same as in case of transmission. The only difference is that they must be preceded with "latestTransmission.". For example: latestTransmission.ticketType.equals("DESIGN"). See below for details about restrictions.
Feed

X - Indicates whether the Feed field is used to specify what feed the notification applies to.

X* - Indicates that either the Feed or the Utility field must be entered.
Utility

X - Indicates that the Utility field must be entered to define what utility the notification should be triggered for.

X* - Indicates that either the Feed or the Utility field must be entered.

O - Indicates that a field is optional. It can be entered or left empty.

Note: If both a Feed and a Utility are entered (on the notification types that support entering them) then the notification will apply to the feed and to the utility. Meaning that if a transmission arrived on the specified feed or for the specified utility then the notification will be triggered.

System-Wide Notifications

The following notification conditions allow entering a single notification entry that applies to the entire system. If the feed field is left blank for these conditions then the notification will apply to all of the feeds in the system:

After hours transmission parse error
Transmission parse error

Note: Even if a utility is specified for these notifications, if the feed field is empty then the notification will be sent for all feeds.

Restrictions

Transmission notifications can be restricted to only apply to some transmissions. Restrictions are applied to information in the transmissions. For example, it is possible to limit notifications to only be sent for a specific ticket type.

The instructions for creating a restriction are:

If necessary, create a Feed, Utility and a Term.
Open the Notification screen.
Select the entry for the Feed, Utility and Condition that will receive the Restriction. A new notification can be created if necessary.
Enter the restriction in the Restriction field of the Create/Edit portion of the screen.
Save the changes.

A restriction can be formatted in two ways: field.comparison(valueExpected) or valueExpected.comparison(field).

Multiple restrictions can be used with the following separators:

|| = Use one restriction or another.
&& = Use one restriction and another.

A few examples (quotes are required):

"NO RESPONSE".equals(ticketType) will limit notifications to only be sent for transmissions with a ticket type of "No Response".
ticketType.startsWith("DIG") will limit notifications to only transmissions with a ticket type starting with "DIG". For example, values like "DIG IN" or "DIG UP".
getLocateString().matches("(\\\w+,)\*termCode(,\\\w+)\*$") will limit notifications to only be sent for transmissions with the specified term code.
getTicket().getTransmissions().size()<=1 will limit notifications to only be sent for the first transmission of a ticket. This is good for avoiding sending duplicate notifications for the same ticket.
isUnder("john.smith") will limit notifications based on user hierarchy. This notification will only fire if the ticket in question is assigned to a bucket whose user falls under the john.smith user in the user hierarchy.

Possible comparisons include:

contains: For example, ticketType.contains("CANCEL") will limit notifications to all tickets whose type contains the word "CANCEL", such as "ROUTINE CANCELLATION" and "NORMAL CANCEL"
endsWith: For example, ticketType.endsWith("CANCEL") will accept all tickets whose type ends with "CANCEL", such as "NORMAL CANCEL", but not "ROUTINE CANCELLATION".
startsWith: For example, ticketType.startsWith("CANCEL") will accept all tickets whose type starts with "CANCEL", such as "CANCEL" and "CANCELLATION", but not "ROUTINE CANCELLATION" or "NORMAL CANCEL".
equals: For example, "CANCEL".equals(ticketType) or ticketType.equals("CANCEL") will accept only tickets whose type is exactly "CANCEL", excluding values like "NORMAL CANCEL" and "CANCELLATION".

Fields that can be used to restrict transmission notifications:

ticketType (see examples above)
county
city
state
streetNumber
streetName
typeOfWork
workDoneFor
excavator
excavatorAddress1
excavatorCity
description
ticketNumber

Note: These restrictions can be used for High-profile locate notifications, however, they must be preceded with "latestTransmission.". For example: latestTransmission.ticketType.equals("DESIGN").

Notifications «

» Office