Oracle Communications Unified Inventory Management

Transcription

1 Oracle Communications Unified Inventory Management Consumer VoIP Technology Pack Implementation Guide Release E January 2013

2 Oracle Communications Unified Inventory Management Consumer VoIP Technology Pack Implementation Guide, Release E Copyright 2010, 2013, Oracle and/or its affiliates. All rights reserved. This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government. This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners. Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group. This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

3 Contents Preface... v Audience... Related Documentation... Documentation Accessibility... v vi vi 1 Consumer VoIP Technology Pack Overview About the Consumer VoIP Technology Pack Consumer VoIP Service Models Contents of the Consumer VoIP Technology Pack Consumer VoIP Technology Pack Javadoc Consumer VoIP Technology Pack Super JAR File Consumer VoIP Technology Pack Individual Jar Files Consumer VoIP Technology Pack ZIP Archive Files Phone Service Cartridges Common Library Consumer VoIP Cartridges Deploying the Consumer VoIP Technology Pack Opening the Technology Pack in Design Studio Phone Specifications and Rulesets Entity Specifications Inventory Group Specifications Logical Device Specifications Logical Device Account Specifications Party Specifications Place Specifications Role Specifications Service Specifications Service Configuration Specifications Rulesets Consumer VoIP Specifications and Rules Entity Specifications Logical Device Account Specifications Logical Device Configuration Specifications iii

4 Logical Device Specifications Service Configuration Specifications Service Specifications Rulesets Common Content Common Library CommonManager ResourceManager ServiceManager Telephone Management Web Services FindTN FindReserveTN ValidateMoveTN ValidatePortTN Extending the Consumer VoIP Technology Pack Extending ATA Capabilities Extending IP Phone Capabilities Extending VoIP Service Capabilities Extending Phone Service Capabilities Extending Telephone Number Capabilities Consumer VoIP Technology Pack Service Example Overview Assumptions Pre-Provisioning Network Resources Pre-Provisioning Users Creating an IP Phone Creating an Telephone Number Inventory Group Creating a Telephone Number Creating an IP Address Creating An Address Creating a Service Location Creating a Voic Access Account Creating a VoIP User Account Creating Services Creating and Provisioning the VoIP Service Creating and Provisioning a Voic Service Creating and Provisioning a Phone Service iv

5 Preface Oracle Communications Unified Inventory Management (UIM) Technology Packs provide support for specific technology domains and a base for project-specific adaptation. Wherever possible, technology packs include elements and business logic based on relevant industry standards. The use of industry standards provides a set of elements and business logic that you can use with a minimal amount of customization. Technology packs are separately licensed and may evolve over multiple releases. Guidelines are provided to facilitate uptake of new or enriched elements while preserving field-developed implementations. The Consumer VoIP Technology Pack provides business entities and behaviors required by providers of consumer phone service using VoIP technology. This includes extended phone number life cycles, VoIP CPE modeling, associations with VoIP nodes and number portability-enabled phone number assignments. This guide contains the following information about the Consumer VoIP Technology Pack: Background and introductory information about VoIP technology and the technology pack Contents of the technology pack Instructions for configuring a VoIP service Example implementation scenario Extension points for the technology pack Audience This document is intended for business analysts and the following groups of people who design and implement a Consumer VoIP inventory solution: Customer-service subject-matter experts who model products in the application Network design engineers who model equipment, connections, and networks in the application Service provisioners who model services in the application The guide assumes that readers have a working knowledge of VoIP technology and UIM. v

6 Related Documentation For more information, see the following documents in Oracle Communications Unified Inventory Management documentation set: UIM Installation Guide: Describes the requirements for installing UIM, installation procedures, and post-installation tasks. UIM System Administrator s Guide: Describes administrative tasks such as working with cartridges and technology packs, maintaining security, managing the database, configuring Oracle Map Viewer, and troubleshooting. UIM Security Guide: Provides guidelines and recommendations for setting up UIM in a secure configuration. UIM Concepts: Provides an overview of important concepts and an introduction to using both UIM and Design Studio. UIM Developer s Guide: Explains how to customize and extend many aspects of UIM, including the data model, life-cycle management, topology, security, rulesets, Web services, user interface, and localization. UIM Information Model Reference: Describes the UIM information model entities and data attributes, and explains patterns that are common across all entities. Oracle Communications Information Model Reference: Describes the Oracle Communications information model entities and data attributes, and explains patterns that are common across all entities. The information described in this reference is common across all Oracle Communications products. UIM Cartridge and Technology Pack Guide: Provides information about how you use cartridges and technology packs with UIM. Describes the content of the base cartridges. UIM technology pack implementation guides: Describe the content of product technology packs as well as configuration guidelines and implementation considerations. For step-by-step instructions for performing tasks, log into each application to see the following: Design Studio online Help: Provides step-by-step instructions for tasks you perform in Design Studio. UIM online Help: Provides step-by-step instructions for tasks you perform in UIM. Documentation Accessibility For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at Access to Oracle Support Oracle customers have access to electronic support through My Oracle Support. For information, visit or visit if you are hearing impaired. vi

7 1 1Consumer VoIP Technology Pack Overview This chapter provides an overview of the Oracle Communications Unified Inventory Management (UIM) Consumer VoIP Technology Pack. The chapter also provides deployment information for the technology pack. About the Consumer VoIP Technology Pack Enterprises and service providers require efficient and cost-effective means to deliver unified voice and data services that address diverse communication needs of customers. Voice over Internet protocol (VoIP) is a viable alternative because it supports both voice and data applications over a single IP network and, therefore, reduces cost. You can configure a VoIP service for a residence, small office, or large enterprise. Consumer VoIP service is the VoIP service for residences or small offices. To configure a Consumer VoIP service, you must connect customer premise equipment (CPE), such as an analog telephony adapter (ATA) or IP phone, to a VoIP network through the Internet. In addition, you provision the CPE by associating it with core VoIP network elements, such as call agents and voic servers. A call agent maintains subscriber information in the VoIP network. You associate a CPE with a call agent to enable subscribers to be added to the Consumer VoIP service after it is configured. The voic server manages access to voice mails. You associate a CPE with a voic server to enable the subscribers to access voice mails. Figure 1 1 displays the simplified view of a Consumer VoIP service: Figure 1 1 Consumer VoIP Service Overview Consumer VoIP Technology Pack Overview 1-1

8 About the Consumer VoIP Technology Pack The Consumer VoIP Technology Pack provides the specifications, characteristics, and rules required to model and deploy a Consumer VoIP service in UIM. You can deploy the technology pack directly to UIM or customize it by using Oracle Communications Design Studio. Design Studio enables you to view the contents of the technology pack and extend its capabilities to meet your business needs. See UIM Concepts, UIM Developer s Guide, and the Design Studio online Help for more information. Figure 1 2 displays the domain of a Consumer VoIP service. Figure 1 2 Consumer VoIP Domain Model Consumer VoIP Service Models You can use the Consumer VoIP Technology Pack to model the following services: Phone service Voic service VoIP service The phone service manages information about the service location, telephone numbers, and subscriber addresses. It also manages telephone number assignment and various calling features. The phone service may exist as a standalone service independent of the voic and VoIP services and may be used by other technology packs to model services such as Mobile or plain old telephone systems (POTS). Figure 1 3 displays the specifications 1-2 UIM Consumer VoIP Technology Pack Implementation Guide

