Work in progress

This extension brings to TeemIp the management of phone number plans: phone number ranges, phone numbers and extensions. It also enhances the end-user devices of the CMDB with SIM cards and links telephony devices to the phone numbers they use.

The TeemIp Telephony Management extension allows telephony administrators to document the phone number plans of their organization and the devices that use them:

• Register phone number ranges per country, in international E.164 format, and organize them in a hierarchy of ranges,
• Register phone numbers and attach them to the smallest range that contains them,
• Register extensions attached to phone numbers,
• Track the status (reserved, allocated, released, unassigned) and the allocation and release dates of each phone number object,
• Document SIM cards and the devices that host them: mobile phones, tablets, PCs, peripherals and network devices,
• Link phone numbers to SIM cards and to telephony devices (phones, IP phones and mobile phones),
• Allocate a phone number to a CI or un-allocate it from all CIs in one click,
• Automatically align the status of phone numbers with the CIs that use them, through background tasks controlled by configuration parameters,
• Audit the CIs that have no phone number.

[Picture: telephony_overview.png - Telephony Space dashboard showing phone number objects and telephony devices]

The TeemIp Telephony Management extension is licensed under the terms of the GNU Affero General Public License Version 3 as published by the Free Software Foundation. This gives you legal permission to copy, distribute and/or modify TeemIp Telephony Management under certain conditions. Read the ’license.txt’ file in the TeemIp distribution. TeemIp Telephony Management is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.

This extension documents phone number plans and telephony devices. It doesn't drive telephony systems (PBX, carriers' portals…).

Phone numbers are managed in international E.164 format only. Numbers typed in national format are rejected.

TeemIp standalone: The extension is embedded in TeemIp standalone.

iTop: When installed on an iTop application, you need IPAM for iTop to be installed as well.

The enhancements of end-user devices (SIM cards, links between devices and phone numbers) require the End-user Devices Management module to be selected at installation time.

TeemIp standalone: Installation is done with the application itself, through the setup.

iTop: To add the extension on an iTop application, follow the Standard installation process.

The extension is made of the following modules:

No specific configuration is required in TeemIp's configuration file for that extension to work. However, some default settings may be changed.

Under the Modules specific settings section, the following parameters may be set for the teemip-phone-number-mgmt module.

The Previous and Next buttons displayed on phone number ranges and phone numbers are controlled by the following parameters:

	'teemip-phone-number-mgmt' => array (
		'range_navigation' => array (
			'enabled' => true,
			'within_range_only' => true,
		),
		'number_navigation' => array (
			'enabled' => true,
			'within_range_only' => true,
		),
	),

Three background tasks may align the status of phone numbers with the CIs that use them. They are all disabled by default.

	'teemip-phone-number-mgmt' => array (
		'pn_allocate_on_ci' => array (
			'enabled' => false,
			'debug' => false,
			'periodicity' => 3600,
			'status_list' => array ('implementation', 'production'),
		),
		'pn_release_on_ci_status' => array (
			'enabled' => false,
			'debug' => false,
			'periodicity' => 3600,
			'status_list' => array ('obsolete'),
		),
		'pn_release_on_no_ci' => array (
			'enabled' => false,
			'debug' => false,
			'periodicity' => 3600,
			'target_status' => 'released',
		),
	),

Common parameters:

This section provides, as an example, a method that can be followed to implement TeemIp Telephony Management.

1. 1. Check that the Country calling codes you need exist. They are loaded at installation time.
2. 2. Create the Phone number ranges assigned to your organization, then the sub-ranges you use internally.
3. 3. Create the Phone numbers within these ranges. Selecting the range first prefills the number with the prefix of the range.
4. 4. Create the Extensions of your phone numbers, if any.
5. 5. Create the SIM cards and attach them to their phone number and to the device that hosts them.
6. 6. Attach phone numbers to your telephony devices, either from the device or with the Allocate number to CI action of the phone number.
7. 7. Activate the background tasks that suit your processes and run the audit rules regularly.

The extension brings a new Telephony Management menu with the following entries:

[Picture: telephony_menu.png - Telephony Management menu and Telephony Space dashboard]

