.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "RT::Extension::SMSNotify::OnShift 3pm"
.TH RT::Extension::SMSNotify::OnShift 3pm "2021-01-09" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
RT::Extension::SMSNotify::IsOnShift \- enable notifications based on shifts
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
An example that uses a 'ShiftCode' custom field on users to look shift
definitions up from the \s-1RT\s0 config file and return user phone numbers only if
they are currently on shift.
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
This module must be specified as a phone number lookup function by passing the
module name. RT::Extension::SMSNotify will look for a function named
\&\f(CW\*(C`GetPhoneForUser\*(C'\fR in the module as per the docs for \f(CW$SMSNotifyGetPhoneForUserFn\fR.
.PP
.Vb 1
\&  Set($SMSNotifyGetPhoneForUserFn, \*(AqRT::Extension::SMSNotify::IsOnShift\*(Aq);
.Ve
.PP
Now the \s-1RT\s0 config \f(CW$SMSNotifyShiftMap\fR must be set to a hashref pointing to a
hash where the shift names are keys and the values are arrayrefs pointing to
two-element arrays of integers. Each key is a shift code that matches the
ShiftCode custom field values. Both values are integers representing minutes
since midnight \s-1UTC\s0 and are in the range 0 <= x < 1440. For example:
.PP
.Vb 4
\&  Set($SMSNotifyShiftMap, {
\&      \*(AqAU\*(Aq => [22*60+0, 4*60+0],
\&      \*(AqUK\*(Aq => [8*60+30, 17*60+30]
\&  });
.Ve
.PP
Be careful to avoid leading zeroes, since Perl will interpret the value as octal:
.PP
.Vb 2
\& $ perl \-e \*(Aqprint 0600 . "\en"\*(Aq;
\& 384
.Ve
.PP
At this point there's no provision for special notification rules if no users
are found on shift, since the filter function only sees one user at a time.
Make sure you define your shifts and user assignments carefully.
.SH "AUTHOR"
.IX Header "AUTHOR"
Craig Ringer <craig@2ndquadrant.com>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2013 2ndQuadrant
.PP
Released under the same license as Perl its self.
.SS "GetPhoneForUser"
.IX Subsection "GetPhoneForUser"
Look up the PagerPhone field of the specified user and return it only if the user is
currently on shift according to their 'ShiftCode' custom field as looked up in
the \s-1RT\s0 configuration 'SMSNotifyShiftMap'.
.PP
See the configuration section and RT::Extension::SMSNotify.