9 About the Consumer VoIP Technology Pack used to design a phone service. In this case, service delivery is provided by a VoIP service. Figure 1 3 Phone Service Model The voic and VoIP services utilize the capabilities of the phone service. The voic service manages a logical device account that stores subscriber information. This account is linked to a voic server. The VoIP service focuses on managing subscriber information, telephone numbers, VoIP call features, CPE devices, and associations of CPE with core VoIP network elements. You can model multiple variants of the Consumer VoIP service based on SIP and H.323 protocols and use Gatekeeper H.323 and SIP proxies. Figure 1 4 shows the high-level structure of the Consumer VoIP service. Consumer VoIP Technology Pack Overview 1-3

10 About the Consumer VoIP Technology Pack Figure 1 4 Consumer VoIP Service Model Figure 1 5, displays the specifications used to model Consumer VoIP site access. Figure 1 5 Consumer VoIP Site Access Figure 1 6, displays the specifications used to model CPE. The CPE can be either an IP phone or an analog telephony adapter (ATA). 1-4 UIM Consumer VoIP Technology Pack Implementation Guide

11 Contents of the Consumer VoIP Technology Pack Figure 1 6 Customer Premise Equipment Model For more information about the content of the technology pack, see "Consumer VoIP Specifications and Rules". Contents of the Consumer VoIP Technology Pack Table 1 1 describes the content of the Consumer VoIP Technology Pack, which is delivered as a ZIP file. Table 1 1 Item Javadoc Super JAR Archive File Consumer VoIP Technology Pack ZIP File Contents Components of the Super JAR Archive File Cartridge Project ZIP Files and Sample Code Common Library Directory doc/javadocfortechpacks See "Consumer VoIP Technology Pack Javadoc" for more information. deploy/superjartodeploy See "Consumer VoIP Technology Pack Super JAR File" for more information. deploy/individualjarsforsuperjar See "Consumer VoIP Technology Pack Individual Jar Files" for more information. designstudio/cartridgezips See "Consumer VoIP Technology Pack ZIP Archive Files" for more information. designstudio/libforstudiodesigntime See "Common Library" for more information. Consumer VoIP Technology Pack Overview 1-5

12 Contents of the Consumer VoIP Technology Pack Consumer VoIP Technology Pack Javadoc From the javadocfortechpacks directory, open the javadoc_rel.date.time.build.zip file and extract the javadoc directory. Double-click the extracted javadoc/index.html file to access the Javadoc provided with the Consumer VoIP Technology Pack, including information that summarizes classes, methods, and parameters. Consumer VoIP Technology Pack Super JAR File The Consumer VoIP Technology Pack super JAR file contains the entire contents of the technology pack and is ready for deployment using the Cartridge Deployer Tool. You use the Cartridge Deployer Tool to simultaneously deploy multiple cartridges to UIM run-time environments. See UIM Cartridge and Technology Pack Guide for more information about the Cartridge Deployer Tool. Consumer VoIP Technology Pack Individual Jar Files In addition to the deployable super JAR file, technology packs include individually JAR files. Deploying individual JAR files may be required if you extend a cartridge in Design Studio. JAR files must be deployed in the order shown below to ensure that all dependencies are met. ora_uim_common_cartproj-*.jar ora_uim_address_cartproj-*.jar ora_uim_tnmgmnt_cartproj-*.jar ora_uim_us_address_cartproj-*.jar ora_uim_canada_address_cartproj-*.jar ora_uim_norway_address_cartproj-*.jar ora_uim_uk_address_cartproj-*.jar ora_uim_saudi_arabia_address_cartproj-*.jar ora_uim_party_customer_cartproj-*.jar ora_uim_service_location_cartproj-*.jar ora_uim_voice_mail_cartproj-*.jar ora_uim_phone_cartproj-*.jar ora_uim_internet_naming_and_addressing_cartproj-*.jar ora_uim_voip_core_cartproj-*.jar ora_uim_consumer_voip_cartproj-*.jar 1-6 UIM Consumer VoIP Technology Pack Implementation Guide

13 Contents of the Consumer VoIP Technology Pack Note: The asterisk in the JAR file names in the previous list represent a five-segment release version number followed by a build number. The five-segment release version numbers represent the: Major Version Number Minor Version Number Maintenance Pack Generic Patch Customer Patch Consumer VoIP Technology Pack ZIP Archive Files The Consumer VoIP Technology Pack comprises a number of cartridges, which can be divided into three broad categories: Phone Service Cartridges Common Library Consumer VoIP Cartridges Phone Service Cartridges These cartridges model generic phone services that can be used in any telephony domain. They may be reused with other services, such as POTS or Mobile. You can deploy only the selection of cartridges that your business requires. For example, if you need to provision a Consumer VoIP service for subscribers in the US and Canada, you need not deploy address cartridges pertaining to Norway addresses. If necessary, you can later deploy any of the cartridges you did not deploy initially. The phone service cartridges are listed below, grouped by their functions. For detailed information, see "Phone Specifications and Rulesets". Address cartridges ora_uim_us_address ora_uim_canada_address ora_uim_uk_address ora_uim_saudi_arabia_address ora_uim_norway_address Core cartridges ora_uim_address ora_uim_tnmgmnt ora_uim_service_location ora_uim_voice_mail ora_uim_party_customer ora_uim_phone Consumer VoIP Technology Pack Overview 1-7

14 Deploying the Consumer VoIP Technology Pack Common Library The common library is a JAR file that provides utility methods that are independent of the technology domain. These utility methods can be used across multiple technology packs, so they reside in a common JAR file that is included in multiple technology packs. The common library is: ora_uim_commonlib.jar See Chapter 4, "Common Content" for more information. Note: The common library is not considered a cartridge because it does not contain content that can be imported into Design Studio to view. The common library contains Java class files only; it does not contain the viewable Java source files from which the classes are compiled. Consumer VoIP Cartridges These cartridges model inventory entities that are specifically related to the Consumer VoIP service. They rely on the contents of the phone service cartridges. The ora_uim_ consumer_voip cartridge contains the bulk of the content, including Logical Device, Logical Device Configuration, Logical Device Account, and VoIP Service specifications. The consumer VoIP cartridges are listed below. See "Consumer VoIP Specifications and Rules" for detailed information. ora_uim_voip_core ora_uim_internet_naming_and_addressing ora_uim_consumer_voip Deploying the Consumer VoIP Technology Pack Oracle recommends that you use the Cartridge Deployer Tool to deploy the Consumer VoIP Technology Pack super JAR archive file to a UIM run-time environment. Deploying the technology pack with the Cartridge Deployer Tool ensures that all cartridges and dependencies are deployed in the proper order. See UIM Cartridge and Technology Pack Guide for more information about the Cartridge Deployer Tool. Important: Before deploying the Consumer VoIP Technology Pack, you must deploy the base cartridges if not previously deployed. For information on how to deploy the base cartridges, see UIM Cartridge and Technology Pack Guide. For information about how to deploy individual cartridges into a UIM test environment, see the Design Studio Help. For information about how to deploy a cartridge into a UIM production environment, see UIM Cartridge and Technology Pack Guide. 1-8 UIM Consumer VoIP Technology Pack Implementation Guide