Phone number ranges, phone numbers and extensions share the following attributes:

A phone number range is a block of consecutive phone numbers of a given country, like the numbers assigned by a carrier to an organization. Ranges can be nested to document how a block is split within the organization.

At creation time, first and last numbers are prefilled with the calling code of the selected country. Numbers can be typed with separators (spaces, dots, dashes, slashes, parentheses), with the 00 international prefix or with the (0) trunk prefix: they are automatically stored in E.164 format (e.g. +33123456789).

[Picture: classcreation_tippnrange.png - Creation form of a phone number range]

From the Phone Number Ranges menu or from the Telephony Space dashboard, select the range you are interested in:

[Picture: classdisplay_tippnrange.png - Details of a phone number range]

The Previous and Next buttons give access to the neighbour ranges, according to the configuration parameters.

The Display Tree action of the ranges' list displays the hierarchy of phone number ranges of the current organization. Delegated ranges may be folded or unfolded. The Display List action brings back the standard list.

[Picture: classdisplay_tippnrange_tree.png - Tree of phone number ranges]

A phone number is a single number, in E.164 format, that may be used by one or several CIs.

Once a range is selected in the creation form, the number is prefilled with the prefix shared by all numbers of the range. For instance, for a range going from +33140000000 to +33140009999, the number is prefilled with +3314000. The prefix replaces the number as long as it is empty or incomplete and doesn't start with the prefix of the selected range.

[Picture: classcreation_tipphonenumber.png - Creation form of a phone number with the range prefix]

From the Phone Numbers menu or from the detailed display of a range, select the phone number you are interested in:

[Picture: classdisplay_tipphonenumber.png - Details of a phone number with its CIs tab]

The Previous and Next buttons give access to the neighbour phone numbers of the same length, according to the configuration parameters.

When a phone number is not allocated, the Allocate number to CI action of the Other Actions menu allows you to attach it to a CI of the same organization. The form proposes:

• The target class, among the classes of CIs that have a phone number attribute and instances in the organization,
• The CI itself,
• The phone number attribute of the CI.

[Picture: classaction_tipphonenumber_allocate.png - Allocate number to CI form]

Once applied, the CI points to the phone number and the phone number status is set to Allocated.

When a phone number is allocated, the Un-allocate number from all CIs action of the Other Actions menu detaches it from all the CIs that use it and sets its status to Released.

[Picture: classaction_tipphonenumber_unallocate.png - Result of the Un-allocate number from all CIs action]

An extension is a code dialed after a phone number to reach a given line, like an internal line behind a switchboard number.

[Picture: classdisplay_tippnextension.png - Details of an extension]

A SIM card is a physical device that may be hosted by a mobile phone, a tablet, a PC, a peripheral or a network device and that may be linked to a phone number.

SIM cards are physical devices: they share the attributes of physical devices (name, organization, status, location, brand, model, serial number, asset number, dates…). The following attributes are specific to SIM cards:

[Picture: classdisplay_tipsimcard.png - Details of a SIM card]

The extension enhances the following end-user devices:

When the End-user Devices / Services bridge is installed, phones, IP phones, mobile phones, tablets and peripherals also display their provider contracts and services.

[Picture: classdisplay_mobilephone.png - Details of a mobile phone with its phone number and SIM cards]

A country calling code defines the international calling code (ITU-T E.164) of a country. The list of countries is loaded at installation time.

Country calling codes are grouped in the dashlet “Telephony Typologies” of the typology configuration menu.

[Picture: overview_typology_telephony.png - Telephony Typologies dashlet]

Audit rules are embedded within the extension. They are grouped under the Telephony audit domain, with one category per class of device:

[Picture: audit_telephony.png - Telephony audit domain and its results]

The TeemIp Telephony Management extension brings a new profile dedicated to the management of phone number objects: “Phone Numbers Manager”, a “Person in charge of the phone numbers space”. It has all rights on phone number ranges, phone numbers and extensions, and on their links with contacts, documents and tickets. It has read rights on all other objects.

This profile extends capabilities and must be used together with other profiles like ConfigurationManager.