contacts.pod

Network Management Information System

=head1 NAME

Contacts

=head1 DESCRIPTION

You can add, edit and delete entries to the NMIS Contacts table.
Allows information to be stored about contacts for the network.

Used to control who is notified about an event, and how, and maybe subject to a dutytime roster system.

Contacts table is used by two Policy tables, L<Events Policy|events.pod> and L<Escalations Policy|escalation.pod>

=over 4

=item *

Event Policy

If the field 'mail=true' is set for an event, then the device 'sysContact' value is used as a contact name, 
and if a matching Contact found, then an email will be sent. 
In this case, DutyTime is not used.

=item *

Escalations Policy

If an event is escalated as part of Escalations Policy,
 then the Escalation table LevelX entry is used to select a Contact name from this table, and an email ( or page ) sent.
In this case, DutyTime is tested.

=back

=head2 Contact

A unique name. An entry of 'default' will be used if no other name matches.

If no 'default', then possibly no contact will be matched, and no user notification delivered for this event. As time moves on, maybe the next LevelX escalation will match a contact|dutytime window.


=head2 DutyTime

A string representing a time range followed by the day of week. Time range may be from late to early am - see examples.
I would suggest that care be taken to have contigious or overlapping dutytimes, [ unless you require a window of silence].

DutyTime policies can be set to restrict the days and hours that this Contact can be contacted. DutyTime intersects with L<Timezone|/Timezone>.

A 'null' entry will assume 24x7, 7 days a week.

		some valid entries
		00:24:SunMonTueWedThuFriSat
		09:13:MonTueWedThuFri
		00:24:MonTueWedThuFriSatSun
		00:24:SatSun 


=head2 Email

A list of comma seperated email addresses.

=head2 Location

A string. Not used.

=head2 Mobile

A string. Not used.

=head2 Pager

A numeric pager number used by SNPP to send an event to a pager.

=head2 Phone

A string. Not used.

=head2 TimeZone

An offset to the localhost time for DutyTime. Offsets L<DutyTime|/DutyTime> so that dutytime policies can be set in the native timezone of the contact.

	-7
	+8

=head2 Example

		1)
		in LevelX of Escalation, use multiple contacts like this
		email:Contact1:Contact2
	
		in Contacts, create two contacts like this
		Contact1 00:24:MonTueWedThuFri email1@s...
		Contact2 00:24:SunSat email2@s...
	
		NMIS will look to email both contacts, but only actually send to the
		contact with a current dutytime window.
	
		2)
		Say you wish to configure a weekend contact roster with dutytime's at 5.00pm Fri to 8.00am Mon, try this.
	
		Contact1 is on duty during the week.
		Contact2 is on weekend duty.
	
		in Escalation LevelX
		email:W1:W2:W3:R1:R2:R3
	
		in contacts, create three contacts, all to the same email...
		R1 17:24:Fri contact2@s...
		R2 00:24:SatSun contact2@s...
		R3 00:08:Mon contact2@s...
		W1 08:24:Mon contact1@s...
		W2 00:24:TueWedThu contact1@s...
		W3 00:17:Fri contact1@s...