15 Opening the Technology Pack in Design Studio Opening the Technology Pack in Design Studio In addition to the cartridge bundle that you deploy into UIM, you can download a ZIP file that contains the individual JAR files that are bundled. You can open these individual files in Design Studio to review or to extend the technology pack. See the Design Studio online Help and UIM Developer s Guide for information about opening files in Design Studio. See UIM Concepts for guidelines and best practices for extending technology packs in general. See Chapter 6, "Extending the Consumer VoIP Technology Pack" for information about extending this technology pack. Consumer VoIP Technology Pack Overview 1-9

16 Opening the Technology Pack in Design Studio 1-10 UIM Consumer VoIP Technology Pack Implementation Guide

17 2 2Phone Specifications and Rulesets This chapter contains information about the entity specifications and rulesets included in the phone cartridges of the Consumer VoIP Technology Pack. The phone cartridges are: Address cartridges ora_uim_us_address ora_uim_canada_address ora_uim_uk_address ora_uim_saudi_arabia_address ora_uim_norway_address Core cartridges ora_uim_address ora_uim_tnmgmnt ora_uim_service_location ora_uim_voice_mail ora_uim_party_customer ora_uim_phone Entity Specifications This section lists the entity specifications included in the phone cartidges, organized by specification type. You can view the details of the specifications by opening the cartridges in Oracle Communications Design Studio. Inventory Group Specifications Table 2 1 lists and describes the Inventory Group specifications included in the phone cartridges. Phone Specifications and Rulesets 2-1

18 Entity Specifications Table 2 1 Specification citycodetnarea geographictnarea postalcodetnarea Inventory Groups Specifications Description Inventory group for telephone numbers based on city. You should also associate the Place entity for the city with the inventory group. Inventory group for telephone number based on geographic area. You should also associate the Place entity for the geographic area with the inventory group. Inventory group for telephone numbers based on postal code. You should also associate the Place entity for the postal code with the inventory group. Logical Device Specifications Table 2 2 Specification voic server Table 2 2 lists and describes the Logical Device specifications included in the phone cartridges. Logical Device Specifications Description Models a voic server. Assigned in a voic service configuration. Logical Device Account Specifications Table 2 3 Specification voic access Table 2 3 lists and describes the Logical Device Account specifications included in the phone cartridges. Logical Device Account Specifications Description Models a voic user account. Assigned in a voic service configuration. The voic access specification includes the following characteristics: Language Time Zone User Name Password Party Specifications Table 2 4 lists and describes the Party specifications included in the phone cartridges. Table 2 4 Party Specifications Specification Description Organization Used when the subscriber is an organization An organization can be a business or a government agency Individual Used when the subscriber is an individual Place Specifications Table 2 5 lists and describes the Place specifications included in the phone cartridges. 2-2 UIM Consumer VoIP Technology Pack Implementation Guide

19 Entity Specifications Table 2 5 Specification canadaaddress canadacity canadaprovince country norwayaddress norwaycity saudiarabiaaddress saudiarabiacity servicelocation ukaddress Place Specifications Description Postal address of the subscriber for the phone service in Canada. The canadaaddress specification contains the following characteristics: Address Line 1: The first line of the Address field, maximum 100 characters long Address Line 2: The second line of the Address field, maximum 100 characters long City: Name of the Canada city where the subscriber is located Postal Code: Postal code of the area where the subscriber is located The Postal Code field is seven characters long Province: Canada province where the subscriber is located Country: Name of the country where the subscriber is located Location specification used to populate the City field in Canadian addresses Location specification used to populate the Province field in Canadian addresses Location specification for countries. Postal address of the subscriber for the phone service in Norway The norwayaddress specification contains the following characteristics: Address Line 1: The first line of the Address field, maximum 100 characters long Address Line 2: The second line of the Address field, maximum 100 characters long City: Name of the Norway city where the subscriber is located Country: Name of the country where the subscriber is located postalcode: Postal code of the Norway state where the subscriber is located The postalcode field is five characters long Location specification used to populate the City field in Norwegian addresses Postal address of the subscriber for the phone service in Saudi Arabia. The saudiarabiaaddress specification contains the following characteristics: Address Line 1: The first line of the Address field, maximum 100 characters long Address Line 2: The second line of the Address field, maximum 100 characters long City: Name of the Saudi city where the subscriber is located Country: Name of the country where the subscriber is located postalcode: Postal code of the Saudi state where the subscriber is located The postalcode field is seven characters long Location specification used to populate the City field in Saudi addresses Location specification used to define where a service is delivered Postal address of the subscriber in the UK. The ukaddress specification contains the following characteristics: Address Line 1: The first line of the Address field, maximum 100 characters long Address Line 2: The second line of the Address field, maximum 100 characters long City: Name of the UK city where the subscriber is located Country: Name of the country where the subscriber is located postalcode: Postal code of the UK state where the subscriber is located The postalcode field is seven characters long Phone Specifications and Rulesets 2-3

20 Entity Specifications Table 2 5 Specification ukcity usaddress uscity usstatecode (Cont.) Place Specifications Description Location specification used to populate the City field in UK addresses Postal address of the subscriber for the phone service in the US. The usaddress specification contains the following characteristics: Address Line 1: The first line of the Address field, maximum 100 characters long Address Line 2: The second line of the Address field, maximum 100 characters long Country: Name of the country where the subscriber is located State: Name of the US state where the subscriber is located City: Name of the US city where the subscriber is located Zip Code: ZIP code of the area where the subscriber is located The Zip Code field is nine characters long Location specification used to populate the City field in US addresses. Child of usstate. Location specification used to populate the State field in US addresses. Parent of uscity. Role Specifications Table 2 6 lists and describes the Role specifications included in the phone cartridges. Table 2 6 Role Specifications Specification Description Customer Designates an Organization or Individual entity as a customer Subscriber Designates an Organization or Individual entity as a subscriber Service Specifications Table 2 7 Specification phoneservice voic service Table 2 7 lists and describes the Service specifications included in the phone cartridges. Service Specifications Description Models a customer s generic phone service Contains information about the voic service for customers You associate this specification to the Voice Mail configuration item of the Phone Service Configuration specification Service Configuration Specifications Table 2 8 lists and describes the service configuration specifications included in the phone cartridges. 2-4 UIM Consumer VoIP Technology Pack Implementation Guide

21 Rulesets Table 2 8 Specification Service Configuration Specifications phoneserviceconfiguratio n voic serviceconfigura tion Description Configuration for the phone service. Includes the following configuration items: Service Location: Assign the a service location. Telephone Number: Assign a telephone number Feature Set: Collection of call features that can be provided to the customer, including toll free calling, call parking, call forward, and many others Primary Carrier: Information about the primary carrier the ensures service delivery Includes Carrier Name, Carrier Code, and Carrier Type characteristics Service Delivery: Assign a technology-specific service (such as VoIP) used for this phone service Voice Mail: Assign a voic service Configuration for the voic service. Includes the following configuration items: Service Registries includes the child configuration item Voic Server (VMS), which assigns the voice mail server used for this service. Voic Server (VMS) references the voic server logical device specification in the ora_ uim_voice_mail cartridge. Subscription includes the child configuration Access, which assigns the user s voice mail account. Access using the voic access logical device account specification in the ora_uim_voice_mail cartridge. Rulesets Table 2 9 lists the rulesets that are included in the phone cartridges. You can modify the rules and their extension points to meet your business needs. Refer to UIM Developer s Guide for more information. Table 2 9 Rulesets List of Rulesets in the Phone Technology Pack SERVICE_VALIDATION Functionality Validates a service configuration The validation rule checks to ensure that the telephone number and the city or postal code are related. The telephone number block and the city or postal code must be associated with the same inventory group or with inventory groups that share a parent. Phone Specifications and Rulesets 2-5

22 Rulesets 2-6 UIM Consumer VoIP Technology Pack Implementation Guide

23 3 3Consumer VoIP Specifications and Rules This chapter contains information about the entity specifications and rulesets VoIP-specific cartridges of the Consumer VoIP Technology Pack. See Chapter 2, "Phone Specifications and Rulesets" for information about the specifications related to generic phone service rather than Consumer VoIP specifically. The VoIP-specific cartridges are: ora_uim_voip_core ora_uim_internet_naming_and_addressing ora_uim_consumer_voip Entity Specifications This section lists the entity specifications included in the Consumer VoIP Technology Pack, organized by specification type. You can view the details of the specifications by opening the cartridges in Oracle Communications Design Studio. Logical Device Account Specifications Table 3 1 lists and describes the Logical Device Account specifications included in the Consumer VoIP Technology Pack. Consumer VoIP Specifications and Rules 3-1

24 Entity Specifications Table 3 1 Specification VoIP User Account Logical Device Account Specifications Description Contains information related to the subscriber of the VoIP service. The VoIP User Account specification includes the following characteristics: voipuserid: The ID of the VoIP subscriber profileid: The ID of the subscriber profile voipuserusername: The user name assigned to the subscriber; this is the user name or ID that the subscriber uses to connect to the VoIP service voipuserpassword: The password associated with the user name of the VoIP subscriber authenticationrealm: The realm used to authenticate the user voipuserpreferredlanguage: The preferred language to communicate with the VoIP subscriber voiceportalusername: The user name for a voice portal used by the subscriber to change or view the configuration of the VoIP service voiceportalpassword: The password associated with the voice portal user name webportalusername: The user name for a Web portal used by the subscriber to change or view the configuration of the VoIP service webportalpassword: The password associated with the Web portal user name Logical Device Configuration Specifications Table 3 2 Configuration Items Analog Telephony Adapter Configuration IP Phone Configuration Table 3 2 lists and describes the Logical Device configuration items included in the Consumer VoIP Technology Pack. Logical Device Configuration Specifications Description Contains configuration information pertaining to analog telephony adapters. This configuration item includes the following characteristics: softwareversion: The version of software or firmware running on the analog telephony adapter Contains configuration information pertaining to IP phones. This configuration item includes the following characteristics: softwareversion: The version of software or firmware running on the IP phone Logical Device Specifications Table 3 3 lists and describes the Logical Device specifications included in the Consumer VoIP Technology Pack. 3-2 UIM Consumer VoIP Technology Pack Implementation Guide

25 Entity Specifications Table 3 3 Specification Analog Telephony Adapter Automatic Location Identification Call Agent Logical Device Specifications Description A device used to connect one or more standard analog telephones to a VoIP network The Analog Telephony Adapter specification includes the following characteristics: voipprotocol: The VoIP protocol supported by the analog telephony adapter tftpprovisioningsupport: Indicates whether the analog telephony adapter can be provisioned using TFTP dhcpprovisioningsupport: Indicates whether the analog telephony adapter can be provisioned using DHCP webbasedconfigurationavailable: Indicates whether a Web-based configuration tool is available adminpasswordlocked: Indicates whether the administrator password can be changed faxcapable: Indicates whether the analog telephone adapter supports fax touchtonedialingsupport: Indicates whether the analog telephony adapter supports touch-tone dialing natsupport: Indicates whether the analog telephony adapter supports network address translation echocancellationsupport: Indicates whether the analog telephony adapter supports echo cancellation voiceactivitydetectionsupport: Indicates whether the analog telephony adapter supports voice activity detection (VAD) The database function that maps a calling phone number to an address for emergency number service A central device in a telecommunications network that connects calls from one phone line to another, entirely by means of software running on a computer system H.323 Gatekeeper A VoIP Proxy for the H.323 VoIP protocol Home Subscriber Server IP Phone SIP Proxy A master user database that contains the subscription-related information (user profiles), performs authentication and authorization of the user, and can provide information about the user's physical location An IP phone that uses VoIP technologies to facilitate telephone calls over an IP network instead of the PSTN system The IP phone specification includes the following characteristics: voipprotocol: The VoIP protocol supported by this IP phone tftpprovisioningsupport: Indicates whether the IP phone can be provisioned using TFTP dhcpprovisioningsupport: Indicates whether the IP phone can be provisioned using DHCP poweroverethernetenabled: Indicates whether the IP phone receives power over Ethernet echocancellationsupport: Indicates whether the IP phone supports echo cancellation voiceactivitydetectionsupport: Indicates whether the IP phone supports voice activity detection (VAD) vlansupport: Indicates whether the IP phone supports VLANs diffservsupport: Indicates whether the IP phone supports DiffServ encryptionmethod: Encryption method used by the IP phone A VoIP Proxy for the SIP protocol. Consumer VoIP Specifications and Rules 3-3

26 Rulesets Service Configuration Specifications Table 3 4 Configuration Items VoIP Service Configuration Table 3 4 lists and describes the service configuration specifications included in the VoIP cartridges. VoIP Service Configuration Specifications Description Configuration for a VoIP Service. Includes the following configuration items: Automatic Location Identification: Database function that maps a calling phone number to an address for emergency number service Customer Site Access: Enables you to specify the details about customer access. Includes the following configuration items: Access Interface: Assigns a device interface that forms the interface between the service provider's network and the CPE Line: Assigns a pipe that represents the line, for example Frame Relay or Sonet, in the service provider's network that connects the CPE to the access interface Customer Premise Equipment: Assigns the analog telephony adapter or an IP phone IP Address: Assigns an IP address to the CPE DHCP Server: Assigns a DHCP server that is used by the CPE to get an IP Address TFTP Server: Assigns a TFTP server that is used by the CPE to get configuration information User Details: Assigns a VoIP user to the VoIP service IP Address: Assigns an IPv4 IP Address or an IPv6 IP Address that has been assigned for use by the CPE Call Agent: Assigns a call agent entity where the VoIP user data is stored. The CPE connects to the call agent to access the user data Home Subscriber Server: Assigns a Home Subscriber server that stores the VoIP user data VoIP Proxy: Assigns a SIP proxy or an H.323 gatekeeper to which the CPE connects Service Specifications Table 3 5 Specification VoIP Service Table 3 5 lists and describes the service specifications that are included in the VoIP cartridges. VoIP Service Specifications Description Contains specifications required to define the VoIP service The VoIP Service specification includes the following characteristics: voipprotocol: The underlying VoIP protocol used to model the VoIP service Rulesets Table 3 6 lists the rulesets that are included in the Consumer VoIP Technology Pack. You can modify the rules and their extension points to meet your business needs. Refer to UIM Developer s Guide for more information. 3-4 UIM Consumer VoIP Technology Pack Implementation Guide

27 Rulesets Table 3 6 List of Rulesets in the VoIP Cartridges Ruleset/Ruleset Extension Points AUTO_ALLOCATE_INV_CONFIG_ ANALOG_TELEPHONY_ADAPTER_ CONFIGURATION AUTO_ALLOCATE_INV_CONFIG_IP_ PHONE_CONFIGURATION AUTO_ALLOCATE_SERVICE_ CONFIG_VOIP_SERVICE_ CONFIGURATION VALIDATE_ANALOG_TELEPHONY_ ADAPTER_CONFIGURATION VALIDATE_IP_PHONE_ CONFIGURATION VALIDATE_IPV4_FORMAT VALIDATE_IPV6_FORMAT VALIDATE_UNALLOCATED_CONFIG_ ITEMS VALIDATE_VOIP_PROTOCOL VALIDATE_VOIP_PROXY_AND_ CALL_AGENT VALIDATE_VOIP_SERVICE_ CONFIGURATION Functionality Stub ruleset that enables you to implement auto-assignment rules for an ATA logical device configuration. Stub ruleset that enables you to implement auto-assignment rules for an IP Phone logical device configuration. Stub ruleset that enables you to implement auto-assignment rules for a VoIP service configuration. Stub ruleset that enables you to implement validation rules for an ATA logical device configuration. Stub ruleset that enables you to implement validation rules for an IP Phone logical device configuration. Validates that IPv4 IP addresses are formatted correctly. Validates that IPv6 IP addresses are formatted correctly. Validates that there are no unassigned configuration items for Analog Telephony Adapter, IP phone, and VoIP Service Configuration specifications. Validates that the VoIP protocol selected for the VoIP service matches the specifications assigned to the VoIP service configuration. For example, if the selected VoIP protocol is SIP, the VoIP Proxy configuration item must be a SIP Proxy and the CPE must support SIP. Similarly, if the selected VoIP protocol is H.323. then the VoIP Proxy configuration item must be an H.323 Gatekeeper and the CPE must support H.323. Validates that the VoIP Service Configuration specification includes either a call agent or a VoIP proxy as a configuration item, based on the VoIP protocol chosen for the VoIP service. Stub ruleset that enables you to implement validation rules for a VoIP service configuration. Consumer VoIP Specifications and Rules 3-5

28 Rulesets 3-6 UIM Consumer VoIP Technology Pack Implementation Guide

29 4 4Common Content This chapter describes the utility methods included in the common library of the Consumer VoIP Technology Pack. Common Library CommonManager The common library is a JAR file that provides utility methods that are independent of the technology domain. These utility methods can be used across multiple technology packs, so they reside in a common JAR file that is included in multiple technology packs. The Consumer VoIP Technology Pack contains one common library: ora_uim_commonlib.jar The common library contains classes that define the utility methods. The Consumer VoIP Technology Pack uses these utility methods, so you must add the common library to your project library list to resolve references to the utility methods. When developing new domain cartridges or enhancing existing cartridges, you can utilize these utility methods in custom code by adding the common library to your project library list. Refer to the Javadoc for detailed information about the utility methods. The utility methods are defined in the following classes: CommonManager ResourceManager ServiceManager The CommonManager class represents the common interface for the use of the technology pack. Table 4 1 describes the utility methods included in the CommonManager class. Table 4 1 Method Signature Utility Methods in CommonManager boolean checkpartyservicerel (ServiceConfigurationVersion scv, Party party) boolean checkpartyservicerel (ServiceConfigurationVersion scv, PartyType subscriberparam) void commitandstarttransaction() Description Checks whether the service is associated with a party. Checks whether the service is associated with a party. For this method, the input parameter is PartyType. Commits an open transaction. Common Content 4-1

30 Common Library Table 4 1 Method Signature (Cont.) Utility Methods in CommonManager GeographicAddress createaddress (GeographicAddressType addresstype, java.lang.string specname) GeographicLocation creategeolocationforserviceaddress (GeographicAddress address) <E extends Persistent> E createliveentity (Persistent entity) Party createparty (PartyType partytype, java.lang.string partyspecname, java.lang.string rolespecname) java.util.list<geographicaddress> findaddress (GeographicAddressType addresstype) java.util.list<inventorygroup> findandvalidateinventorygroup (java.lang.string inventorygroupname, java.lang.string specificationname) Specification findandvalidatespecification (java.lang.class specclass, java.lang.string specificationname) Specification findandvalidatespecification (java.lang.string specificationname) java.util.list<inventorygroup> findinventorygroup (java.lang.string inventorygroupname, java.lang.string specificationname) GeographicLocation findlocationforserviceaddress (GeographicAddress serviceaddress) java.util.list<party> findparty (PartyType partytype) java.util.list<inventorygroup> findservingareaforserviceaddress (GeographicAddress serviceaddress, java.lang.string placecharname, java.lang.string invgroupspecname) GeographicAddress getaddress (GeographicAddressType addresstype, java.lang.string specname) GeographicLocation getlocation (GeographicAddress address) Party getparty (PartyType partytype, java.lang.string partyspecname, java.lang.string rolespecname) CharValue makecharvalue (characteristicextensible, java.lang.string charspecname, java.lang.string value) void validateinventorygroupname (InventoryGroup inventorygroup, java.lang.string specificationname) Description Creates a geographic address based on the address, city, and state information. Creates a service location for the given service address. Creates an entity in live context. Creates a party based on the name, specification, and account number information. Finds a service address based on the address, city, and state information. Finds all inventory groups based on the name of the inventory group and its specification. Finds a specification based on the name of the specification and validates it. This method requires the name of the specification class as an input parameter. Finds a specification based on the name of the specification and validates it. Finds all the inventory groups based on the inventory group name and specification. Finds a service location for the given service address. If a service location is not found, it returns null. Finds a party based on the party name, specification, and account number information. Finds inventory groups that are defined for a serving area. Finds an address entity based on the given parameter type. When an address is not found, it creates one address with the given information in the parameter type. Finds a geographical location entity based on the given address. When a location is not found, it creates a location and relates it to the address. Finds a party entity based on the given parameter type. When a party is not found, it creates one party with the given information in the party parameter. Creates a characteristic value. Checks whether an inventory group exists for an instance of this specification. 4-2 UIM Consumer VoIP Technology Pack Implementation Guide

31 Common Library ResourceManager The ResourceManager class represents the common interface for resource management of the technology pack. Table 4 2 describes the utility methods included in the ResourceManager class. Table 4 2 Method Signature Utility Methods in ResourceManager PhysicalDevice createphysicaldevice (java.lang.string physicaldevicename, java.lang.string specificationname, java.util.collection<physicaldevicecharacteristic> pdcharacteristics) PhysicalDevice createphysicaldevice (java.lang.string physicaldevicename, java.lang.string specificationname, java.lang.string serialnumber, java.lang.string physicaladdress, java.lang.string physicallocation, java.util.collection<physicaldevicecharacteristic> pdcharacteristics) java.util.list<logicaldevice> findandvalidatelogicaldevice (java.lang.string logicaldevicename, java.lang.string specificationname) java.util.list<physicaldevice> findandvalidatephysicaldevice (java.lang.string physicaldevicename, java.lang.string specificationname) java.util.list<physicaldevice> findandvalidatephysicaldevicebyphysicaladdress (java.lang.string physicaladdress, java.lang.string specificationname) java.util.list<logicaldevice> findlogicaldevice (InventoryGroup group, java.lang.string specname) java.util.list<logicaldevice> findlogicaldevice (java.lang.string logicaldevicename, java.lang.string specificationname) java.util.list<logicaldeviceaccount> findlogicaldeviceaccountbychar (java.lang.string charname, java.lang.string charvalue, java.lang.string specname, LogicalDevice ld) java.util.list<logicaldevice> findlogicaldevicebychar (java.lang.string charname, java.lang.string charvalue, java.lang.string specname) java.util.list<physicaldevice> findphysicaldevice (java.lang.string physicaldevicename, java.lang.string specificationname) Description Creates a physical device based on name and specification. Creates a physical device based on name and specification. The hard attributes serial number, physical address, and physical location are additional input parameters for this method. Finds all the logical devices based on the name of the logical device and its specification. Finds all the physical devices based on the name of the physical device and its specification and validates them. Finds all the physical devices based on the physicaladdress characteristic and its specification. Finds all the logical devices in the given inventory group. Finds all the logical devices based on the name of the logical device and its specification name. Finds all logical device accounts based on a characteristic. If a logical device account is not found, it returns either null or an empty list. Finds all logical devices based on a characteristic. Finds all the physical devices based on the name of a physical device and the specification. Common Content 4-3

32 Common Library Table 4 2 Method Signature (Cont.) Utility Methods in ResourceManager java.util.list<physicaldevice> findphysicaldevicebyphysicaladdress (java.lang.string physicaladdress, java.lang.string specificationname) void validatelogicaldevicename (LogicalDevice logicaldevice, java.lang.string specificationname) void validatephysicaldevicename (PhysicalDevice physicaldevice, java.lang.string specificationname) Description Finds physical devices in the inventory based on the physical address (MAC address) and specification. Checks whether a logical device already exists for an instance of this specification. Checks whether a physical device already exists for an instance of this specification. ServiceManager The ServiceManager class represents the common interface for the service and service configuration management of the technology pack. Table 4 3 describes the methods included in the ServiceManager class. Table 4 3 Method Signature Utility Methods in ServiceManager addchildconfigitem (ServiceConfigurationVersion scv, ServiceConfigurationItem parentitem, java.lang.string childitemname) addchildconfigitem (ServiceConfigurationVersion scv, java.lang.string parentitemname, java.lang.string childitemname) checkitemassignedreferenced (ServiceConfigurationVersion scv, ServiceConfigurationItem item) checkitemassignedreferenced (ServiceConfigurationVersion scv, java.lang.string itemname) findserviceconfigitembyname (ServiceConfigurationVersion scv, java.lang.string itemname) getallchildserviceconfigurationitems (java.util.list<serviceconfigurationitem> items) getallchildserviceconfigurationitemsmatching (ServiceConfigurationItem item, java.lang.string matchingname) getserviceconfigurationitems (ServiceConfigurationVersion scv, Assignment assignment) getserviceconfigurationitems (ServiceConfigurationVersion scv, ConfigurationReference reference) getserviceconfigurationversion (Service svc, java.lang.string configspecname) Description Adds a child configuration item in the given configuration version. Adds a child configuration item in the given configuration version. For this method, the name of the parent service configuration item, rather than the configuration item itself, is passed as an input parameter. Checks whether the configuration item has an assignment or reference. Checks whether the configuration item has an assignment or reference. For this method, the name of the service configuration item, rather than the configuration item itself, is passed as an input parameter. Finds service configuration items by the name of a configuration item in the given service configuration version. Retrieves all the levels of child configuration items for the given configuration items. Retrieves the child configuration items for the given configuration item that match with the given name. Finds the service configuration items based on the assigned resources. Finds the service configuration items based on the referenced resources. Finds whether a service configuration version that is in progress exists before a new version can be created. 4-4 UIM Consumer VoIP Technology Pack Implementation Guide

33 Common Library Table 4 3 Method Signature (Cont.) Utility Methods in ServiceManager relateservicetoparty (ServiceConfigurationVersion scv, Party party, java.lang.string rolespec) relateservicetoparty (ServiceConfigurationVersion scv, PartyType partytype, java.lang.string partyspecname, java.lang.string rolespec) updateserviceconfigurationversion (ServiceConfigurationVersion scv) Description Relates a party to the service. Relates a party to the service. For this method, the input parameter is PartyType. Updates the service configuration version for the given configuration version and returns the updated version. Common Content 4-5

34 Common Library 4-6 UIM Consumer VoIP Technology Pack Implementation Guide

35 5 5Telephone Management Web Services This chapter contains information about the telephone management Web Services provided with the Consumer VoIP Technology Pack. The Web Services are provided in the PhoneUim.war file, packaged in the ora_uim_phone_webservice.zip file included with the technology pack. Four Web Services are provided: FindTN FindReserveTN ValidateMoveTN ValidatePortTN See UIM Developer s Guide for information about using and extending Web Services. FindTN Finds telephone numbers based on the arguments specified. For example, you can find ten numbers in the zip code. The Web Service returns a list of the numbers found. This Web Service is a wrapper for the findtn() API. You supply four arguments: city: The city in which the numbers should be located. You can specify city, postalcode or both. postalcode: The postal code in which the numbers should be located. You can specify city, postalcode or both. tntype: The value of the tntype characteristic for the number (OWNED, PORTED, PORTEDIN, or TOLLFREE). Defaults to OWNED if you do not supply this argument. quantity: The quantity of telephone numbers to find. Defaults to 1 if you do not supply this argument. If the specified city or postal code is not associated with an inventory group, the operation fails. FindReserveTN Finds and reserves telephone numbers based on the arguments specified. For example, you can find and reserve four numbers in Dallas. The Web Service returns a list of the numbers, which have short-term reservations. Telephone Management Web Services 5-1

36 ValidateMoveTN ValidateMoveTN ValidatePortTN This Web Service is a wrapper for the findreservetn() API. You supply four arguments: city: The city in which the numbers should be located. You can specify city, postalcode or both. postalcode: The postal code in which the numbers should be located. You can specify city, postalcode or both. tntype: The value of the tntype characteristic for the number (OWNED, PORTED, PORTEDIN, or TOLLFREE). Defaults to OWNED if you do not supply this argument. quantity: The quantity of telephone numbers to find and reserve. Defaults to 1 if you do not supply this argument. If the specified city or postal code is not associated with an inventory group, the operation fails. Checks the validity of moving a number from one location to another. The validation logic finds the inventory groups for the To and From city and postalcode. If the two inventory groups share a parent inventory group, the validation is successful. If no parent inventory group exists or either of the inventory groups cannot be determined, validation fails. This Web Service is a wrapper for the validatemovetn() API. You supply four arguments: cityfrom: The city from which a number will be moved. postalcodefrom: The postal code from which a number will be moved. cityto: The city to which a number will be moved. postalcodeto: The postal code to which a number will be moved. Checks the validity of porting a number from one location to another. The validation logic finds the inventory groups for the number to be ported and for the location to which it will be ported. If the two inventory groups share a parent inventory group, the validation is successful. If no parent inventory group exists or either of the inventory groups cannot be determined, validation fails. This Web Service is a wrapper for the validateporttn() API. You supply three arguments: city: The city to which the number will be ported. postalcode: The postal code to which the number will be ported. telephoneid: The telephone number to be ported. 5-2 UIM Consumer VoIP Technology Pack Implementation Guide

37 6 6Extending the Consumer VoIP Technology Pack You can extend the Consumer VoIP Technology Pack to meet the business needs of your organization. This chapter describes the most commonly extended areas. See UIM Concepts, UIM Developer s Guide, and the Oracle Communications Design Studio online Help for information about how you extend specifications, characteristics, and rulesets. Important: To ensure that your extensions are upgradeable and supportable, you must follow the guidelines and policies described in UIM Concepts. Extending ATA Capabilities You can extend the specifications and rules associated with analog telephony adapters (ATA). For example, you can associate additional characteristics with the Analog Telephony Adapter Logical Device Configuration specification. You can also add auto assignment and validation logic. The configuration specification includes the following features to facilitate extensions: Extending IP Phone Capabilities The Additional Characteristics configuration item is a stub that has no default functionality. You can upwardly relate ATA configuration specifications to this configuration item to associate additional characteristics to the ATA. AUTO_ALLOCATE_INV_CONFIG_ANALOG_TELEPHONY_ADAPTER_ CONFIGURATION is an empty ruleset that you can overwrite by using a supplemental cartridge. You can use this ruleset to provide auto-assignment logic for the configuration. VALIDATE_ANALOG_TELEPHONY_ADAPTER_CONFIGURATION is an empty ruleset that you can overwrite by using a supplemental cartridge. You can use this ruleset to provide validation logic for the configuration to ensure that all required configuration items have been correctly assigned. You can extend the specifications and rules associated with IP phones. For example, you can associate additional characteristics with the IP Phone Configuration specification. You can also add auto assignment and validation logic. The configuration specification includes the following features to facilitate extensions: Extending the Consumer VoIP Technology Pack 6-1

38 Extending ATA Capabilities The Additional Characteristics configuration item is a stub that has no default functionality. You can upwardly relate IP phone configuration specifications to this configuration item to associate additional characteristics to the IP phone. AUTO_ALLOCATE_INV_CONFIG_IP_PHONE_CONFIGURATION is an empty ruleset that you can overwrite by using a supplemental cartridge. You can use this ruleset to provide auto-assignment logic for the configuration. VALIDATE_IP_PHONE_CONFIGURATION is an empty ruleset that you can overwrite by using a supplemental cartridge. You can use this ruleset to provide validation logic for the configuration to ensure that all required configuration items have been correctly assigned. Extending VoIP Service Capabilities You can extend the specifications and rules associated with the VoIP service. For example, you can associate additional characteristics with the VoIP Service Configuration specification. You can also add auto assignment and validation logic. The configuration specification includes the following features to facilitate extensions: The Additional Characteristics configuration item under User Details configuration item is a stub that has no default functionality. You can upwardly relate VoIP service configuration specifications to this configuration item to associate additional characteristics to the IP phone. AUTO_ALLOCATE_SERVICE_CONFIG_VOIP_SERVICE_CONFIGURATION is an empty ruleset that you can overwrite by using a supplemental cartridge. You can use this ruleset to provide auto-assignment logic for the configuration. VALIDATE_VOIP_SERVICE_CONFIGURATION is an empty ruleset that you can overwrite by using a supplemental cartridge. You can use this ruleset to provide validation logic for the configuration to ensure that all required configuration items have been correctly assigned. Extending Phone Service Capabilities You can extend the specifications associated with the phone service. For example, you can associate additional characteristics with the Phone Service Configuration specification. The configuration specification includes the following feature to facilitate extensions: The Feature Set configuration item is a stub that has no default functionality. You can upwardly relate up to 17 call features to this configuration item. Extending Telephone Number Capabilities You can extend the specifications associated with the telephone numbers. For example, you can associate additional characteristics with the Telephone Number specification. The specification includes the following feature to facilitate extensions: The Telephone Number Type configuration item is a stub that has no default functionality. You can upwardly relate four types of telephone numbers, including Owned, Ported In, Ported Out, and Tollfree to this configuration item. 6-2 UIM Consumer VoIP Technology Pack Implementation Guide

39 7 7Consumer VoIP Technology Pack Service Example This chapter provides an example of using the Consumer VoIP Technology Pack to create a service for a user. This includes a service for VoIP itself, a voic service, and a generic phone service. These three services and the resources assigned to them model the user s complete service. Overview Setting up service for a consumer VoIP user involves three groups of tasks: Pre-Provisioning Network Resources Pre-Provisioning Users Creating Services For clarity in this example, resources are created first, but it is also possible to create them as you assign them to services. Assumptions This example assumes that address elements such as country codes, state and province codes, and cities already exist in Oracle Communications Unified Inventory Management (UIM). Note: This example is based on the use of the default specifications and characteristics supplied with the technology pack. Extending the technology pack may influence how you configure the service. Pre-Provisioning Network Resources You must pre-provision the network resources used by the VoIP service. In most cases, these devices will exist already when you set up a VoIP service. You just need to know which particular resources are applicable to the service you are creating. For this example: Create a call agent by using the Call Agent Logical Device specification. Create a voic server by using the voic server Logical Device specification. Create a DHCP server by using the DHCP Server Logical Device specification. Consumer VoIP Technology Pack Service Example 7-1

40 Pre-Provisioning Users Create a TFTP server by using the TFTP Server Logical Device specification. Pre-Provisioning Users Creating an IP Phone You must pre-provision user resources used by the VoiP and phone services. Pre-provisioning users includes several groups of tasks: Creating an IP Phone Creating a Telephone Number Creating an IP Address Creating An Address Creating a Service Location Creating a Voic Access Account Creating a VoIP User Account You create an IP Phone entity to represent the user s handset. If the customer decided to use an ATA (Analog Telephony Adapter) rather than an IP Phone, you would create that instead. For this example: Create a logical device based on the IP Phone specification. Select the characteristics that apply to the phone and select the appropriate VoIP protocol. Add configuration to the IP Phone entity. Only one configuration specification is available, IP Phone Configuration. If appropriate, you can set a value for the Software Version configuration item. Creating an Telephone Number Inventory Group You can optionally create inventory groups to contain telephone numbers or telephone number blocks. You can create groups based on city, geographic area, or postal code. For example, you can create an inventory group to contain blocks of telephone numbers for a particular US Zip code. You associate an appropriate Place entity to the inventory group. You also add telephone numbers or blocks of telephone numbers as items to the inventory group. Later, when you assign a telephone to a Phone service, UIM validates that the place associated with the inventory group matches the equivalent place associated with the service. For example, if the telephone number is in an inventory group for Zip codes, UIM validates that the Zip code associated with the Phone service matches the Zip code of the telephone number s inventory group. For this example: Create an inventory group based on one of the following specifications: citycodetnarea geographictnarea postalcodetnarea 7-2 UIM Consumer VoIP Technology Pack Implementation Guide

41 Pre-Provisioning Users Associate an appropriate Place entity to the inventory group. For example, if you created an inventory group based on the citycodetnarea, associate a location-type Place entity for a city. If telephone numbers appropriate for the group already exist, you can add them as items to the inventory group. If numbers are not available, you can create them and add them to the group. See the next section, "Creating a Telephone Number", for information about creating a telephone number. Figure 7 1 illustrates some of the contents of an inventory group for a city, including its telephone numbers. Figure 7 1 Contents of Inventory Group Creating a Telephone Number You create a telephone number entity to represent the number associated with the user s phone. The technology pack includes several different specifications for telephone numbers in various countries. You can extend the technology pack by creating additional specifications for other countries. For this example: Create a telephone number for the phone. Choose the Telephone Number specification that is appropriate for the user s location, such as canadatelephonenumber. Consumer VoIP Technology Pack Service Example 7-3

42 Pre-Provisioning Users Because you are creating only a single number, enter the number into the Range From field. If you were creating a range of numbers based on the same specification, you would also enter a number into the Range To field. Optionally set a value for Responsible Provider and choose a TN Type. Optionally add the telephone number to an inventory group. Creating an IP Address Creating An Address Creating a Service Location You create an IP address that is associated with the user s phone. The technology pack includes specifications for both IPv4 and IPv6 addresses. For this example: Create a Custom Network Address based on the IPv4 IP Address or IPv6 IP Address specification, depending on which version is used in this network. Set a value for the address, such as and for the CIDR, such as 32. You create an address entity to represent the user s the street address. Because different countries have different address standards, the technology pack includes several different specifications for various countries. You can extend the technology pack by creating additional address specifications. For this example: Create an address-type Place entity based on the specification that is appropriate for the location, such as canadaaddress. Enter the address and postal code; select values for the city, state or province, and country. The possible values will depend on the values that have been stored already in UIM. The service location is the place where the service is delivered. For a consumer VoIP service, this is likely a residence. You associate the address you created earlier to this location. For this example: Create a location-type Place entity based on the servicelocation specification. In the Place Hierarchy area, add the address you created earlier as a child item. Creating a Voic Access Account Creating a VoIP User Account You create an entity to represent the user s voic account. For this example: Create a Logical Device Account entity based on the voic access specification. Select the voic server logical device for this account. You create an entity to represent the user s VoIP account. For this example: Create a Logical Device Account entity based on the VoIP User specification. This specification provides required and optional characteristics for a variety of attributes associated with VoIP accounts. 7-4 UIM Consumer VoIP Technology Pack Implementation Guide

43 Creating Services Figure 7 2 illustrates some sample values in a Logical Device Account Information page. Figure 7 2 VoIP User Account Creating Services After pre-provisioning the network and the user, you can create and provision the services that together make up a user s full consumer VoIP service. There are three services: A VoIP service. See "Creating and Provisioning the VoIP Service". A voic service. See "Creating and Provisioning a Voic Service". A phone service. See "Creating and Provisioning a Phone Service". Creating and Provisioning the VoIP Service The VoIP service enables you to provision specifically VoIP-related resources. For this example: Create a Service entity based on the VoIP Service specification. Select the correct VoIP Protocol for the Service. Create a configuration for the service. Only one configuration specification, VoIP Service Configuration, is available. The configuration includes one default configuration item, User Details, and an optional Service Level characteristic. Optionally set a value for the Service Level characteristic. Service level names vary by carrier. In the User Details configuration item, assign the VoIP user account you created earlier. Add a Call Agent configuration item and assign the Call Agent logical device you created earlier. Consumer VoIP Technology Pack Service Example 7-5

44 Creating Services Add a Customer Site Access configuration item, and then add the following configuration items to it: Customer Premise Equipment. Assign the IP Phone logical device that you created earlier. Note that the IP Phone s logical device configuration is automatically included when you assign the device. If the customer were using an ATA rather than a phone, you would assign that instead. IP Address. Assign the IP Address custom network address that you created earlier. DHCP Server. Assign the DHCP logical device that you created earlier. TFTP Server. Assign the TFTP logical device that you created earlier. Figure 7 3 shows a VoIP service configuration with values for these characteristics and configuration items. Figure 7 3 VoIP Service Configuration Creating and Provisioning a Voic Service The voice mail services defines information about the user s voic . For this example: Create a Service entity based on the voic service specification. 7-6 UIM Consumer VoIP Technology Pack Implementation Guide

45 Creating Services Add a configuration for the service. Only one configuration specification, voic serviceconfiguration, is available. The configuration includes two configuration items: VM Server. Assign the Voic Server logical device you created earlier. VM Access. Assign the Voic Access logical device account entity that you created earlier. Creating and Provisioning a Phone Service The Phone service links together the other services and enables you to enter information about the service location and primary carrier. For this example: Create a Service entity based on the phoneservice specification. Add a configuration to the service. Only one configuration specification, phoneserviceconfiguration, is available. Assign the telephone number entity that you created earlier to the Telephone Number configuration item. Add the following configuration items to the phone service configuration: Service Location. Assign the servicelocation Place entity that you created earlier. Service Delivery. Assign the VoIP Service that you created earlier. Voice Mail. Assign the voic service entity that you created earlier. Figure 7 4 shows a phone service configuration with values for these characteristics and configuration items. Figure 7 4 Phone Service Configuration Consumer VoIP Technology Pack Service Example 7-7

46 Creating Services 7-8 UIM Consumer VoIP Technology Pack Implementation Guide