Les cookies nous permettent de vous proposer nos services plus facilement. En utilisant nos services, vous nous donnez expressément votre accord pour exploiter ces cookies.En savoir plus OK

EBP Comptabilité Open Line Pro 2010

EBP Comptabilité Open Line Pro 2010

Le pdf se trouve ci-dessous. Vous pouvez télécharger le pdf en cliquant à droite.

Revenir à l'accueil

 

Au format "texte" :

EBP Comptabilité Open Line Pro Table des matières Félicitations ! ........................................................................................................................................ 1 Convention d'utilisation d'EBP ................................................................................................................. 3 Préambule ......................................................................................................................................... 3 Livraison, Suivi et Droit de rétractation ( loi Chatel du 3 janvier 2008 ) ..................................................... 3 Étendue des obligations de support d’EBP .............................................................................................. 3 Assistance de proximité sur le site ........................................................................................................ 3 Sauvegarde des données ..................................................................................................................... 3 Limitation de garantie ......................................................................................................................... 3 Limitations de responsabilité ................................................................................................................ 4 Dispositions finales ............................................................................................................................. 4 MISE EN ROUTE .................................................................................................................................... 5 Configuration minimale requise ............................................................................................................ 5 Installation......................................................................................................................................... 5 Le dossier de démonstration ................................................................................................................ 5 Activation du logiciel ........................................................................................................................... 5 Comment obtenir le code d'activation ? ............................................................................................... 5 Introduction du code d'activation manuellement .................................................................................. 5 INFORMATIONS GÉNÉRALES ................................................................................................................... 7 Interface ............................................................................................................................................ 7 Présentation du volet de navigation ....................................................................................................... 7 Détail des groupes et fonctions associées ............................................................................................ 7 Les Actions ........................................................................................................................................ 9 LES MASQUES DE SAISIE .................................................................................................................... 9 Les champs de saisie ........................................................................................................................ 9 Liste déroulante ............................................................................................................................... 9 La barre d'outils des textes enrichis .................................................................................................. 10 FENETRE PRINCIPALE DE NAVIGATION ................................................................................................ 11 La fenêtre principale de navigation ................................................................................................... 11 Menu contextuel des colonnes ......................................................................................................... 12 Export à partir de la fenêtre principale de navigation .......................................................................... 13 Les filtres ...................................................................................................................................... 13 Les vues ....................................................................................................................................... 13 GESTION D'UNE FICHE ...................................................................................................................... 14 Gestion d'une fiche ......................................................................................................................... 14 Notes ........................................................................................................................................... 15 GUIDE ................................................................................................................................................ 17 COMMENCER .................................................................................................................................... 17 Comment commencer ? .................................................................................................................. 17 Comment créer les données principales ? .......................................................................................... 17 Options à remplir dès maintenant .................................................................................................... 17 Les données de base ...................................................................................................................... 18 Tout est prêt ! ............................................................................................................................... 18 TRAVAILLER ..................................................................................................................................... 18 Comment créer un exercice ? .......................................................................................................... 18 Comment changer d'exercice courant ............................................................................................... 19 Comment créer un journal ? ............................................................................................................ 19 Comment créer un compte ? ........................................................................................................... 19 Comment consulter un compte ? ...................................................................................................... 19 Comment lettrer ou délettrer un compte ?......................................................................................... 19 Comment créer un rapprochement ? ................................................................................................ 20 Quel mode de saisie faut-il choisir ? ................................................................................................. 20 Comment saisir dans un journal ? .................................................................................................... 21 Comment saisir dans un guide ? ...................................................................................................... 21 Saisie au kilmomètre ...................................................................................................................... 22 Comment saisir en saisie pratique ? ................................................................................................. 24 Comment simuler, confirmer ou valider une écriture ? ........................................................................ 24 Comment gérer les écritures de régularisation ? ................................................................................ 25 Comment gérer les échéances ? ....................................................................................................... 25 Comment effectuer une déclaration de TVA ? .................................................................................... 26 Comment effectuer la clôture mensuelle ? ......................................................................................... 26 Comment générer les A Nouveaux ? ................................................................................................. 26 Comment effectuer la clôture annuelle ? ........................................................................................... 27 Comment imprimer ? ...................................................................................................................... 27 DIVERS ........................................................................................................................................... 28 Comment consulter le journal des événements ? ................................................................................ 28 Comment sauvegarder ? ................................................................................................................. 28 Comment restaurer ?...................................................................................................................... 28 MANUEL ............................................................................................................................................. 29 iii EBP Comptabilité Open Line Pro FICHIER .......................................................................................................................................... 29 Nouveau dossier ............................................................................................................................ 29 Créer un nouveau raccourci ............................................................................................................. 29 Ouvrir un dossier ........................................................................................................................... 30 Fermer un dossier .......................................................................................................................... 30 Quitter l'application ........................................................................................................................ 30 AFFICHAGE ...................................................................................................................................... 30 Tableau de bord ............................................................................................................................. 30 Ecran de démarrage ....................................................................................................................... 31 QUOTIDIEN ...................................................................................................................................... 31 Quotidien - Démarrer une tâche ....................................................................................................... 32 PLAN COMPTABLE ENTREPRISE ........................................................................................................ 32 SAISIE PAR JOURNAL ..................................................................................................................... 35 RECHERCHE D'ÉCRITURES .............................................................................................................. 56 SAISIE AU KILOMETRE ................................................................................................................... 57 SAISIE PAR GUIDE ......................................................................................................................... 60 SAISIE PRATIQUE .......................................................................................................................... 62 CONSULTATION/LETTRAGE ............................................................................................................. 64 RELEVÉ BANCAIRE ......................................................................................................................... 67 RAPPROCHEMENT BANCAIRE ........................................................................................................... 69 ÉCRITURES DE RÉGULARISATION .................................................................................................... 73 DÉCLARATION DE TVA .................................................................................................................... 81 Impression - Fenêtre principale de navigation .................................................................................. 100 CONSULTATION .............................................................................................................................. 101 Consultation - Démarrer une tâche ................................................................................................. 101 CONSULTATION/LETTRAGE ........................................................................................................... 101 LETTRAGE AUTOMATIQUE ............................................................................................................. 104 LETTRAGE SIMPLIFIÉ .................................................................................................................... 105 GRAND LIVRE INTERACTIF ............................................................................................................ 109 BALANCE INTERACTIVE ................................................................................................................ 110 Impression - Fenêtre principale de navigation .................................................................................. 111 ÉCHÉANCIER / REGLEMENTS ............................................................................................................ 112 Echéanciers / Règlements - Démarrer une tâche .............................................................................. 112 CONSULTATION ........................................................................................................................... 112 LETTRAGE AUTOMATIQUE ............................................................................................................. 115 CLIENTS ..................................................................................................................................... 116 FOURNISSEURS ET AUTRES TIERS ................................................................................................. 121 DONNEES ................................................................................................................................... 126 Impression - Fenêtre principale de navigation .................................................................................. 131 EXERCICES/CLOTURES .................................................................................................................... 132 Exercices/Clôtures - Démarrer une tâche ........................................................................................ 132 EXERCICES ................................................................................................................................. 132 GESTIONNAIRE DE JOURNAUX ...................................................................................................... 134 CLOTURE ANNUELLE ..................................................................................................................... 135 Impression - Fenêtre principale de navigation .................................................................................. 136 PARAMETRES ................................................................................................................................. 137 Paramètres - Démarrer une tâche .................................................................................................. 137 JOURNAUX .................................................................................................................................. 138 PLAN COMPTABLE ENTREPRISE ...................................................................................................... 139 BANQUES .................................................................................................................................... 142 NATURES DE COMPTE ................................................................................................................... 144 MODELES DE GUIDE ..................................................................................................................... 144 MODELES DE LIBELLE ................................................................................................................... 145 TAXES ........................................................................................................................................ 146 DIVERS ....................................................................................................................................... 148 SOCIÉTÉ ..................................................................................................................................... 152 UTILISATEURS ............................................................................................................................. 163 Impression - Fenêtre principale de navigation .................................................................................. 166 OUTILS .......................................................................................................................................... 167 Sauvegarde rapide ....................................................................................................................... 167 Sauvegarde ................................................................................................................................. 167 Restauration ................................................................................................................................ 168 Historique de sauvegarde .............................................................................................................. 169 Sauvegarde en ligne ..................................................................................................................... 169 Export du schéma de la base de données ........................................................................................ 170 Communication Entreprise-Expert .................................................................................................. 170 Exporter les liasses fiscales ........................................................................................................... 171 Assistant de maintenance des données ........................................................................................... 171 Outil de requêtage ....................................................................................................................... 172 Supprimer un dossier ................................................................................................................... 173 Maintenance sur les journaux ........................................................................................................ 173 Purger le plan comptable .............................................................................................................. 174 iv Table des matières v Purger les relevés bancaires .......................................................................................................... 174 Editeur de modèles ...................................................................................................................... 174 Plan de regroupement .................................................................................................................. 174 Import/Export de la configuration .................................................................................................. 177 Archivage .................................................................................................................................... 177 Journal des événements ............................................................................................................... 178 OPTIONS .................................................................................................................................... 179 INFORMATIONS SOCIÉTÉ ................................................................................................................... 181 Assistance technique ....................................................................................................................... 181 Nous contacter ............................................................................................................................... 181 Glossaire .......................................................................................................................................... 183 Index ............................................................................................................................................... 189 1 Félicitations ! Vous venez d’acquérir un logiciel EBP, nous vous en souhaitons bonne utilisation. Cette aide en ligne et contextuelle présente le logiciel EBP Compta & Gestion commerciale Open Line TM Pro 2010 et donne toutes les informations nécessaires à son installation et à sa découverte. Celle-ci est mise à jour régulièrement et doit répondre à la totalité des questions que vous pourriez vous poser. Pour accéder à l’aide en ligne, deux possibilités sont à votre disposition : La touche F1 ou le bouton Aide pour une aide directe sur un écran précis, Le menu ? - Aide + Nom du module ouvert, pour obtenir une aide générale composée d’un Sommaire, d’un Index qui affiche l’ensemble des informations traitées dans l’aide et d’un onglet Recherche qui génère la totalité des mots utilisés dans l’aide pour une recherche très approfondie. Convention d'utilisation d'EBP Préambule En achetant un progiciel EBP (de la Sté EBP SA au capital d’un million d’euros immatriculée au RCS de Versailles N° 330 838 947), « le Client » fait l’acquisition du droit non exclusif de l'utiliser à des fins personnelles ou professionnelles sur un seul ordinateur individuel. Le client ne peut transférer ou laisser transférer le progiciel vers d'autres ordinateurs via un réseau. Il est strictement interdit de dupliquer le progiciel ou sa documentation selon la loi en vigueur sauf à des fins exclusives de sauvegarde. Chaque utilisateur sur son poste de travail doit bénéficier d'une licence d'utilisation y compris si son poste utilise le progiciel via un réseau local ou Internet en mode "terminal server" (TSE) ou analogue. L'achat d'un progiciel « monoposte » ne donne droit qu'à UNE seule licence d'utilisation sur un poste de travail habituel. Une utilisation multiposte ou réseau nécessite une licence correspondante. L'ensemble des progiciels est protégé par le copyright d'EBP. Toute duplication illicite est susceptible de donner lieu à des poursuites judiciaires civiles et/ou pénales. Les progiciels sont incessibles et insaisissables. Ils ne peuvent faire l’objet d’un nantissement ou d’une location à aucun titre que ce soit. EBP se réserve le droit de faire dans le progiciel toutes les modifications qu'il estime opportunes. Livraison, Suivi et Droit de rétractation ( loi Chatel du 3 janvier 2008 ) En vertu de l’article L. 121-20-3 du Code de la Consommation, EBP s’engage, sauf mention expresse et spéciale sur ses documents commerciaux, à livrer les progiciels au plus tard dans les 3 jours ouvrés qui suivent la commande. A ce délai, s’ajoutent les délais postaux en vigueur. En cas de téléchargement, les progiciels sont disponibles immédiatement. En conformité avec l’article L. 121-84-3 du Code de la consommation, le client peut suivre l’exécution de sa commande, par un numéro d’appel téléphonique fixe et non surtaxé accessible depuis le territoire métropolitain. En conformité avec l’article L. 121-20.2 du Code de la consommation, le client est informé qu’il ne peut pas exercer son droit de rétractation auquel il renonce expressément et ce dès la livraison du logiciel dans la mesure où le Client ou l’un de ses préposés fait une demande d’activation au moyen du N° de licence du produit et d’une « raison sociale ». Il en est de même si un contrat de services est souscrit dont l’exécution commence immédiatement à compter de l’activation du logiciel qui est fait de façon concomitante et automatiquement avec son installation. Il en est encore de même si le logiciel complet est téléchargé par Internet. Étendue des obligations de support d’EBP Les services d’assistance d’EBP sont destinés à fournir des conseils, des recommandations et des informations relatifs à l’usage des progiciels EBP dans les configurations matérielles et logicielles requises. EBP s’engage à fournir au CLIENT les conseils les plus adéquats pour aider à résoudre les problèmes que le CLIENT pourrait rencontrer dans l’utilisation ou le fonctionnement du progiciel, mais EBP ne donne aucune garantie de résolution des problèmes. Les services de support d’EBP qui font l’objet d’un contrat distinct des présentes conditions sont disponibles aux tarifs en vigueur et n’incluent pas le support sur site. Assistance de proximité sur le site L’utilisateur doit pouvoir faire appel à un professionnel de l’informatique pour dénouer sur son site une difficulté technique dont la cause ne serait pas déterminée ou résolue par l’assistance téléphonique d’EBP. Pour ce faire, le Client reconnaît conclure avec un distributeur ou un professionnel de l’informatique une convention pour l’assister sur site en cas de besoin. Cette convention fixe les conditions d’intervention de ce professionnel. EBP ne peut être rendu responsable d’un défaut d’accord ou des conséquences d’un non-respect des obligations réciproques des parties convenues dans cette convention tierce. Sauvegarde des données Le CLIENT reconnaît avoir être informé par EBP et/ou par son distributeur qu’il est prudent en termes de bonne gestion informatique, de procéder au moins une fois par vingt-quatre (24) heures à la sauvegarde des systèmes, programmes et fichiers de données, et que l’absence d’une telle sauvegarde réduit de manière significative ses chances de limiter l’impact des dommages qui pourraient résulter d’une irrégularité dans le fonctionnement de son système ou ses progiciels et peut réduire la portée des services de support fournis par EBP. Le CLIENT reconnaît qu’il est de sa responsabilité de mettre en œuvre une procédure pour assurer la récupération des données, fichiers ou programmes détruits, endommagés ou perdus. EBP ne saurait être tenue responsable en cas de perte de données. Limitation de garantie EBP garantit que les produits et services fournis aux termes des présentes seront conformes, pour l'essentiel, au besoin d’un utilisateur standard. Le progiciel est fourni en l'état sans garantie d'aptitude à une utilisation particulière, tous les risques relatifs aux résultats et à la performance du progiciel sont assumés par l'acheteur. En toute hypothèse, EBP n’assume que des obligations de moyens à l’exclusion de toute obligation de résultat. La présente garantie est exclusive de toute autre garantie. EBP exclut toute autre garantie expresse ou implicite 3 EBP Comptabilité Open Line Pro 4 y compris, de manière non limitative, toute garantie de qualité ou d’adéquation à un besoin particulier. En outre, le CLIENT reconnaît que la fourniture des services de support téléphonique dans le cadre d’un contrat d’assistance dépend de la disponibilité ininterrompue des moyens de communication et qu’EBP ne peut garantir une telle disponibilité. Limitations de responsabilité Sauf disposition contraire d’ordre public, EBP ou ses fournisseurs ne seront en aucun cas responsables à raison de préjudices directs ou indirects (y compris les manques à gagner, interruptions d’activité, pertes d’informations ou autres pertes de nature pécuniaire) résultant d’un retard ou d’un manquement commis par EBP dans la fourniture ou l’absence de fourniture des services de support, alors même qu’EBP ou ses fournisseurs auraient été informés de l'éventualité de tels préjudices. EBP ne peut être rendu responsable d’un fonctionnement non conforme, d’un dysfonctionnement, d’une inaptitude particulière ou d’une absence de fonctionnalité dans un de ses progiciels. En outre, le CLIENT reconnaît qu’EBP et ses fournisseurs ne seront responsables à raison d’aucun manque à gagner subi par un tiers et d'aucune réclamation ou action en justice dirigée ou intentée contre le CLIENT par un tiers. En toute hypothèse, la responsabilité d’EBP ou de ses fournisseurs, quelle qu'en soit la cause ou le fondement, ne saurait excéder, au total, les sommes payées par le CLIENT à EBP (ou à son distributeur) pour la fourniture du progiciel ou du service au titre du contrat d’assistance. L’utilisateur reconnaît avoir évalué le logiciel de façon approfondie par une démonstration ou un test réel pour vérifier qu’il est en adéquation avec ses besoins. Dispositions finales Ces conditions générales de vente interviennent pour toutes commandes du Client faites verbalement ou bien passées par téléphone, fax, courrier, email, formulaire électronique à l'attention du service clients d’EBP ou d’un distributeur EBP. La validation d’un formulaire en ligne vaut acceptation par le client des présentes CGV dès lors que ce dernier a coché la case prévue a cet effet sur le formulaire. Les CGV font partie intégrale du contrat de licence et sont opposables au Client ou ses préposés. Conformément à Loi « Informatique et libertés » du 6 janvier 1978, le Client dispose d'un droit d'accès et de rectification aux données le concernant. Pour tout litige, il sera fait attribution de juridiction devant les tribunaux du ressort de Versailles, même en cas de pluralité de défendeurs ou d’appel en garantie. Version 2.0: Janvier 2008 MISE EN ROUTE Configuration minimale requise La configuration minimale conseillée pour une utilisation optimale de votre logiciel est la suivante : Processeur : P4 2 GHz ou équivalent Mémoire : 1 Go Ecran : résolution 1024x768 en 16 bits Espace disque libre : 1.5 Go Systèmes d'exploitation supportés : o Windows XP SP2, o Windows Vista SP1 bits & 64 bits, o Windows 7 32 bits & 64 bits. Windows XP, Vista et 7 sont des logiciels Microsoft dont vous devez faire l'acquisition préalablement à l’installation du logiciel. Installation Lors de l'installation, la présence des composants ci-dessous est vérifiée : Windows installer 3.1 Internet Explorer 6.0 SP1 Framework 2.0 S'ils ne sont pas présents sur le poste, ils sont automatiquement installés lors de la procédure. SQL Server 2005 est également installé avec une instance "ebp". L'instance "Ebp" permet de réaliser des créations de dossiers, sauvegardes et restaurations simplifiées. Ensuite, les éléments composant l'intégré sont installés. Le dossier de démonstration Accès : Menu Fichier / Ouvrir Le dossier Démonstration vous permet de découvrir l’ensemble des fonctionnalités du logiciel. De ce fait, nous vous conseillons vivement d'ouvrir le dossier afin de vous familiariser avec le logiciel avant de créer votre propre dossier-société. A l'ouverture du dossier de démonstration, une page d'accueil apparaît affichant une synthèse de l'activité (tableau de bord). Activation du logiciel Vous venez de faire l'acquisition d'un logiciel EBP Compta & Gestion commerciale Open Line TM Pro 2010 Pour pouvoir utiliser toutes les fonctions du logiciel, vous devez utiliser un code d'activation qui est fourni par EBP. Tant que le code d'activation n’a pas été saisi, le logiciel reste en version d'évaluation. Cela signifie que vous pouvez utiliser librement toutes les fonctions du logiciel pendant 40 jours. Au delà, le logiciel passe en version limitée en nombre de données : 20 articles, 20 documents, 100 écritures comptables et les impressions porteront la mention "Démonstration". Après cette limite, vous devrez saisir votre code d'activation pour ouvrir votre dossier. Comment obtenir le code d'activation ? Cliquez sur l'option "Obtenir votre code d’activation" (menu ? + Activer votre logiciel). L’activation du logiciel se faisant via le site Internet EBP, la connexion à notre site Web se fera automatiquement depuis le logiciel si votre ordinateur dispose d’Internet. Vous n’aurez ensuite qu’à suivre les instructions à l’écran pour activer automatiquement votre logiciel. Si vous ne disposez pas d'Internet sur votre ordinateur, un message d’information s’affichera automatiquement vous expliquant la procédure à suivre pour activer votre logiciel. Introduction du code d'activation manuellement Au lancement du logiciel, l'écran d'introduction s'affiche. Choisissez l'option Activer votre logiciel. La fenêtre d'activation s'ouvre et vous avez alors accès aux zones suivantes : Clé PC : elle est rensignée automatiquement et est indispensable pour l'activation du logiciel. 5 EBP Comptabilité Open Line Pro 6 Nom de l'entreprise : Vous devez impérativement saisir le même nom que vous nous avez communiqué sur le courrier en respectant la même syntaxe (points, majuscules). Licence : Vous devez saisir ici le numéro de licence indiqué sur le courrier "Licence d'utilisattion" joint à la boîte du logiciel. Clé Web : Elle vous sera demandée pour accéder à l'espace clients sur le site www.ebp.com et vous permettra, entre autres, de consulter les dernières nouveautés, de télécharger les mises à jour de votre logiciel. Code d'activation : Vous devez saisir ici le code (composé de 4 séries de 4 caractères) sans espace ni point, qu'EBP vous a communiqué. Validez ensuite en cliquant sur le bouton OK. Un message d'avertissement apparaît : • Si le code a été correctement saisi, le message vous indique à quelle version du logiciel correspond ce code. • Si le code saisi n'est pas valide, vous avez le message suivant : le code saisi est incorrect. Dans ce cas, vous pouvez ressaisir votre code en passant par le menu ? - Activer votre logiciel. INFORMATIONS GÉNÉRALES Interface EBP Compta & Gestion commerciale Open Line TM Pro évolue dans un environnement Windows XP ou supérieur. Ainsi, les règles de fonctionnement à l'intérieur du logiciel restent les mêmes que votre environnement de travail quotidien : • Des menus déroulants avec une liste de commandes à exécuter. • Des barres d'outils et d'application permettent l’accès rapide aux commandes les plus utilisées par simple clic sur les icônes. • Un volet de navigation (sur le côté gauche de l'écran) permet de naviguer rapidement entre les données. • Une barre d’état (en bas de l'écran) qui contient : ƒ Le nom du dossier : Le positionnement du curseur sur le nom du dossier permet d'afficher le chemin du raccourci du dossier. Un clic sur le nom du dossier affiche la volumétrie des tables de la base de données (tables et nombre d'enregistrements). ƒ L'utilisateur connecté : Le positionnement du curseur sur le code utilisateur permet d'afficher le nom complet de cet utilisateur. Un clic sur cet utilisateur permet de changer d'utilisateur. ƒ L'icône EBP : Un clic sur l'icône permet d'accéder à la page d'accueil du site EBP. Lorsque vous êtes sur une liste, le nombre d'enregistrements sélectionné et le nombre d'enregistrement total sont affichés. Exemple : pour une liste clients de 20 enregistrements et sélection de 2 lignes, l'affichage dans la barre d'état sera 2/20. • Une gestion des fenêtres principales de navigation associée à de nombreuses possibilités de recherches (avec les tris, filtres, colonnes...) • Des champs de saisie avec des caractéristiques particulières dans les masques de saisie. • Des barres d'outils pour vous permettre de personnaliser vos textes (choix de la couleur, la police, etc.). Présentation du volet de navigation Le volet de navigation (sur le côté gauche de l'écran) permet de se déplacer rapidement entre les données. Il est composé de 3 parties : 5 menus, une barre de navigation qui contient les fonctions associées à chaque menu, une barre de tâches qui contient les actions possibles pour chaque fonction. Les menus et fonctions associées sont également disponibles à partir de la barre de menus située en haut de l'application (Fichier, Edition, Affichage, Quotidien...) Il est possible de réduire ou d'agrandir la barre de navigation. En mode réduit, il vous suffit de cliquer ensuite à l'intérieur du bandeau, cela ouvre le contenu du volet de navigation. La nouvelle configuration de la barre sera sauvegardée à la fermeture de l'application. Détail des groupes et fonctions associées Quotidien : - Démarrer une tâche - Plan comptable entreprise - Saisie par journal - Recherche d'écritures - Saisie au kilomètre - Saisie par guide - Saisie pratique - Consultation/Lettrage - Relevé bancaire 7 EBP Comptabilité Open Line Pro - Rapprochement bancaire - Ecritures de régularisation - Déclaration de TVA - Impressions Consultation : - Démarrer une tâche - Consultation de compte - Lettrage simplifié - Lettrage automatique - Grand Livre interactif - Balance interactive - Impressions Echéanciers / Réglements - Démarrer une tâche - Consultation / Lettrage - Lettrage automatique - Clients : Echéancier interactif - Clients : Règlements clients - Fournisseurs : Echéancier interactif - Fournisseurs : Règlements fournisseurs. Exercices/Clôtures : - Démarrer une tâche - Exercices - Gestionnaire de journaux - Clôture annuelle - Impressions Paramètres : - Démarrer une tâche - Journaux - Plan comptable entreprise - Banques - Natures de comptes - Modèles de guide - Modèles de libellés - Taxes - Taux de TVA - Type de TVA - Territorialité - Types d'opération - Régimes de TVA - Déclarations et Paramétrage des déclarations - Divers - Civilités, - Codes postaux, - Départements, - Pays, - Moyens de paiement, - Modes de règlement, - Code NAF - Société - Coordonnées - Identification - Logo - Expert (cabinet et contacts) - Trésor Public - Paramétrage - Général (police par défaut) - Utilisateurs - Utilisateurs - Groupes d'utilisateur - Impressions. Pour chaque menu, vous disposez d'une entrée de menu Démarrer une tâche. Elle permet de visualiser l'enchaînement des fonctions disponibles dans chaque menu. 8 INFORMATIONS GÉNÉRALES En bas du volet de navigation, en cliquant sur l'icône >>, vous avez la possibilité de déplacer les menus en icônes grâce à l'option Afficher moins de boutons. Ainsi, vous n'aurez plus d"ascenseur dans les fonctions associées de chaque menu. Les Actions Les Actions sont accessibles à partir : de la barre de tâches située au dessus de la barre de navigation, du menu contextuel (clic droit) des fenêtres principales de navigation, du menu Actions de la barre de menus des fiches. Les actions varient en fonction de la fenêtre principale de navigation ou de la fiche affichée. LES MASQUES DE SAISIE Les champs de saisie Afin de faciliter l'utilisation du logiciel, des champs de saisie ayant des caractéristiques particulières sont proposés : • Ouvre la fiche de la donnée sélectionnée dans la zone. • Ouvre la liste des données. Raccourci clavier [F4] • Ouvre une liste déroulante ou un calendrier. Raccourci clavier [Flèche basse] • Zone de texte simple : Permet de saisir du texte (ex : zone de description d'un Intitulé de compte). • Pour une zone multi-lignes (exemple : Notes), utilisez les touches suivantes : o [Entrée] pour passer à la ligne suivante. o [Ctrl] + [flèche biais] et [Ctrl]+[Fin] pour accéder au début et à la fin du texte saisi. o [flèche biais] et [Fin] pour accéder au début et à la fin de la ligne. • Les champs inaccessibles sont grisés. Liste déroulante La liste déroulante est disponible à partir des champs de saisie contenant l'icône . Elle permet d'afficher la liste des données d'une table. - Champ "Compte" en entête de document - Champ "Pays" dans les parties Adresses - Champ "Article" dans le corps du document ... Ouverture de la liste Une liste peut être ouverte par : la touche [F4], l'icône , la touche [Flèche basse] du clavier. Sélection des données La sélection des données s'effectue soit : par un clic dans la case à cocher située en première position dans la liste déroulante, par un clic n'importe où sur une des lignes de la liste déroulante, puis la touche [Entrée] ou bouton Sélectionner. Elle peut également s'effectuer par la saisie de tout ou une partie du code/libellé ou intitulé de la donnée souhaitée. La liste s'ouvre alors et se filtre sur la première ligne correspondante à la saisie. Cette sélection peut être mono (sélectionner une seule données) ou multiple (sélectionner plusieurs données). 9 EBP Comptabilité Open Line Pro Si la saisie effectuée ne correspond pas à une donnée existante, la liste déroulante s'affiche mais elle est "vide". Fonctions de la liste La liste déroulante contient les fonctions suivantes : Sélectionner Ce bouton et la touche [Entrée] permettent de valider la sélection des données. Fermer Ce bouton et la touche [F4] permettent de fermer la liste sans sélectionner de données. Ajouter Ce bouton et la touche [Inser] permettent d'ouvrir une nouvelle fiche de données. Modifier Ce bouton et la touche [F2] sont disponibles uniquement si au moins une donnée est cochée dans la liste. Ils permettent d'ouvrir une fiche de donnée existante en mode modification. Rafraîchir Ce bouton et la touche [F5] permettent de mettre à jour la liste déroulante. Si vous sélectionnez plusieurs lignes de données puis demandez à Rafraîchir, la sélection des données est annulée. Sélection d'une Vue Cette liste permet de changer l'affichage de la liste. Éditeur de vue La sélection de ce bouton permet de réaliser une nouvelle vue des données. La barre d'outils des textes enrichis Dans tous les champs de type texte enrichi (dans vos documents, dans l'onglet Notes disponible dans toutes les fiches etc...), vous avez la possibilité d'appliquer à votre texte différents attributs : Police Sélectionnez dans la liste déroulante la police à appliquer sur le texte sélectionné. Nombre de caractères Indiquez la taille de la police à appliquer sur le texte sélectionné. Gras Cliquez sur cette icône pour mettre en gras le texte sélectionné. Italique Cliquez sur cette icône pour mettre en italique le texte sélectionné. Souligné Cliquez sur cette icône pour souligner le texte sélectionné. Barré Cliquez sur cette icône pour barrer le texte sélectionné. Aligné à gauche Cliquez sur cette icône pour aligner le texte sélectionné sur la gauche. Centré Cliquez sur cette icône pour centrer le texte sélectionné. Aligné à droite Cliquez sur cette icône pour aligner le texte sélectionné sur la droite. Justifié Cliquez sur cette icône pour justifier le texte sélectionné (toutes les lignes sont alignées à droite comme à gauche). Puce Cliquez sur cette icône pour afficher le texte sélectionné sous forme de paragraphe commençant par une puce. Diminuer le retrait 10 INFORMATIONS GÉNÉRALES Cliquez sur cette icône pour déplacer le texte sélectionné vers la gauche (aligne le texte sur le précédent texte positionné vers la gauche). Augmenter le retrait Cliquez sur cette icône pour déplacer le texte sélectionné vers la droite (aligne le texte sur le précédent texte positionné vers la droite). Couleur de police Cliquez sur cette icône pour choisir la couleur à appliquer au texte à saisir. Couleur de surlignage Cliquez sur cette icône pour choisir la couleur à appliquer au texte sélectionné. Annuler Cliquez sur cette icône pour annuler les dernières saisies, modifications réalisées. Refaire Cliquez sur cette icône pour remettre les dernières saisies, modifications réalisées. Orthographe Cliquez sur cette icône pour vérifier l'orthographe du texte saisi. Les mots contenant des fautes seront automatiquement soulignés en rouge. Un dictionnaire est livré avec le correcteur orthographique. Des mots synonymes à ceux saisis vous seront proposés pour corriger les mots sur lesquels des erreurs ont été saisies. Vous pouvez donc choisir parmi les synonymes proposés, ressaisir directement le bon mot ou choisir d'ignorer la correction et ajouter le mot à votre dictionnaire (afin que celui-ci ne soit plus souligné lors de la prochaine saisie). FENETRE PRINCIPALE DE NAVIGATION La fenêtre principale de navigation Dans toutes les fenêtres principales de navigation, vous avez accès à des fonctions spécifiques pour faciliter la gestion de vos données, le déplacement dans la liste... Vue - Précédent Permet d’accéder à la fenêtre principale de navigation précédente. Vue - Suivant Permet d’accéder à la fenêtre principale de navigation suivante. Rafraîchir Permet de mettre à jour l'affichage de la fenêtre principale de navigation. Il est conseillé de cliquer sur ce bouton suite à la modification de différentes fiches de la fenêtre principale de navigation. Ajouter Permet d'ouvrir une nouvelle fiche vierge. Pour certaines fenêtres principales de navigation (par exemple : Saisie par guide), vous devez cliquer sur Ajouter puis sélectionner le type de fiche que vous souhaitez ajouter (en l'occurrence : Achats, Ventes, Trésorerie ou Opérations Diverses). Modifier Permet d'ouvrir la/les fiche(s) sélectionnée(s) afin de les visualiser, modifier... Supprimer Permet de supprimer la/les fiche(s) sélectionnée(s). Dupliquer Permet de créer une copie conforme de la/les fiche(s) sélectionnée(s). En fonction de la fiche dupliquée, le code sera ou non affecté automatiquement (numéro de comptes, code journal...). Rechercher Permet de rechercher un texte ou une donnée précise dans tous les champs de la fenêtre principale de navigation. Vous n'avez pas l'obligation de cliquer dans la zone de recherche pour saisir le texte, la donnée ou la valeur que vous recherchez. Vous pouvez saisir dans la fenêtre principale de navigation et automatiquement le champ 11 EBP Comptabilité Open Line Pro rechercher se renseignera. L'affichage des données de la fenêtre principale de navigation se modifiera en fonction du texte de votre recherche. Sélectionner tout ou Crtl+A Permet de sélectionner automatiquement toutes les lignes de la fenêtre de navigation. Imprimer Permet d'imprimer : ƒ la fiche de la liste avec choix du modèle et des filtres : Imprimer... ou Ctrl + P, ƒ la liste ouverte : Imprimer la liste. Exporter Permet d'exporter la sélection, la vue ou tout. Pour plus d'explications, cliquez ici. Vue Permet d'avoir un affichage personnalisé de la fenêtre principale de navigation. Pour plus d'explications, cliquez ici. Sauvegarde rapide Permet de sauvegarder rapidement le dossier en fonction des modifications réalisées et des personnalisations de listes (vues). Vous pouvez accéder également à ces différentes fonctions par le menu contextuel (clic droit) de la fenêtre principale de navigation. Ce menu permet en plus de réaliser un filtre sur la valeur sélectionnée Filtrer sur cette valeur. Menu contextuel des colonnes A partir de la barre d'en-tête des colonnes des fenêtres principales de navigation ou grille de saisie, vous avez la possibilité de : Trier Choisissez le tri (ascendant ou descendant) que vous souhaitez sur au moins une colonne de la liste en cliquant sur l'une des fonctions ci-dessous : - Trier par ordre croissant - Trier par ordre décroissant - Annuler le tri, qui permet de revenir au tri précédent. Par un simple clic sur " l'intitulé de la colonne", vous pouvez trier en croissant ou décroissant. Les tris appliqués se remarquent par l'apparition d'un petit triangle ascendant ou descendant à côté de l'intitulé de la colonne triée dans votre liste. Regrouper - Grouper sur cette colonne Cette fonction permet de regrouper les données en fonction de la colonne sélectionnée. Ce groupe se matérialise par une ligne pour chaque donnée de la colonne avec un petit "+" pour voir les données associées. Si le panneau de regroupement est affiché, la colonne est automatiquement transférée dans celui-ci. - Panneau de regroupement Les boîtes de regroupement permettent de classer rapidement le contenu de vos listes selon les colonnes de votre choix. Pour l'activer, vous devez ouvrir à l'écran la liste que vous souhaitez classer et vous placer sur la barre d'entête des colonnes + menu contextuel Menu contextuel = clic droit de la souris. Une bande grisée apparaît alors au dessus de votre liste et vous permet de tirer-glisser, à l'aide de la souris, le titre de la colonne correspondant au groupe de classement à appliquer. Ajuster la taille des colonnes - Ajustement automatique La sélection de cette option permet de redimensionner automatiquement la colonne sur laquelle vous êtes positionné en fonction des données qu'elle contient. - Ajustement automatique toutes les colonnes 12 INFORMATIONS GÉNÉRALES La sélection de cette option permet de redimensionner automatiquement toutes les colonnes en fonction des données qu'elles contiennent. Filtrer Le filtre permet d'afficher uniquement les données de la colonne correspondante à une condition. Export à partir de la fenêtre principale de navigation Les données affichées peuvent être exportées sous différents formats (xml, xls, htm, html, txt). Pour cela, il suffit de sélectionner la commande "Export" depuis le menu contextuel de la fenêtre principale de navigation (clic droit). Vous devez ensuite donner un nom au fichier à générer. Le fichier sera généré par défaut sur "//mes documents/gestion commerciale/Data..." mais vous pouvez saisir un répertoire précis. En fonction de la fenêtre principale de navigation ouverte, vous disposez de différents exports : • "Exporter la sélection" consiste à exporter uniquement les lignes de la fenêtre principale de navigation sélectionnées. • "Exporter Tout" consiste à exporter tous les éléments de la fenêtre principale de navigation qu'ils soient visibles ou non dans la vue. Les filtres Le filtrage permet de rechercher et de manipuler rapidement et aisément un sous-ensemble de données dans une liste. Une liste filtrée affiche uniquement les lignes répondant aux critères spécifiés pour une colonne. Contrairement au tri, le filtrage ne réorganise pas la liste, mais masque momentanément les lignes que vous ne souhaitez pas afficher. Filtre automatique Il correspond au filtrage par sélection pour des critères simples. Pour accéder au filtre automatique, vous devez cliquer sur l'icône en haut à droite dans le champ en en-tête de colonne. Vous voyez apparaître une liste de chaque élément visible dans la colonne, y compris les éléments vides (constitués uniquement d'espaces). En sélectionnant un élément dans la liste d'une colonne, vous pouvez masquer instantanément toutes les lignes qui ne contiennent pas la valeur sélectionnée. En sélectionnant "Personnalisé", vous avez la possibilité de créer un filtre personnalisé à une ou deux conditions pour la colonne. Pour créer un filtre, vous devez choisir : l'opérateur souhaité, la valeur souhaitée, une condition (Et, Ou), l'opérateur souhaité, la valeur souhaitée. L'icône de filtrage automatique apparaît en bleu dans la colonne qui contient une valeur sélectionnée. Vous avez la possibilité de définir des filtres et de les enregistrer à partir de la gestion des vues. Effacer le filtre Pour effacer le filtre appliqué, vous devez faire un clic droit sur l'en-tête de la colonne puis sélectionner la fonction "Supprimer les filtres". Les vues L'éditeur de vues est disponible à partir de la barre d'outils de toutes les fenêtres principales de navigation et des listes déroulantes. Il contient la liste des affichages disponibles et permet de réaliser de nouveaux affichages. 13 EBP Comptabilité Open Line Pro Les vues contenant le mot "(système)" ne sont pas modifiables. Si vous souhaitez réaliser une nouvelle vue à partir d'une vue "système", vous devez dupliquer la vue "système" puis lui donner un autre nom. Si vous modifiez le tri (regroupement d'une fenêtre principale de navigation ou d'une liste déroulante) ; dès que vous confirmerez la modification (en cliquant sur le bandeau), ces modifications seront prises en compte dans la vue. Si cette vue est une vue "système", une copie de la vue avec le même nom mais sans le mot système sera automatiquement créée. Il est possible de définir une vue en "affichage par défaut" en cliquant sur le bouton "Défaut". Les modifications de la vue s'effectuent à l'aide de l'éditeur de requêtes. Cet éditeur permet : d'ajouter une requête : une requête s'effectue sur une ou plusieurs tables, elle est la base de la vue ; d'ajouter une colonne : les colonnes permettent de visualiser les données de la table ; d'ajouter une condition ou un groupe de conditions (filtres) : une condition permet de sélectionner les données à afficher ; d'ajouter une requête de détail : une requête de détail permet de réaliser un lien table entre deux tables (requêtes). de supprimer un élément : permet de supprimer une requête, colonne, condition, relation... ; d'importer ou exporter une requête (fichier qry). Ci-dessous quelques exemples : Définir une vue par défaut Ajouter une colonne dans une vue Supprimer des colonnes dans une vue Ajouter une condition Ajouter une requête de détail Ajouter une somme GESTION D'UNE FICHE Gestion d'une fiche Dans tous les masques de saisie ou fiches, vous avez accès à des fonctions spécifiques pour faciliter la gestion de vos données, le déplacement dans le fichier... Certaines fonctions décrites ci-dessous sont accessibles directement depuis un bouton de la barre d'outils située en dessous de la barre de menu de la fiche. Création d'une fiche Fichier - Nouveau ou Ctrl + I Permet de créer une nouvelle fiche vierge. Fichier - Dupliquer Permet de créer une copie conforme à la fiche d’origine. En fonction de la fiche dupliquée, le code sera ou non affecté automatiquement (numéro de compte, code journal, code d'un modèle de libellé…). Sauvegarde d'une fiche Fichier - Sauvegarder ou Ctrl + S Permet d'enregistrer la saisie sans fermer la fenêtre ouverte. Dans le corps d’un document, il est recommandé de valider de temps en temps si vous saisissez beaucoup de données. Fichier - Sauvegarder et Nouveau Permet d'enregistrer la saisie effectuée et d’ouvrir une nouvelle fiche. Fichier - Sauvegarder et Fermer Permet d'enregistrer la saisie effectuée et de fermer la fenêtre pour revenir à l'écran précèdent. Autres Fichier - Supprimer ou Ctrl + D Permet de supprimer la fiche. 14 INFORMATIONS GÉNÉRALES 15 Fichier - Imprimer ou Ctrl + I Permet d'imprimer la fiche sélectionnée. Le positionnement du curseur sur cet icône permet de visualiser dans une info bulle le nom de l'imprimante et le modèle utilisé. Fichier - Fermer Permet de fermer la fenêtre de saisie sans enregistrer. Gestion des données Edition - Annuler ou Ctrl + Z Permet d’annuler la dernière saisie, modification effectuée sur la fiche. Edition - Refaire ou Ctrl + Y Permet de remettre les dernières saisies, modifications réalisées. Edition - annuler tout ou Ctrl + U Permet d’annuler toutes les modifications effectuées sur la fiche depuis le dernier enregistrement. Edition - Couper ou Ctrl + X Permet de couper la partie du texte sélectionnée. Edition - Copier ou Ctrl + C Permet de copier la partie du texte sélectionnée. Edition - Coller ou Ctrl + V Permet de coller à l'endroit sélectionné la partie du texte précédemment copiée ou coupée (dans le logiciel ou dans une autre application). Navigation Action -... Ce menu permet d'accéder aux opérations liées à la fiche. Une fiche Compte a pour actions associées : - Consultation/Lettrage (accessible dans tous les cas, ce bouton permet d'accéder à la fenêtre de Consultation/Lettrage), - Fiche Tiers (accessible si le compte a été créé en Gestion commerciale, ce bouton permet d'afficher la fiche Tiers existant dans cette application). Vue - Précédent Permet d’accéder à la fiche précédente. Vue - Suivant Permet d’accéder à la fiche suivante. Fenêtre - Fermer tout Permet de fermer toutes les fiches ouvertes en une seule fois, y compris celle qui appelle cette fonction. Fenêtre - Liste des fenêtres Permet de naviguer entre les fiches/listes ouvertes. Aide ? - Aide Permet d’appeler l’aide en ligne de la fiche ouverte. Notes La saisie d'une note est possible à partir d'un onglet ou d'une partie Notes sur toutes les fiches. Cette note contient une zone de saisie libre, qui vous permet de saisir des renseignements complémentaires sur votre fiche. Vous pouvez utiliser tous les attributs disponibles dans la barre d'outils. GUIDE COMMENCER Comment commencer ? Une fois le programme démarré, l'écran de bienvenue vous propose : d'ouvrir le dernier dossier, de créer un nouveau dossier, d'ouvrir le dossier de démonstration, d'ouvrir l'aide en ligne. Si vous sélectionnez la création de dossier, nous vous conseillons de renseigner ensuite les options principales. Comment créer les données principales ? Après avoir créé les données de base, vous pouvez vous lancer dans la création de votre exercice, de vos journaux et de vos comptes. Création d'un exercice Vous pouvez accéder à la liste des exercices depuis le menu Exercices/Clôtures - Exercices. La liste des exercices répertorie l'ensemble des exercices existants sur le dossier. Elle permet, entre autres, d'identifier l'exercice courant ou de le définir grâce à la tâche Définir comme exercice courant ou grâce au menu contextuel. Pour créer un exercice, utilisez la touche Inser ou menu contextuel Ajouter ou le bouton Ajouter puis sélectionnez si vous souhaitez créer un exercice suivant ou un exercice précédent à l'exercice courant. Création d'un journal Vous pouvez accéder à la liste des journaux depuis le menu Paramètres - Journaux. Le plan de journaux répertorie l'ensemble des journaux existants sur le dossier. Le logiciel vous permet de faire une distinction entre les différents types de journaux, qui déterminent les opérations ou les modes de comptabilisation que vous pourrez effectuer dans chacun d'entre eux. Le choix du type de journal est déterminant. Il ne sera plus possible de modifier le type de journal dès que le journal sera mouvementé. Pour créer un journal, utilisez la touche "Inser" ou menu contextuel "Ajouter" ou le bouton "Ajouter". Remplissez alors les champs de paramétrage, comme les racines interdites, la numérotation des pièces, la reprise des dates, le choix de contrepartie et le choix du libellé contenus dans l'onglet "Saisie". Création d'un compte Vous pouvez accéder à la liste des comptes depuis les menus Quotidien - Plan comptable entreprise ou Paramètres - Plan comptable entreprise. Le plan comptable répertorie l'ensemble des comptes existants sur l'exercice courant. Le logiciel vous permet de faire une distinction entre les différentes classes de comptes. Pour créer un compte, utilisez la touche Inser ou menu contextuel Ajouter ou le bouton Ajouter. Remplissez alors les champs de paramétrage comme, par exemple, le type de compte, le type de journaux autorisés et le sens de saisie, les options liées à l'échéancier, les options liées au lettrage contenus dans les onglets "Saisie" et "Options Diverses" Options à remplir dès maintenant Après la création d'un nouveau dossier, il est fortement recommandé de vérifier le paramétrage des options à partir du menu Paramètres - Société. 17 EBP Comptabilité Open Line Pro La fenêtre des options se compose en deux parties : une arborescence sur la partie gauche, pour chaque partie des options et, sur la partie droite, les options correspondantes à saisir. Il est important de renseigner, en priorité, les parties suivantes : Coordonnées : Permet d'identifier le dossier. Trésor Public : Permet de renseigner toutes les informations liées aux impositions du dossier et notamment à la TVA. Options comptables : Permet de déterminer les principes de comptabilisation retenus pour l'ensemble du dossier. Les données de base Un certain nombre de données peuvent être créées au fur et à mesure de l'utilisation du logiciel. Toutefois, nous vous conseillons de renseigner quelques unes d'entre elles : - les paramétrages de TVA sur le dossier, - les paramétrages de TVA sur les comptes, - les valeurs par défaut dans les options du dossier, - les modes de règlements, - les civilités, - les codes postaux, - les départements, - les pays, - les codes NAF. Tout est prêt ! Si vous avez suivi les différentes étapes décrites depuis le début de ce guide d'utilisation, vous avez donc créé votre dossier avec les principales données nécessaires pour commencer à travailler. Dans les étapes suivantes, vous allez donc découvrir : Comment créer un exercice ? Comment changer d'exercice courant ? Comment créer un journal ? Comment créer un compte ? Quel mode de saisie choisir ? Comment saisir dans un journal ? Comment saisir dans un guide ? Comment saisir dans un masque de saisie pratique ? Comment gérer les échéances ? Comment gérer les écritures de régularisation ? Comment consulter un compte ? Comment lettrer ou délettrer un compte ? Comment créer un rapprochement ? Comment simuler, confirmer ou valider une écriture ? Comment effectuer une déclaration de TVA ? Comment effectuer la clôture mensuelle ? Comment générer les A Nouveaux ? Comment effectuer la clôture annuelle ? Comment imprimer ? Comment consulter le journal des événements ? Comment restaurer ? Comment sauvegarder ? TRAVAILLER Comment créer un exercice ? Vous pouvez créer un nouvel exercice dans le menu Exercices/Clôtures - Exercices. Pour créer un exercice, vous pouvez activer: - soit le bouton Ajouter de la barre d'outils, - soit la touche Inser de votre clavier, - soit Ajouter dans le menu contextuel. 18 GUIDE Enfin, dans la nouvelle fiche exercice, saisissez les dates qui vous conviennent. Un dossier ne peut contenir au maximum que deux exercices ouverts. Aussi, si vous désirez créer un troisième exercice, vous devez d'abord effectuer la clôture annuelle du premier exercice. Comment changer d'exercice courant Le changement d'exercice courant est une opération qui est indispensable dès lors que plusieurs exercices existent sur le même dossier. Pour changer d'exercice courant, il vous suffit de sélectionner Exercices dans le menu Exercices/Clôtures. Puis lorsque la liste des exercices du dossier s'affiche, il suffit de pointer sur l'exercice courant désiré et de sélectionner Définir comme exercice courant, dans la barre de tâches ou dans le menu contextuel. Comment créer un journal ? Vous pouvez créer un journal à partir du plan de journaux dans le menu Paramètres - Journaux. Pour créer un journal, vous pouvez activer : - soit le bouton Ajouter de la barre d'outils, - soit la touche Inser de votre clavier, - soit Ajouter dans le menu contextuel. Lorsque la nouvelle fiche journal est affichée, vous devez d'abord renseigner le type de journal et les éléments de l'en-tête puis modifier, si besoin, les paramétrages proposés par défaut. Comment créer un compte ? Vous pouvez créer un compte à partir du plan comptable accessible dans le menu Quotidien ou dans le menu Paramètres. Pour créer un compte, vous pouvez activer : - soit le bouton Ajouter de la barre d'outils, - soit la touche Inser de votre clavier, - soit Ajouter dans le menu contextuel. Lorsque la nouvelle fiche compte s'affiche, vous d'abord devez impérativement renseigner le type de compte et les éléments de l'en-tête puis vous pouvez, si besoin, modifier les propositions par défaut effectuées dans la fiche. Comment consulter un compte ? Le contenu et le solde d'un compte peuvent être consultés grâce au menu Quotidien - Consultation/Lettrage ou grâce au menu Consultation - Consultation/Lettrage. Le contenu et le solde d'un compte peuvent être consultés grâce au menu Quotidien - Consultation de compte. Il vous suffit de sélectionner ou de saisir le numéro de compte désiré dans le champ Compte, puis de renseigner tous les filtres en fonction des critères désirés (période, validation, comptes...). A l'issue de votre sélection, l'affichage des lignes d'écritures et du solde de la fenêtre consultation est mis à jour. Comment lettrer ou délettrer un compte ? Paramétrage des comptes Le lettrage et le délettrage sur un compte sont possibles, si les options qui conviennent ont été sélectionnées sur les options du dossier et sur la fiche compte. Pour paramétrer le dossier, vous devez sélectionner le menu Paramètres - Société - Options comptables - Valeurs par défaut et renseigner l'option Lettrage qui convient dans la zone Valeurs par défaut. 19 EBP Comptabilité Open Line Pro Pour paramétrer la fiche compte, vous devez sélectionner le menu Quotidien - Plan comptable entreprise ou le menu Paramètres - Plan comptable entreprise et renseigner l'option Lettrage qui convient dans l'onglet Paramétrage. Deux modes de lettrage Deux modes de lettrage existent : le lettrage manuel ou le lettrage automatique. Lettrage manuel Les lignes d'écritures affichées dans un compte peuvent être lettrées ou délettrées à partir : - du menu Quotidien - Consultation/Lettrage - du menu Consultation - Consultation/Lettrage - du menu Consultation - Lettrage simplifié Il vous suffit de sélectionner ou de saisir le numéro de compte désiré dans le champ Compte, puis de renseigner tous les filtres en fonction des critères désirés (période, validation, comptes...). Les lignes d'écritures peuvent être lettrées ou délettrées à condition de respecter les principes de fonctionnement du lettrage et les règles d'affichage de la fenêtre. Lettrage automatique Un ou plusieurs comptes peuvent faire l'objet d'un lettrage automatique à partir du menu "Consultation - Lettrage automatique". Comment créer un rapprochement ? Paramétrage de la fiche compte Pour être rapprochable, l'option "Rapprochement par journal" ou "Rapprochement par compte" doit être activée sur la fiche du compte, dans l'onglet Paramétrage. Création d'un rapprochement La création d'un rapprochement est possible à partir de la liste des rapprochements, accessible dans le menu Quotidien - Rapprochements. Dans cette liste, activez : - le bouton Ajouter de la barre d'outils, - la touche Inser de votre clavier, - ou la tâche Ajouter du menu contextuel. Puis, renseignez le contenu de la fenêtre complémentaire. Exécution d'un rapprochement Lorsque l'option Automatique est sélectionnée dans cette fenêtre complémentaire, alors la fenêtre de rapprochement présente les lignes d'écritures comptabilisées et les lignes de relevés qui pourront alors être pointées (manuellement ou automatiquement) entre elles. Lorsque l'option Automatique n'est pas sélectionnée dans cette fenêtre complémentaire, alors la fenêtre de rapprochement présente les lignes d'écritures comptabilisées qui pourront être pointées manuellement. Quel mode de saisie faut-il choisir ? L'application propose plusieurs modes de saisie. Chacun présente ses propres avantages et répond à des besoins différents. Nous vous les présentons ci-dessous, de la saisie nécessitant le moins de connaissances comptables à la saisie la plus professionnelle. Saisie pratique La saisie pratique est un mode de saisie simplifié, qui permet de saisir des achats, des ventes, des décaissements, des encaissements... sans devoir posséder de notions comptables. Saisie par écriture La saisie d'une écriture comptable est le mode de saisie comptable traditionnel. Elle permet de saisir une écriture en respectant, entre autres, les sens de saisie Débit/Crédit. 20 GUIDE Saisie par guide La saisie par guide est un mode de saisie qui permet de définir un schéma d'écriture spécifique pour une opération donnée. Elle permet donc d'automatiser la saisie comptable. Ce mode de saisie est un mode transitoire : pour qu'une opération soit visible dans les impressions, les consultations..., il faut nécessairement que cette opération soit comptabilisée dans la saisie par journal. Saisie par journal La saisie journal est le mode de saisie comptable traditionnel. Elle présente les écritures comptables sous forme de lignes distinctes qui doivent être saisies en respectant, entre autres, les sens de saisie Débit/Crédit. Une opération peut y être saisie directement ou être comptabilisée par l'intermédiaire des saisies par classeur, des saisies par guide, des saisies pratiques ou de la saisie au kilomètre. Saisie au kilomètre La saisie au kilomètre est un mode de saisie comptable. Elle permet de saisir dans un même masque toutes les écritures que vous désirez sans avoir besoin de changer de journal ou de mois, comme en Saisie par journal. C'est un mode de saisie transitoire, car toutes les écritures saisies par ce moyen sont déversées en Saisie par journal à chaque sauvegarde. Comment saisir dans un journal ? La saisie par journal dépend des journaux et des mois existants de l'exercice courant : - si l'exercice courant est ouvert, alors la saisie est possible sur tous les journaux/mois des exercices ouverts, - si l'exercice courant est clôturé, alors la saisie journal est accessible uniquement en mode consultation sur tous les journaux/mois de cet exercice clôturé. La fenêtre de saisie par journal est le lieu dans lequel vous pouvez comptabiliser directement vos écritures comptables ou effectuer, par exemple, la comptabilisation des pièces saisies dans la saisie guidée. Elle est accessible principalement grâce au menu Quotidien - Saisie par journal. Après avoir sélectionné votre journal dans la liste des journaux/mois, double cliquez sur la ligne du journal sélectionné, sélectionnez Saisir par journal dans le menu contextuel ou dans la barre de tâches. Mais d'autres accès existent comme Exercice/Clôtures - Gestionnaire de journaux - Saisie par journal ou comme les boutons Saisie par journal disponibles dans différentes fenêtres. Pour effectuer une saisie par journal, vous devez vous reporter aux règles d'affichage de la fenêtre et respecter ses règles de fonctionnement. Comment saisir dans un guide ? La saisie par guide est régie par différents principes. Modèles de guides La saisie par guide nécessite tout d'abord de créer le modèle de guide qui convient. Pour cela, vous devez accéder à la liste des modèles de guides grâce au menu "Paramètres - Modèles de guide". Dans cette liste, vous pouvez : - activer le bouton Ajouter dans la barre d'outils, - activer la touche Inser de votre clavier, - sélectionner la tâche Ajouter dans le menu contextuel. Enfin, lorsque le modèle est affiché, vous devez renseigner les différents champs du modèle de guide en fonction de vos besoins. Saisie par guide Lorsque le modèle est créé, vous pouvez créer le guide de saisie qui lui correspond. Pour cela, vous devez accéder à la liste des guides grâce au menu Quotidien - Saisie par guide. Dans cette liste, vous pouvez : - activer le bouton Ajouter dans la barre d'outils, - activer la touche Inser de votre clavier, 21 EBP Comptabilité Open Line Pro - sélectionner la tâche Ajouter dans le menu contextuel. Ensuite, lorsque le guide de saisie est affiché, vous devez sélectionner le type de guide à créer, renseigner les différents champs de l'en-tête de ce guide et enfin effectuer toutes les saisies désirées. La comptabilisation de ce guide se fait uniquement à la demande, grâce au bouton Comptabiliser de la barre d'outils. Saisie au kilmomètre Accès : Quotidien – Saisie au kilomètre La Saisie au kilomètre vous permet de saisir très rapidement des opérations de nature et de mois différents sans changer de fenêtre : factures, règlements, opérations diverses … Il s’agit d’une fenêtre de saisie et non de consultation : une fois les écritures enregistrées, elles seront consultables et modifiables en Saisie par journal. La provenance des écritures sera visible en Recherche d’écritures. A l’ouverture de la Saisie au kilomètre, l’écran est vide : saisissez alors rapidement toutes les écritures souhaitées puis enregistrez à n’importe quel moment par Ctrl + S ou le bouton Sauvegarder, puis continuez à ajouter des écritures. Les écritures saisies restent visibles sur fond gris mais ne sont plus modifiables dans la fenêtre de Saisie au kilomètre. La Saisie au kilomètre vous permet également de saisir les dates d’échéance de vos factures, mais le pointage de l’échéancier devra s’effectuer en Saisie par journal ou dans l'échéancier interactif. Navigation dans la fenêtre de saisie La navigation entre les champs, les lignes et les écritures peut se faire entre les différents champs grâce aux touches Tab et Shift+Tab, à la touche Entrée, à la souris ou encore avec les flèches directionnelles. Choix de l’exercice Tous les exercices ouverts sont disponibles dans la saisie : choisissez l’exercice de saisie dans l’entête de la fenêtre. Colonnes par défaut • Journal : Vous pouvez saisir sur tous les types de journaux, sauf les journaux de type A Nouveaux et de type Trésorerie avec contrepartie pied de journal. • Date : La date est saisissable en totalité. Elle tient compte du paramétrage de la fiche du journal sélectionné (avec ou sans reprise de dates). • Pièce : La numérotation suit la numérotation paramétrée dans la fiche journal (avec ou sans reprise de pièce - en fonction du type de numérotation). Elle reste modifiable. Le numéro saisi dans la Saisie au kilomètre est un numéro "provisoire". En effet, il est possible qu'un autre utilisateur utilise ce même numéro avant que vous n'ayez sauvegardé votre travail. Si vous avez activé l'option Gestion des doublons dans les options du dossier, lorsque vous sauvegarderez votre saisie, alors un message vous signalera les doublons et vous proposera la renumérotation de vos pièces. Si vous n'avez pas activé cette option, vos numéros de pièces seront conservés en l'état. • Compte : Le compte peut être choisi dans le look-up ou crée directement en cours de saisie. Les comptes associés ne sont pas pris en compte en saisie au kilomètre. • Libellé : Un libellé est proposé par défaut en fonction de la règle définie sur le journal. Il reste modifiable. • Débit / Crédit : Le curseur est pré-positionné en fonction du sens de saisie défini sur la fiche du compte et du journal sélectionné. Vous pouvez équilibrer votre écriture en la soldant grâce à la touche F12 ou au bouton Equilibrer. • Date d’échéance : Cette colonne est renseignée sur les comptes de nature "Clients et comptes rattachés" et "Fournisseurs et comptes rattachés", lorsque vous saisissez dans un journal de type Achats, Ventes ou Opérations Diverses. Elle affiche la première date d'échéance calculée en fonction du Mode de règlement renseigné dans la fiche du compte. 22 GUIDE L'ouverture de l'échéancier peut être automatique (si vous avez sélectionné l'option Echéancier en cours de saisie dans la fiche du compte) ou manuelle (si vous cliquez sur le bouton "+" disponible dans le champ). • Moyen de paiement : Cette colonne est renseignée sur les comptes de nature "Clients et comptes rattachés" et "Fournisseurs et comptes rattachés", lorsque vous saisissez dans un journal de type Trésorerie. Ce champ est non obligatoire et vous permet de renseigner, si besoin, le moyen de paiement (chèque, virement...) par lequel vous réglez vos fournisseurs ou êtes réglés par vos clients. Champs obligatoires Pour passer à la ligne suivante, les champs suivants doivent obligatoirement être renseignés : • Journal • Date • Compte • Montant Tant que l'un de ces champs n’est pas renseigné, il vous sera impossible de passer à la ligne suivante. Affichage Un trait est automatiquement affiché à la fin d'une écriture dont l'équilibrage a été réalisé. Cet affichage a uniquement pour but de vous permettre de visualiser plus facilement votre Saisie au kilomètre. Tant que l'écriture courante n'est pas équilibrée, alors elle s'affiche en rouge. A l'équilibre, elle repasse en noir. Certains paramètres d'affichage peuvent être personnalisés dans Paramètres - Société - Général - Environnement de saisie, comme la grille horizontale, la grille verticale et la couleur des écritures déséquilibrées. Barre d’outils • Ajouter, insérer, supprimer : ces boutons vous permettent d'ajouter, d'insérer et de supprimer une ligne d'écriture. • Gestion des vues : ce bouton permet de modifier les vues et d'ajouter des colonnes optionnelles. • Monter, descendre : : ces boutons vous permettent de modifier l'ordre de priorité des lignes d'écritures. • Couper, coller, copier : ces boutons vous permettent de copier, couper et coller une ligne d'écriture. • Equilibrer (F12) : ce bouton et cette touche permettent de réaliser l'équilibre du journal. Sauvegarde La sauvegarde doit être une action volontaire de votre part. Elle s'effectue en cliquant sur le bouton Sauvegarder ou en utilisant la combinaison Ctrl+S. Elle ne tient pas compte de l'Option de saisie par journal activée dans Paramètres - Société - Options générales de saisie. Avertissements lors de l'enregistrement Les avertissements apparaissent uniquement lors de l'enregistrement de la Saisie au kilomètre. Ils sont de deux types. Avertissements non bloquants Ces avertissements vous signalent une anomalie, mais n'empêchent pas la génération de vos écritures en Saisie par journal. Montants négatifs : ce message apparaît si votre saisie contient des montants négatifs et que l'option Afficher en saisie les alertes sur les montants a été activée dans les options du dossier. Comptes non autorisés en saisie sur un type de journal / racines de comptes non autorisées dans un journal : ce message apparaît si votre saisie contient des "incohérences" entre les comptes et les journaux utilisés et que l'option Afficher en saisie les alertes sur les comptes a été activée dans les options du dossier. Gestion des doublons des numéros de pièces La gestion des doublons de numéros de pièce est effectuée lors de l'enregistrement de la Saisie au kilomètre, si l'option correspondante a été activée dans les options du dossier. A l'affichage de ces messages, les écritures s'enregistrent : toute modification devra donc s'effectuer en Saisie par journal. Avertissements bloquants 23 EBP Comptabilité Open Line Pro Ces avertissements vous signalent une erreur, que vous devez d'abord corriger. Ils concernent : • Déséquilibre du journal • Ecriture composée d’une seule ligne • Compte bloqué • Mois clôturé • Champ obligatoire manquant Totaux Une ligne de totalisation est présente en pied de masque : elle affiche le total des lignes débitrices et le total des lignes créditrices. Récapitulatif Un bouton Récapitulatif est disponible. Le récapitulatif présente une vue synthétique de votre Saisie au kilomètre : - il affiche les totaux des Débits, Crédits et Soldes pour chaque mois et chaque journal ; - il met en évidence les déséquilibres. Impression du brouillon Le bouton Impression du brouillon permet d'imprimer sous forme de brouillon les écritures saisies dans cette option. Comment saisir en saisie pratique ? La saisie pratique permet de saisir vos opérations sans aucune notion comptable préalable. Des modèles pré-paramétrés vous sont proposés et vous permettent de saisir les opérations suivantes : facture d'achats, facture de ventes, avoir ou remise, encaissement client, décaissement fournisseur et d'autres opérations. Pour accéder aux saisies pratiques, il faut sélectionner les menus Quotidien - Saisie pratique puis le type d'opération à effectuer (Mes achats, Mes ventes, Ma trésorerie). Puis pour ajouter une nouvelle saisie, vous disposez de plusieurs moyens : - faire Inser, - cliquer sur Ajouter dans la barre d'outils, - sélectionner Ajouter dans le menu contextuel. Comment simuler, confirmer ou valider une écriture ? Pour simuler, confirmer ou valider une écriture, vous devez être positionné sur en mode de saisie comptable : saisie par journal, saisie par écriture. Vous pouvez choisir pour une écriture l'un des trois statuts suivants : - écriture simulée, - écriture non validée ou confirmée, - écriture validée. Le même statut s'applique à toutes les lignes d'une même écriture. Le statut de chaque écriture est visible dans la colonne "Statut" des différents affichages. La modification de ce statut s'exécute en saisie par journal ou dans la saisie par écriture en sélectionnant l'une des options suivantes : - Bouton Traitement sur les écritures - Simuler l'écriture - Bouton Traitement sur les écritures - Confirmer l'écriture - Bouton Traitement sur les écritures - Valider l'écriture courante - Bouton Traitement sur les écritures - Valider tout - Menu Actions - Simuler l'écriture - Menu Actions - Confirmer l'écriture - Menu Actions - Valider l'écriture courante - Menu Actions - Valider tout La modification du statut peut aussi être commandée pour l'intégralité d'un journal et d'un mois à partir du gestionnaire de journaux, accessible par le menu Exercices/Clôtures - Gestionnaire de journaux. 24 GUIDE Comment gérer les écritures de régularisation ? Principes généraux des écritures de régularisation De nombreux principes régissent la gestion des écritures de régularisation, dont font partie les Factures Non Parvenues, les Factures A Emettre, les Charges Constatées d'Avance, les Produits Constatés d'Avance... Des exemples de ce type d'écriture sont disponibles. Comment définir une écriture de régularisation ? Il suffit de se positionner sur la ligne d'écriture de la saisie journal que l'on veut régulariser. En fonction du compte de cette ligne, l'un de ces deux boutons peut être actif : - si le compte est un compte Fournisseur ou un compte Client, alors le bouton Facture à recevoir ou à émettre est actif, - si le compte est un compte Charge ou un compte Produit, alors le bouton Charge ou Produit constaté d'avance est actif. L'activation de ce bouton permet d'afficher la fenêtre de paramétrage de Facture non parvenue ou à recevoir ou de Charge ou Produit constaté d'avance. Comment générer les écritures de régularisation ou d'extourne ? Dans la fenêtre de paramétrage des Factures Non Parvenues ou A Emettre comme dans la fenêtre de paramétrage des Charges et Produits Constatés d'Avance, il faut renseigner un certain nombre de champs obligatoires. Lorsque tous ces champs sont valides, il suffit de cliquer sur les boutons disponibles Générer l'écriture de régularisation et/ou Générer l'écriture d'extourne. Les écritures voulues seront alors générées automatiquement dans la saisie journal. Comment suivre les écritures de régularisation ? Les écritures qui sont définies comme étant des écritures de régularisation sont répertoriées dans deux listes. Un certain nombre d'actions (visualisation, comptabilisation...) y sont également disponibles. Comment gérer les échéances ? Paramétrage des comptes La gestion des échéances dépend des paramétres sélectionnés sur les valeurs par défaut des options du dossier puis sur la fiche compte. Pour paramétrer les valeurs par défaut du dossier, vous devez : - sélectionner le menu Paramètres - Société - Options comptables - renseigner l'option Echéancier qui convient dans la Valeurs par défaut. Pour paramétrer la fiche compte, vous devez : - sélectionner le menu Quotidien - Plan comptable entreprise - renseigner l'option Echéancier qui convient dans l'onglet Paramétrage. Saisie des échéances La saisie des échéances s'effectue à partir de la saisie par journal ou à partir d'une nouvelle écriture comptable. La saisie d'une date d'échéance est possible en saisissant directement une date dans la colonne Date d'échéance. L'ouverture de l'échéancier et sa modification sont possibles soit en cliquant sur le bouton Echéancier disponible dans la barre de tâches, soit en cliquant sur le bouton "+" présent dans la colonne Date d'échéance. L'échéancier autorise un nombre illimité d'échéances par pièce. Pointer les échéances Pour effectuer le pointage d'une échéance, il suffit de cliquer sur le bouton Pointages disponible dans la barre de taches de la saisie journal. 25 EBP Comptabilité Open Line Pro Impression des échéances Toutes les échéances saisies peuvent être imprimées sous forme d'échéancier ou de Balance âgée et filtrées en fonction de leur date d'échéance (échues ou à échoir Echues = Dettes et créances dont le terme est dépassé et n'ont pas encore été payées. A Echoir = Dettes et créances qui ne sont pas encore arrivées à terme.). Comment effectuer une déclaration de TVA ? Avant toute saisie, vous devez tout d'abord : - paramétrer la TVA au niveau du dossier, - paramétrer la TVA au niveau des comptes. Puis, après ces paramétrages, vous pouvez exécuter les opérations liées à la déclaration elle-même : - création d'une déclaration de TVA, - exécution de la déclaration de TVA. Paramétrer la TVA sur le dossier Vous devez tout d'abord renseigner dans le menu Paramètres - Société - Coordonnées et Identification tous les éléments nécessaires à la gestion de la TVA sur votre dossier et à l'établissement des déclarations à proprement parler. Paramétrer de la TVA sur les comptes Ensuite, vous devez renseigner pour chaque compte, les différents champs de la zone "Paramétrage TVA" de l'onglet Paramétrages. Des exemples de paramétrage de comptes et de schémas d'écritures sont disponibles. Créer une nouvelle déclaration Vous pouvez créer une nouvelle déclaration dans la liste des déclarations de TVA, grâce au menu Quotidien - Déclarations de TVA, en : - activant le bouton Ajouter de la barre d'outils, - activant la touche Inser de votre clavier, - sélectionnant la tâche Ajouter dans le menu contextuel. Une fenêtre complémentaire vous permet de sélectionner la déclaration et la période de déclaration à créer. Exécuter une déclaration Après la validation de la fenêtre de création, le contenu même de la déclaration et des lignes qu'elle contient est affiché. Régulariser une déclaration Des exemples de régularisations à saisir lorsque la déclaration contient des montants négatifs sont disponibles. Comment effectuer la clôture mensuelle ? La clôture mensuelle est une opération périodique qui vise à rendre intangible les éléments saisis sur un mois et un journal de l'exercice courant. Pour pouvoir la mener à bien, vous devez d'abord vous assurer d'avoir respecté un certain nombre de principes. La clôture mensuelle est accessible dans le menu Exercices/Clôtures - Gestionnaire de journaux. Dans le gestionnaire de journaux, vous devez d'abord sélectionner les journaux/mois que vous voulez clôturer : - soit en cochant la case située à gauche de la ligne, - soit en utilisant la combinaison Ctrl + Espace, - soit en utilisant le clavier et la souris Ctrl + Clic gauche de la souris. Les journaux/mois sélectionnés sont mis en surbrillance. Puis, dans la barre de tâches, sélectionnez Clôturer journaux/mois. Comment générer les A Nouveaux ? A Nouveaux automatiques La génération des A Nouveaux vise à enregistrer automatiquement le résultat comptable d'un exercice. 26 GUIDE Cet enregistrement peut être : - provisoire, s'il est généré en cours d'exercice, - ou définitif, s'il est généré au cours de la clôture annuelle ou après celle-ci. Dans les options du dossier, vous devez d'abord sélectionner le mode de génération des A Nouveaux, leur niveau de détail... Ensuite vous devez définir l'exercice destination ( = premier exercice suivant) comme étant l'exercice courant. Enfin, pour procéder à la génération des A Nouveaux, deux entrées sont disponibles : - menu Exercices/Clôtures - Exercices puis de la liste des exercices, - menu Quotidien - Exercices puis de la liste des exercices, De là, vous pouvez sélectionner Générer les A Nouveaux dans la barre de tâches. Lorsque la génération des A Nouveaux est demandée, un assistant s'ouvre : il est impératif que tous les contrôles qu'il contient soient exécutés avec succès pour que les A nouveaux soient effectivement générés. Pour information, les règles et accès valables pour la génération des A nouveaux sont également valables pour leur suppression. Balance d'ouverture Des A Nouveaux peuvent être saisis manuellement par l'intermédiaire de la Balance d'ouverture. Cette option s'avère particulièrement intéressante lorsque le dossier a d'abord été géré sur un autre logiciel puis que sa comptabilité est transférée sur Open Line. Pour créer cette balance d'ouverture, deux entrées existent : - menu Exercices/Clôtures - Exercices, - menu Quotidien - Saisie par journal, Sur un même exercice, il n'est pas recommandé de générer à la fois les A Nouveaux automatiques et une Balance d'ouverture. Comment effectuer la clôture annuelle ? La clôture annuelle est une opération périodique qui vise à rendre intangible tous les éléments d'un exercice comptable. Pour pouvoir la mener à bien, vous devez d'abord vous assurer d'avoir respecté un certain nombre de principes. La clôture annuelle est accessible dans le menu Exercices/Clôtures - Clôture annuelle et passe par l'utilisation d'un assistant qui détaille la totalité des contrôles et des traitements. Comment imprimer ? Une impression peut être lancée de plusieurs façons : A partir d'une fiche, d'un masque de saisie..., cliquez simplement sur le bouton Imprimer de la barre d'outils. A partir d'une liste, cliquez sur le bouton Imprimer de la barre d'outils pour accéder à la page de filtres. A partir de chaque menu, sélectionner Impression, puis la catégorie et/ou le modèle d'impression désiré. Toutes ces impressions sont régies par un fonctionnement uniforme (Fenêtre principale de navigation, Modèles d'impression, Mots clefs, Filtres et aperçus). Des modèles par défaut existent et permettent d'imprimer, entre autres : - un journal, - un Grand Livre, - une balance, - une Balance Agée, - un échéancier, - un bilan, - un compte de résultat, - un journal centralisateur, - un rapprochement, - un comparatif entre N et N-1, - une situation de compte, 27 EBP Comptabilité Open Line Pro 28 - un avancement de la saisie, - un suivi des écritures. Ces modèles sont modifiables et peuvent être paramétrés à votre convenance grâce à l'éditeur de modèles. DIVERS Comment consulter le journal des événements ? Vous pouvez consulter le journal des événements à partir du menu Outils - Journal des événements. Il stocke les informations concernant les différents événements intervenus sur le dossier comme, par exemple,: la modification du type de numérotation dans un journal, la date de la validation des écritures, la date de la clôture mensuelle... Comment sauvegarder ? Il est très important d’effectuer régulièrement une sauvegarde des données. En fonction de la taille de votre dossier, nous vous conseillons d'effectuer des sauvegardes sur des supports contenant davantage de données, et plus fiables, comme les disques ZIP, ou CD-ROM*. La sauvegarde est le seul moyen de pouvoir retrouver votre travail si votre base a été malencontreusement supprimée ou endommagée. Par le menu Outils - Sauvegarde, vous accédez à l'assistant de sauvegarde qui vous permet de sélectionner les options de sauvegardes et lancer la procédure. Une fois la première sauvegarde effectuée, vous avez la possibilité de lancer uniquement la sauvegarde rapide. Comment restaurer ? Ce traitement vous permet de récupérer les données sauvegardées sur un support externe ou sur votre disque dur. Toutes les données qui auront été saisies après que vous ayez enregistré votre sauvegarde seront effacées. Par le menu Outils - Restauration, vous accédez à l'assistant de restauration qui vous permet de sélectionner le dossier à restaurer et lancer la procédure. MANUEL FICHIER Nouveau dossier Accès : Fichier - Nouveau Pour créer un nouveau dossier, vous devez suivre les différentes étapes proposées par l'assistant de création du dossier. Ces étapes consistent à : Sélectionner le type d'installation (les données sont installées sur l'ordinateur ou elles sont sur un autre ordinateur). En fonction du type d'installation sélectionné vous aurez des étapes différentes : Pour l'installation avec les données sur un autre ordinateur, l'étape suivante consiste à : Saisir le nom du serveur, La case à cocher "Afficher les options de connexions avancées" permet de : - sélectionner le protocole, - saisir l'authentification de l'utilisateur. La suite de la création du dossier est identique à "lorsque les données sont installées sur l'ordinateur". Pour l'installation avec les données sur l'ordinateur, vous devez ensuite : Saisir le nom de la base de données, Saisir l'identification et les coordonnées de la société, Saisir d'autres informations et les informations de TVA, La territorialité est obligatoire car elle détermine un certain nombre de fonctionnalités dans l'application comme par exemple les taux de TVA pour le dossier. Il en va de même pour l'option de calcul de la TVA. Vous avez également le choix d'importer tous les codes postaux (coché par défaut) ou une liste simplifiée (codes postaux des préfectures et arrondissements de Paris). Saisir les dates d'exercice et le type de plan comptable général. Entre chaque étape, utilisez les boutons Suivant et Précédent pour respectivement avancer et reculer dans l'assistant de création de dossier. Pour lancer la création du dossier, vous devez cliquer sur le bouton Lancer. Vous allez alors voir une barre de progression qui permet d'ouvrir un nouveau dossier et d'importer les tables par défaut. A la fin du traitement, le nouveau dossier est ouvert automatiquement. Nous vous conseillons ensuite d'ouvrir les infos de société et les options générales du dossier afin de contrôler les informations que vous venez de saisir et de renseigner les options. Créer un nouveau raccourci Accès : Fichier - Créer un nouveau raccourci Cette fonction permet de réaliser le lien entre la base de données et l'application. La création d'un raccourci de la base passe par un assistant. Entre chaque étape, utilisez les boutons Suivant et Précédent pour respectivement avancer et reculer dans l'assistant de création d'un raccourci. • La 1ère étape vous présente l'assistant de création ; 29 EBP Comptabilité Open Line Pro Vous devez ensuite sélectionner le type d'installation (les données sont installées sur l'ordinateur où elles sont sur un autre ordinateur) ; En fonction du type d'installation sélectionné vous aurez les étapes différentes : - Pour l'installation avec les données sur un autre ordinateur, l'étape suivante consiste à : Saisir le nom du serveur, La case à cocher "Afficher les options de connexions avancées" permet de : Sélectionner le protocole, Saisir l'authentification de l'utilisateur. La suite de la création du dossier est identique à "les données sont installées sur l'ordinateur". - Pour l'installation avec les données installées sur l'ordinateur, vous devez ensuite : • L'étape suivante vous demande d'indiquer le nom du dossier (nom de la base de données) que vous souhaitez ouvrir ; • Enfin, les paramètres que vous avez saisi sont proposés. Vous devez cliquer sur le bouton Lancer pour créer le raccourci. • Le traitement va alors créer le raccourci et ouvrir la base de données. Vous pouvez à tout moment stopper la création du raccourci en cliquant sur le bouton Annuler. Ouvrir un dossier Accès : Fichier - Ouvrir Cette fonction permet d'ouvrir un dossier. Suite à l'appel de la fonction, une fenêtre contenant une liste des fichiers à l'emplacement sélectionné s'affiche. Vous devez sélectionner le répertoire des données de Comptabilité et sélectionner le raccourci de la base que vous souhaitez ouvrir. Si le raccourci n'est pas disponible, fermer la fenêtre par le bouton Annuler et appeler la fonction "Créer un nouveau raccourci" du menu Fichier. Fermer un dossier Accès : Fichier - Fermer Cette fonction permet de fermer le dossier en cours sans fermer l'application. Vous pouvez ensuite ouvrir un autre dossier. Si au moins une fiche est en cours de modification lorsque vous demandez la fermeture du dossier, vous aurez un message vous proposant une sauvegarde des modifications. Quitter l'application Accès : Fichier - Quitter Cette fonction permet de fermer l'application. Si au moins une fiche est en cours de modification lorsque vous demandez la fermeture de l'application, vous aurez un message vous proposant une sauvegarde des modifications. AFFICHAGE Tableau de bord Accès : Affichage - Afficher le tableau de bord Le tableau de bord permet de visualiser à la date système les éléments comptables les plus importants de votre exploitation. Contenu du tableau de bord Trois parties distinctes existent dans le tableau de bord livré par défaut : 30 MANUEL Situation de trésorerie Cet état se décompose en deux parties : Disponibilités : affiche le solde des comptes de caisse (Comptes de nature Caisse), le solde des comptes bancaires (comptes de nature Banque et Chèques postaux) et le solde des autres comptes financiers (Comptes de nature Autres comptes financiers) à la date système. Etat des créances et dettes : présente le solde des échéances échues et à échoir, par rapport à la date système. Les Créances et les Dettes diverses sont calculés grâce à la nature de compte Créances et Dettes diverses. Comparatif des résultats cumulés Ce graphique permet de comparer le résultat cumulé de l'exercice courant par rapport à celui de l'exercice précédent. Le résultat comptable est la différence existant entre la somme de tous les comptes de nature Produits et la somme de tous les comptes de nature Charges (= "nature Produits - nature Charges"). Comparatif chiffre d'affaire, résultat comptable et marge brute Ce graphique vous présente trois valeurs clefs pour suivre votre activité sur l'exercice courant. Le chiffre d'affaires correspond au cumul de tous les comptes de racine 70. La marge brute est la somme de tous les comptes de racine 70, 71, 72, 73 et 791 diminuée de tous les comptes de racine 60 (= racines "70+71+72+73+791-60") Il peut exister une divergence entre les éléments affichés dans le tableau de bord de la Comptabilité et le tableau de bord de la Gestion commerciale. Cette divergence peut provenir par exemple : - de pièces saisies directement en comptabilité, sans avoir été saisies sur la Gestion Commerciale ; - de pièces saisies sur la Gestion Commerciale mais n'ayant pas encore été transférées en Comptabilité. Afficher ou ne plus afficher le tableau de bord Lors de l'ouverture du dossier, le tableau de bord peut être affiché automatiquement. Pour cela il suffit de cocher la case Outils - Options - Apparence - Afficher le tableau de bord. Ecran de démarrage Accès : Affichage - Ecran de démarrage Cet écran vous permet de visualiser l'enchaînement des principales fonctions disponibles dans l'application. Les actions ci-dessous sont associées à cette entrée : Saisie mois courant : permet de se positionner sur la liste des journaux/mois pour accéder à la saisie par journal. Echéancier / Règlements : permet d'accéder à Démarrer une tâche du menu Echéancier/Règlement. Consultation / Lettrage : permet d'ouvrir la fenêtre de consultation sur le compte consulté en dernier. Rapprochement bancaire : permet d'accéder à la liste des rapprochements existants sur l'exercice courant. Déclaration de TVA : permet d'accéder à la liste des déclarations de TVA. Balance Clients et Fournisseurs : permet d'accéder à la Balance interactive. Situations de comptes : permet d'accéder à l'impression des situations de comptes de vos clients et de vos fournisseurs. Tableau de bord : permet d'afficher le tableau de bord du dossier. QUOTIDIEN 31 EBP Comptabilité Open Line Pro Quotidien - Démarrer une tâche Accès : Quotidien - Démarrer une tâche Pour chaque menu du volet de navigation, vous disposez en début des fonctions associées d'une entrée de menu Démarrer une tâche. Cette entrée permet de visualiser l'enchaînement des fonctions disponibles dans chaque menu. Les actions ci-dessous sont associées à cette entrée : Saisie par journal : permet de se positionner sur la liste des cumuls des journaux pour accéder à la saisie par journal. Consultation/Lettrage : permet d'ouvrir la fenêtre de consultation ou de lettrage sur le compte consulté ou lettré en dernier. Rapprochement bancaire : permet d'accéder à la liste des rapprochements existants sur l'exercice courant. Relevé bancaire : permet d'accéder à la liste des relevés bancaires utilisés lors de la génération des rapprochements automatiques. Déclaration de TVA : permet d'accéder à la liste des déclarations de TVA créées sur le dossier et d'en créer une nouvelle. Recherche d'écritures : permet d'accéder à la liste regroupant toutes les écritures comptabilisées et d'y effectuer une recherche. PLAN COMPTABLE ENTREPRISE Plan comptable Accès : Quotidien - Plan comptable entreprise OU Paramètres - Plan comptable entreprise La gestion de la liste du plan comptable est commune à toutes les listes. Le plan comptable choisi par défaut lors de la création du dossier est importé sur le premier exercice comptable et son contenu reste modifiable à tout moment. Les créations, suppressions et modifications du plan comptable sont propagées automatiquement sur les exercices postérieurs à l’exercice courant, que ces exercices soient déjà créés ou à créer. En revanche, en aucun cas, les créations, suppressions et modifications intervenant dans le plan comptable ne sont rétroactives sur les exercices précédents. Un compte comptable peut être supprimé uniquement s’il n’a pas été mouvementé sur l’exercice duquel il est supprimé. La liste du plan comptable est divisée en onglets successifs : L’onglet « Tous » affiche tous les comptes du plan comptable sans distinction, du compte 1 au compte 9zzzzzzzzz. L’onglet « Capitaux » affiche tous les comptes de la classe 1 « Comptes de Capitaux », soit tous les comptes compris entre 1 et 1zzzzzzzzz. L’onglet «Immobilisations » affiche tous les comptes de la classe 2 « Comptes d’Immobilisations », soit tous les comptes compris entre 2 et 2zzzzzzzzz. L’onglet « Stocks » affiche tous les comptes de classe 3 « Comptes de Stocks et En-cours », soit tous les comptes compris entre 3 et 3zzzzzzzzz. L’onglet « Fournisseurs » affiche une partie des comptes de classe 4 « Comptes de Tiers », soit tous les comptes compris entre 40 et 40zzzzzzzzz. L’onglet « Clients » affiche une partie des comptes de classe 4 « Comptes de Tiers », soit tous les comptes compris entre 41 et 41zzzzzzzzz. 32 MANUEL L’onglet « Autres Tiers » affiche tous les autres comptes de classe 4 « Comptes de Tiers », soit tous les comptes compris entre 4 et 4zzzzzzzzz et non déjà présents dans les onglets Fournisseurs et Clients. L’onglet « Financiers » affiche tous les comptes de classe 5 « Comptes Financiers», soit tous les comptes compris entre 5 et 5zzzzzzzzz. L’onglet « Charges » affiche tous les comptes de classe 6 « Comptes de Charges », soit tous les comptes compris entre 6 et 6zzzzzzzzz. L’onglet « Produits » affiche tous les comptes de classe 7 « Comptes de Produits », soit tous les comptes compris entre 7 et 7zzzzzzzzz. Les colonnes du plan comptable reprennent les valeurs principales des fiches comptes Les colonnes N° de compte et Intitulé affichent le numéro et l’intitulé de la fiche du compte créé. Les colonnes Echéancier et Bloqué affichent une coche si l’option correspondante a été activée dans la fiche de ce compte. Les colonnes Débit et Crédit et Solde affichent le montant cumulé des mouvements intervenus sur ce compte durant l’exercice courant. Une ligne de totalisation de tous les Débits et de tous les Crédits affichés est disponible en pied de la liste. La colonne Type de compte affiche le type du compte qui peut être soit Racine, soit Détail. Les colonnes A et V indiquent si le compte est autorisé à être utilisé en Saisie pratique sur Achats (A) et/ou sur Ventes (V). Les actions possibles dans la liste Outre, les actions standards possibles sur toutes les listes, quelques actions supplémentaires sont disponibles : Consultation/Lettrage : pour accéder à la consultation de compte sans changer de menu, il vous suffit de sélectionner un compte dans la liste puis de cliquer sur la tâche Consultation/Lettrage. Cette action est possible sur un seul compte à la fois. Nature d'achat saisie pratique / Nature de vente saisie pratique : pour autoriser ou interdire un compte en Saisie pratique, sans avoir à ouvrir la fiche de ce compte, il vous suffit de le sélectionner dans la liste puis de cliquer sur la tâche Nature d'achat saisie pratique ou sur la tâche Nature de vente saisie pratique. Cette action est également possible sur plusieurs comptes à la fois. Autoriser/interdire le lettrage approché : pour autoriser ou interdire le lettrage approché sur un compte, sans ouvrir la fiche de ce compte, il vous suffit de le sélectionner dans la liste puis de cliquer sur la tâche Autoriser/interdire le lettrage approché. Cette action est possible également sur plusieurs comptes à la fois. Fiche compte Accès : Quotidien - Plan comptable entreprise OU Paramètres - Plan comptable entreprise La gestion de la fiche compte est commune à l’ensemble des fiches. Cette fiche se décompose en plusieurs onglets. - un en-tête Description de l'en-tête - un onglet Paramétrage Lettrage et rapprochement Autoriser le lettrage Autoriser le lettrage approché Prochain code lettrage Type de rapprochement 33 EBP Comptabilité Open Line Pro Règlement Gestion des échéanciers Mode de règlement Paramétrage de TVA Paramétrage de TVA Saisies pratiques Nature d'achat et Nature de vente - un onglet Paramétrage avancé Divers Comptes bloqués AN non détaillés Centralisation sur le Grand Livre Types de journaux autorisés et sens de saisie Type de journaux autorisés et sens de saisie Comptes associés Comptes associés - un onglet Coordonnées Cet onglet vous permet de renseigner l'adresse principale de facturation, le contact principal de facturation et les coordonnées bancaires principales du compte. Ces informations sont liées à la fiche Tiers : La modification de cet onglet entraînera la modification de la fiche Tiers et inversement. - un onglet Cumuls Description de l'onglet - un onglet Notes La gestion de l'onglet Notes est commune à toutes les fiches. - Autres actions possibles Certaines actions sont possibles sur un compte à partir de sa fiche : - Consultation du compte - Lettrage du compte - activation des saisies pratiques - Options diverses Un certain nombre de boutons sont disponibles dans la barre d'outils de la fiche compte. Ils permettent de faciliter la navigation entre l'application de comptabilité et l'application de Gestion Commerciale, ainsi que vers des sites internet. Fiche Tiers : Ce bouton permet d'accéder à la fiche Tiers et la totalité des contacts, adresses et coordonnées bancaires... d'un Tiers. La fiche Tiers ouverte dépend de l'application qui a créée le compte : - Lorsque le compte a été créé en Gestion commerciale, alors la fiche Tiers de la Gestion Commerciale est ouverte. - Lorsque le compte a été crée en Comptabilité, alors la fiche Tiers de la Comptabilité est ouverte. Solvabilité : Ce bouton permet d'accéder à une sélection de sites internet permettant de répondre aux questions de solvalibité. Plan : Ce bouton permet d'accéder à une sélection de sites internet fournissant des plans. Itinéraires : Ce bouton permet d'accéder à une sélection de sites internet fournissant des itinéraires. 34 MANUEL SAISIE PAR JOURNAL SAISIE PAR JOURNAL Saisie par journal : la liste des journaux/mois Accès : Quotidien - Saisie par journal Cette liste est affichée pour information seulement. Aucun ajout, aucune modification ni suppression n'est possible directement. Elle affiche par journal et par mois les cumuls débiteurs et créditeurs enregistrés en comptabilité. Elle permet également d'accéder aux différents masques de saisie comptables. Les onglets Trois onglets différents sont proposés : chacun propose un tri différent de la même liste. Mois en cours Cet onglet affiche tous les journaux/mois existants sur le mois courant. Définition du mois en cours : - Si le mois système Mois système = Mois de l'ordinateur. est inclus dans l'exercice courant, alors le mois en cours est le mois système. Exercice courant 01/01/2008 au 31/12/2008 ; Date système : 10/03/2008 ; Mois en cours : Mars 2008. - Si le mois système Mois système = mois de l'ordinateur. est situé hors de l'exercice courant, alors le mois en cours est un mois qui est, à la fois, le plus proche du mois système et inclus dans l'exercice courant. Exercice courant 01/01/2007 au 31/12/2007 ; Date système : 10/03/2008 ; Mois en cours : décembre 2007. Tous les mois Le contenu de la liste dépend de l'état de l'exercice courant : - Si l'exercice courant est clôturé, alors seuls les mois de cet exercice clôturé sont visibles. - Si l'exercice courant est ouvert, alors tous les mois des exercices non clôturés sont visibles. Cet onglet affiche tous les journaux et tous les mois, triés d'abord par mois puis par journal. Tous les journaux Le contenu de la liste dépend de l'état de l'exercice courant : - Si l'exercice courant est clôturé, alors seuls les mois de cet exercice clôturé sont visibles. - Si l'exercice courant est ouvert, alors tous les mois des exercices non clôturés sont visibles. Cet onglet affiche tous les journaux et tous les mois, triés d'abord par journal puis par mois. Le contenu de la liste Quelque soit l'onglet sélectionné, le contenu de la liste reste identique : Débit : Affiche la somme de tous les montants débiteurs saisis sur un journal et une période. Elle est identique à la somme figurant en pied de ce journal/mois dans la colonne Débit. Crédit : Affiche la somme de tous les montants créditeurs saisis sur un journal et une période. Elle est identique à la somme figurant en pied de ce journal/mois dans la colonne Crédit. Un journal/mois doit être obligatoirement équilibré : la somme de tous les montants débiteurs doit être égale à la somme de tous les montants créditeurs. Lignes au débit : Ce champ affiche le nombre de lignes d'écritures saisies au débit sur un journal/mois. Lignes au crédit : Ce champ affiche le nombre de lignes d'écritures saisies au crédit sur un journal/mois. Clôturé : Une icône est affichée si un journal/mois a fait l'objet d'une clôture mensuelle. Si un journal/mois n'a pas été mouvementé, alors la ligne correspondante reste vierge. Le cumul des journaux/mois est automatiquement remis à jour à chaque saisie. Accéder à la saisie Plusieurs modes de saisies comptables vous sont proposés. Pour accéder à la saisie journal, il suffit de sélectionner un journal et une période, puis de choisir l'une ces possibilités : - double cliquer sur la ligne désirée ; - faire Entrée sur la ligne désirée ; - sélectionner Saisie par journal dans la barre de tâches ; 35 EBP Comptabilité Open Line Pro - sélectionner Saisie par journal dans le menu contextuel Menu contextuel = Clic droit de la souris.. Pour accéder à la saisie d'une nouvelle écriture comptable, il suffit de sélectionner un journal et une période, puis de choisir l'une de ces possibilités : - sélectionner Nouvelle écriture comptable dans la barre de tâches ; - sélectionner Nouvelle écriture comptable dans le menu contextuel Menu contextuel = Clic droit de la souris. . Pour accéder à la saisie de la balance d'ouverture, il suffit de sélectionner un journal et une période, puis de choisir l'une de ces possibilités : - sélectionner Saisir la balance d'ouverture dans la barre de tâches ; - sélectionner Saisir la balance d'ouverture dans le menu contextuel Menu contextuel = Clic droit de la souris. . Corps de la fenêtre de saisie par journal Accès : Quotidien - Saisie par journal C'est à l'intérieur de la fenêtre de saisie que les opérations de saisie sont enregistrées. Cette page détaille les règles de navigation entre les lignes et les écritures, le contenu des différentes colonnes et leur comportement, le calcul des totaux des journaux. La saisie est régie par des principes de comptabilisation (lignes d'écritures, écritures comptables, mentions obligatoires, équilibrage des journaux). La saisie journal est le mode standard de comptabilisation. Il permet de saisir sur un même journal/mois plusieurs écritures, sans sortir du masque de saisie. C'est également le lieu dans lequel sont déversées toutes les écritures comptables provenant d'autres fonctionnalités (Saisie par guide ; écritures transférées de la Gestion Commerciale ; saisie par écriture...). Navigation dans la fenêtre de saisie La navigation entre les champs, les lignes et les écritures peut se faire entre les différents champs grâce aux touches Tab et Shift+Tab, à la touche Entrée, à la souris ou encore avec les flèches directionnelles. Colonnes obligatoires affichées par défaut pour tous les types de journaux Les colonnes sont listées de gauche à droite : Statut Les différents statuts : Le statut s'applique à une écriture et donc à toutes les lignes d'écriture qui la composent. - Ecritures non validées (ni validées, ni simulées) : Les écritures possèdent par défaut le statut "non validé" lors de leur création. Elles sont modifiables et possèdent un statut vierge. Ce statut reste modifiable. - Ecritures validées : Dans certains cas (validation, clôture mensuelle, clôture annuelle), il est nécessaire de valider les écritures comptables, c'est-à-dire de les rendre intangibles. Elles affichent alors un statut "V". Ce statut n'est plus modifiable. - Ecritures simulées : Dans d'autres cas (situation périodique), il peut être nécessaire de passer les écritures comptables en mode "Simulé". Elles sont alors facilement identifiables, restent modifiables et sont obligatoirement exclues des opérations de rapprochement bancaire. Elles affichent alors un statut "S". Ce statut reste modifiable. Changement de statut : Le statut d'une écriture peut être modifié grâce au menu Ecritures ou grâce au menu contextuel Menu contextuel = clic droit de la souris, sachant qu'une écriture ne peut posséder qu'un seul statut à la fois. Trois opérations sont possibles en fonction du statut en cours sur l'écriture sélectionnée : - Simuler : si l'écriture est de statut "Non validé", elle prend le statut "Simulé". - Confirmer : si l'écriture est de statut "Simulé", elle prend le statut "Non validé". - Valider : si l'écriture est de statut "Non validé", elle prend le statut "Validé". Cas particulier du journal de type Trésorerie avec contrepartie en pied de journal Le journal de type Trésorerie avec contrepartie en pied de journal est composé d'une seule et unique écriture, composée de toutes les lignes d'écriture du journal. Le même statut s'applique donc à toutes les lignes du journal sans distinction. Jour * Le jour de saisie s'entend ici comme un jour calendaire, dépendant de l'exercice courant et de la période de saisie sélectionnée. Le jour peut être saisi directement ou sélectionné dans le calendrier. 36 MANUEL Le comportement de la date dépend du paramétrage "Reprise de date" effectué dans la fiche journal. N° de pièce Le comportement du numéro de pièce dans les écritures et les lignes d'écritures dépend du paramétrage effectué dans la fiche journal. Même si un numéro de pièce est proposé, il reste néanmoins modifiable par l'utilisateur. N° de document Lorsque la pièce provient d'une autre application (par exemple : Gestion Commerciale), alors ce champ affiche le numéro que ce document possède dans son application d'origine. Lorsque la pièce provient de la saisie guidée, alors ce champ affiche le numéro de l'écriture guidée à l'origine de cette écriture. Dans tous les autres cas, ce champ reste vierge et librement saisissable. Compte * La liste des comptes existants sur l'exercice courant est disponible grâce à la liste déroulante. Un bouton situé à gauche de cette liste déroulante permet d'ouvrir la fiche du compte sélectionné. Pour obtenir les affichages des messages d'alerte sur les comptes saisis dans un mauvais journal, vous devez d'abord activer l'option Afficher en saisie les alertes sur les comptes dans les Options comptables. Les messages d'alerte affichés peuvent être : - bloquants et vous interdire de saisir le compte désiré, car ce compte est bloqué ; - non bloquants et vous permettre de poursuivre malgré tout votre saisie, quand le compte désiré n'est pas autorisé en saisie sur type de journal ou quand il fait partie des racines interdites de ce journal. Afin de vous faciliter la saisie des chaînes de comptes associés peuvent être créées. Libellé Le comportement du Libellé dépend du paramétrage effectué dans la fiche journal. Même si un libellé est proposé, il reste néanmoins modifiable par l'utilisateur. D'autre part, quelque soit le paramétrage de la fiche journal, il est possible de choisir dans la liste déroulante l'un des libellés type disponible et ainsi de remplacer le libellé proposé sans avoir à le resaisir manuellement. Débit / Crédit * Le positionnement par défaut du curseur dans le champ Débit ou Crédit dépend : - du sens par défaut paramétré sur la fiche compte, - de la nature du compte saisi, - du type de journal dans lequel la saisie est effectuée. Dans tous les cas, le sens par défaut proposé peut être modifié. Le montant peut être saisi directement dans le champ ou obtenu grâce à la calculatrice. Il ne peut pas être nul. Il peut être négatif. Néanmoins, si vous souhaitez limiter l'utilisation des montants négatifs, vous pouvez activer l'option Afficher en saisie les alertes sur les montants dans les Options comptables. Ainsi, à chaque saisie d'un montant négatif, un message d'alerte non bloquant sera affiché. Une écriture doit obligatoirement être équilibrée, c'est-à-dire que la somme des Débits de toutes les lignes qui la composent doit être égale à la somme des Crédits de toutes les lignes de la même écriture. Date d'échéance Cette colonne est uniquement présente dans les journaux de type Achats, Ventes et Opérations Diverses. Elle est accessible sur les comptes de natures Clients et Comptes rattachés et Fournisseurs et comptes rattachés. Elle affiche par défaut la première date d'échéance calculée en fonction du Mode de règlement présent dans la fiche du Tiers saisi. La date de l'échéance présentée peut être modifiée de plusieurs façons : - en saisissant directement dans le champ, - en sélectionnant une date dans le calendrier en cliquer sur le bouton d'accès à la liste déroulante,. - en modifiant l'échéancier, en cliquant sur le bouton "+" disponible dans le champ. Moyen de paiement Cette colonne est uniquement présente dans les journaux de type Trésorerie. Elle est accessible sur les comptes de natures Clients et Comptes rattachés et Fournisseurs et comptes rattachés. Elle est vierge par défaut et vous permet de renseigner le moyen de paiement par lequel vous avez réglé votre Fournisseur ou avez été réglé par votre Client. Totaux du journal Ces cumuls sont mis à jour en temps réel lors de chaque opération de saisie. Ils sont reportés sur le cumul des journaux. 37 EBP Comptabilité Open Line Pro L'équilibre du journal est une condition nécessaire à la sortie du journal. Débit : La somme des montants débiteurs saisis sur ce journal et sur ce mois est affichée en pied de saisie. Crédit : La somme des montants créditeurs saisis sur ce journal et sur ce mois est affichée en pied de saisie. Présentation de la fenêtre de saisie comptable Accès : Quotidien - Saisie par journal OU Quotidien - Nouvelle écriture comptable La gestion de la fenêtre de saisie est, dans les grandes lignes, commune à toutes les fiches. La fenêtre de saisie comptable s'applique à la saisie par journal et à la saisie par écriture. Cette page d'aide détaille les différents éléments dont la fenêtre de saisie comptable est composée. Barre de menus La barre de menus permet de réaliser un certain nombre d'actions liées au journal et au mois affiché. Les menus sont Fichier, Edition, Actions, Vues, ?. Barre d'outils La barre d'outils est représentée par des menus déroulants qui permettent de réaliser un certain nombre d'actions dans la fenêtre de saisie. Ces menus déroulants reprennent en partie les tâches disponibles dans la barre de menus, mais en facilitent l'utilisation : Sauvegarder : Permet de sauvegarder les saisies effectuées, sans fermer la fenêtre de saisie. La sauvegarde des écritures n'est pas automatique. Nous vous recommandons d'effectuer fréquemment leur sauvegarde ou de paramétrer les options du dossier, en cochant l'option Sauvegarde automatique dès l'équilibre de l'écriture, disponible dans Paramètres - Paramétrages - Options de saisie. Sauvegarder et Fermer : Permet de sauvegarder les saisies effectuées et de fermer la fenêtre de saisie. Fermer : Permet de fermer la fenêtre de saisie. Lorsque ce bouton est activée, un message de confirmation de sauvegarde apparait. Ce message concerne toutes les écritures saisies qui n'ont pas encore été sauvegardées et pas seulement la dernière écriture saisie ou modifiée. Annuler/Refaire : Permettent d'annuler et de refaire autant de fois que nécessaire les dernières actions réalisées et évite de devoir les reconstituer manuellement. Le logiciel mémorise les 15 dernières actions accomplies. Pour connaître les règles d'activation et de désactivation de ces options en saisie journal, il est nécessaire de se reporter aux Options Comptables du dossier. Précédent/Suivant : Permet de naviguer entre les différents masques de saisie sans être obligé de sortir de la saisie. Les règles de navigation dépendent de la liste à partir de laquelle la fenêtre de saisie a été ouverte. - Accès à la saisie journal, à partir de Quotidien - Saisie journal - Mois en cours : la navigation s'effectue d'un journal à un autre, mais reste sur le mois en cours. - Accès la saisie journal, à partir de Quotidien - Saisie par journal - Tous les mois : la navigation s'opère d'abord de journal en journal sur le même mois, puis passe seulement ensuite au mois suivant ou précédent. - Accès la saisie journal, à partir de Quotidien - Saisie par journal - Tous les journaux : la navigation s'opère d'abord de mois en mois sur le même journal, puis passe seulement ensuite au journal suivant ou précédent. - Accès à la saisie journal, à partir de Exercices/Clôtures - Gestionnaire de journaux : la navigation est impossible ; il faut fermer la saisie journal puis la rouvrir sur le journal/mois désiré. Consultation/Lettrage : Permet d'accéder à la fenêtre de consultation du compte saisi sur la ligne d'écriture sélectionnée. Voir document : 38 MANUEL Permet d'accéder au document ayant permis de comptabiliser l'écriture sélectionnée. il peut s'agir d'une facture provenant de la Gestion commerciale, d'une écriture provenant de la saisie guidée, d'une écriture provenant de la saisie pratique. Lorsque une écriture issue de la saisie guidée puis comptabilisée dans la saisie journal est modifiée, alors le lien est cassé et le bouton Voir le document devient inactif. Régler : Permet de créer un nouveau règlement, si l'écriture sélectionnée est une Facture ou Avoir Client ou Fournisseurs. Ajouter : - Pour la saisie journal : Quelque soit la ligne sélectionnée, cette fonction permet d'ajouter une nouvelle écriture à la fin du journal, à la suite des autres écritures déjà existantes. Cette nouvelle écriture reprend l'ensemble des critères définis pour cette écriture dans le journal (date, n° de pièce...). - Pour la saisie par écriture : Quelque soit la ligne sélectionnée, cette fonction permet d'ajouter une nouvelle ligne, à la suite des autres lignes déjà existantes. Insérer : - Pour la saisie journal : Si la ligne d'écriture sélectionnée dans le journal est la première ligne d'une écriture, alors cette fonction permet d'insérer une écriture entre l'écriture sélectionnée et l'écriture précédente. Cette nouvelle écriture reprend l'ensemble des critères définis pour cette écriture dans le journal (date, n° de pièce...) Si la ligne d'écriture sélectionnée dans le journal est une autre ligne que la première ligne de l'écriture, alors cette fonction permet d'insérer une ligne entre la ligne sélectionnée et la ligne précédente. Cette nouvelle ligne reprend alors l'ensemble des critères déjà définis pour les autres lignes de la même écriture. - Pour la saisie par écriture : Cette fonction permet d'insérer une ligne, dans la même écriture, au-dessus de la ligne sélectionnée. Supprimer l'écriture : Permet de supprimer une écriture (et donc toutes les lignes d'écriture qui la compose). En conséquence, l'équilibrage du journal n'est pas remis en question. Supprimer la ligne : Permet de supprimer une ligne d'écriture en particulier, sans modifier ni supprimer les autres lignes de la même écriture. La suppression d'une ligne d'écriture remet en cause l'équilibrage obligatoire de cette écriture. Equilibrer : Permet de calculer automatiquement le montant qui équilibre l'écriture en cours de saisie. Autres fonctions disponibles : Plusieurs autres fonctions sont disponibles, sous forme de boutons dans la barre d'outils, comme sous forme d'actions incluses dans les menus déroulants de la barre de menus ou encore dans le menu contextuel Menu contextuel = clic droit de la souris.. En-tête de la fenêtre de saisie Journal : La liste des journaux existants est accessible dans la liste déroulante. Période : La liste de périodes dépend de l'état de l'exercice courant. Si l'exercice courant est clôturé, alors seules les périodes de cet exercice clôturé sont accessibles. Si l'exercice courant est ouvert, alors toute les périodes des exercices ouverts sont accessibles. Une période ne s'entend pas obligatoirement comme un mois complet mais peut aussi être une période faisant partie d'un mois calendaire. Exercice courant : du 15/01/2008 au 14/01/2009 inclus, 39 EBP Comptabilité Open Line Pro - La saisie est possible sur tous les journaux de l'exercice pour les mois entiers de février 2008 à décembre 2008 inclus. - La saisie est possible sur tous les journaux de l'exercice pour deux périodes inférieures aux mois calendaires, à savoir : * Période du 15 au 31 janvier 2009, affichée "janvier 2008" * Période du 01 au 14 janvier 2009, affichée "janvier 2009". Navigation dans la fenêtre de saisie : La navigation entre les journaux et les mois est possible en fermant la fenêtre de saisie et en sélectionnant un autre journal et une autre période dans le cumul des journaux. Elle est également possible en sélectionnant directement le journal et/ou la période dans l'en-tête de la fenêtre de saisie grâce aux listes déroulantes. Corps de la fenêtre de saisie Vous pouvez obtenir ici plus de détail sur le corps de la fenêtre de saisie de la saisie par journal et sur le corps de la fenêtre de saisie de la saisie par écriture. Fermeture de la fenêtre de saisie La fenêtre de saisie peut être fermée, à la condition que l'écriture en cours de saisie soit équilibrée. La fenêtre de saisie peut être fermée : - directement par la croix rouge de la fenêtre, - par le menu Fichier - Fermer, - par le menu Fichier - Sauvegarder et Fermer, - par la combinaison de touches Alt + F4, - par le bouton Fermer, - par le bouton Sauvegarder et Fermer. Menu contextuel Le menu contextuel Menu contextuel = clic droit de la souris. reprend un certain nombre de tâches disponibles dans les menus et dans la barre d'outils. Colonnes optionnelles Plusieurs colonnes optionnelles sont disponibles en fonction du type de journal sélectionné. Pour ajouter ou supprimer une colonne optionnelle, il faut cliquer sur le bouton Editer les vues de la barre de tâche de la fenêtre de saisie. Certaines colonnes sont obligatoires. Il est donc impossible de les retirer de la fenêtre de saisie (par exemple : Débit, Crédit, Date...). Les colonnes optionnelles sont gérées par dossier. Si le même dossier est ouvert par plusieurs utilisateurs différents, alors tous auront le même affichage. Autres fonctions disponibles en saisie Accès : Quotidien - Saisie par journal OU Quotidien - Nouvelle écriture comptable A côté des fonctions de base disponibles en saisie, il existe d'autres fonctions qui peuvent faciliter la saisie par journal ou la saisie par écriture. Traitement sur les écritures Simuler / Confirmer l'écriture Le fonctionnement de cette fonction correspond aux principes décrits sur la simulation et aux règles décrites dans la colonne Statut de la fenêtre de saisie par journal . Valider l'écriture courante Cette fonction permet de valider l'écriture sélectionnée. La validation d'une écriture s'opère dans les conditions suivantes : - l'écriture sélectionnée doit être équilibrée ; - l'écriture sélectionnée doit être de statut Non validé (la colonne Statut doit être vierge) ; - dans un journal de Trésorerie avec contrepartie en pied, la validation s'appliquera à l'unique écriture du journal et empêchera ensuite toute nouvelle création de ligne d'écriture ; - la validation n'empêche pas la modification des échéanciers ; - la validation rend intangibles les écritures comptables et leur contenu. Valider tout Cette fonction permet de valider l'ensemble des écritures d'un même journal/mois. Les règles de validation sont les mêmes que celles décrites dans le paragraphe Valider l'écriture courante. Contrepasser l'écriture 40 MANUEL La contrepassation est une opération consistant à créer une écriture inverse à une écriture déjà existante, mais n'ayant aucune incidence sur cette écriture d'origine. Cette fonction, disponible dans la barre de menus Ecritures - Contrepasser l'écriture et dans le menu contextuel Menu contextuel = clic droit de la souris., nécessite un paramétrage passant par une boite de dialogue. L'écriture déjà existante peut être située : - dans n'importe quel type de journal, sauf le journal de Trésorerie avec contrepartie en pied et dans le journal de type A Nouveaux, - sur n'importe quel mois de l'exercice courant et même sur un mois clôturé. L'écriture contrepassée doit être affectée : - dans le journal d'origine ou dans un journal de type Opérations Diverses, - sur le mois d'origine s'il est non clôturé, ou à défaut sur le premier mois non clôturé de l'exercice. Le statut de l'écriture contrepassée dépend du statut de l'écriture déjà existante : - Si l'écriture d'origine possède le statut Simulé, alors l'écriture contrepassée possède le statut Simulé ; - Si l'écriture d'origine possède le statut Validé ou Non Validée, alors l'écriture contrepassée possède dans tous les cas le statut Non Validé. L'écriture contrepassée prend comme numéro le numéro de pièce qui lui est attribué en fonction du paramétrage du journal de destination. Une écriture saisie dans un journal de type Trésorerie avec contrepartie en pied ne peut pas être contrepassée. Transférer Le transfert d'une écriture est une opération consistant à transférer une écriture saisie dans un journal et un mois vers un autre journal et un autre mois. L'écriture disparaît donc du journal/mois dans lequel elle se trouvait à l'origine. Cette fonction, disponible dans la barre menu Ecritures - Transférer l'écriture et dans le menu contextuel Menu contextuel = clic droit de la souris , nécessite un paramétrage passant par une boite de dialogue. L'écriture à transférer doit être : - de statut Non validé ou Simulé, - située dans un journal de type autre que Trésorerie avec contrepartie en pied et A Nouveaux. Le journal et le mois de destination doivent être : - différents du journal et du mois d'origine, - des journaux de type autre que Trésorerie avec contrepartie en pied et A Nouveaux, - des mois non clôturés. L'écriture transférée conserve le numéro de pièce qui lui a été attribué à l'origine et cela quelque soit le paramétrage du journal de destination. Ecritures de régularisation Facture non parvenue ou à émettre Ce bouton permet d'accéder à la fenêtre de paramétrage Facture/Avoir à emettre ou Facture/Avoir à recevoir et de générer l'écriture d'extourne. Charge ou produit constaté d'avance Ce bouton permet d'accéder à la fenêtre de paramétrage Charges ou Produits constatés d'avance et de générer l'écriture de régularisation puis l'écriture d'extourne. Echéanciers Deux types d'échéanciers existent. Le logiciel détermine quel échéancier doit être ouvert, en fonction du compte, du journal, du sens et du signe de la ligne sélectionnée. Echéancier de la Facture Ce bouton permet d'accéder à un échéancier spécifique dans lequel sont créées les échéances de la facture sélectionnée. Pointages Ce bouton permet d'accéder à la fenêtre spécifique dans laquelle les pointages sont effectués. Fonctions spécifiques au menu contextuel Modifier la saisie guidée Une écriture saisie dans la saisie guidée puis comptabilisée en saisie journal n'est pas directement modifiable. Il faut d'abord sélectionner l'option Modifier la saisie guidée, disponible dans le menu contextuel. 41 EBP Comptabilité Open Line Pro Lorsque ce bouton est activé, alors l'écriture devient supprimable ou modifiable en saisie journal. Les modifications ou suppressions effectuées dans la saisie journal sont sans incidence sur la saisie guidée d'origine. Seul le statut de cette saisie guidée est modifié, il affiche Modifié en comptabilité. Ce statut signifie que le lien existant entre la saisie guidée d'origine et l'écriture comptable modifiée est cassé. Le bouton Modifier la saisie guidée devient inactif dès lors que l'écriture provenant de la saisie guidée a été modifiée en compta. Rafraîchir : Permet de mettre à jour l'affichage de la fenêtre de saisie, lorsque celui-ci a été modifié par une action effectuée dans une autre fenêtre (consultation, lettrage...). Cette fonction est indispensable pour prendre en compte les modifications effectuées dans les fenêtres de l'échéancier, du lettrage... La gestion des échéanciers et des pointages en saisie Accès : Quotidien - Saisie par journal OU Quotidien - Saisie par écriture L'échéancier est accessible à partir de la saisie journal et de la saisie par écriture. Comptes autorisés pour gérer les échéanciers Les échéanciers existent uniquement sur les comptes de nature "Fournisseurs et comptes rattachés", "Clients et comptes rattachés" et "Autres Tiers avec échéance". Dans la fiche de chacun des comptes de ces natures, il est ensuite possible d'affiner le mode de gestion (avec ou sans échéancier) et le mode d'affichage (ouverture automatique ou à la demande uniquement). Fonctionnement des échéanciers Deux types d'échéancier existent en fonction du compte, du journal, du sens et du signe de la ligne d'écriture sélectionnée dans la saisie journal. Il s'agit de l'échéancier de la facture et des Pointages. Echéancier de la facture L'Echéancier de la Facture est l'échéancier dans lequel sont déterminées les échéances de paiement de la facture en cours de saisie. Pour saisir une échéance sur une facture, plusieurs solutions existent : - saisir directement l'échéance dans la colonne Date de l'échéance, ce qui entraîne la modification de la première échéance disponible ; - ouvrir l'échéancier principal en cliquant sur le bouton Echéancier de la facture disponible dans la barre d'outils - ouvrir l'échéancier simplifié en cliquant sur le bouton "+" disponible dans la colonne Date d'échéance. Pour que les différents masques de saisie (Saisie journal, Echéancier Facture Principal, Echéancier Facture simplifié, Echéancier Pointages, Colonne Date de l'échéance) affichent les dernières modifications, nous vous invitons à procéder régulièrement à des sauvegardes (bouton Sauvegarder) et à des rafraîchissements (fonction Rafraîchir dans le menu contextuel). En-tête La zone d'en-tête est affichée uniquement lorsque l'échéancier est ouvert à partir du bouton Echéancier de la facture de la barre d'outils. Cette partie non saisissable reprend les éléments saisis sur la ligne d'écriture (compte, libellé du compte, date et le montant de la pièce) Corps 42 MANUEL Cette partie affiche par défaut toutes les échéances prévues qui résultent du respect du mode de règlement renseigné sur la fiche du compte saisi. Le nombre de lignes d'échéance pour une même ligne d'écriture est illimité : les boutons Ajouter et Supprimer permettent de créer et de supprimer des lignes d'échéances. La modification du contenu d'une ligne d'échéance est également possible en saisissant directement dessus. Quelques règles impératives doivent néanmoins être respectées : - La somme des pourcentages doit être égale à 100%. - La somme des montants doit être égale au montant de la pièce. Autres fonctions Répartir sur la sélection Ce bouton est disponible quelque soit le moyen d'affichage de l'échéancier. Il permet d'affecter à la ligne d'échéance sélectionnée la totalité du montant et du pourcentage non encore ventilés. Contenu de l'échéancier : Montant de la pièce : 400 Euros Echéance 1 : 30/06/2009 - 100 Euros - 25 % Echéance 2 : 31/07/2009 - 100 Euros - 25 % Echéance 3 : 31/08/2009 - Ni montant ni pourcentage renseignés Total des montants : 200 Euros Total des pourcentages : 50 % Lorsque je sélectionne Répartir sur la sélection, l'échéancier est recalculé ainsi, en renseignant automatiquement les valeurs de l'échéance 3 : Echéance 1 : 30/06/2009 - 100 Euros - 25 % Echéance 2 : 31/07/2009 - 100 Euros - 25 % Echéance 3 : 31/08/2009 - 200 Euros - 50 % Total des montants : 400 Euros Total des pourcentages : 100 % Régler l'échéance Ce bouton permet de créer un nouveau règlement du montant de l'échéance sélectionnée et, dans le même temps, de pointer ce règlement avec cette échéance. Régler la facture : Ce bouton permet de créer un nouveau règlement du montant total de la facture (toutes échéances confondues) et, dans le même temps, de pointer ce règlement avec ces échéances. Echéancier interactif : Ce bouton permet d'accéder à l'échéancier interactif. Visualiser les pointages Ce bouton permet d'afficher une nouvelle fenêtre listant toutes les lignes d'écritures avec lesquelles l'échéance sélectionnée a été pointée. Les lignes présentes dans cette fenêtre peuvent être des avoirs, des règlements et de remboursements. Pour consulter ou modifier le pointage exécuté entre l'échéance et n'importe laquelle de ces lignes, il vous suffit de cliquer sur Modifier. Choix des vues Une vue de l'échéancier Factures est proposé par défaut. Néanmoins les vues sont paramétrables afin de répondre aux besoins. Sauvegarder ou Fermer un échéancier Le bouton Sauvegarder permet de sauvegarder les dernières modifications faites dans l'échéancier sans le fermer. Le bouton Sauvegarder et Fermer permet à la fois de sauvegarder les dernières modifications et de le fermer. Le bouton Fermer entraîne la fermeture de l'échéancier sans sauvegarder les dernières modifications. Pointages 43 EBP Comptabilité Open Line Pro La fenêtre Pointages permet d'effectuer les pointage entre les avoirs, les règlements, les remboursements et les échéances de facture. Pour effectuer le pointage d'une échéance, il suffit de cliquer sur le bouton Pointages disponible dans la barre de taches de la saisie journal. En-tête Cette partie non saisissable reprend les éléments saisis sur la ligne d'écriture (compte, date et le montant du règlement, Reste à affecter...). Le Reste à affecter se calcule automatiquement : il résulte automatiquement de la différence entre le montant du règlement et le montant total des échéances pointées. Corps Cette partie affiche les échéances des factures et avoirs qui n'ont pas encore été totalement soldées. Aucune modification, aucune suppression ni aucun ajout de lignes d'échéances n'est possible dans cette zone. Seule la case à cocher Pointée ? est accessible : lorsqu'elle est cochée, elle permet d'imputer en totalité le montant affiché dans le champ Reste à affecter à une ligne d'échéance. Lorsqu'une échéance est rayée, cela signifie qu'elle a été "soldée" dans l'application de Gestion commerciale, c'est-à-dire que le règlement était supérieur ou inférieur au montant de l'échéance et qu'une écriture Perte ou Profit (comptes 658 ou 758) a été générée en comptabilité. Lorsqu'une échéance est en rouge, cela signifie qu'elle été pointée par une autre application et, donc, que ni pointage ni dépointage ne peuvent plus être effectués en comptabilité. La somme des Montants pointés de la grille ne peut être supérieure au montant du Reste à affecter de l'en-tête. Choix des vues Une vue de la fenêtre Pointages est proposée par défaut. Néanmoins les vues sont paramétrables afin de répondre aux besoins. Lors du transfert des factures d'acompte provenant d'autre module EBP, les échéances sur les comptes 4191 et/ou 4091, ne sont pas pointées. Il faudra donc faire le pointage en compta. Sauvegarder ou Fermer un échéancier Le bouton Sauvegarder permet de sauvegarder les dernières modifications faites dans l'échéancier sans le fermer. Le bouton Sauvegarder et Fermer permet à la fois de sauvegarder les dernières modifications et de le fermer. Le bouton Fermer entraîne la fermeture de l'échéancier sans sauvegarder les dernières modifications. Choix de l'échéance de l'avoir En Gestion commerciale, il est possible d'émettre des factures négatives possédant une ou plusieurs échéances. Lorsqu'elles sont transférées en comptabilité, ces factures négatives sont comptabilisées comme des avoirs mais conservent leurs échéances. Dans ce cas, lorsque vous cliquez sur le bouton Pointages d'une ligne d'avoir avec plusieurs échéances, la fenêtre Choix de l'échéance de l'avoir s'affiche : elle contient toutes les échéances de l'avoir sélectionné (= de la facture négative en Gestion commerciale). Il vous suffit de sélectionner l'une des échéances de cet avoir puis de cliquer sur Ok pour que la fenêtre de Pointages s'ouvre. Dès lors, le pointage d'une échéance de cet avoir avec une échéance de facture est possible de la même façon que pour un avoir ou un règlement (voir supra, paragraphe Pointages). Pour fermer cette fenêtre, sans traitement, il vous suffit de cliquer sur la croix rouge de la fenêtre. Règles d'accès aux échéances et aux pointages en fonction du type de ligne saisie Pour chaque ligne d'écriture saisie, le logiciel détermine automatiquement un type de ligne en analysant le compte, le sens de saisie et le type de journal. Ce type de ligne permet de définir quelle fenêtre est accessible (Echéancier de la facture ou Pointages), quelles lignes sont visibles et quelles actions y sont possibles. Ligne de type Facture 44 MANUEL Une ligne est de type Facture : - si le compte est de racine 411, qu'il est saisi au Débit, dans les journaux de type Ventes, Opérations ou A Nouveaux, - si le compte est de racine 401, qu'il est saisi au Crédit, dans les journaux de type Achats, Opérations Diverses et A Nouveaux. Sur une ligne de ce type, la saisie des échéances est possible soit en saisissant directement dans la colonne Date d'échéance, soit en cliquant sur le bouton Echéancier de la facture, soit en cliquant sur le bouton "+" de la colonne Date d'échéance. Seules les échéances de la facture en cours de saisie sont visibles. Aucun pointage n'est possible dans cette fenêtre. Ligne de type Avoir Une ligne est de type Avoir : - si le compte est de racine 411, qu'il est saisi au Crédit, dans les journaux de type Ventes ou A Nouveaux, - si le compte est de racine 401, qu'il est saisi au Débit, dans les journaux de type Achats ou A Nouveaux. Sur une ligne de ce type, la saisie des échéances est impossible. En revanche, en cliquant que le bouton Pointages, il est possible d'accéder à la fenêtre de pointage qui présente toutes les échéances de factures non encore soldées sur le compte. Il est possible de pointer un avoir avec des échéances factures jusqu'à ce que le Reste à affecter soit nul. Audelà tout nouveau pointage devient impossible. Ligne de type Règlement Une ligne est de type Règlement : - si le compte est de racine 411, qu'il est saisi au Crédit, dans les journaux de type Opérations Diverses ou Trésorerie, - si le compte est de racine 401, qu'il est saisi au Débit, dans les journaux de type Opérations Diverses ou Trésorerie. Sur une ligne de ce type, la saisie des échéances est impossible. En revanche, en cliquant que le bouton Pointages, il est possible d'accéder à la fenêtre de pointage qui présente toutes les échéances de factures et tous les avoirs non encore soldés sur le compte. Il est possible de pointer un règlement avec des échéances de facture jusqu'à ce que le Reste à affecter soit nul. Au-delà tout nouveau pointage d'échéance facture est impossible. Il est également possible de pointer un règlement avec des avoirs et cela sans limitation sur le Reste à affecter. Ligne de type Remboursement Une ligne est de type Remboursement : - si le compte est de racine 411, qu'il est saisi au Débit, dans les journaux de type Trésorerie, - si le compte est de racine 401, qu'il est saisi au Crédit, dans les journaux de type Trésorerie. Sur une ligne de ce type, la saisie des échéances est impossible. En revanche, en cliquant que le bouton Pointages, il est possible d'accéder à la fenêtre de Pointage qui présente toutes les échéances de factures et tous les avoirs non encore soldés sur le compte. Il est possible de pointer un règlement avec des avoirs et cela sans limitation sur le Reste à affecter. Il est également possible de pointer un remboursement avec des factures, à condition que le Reste à affecter soit positif (c'est-à-dire que le règlement a déjà été pointé avec des avoirs). SAISIE PAR ÉCRITURE Saisir une nouvelle écriture comptable Accès : Quotidien - Saisie par journal - Nouvelle écriture comptable Cette fonction a pour but de vous permettre de saisir une écriture à la fois. Créer une nouvelle écriture ou accéder à une écriture déjà existante Les actions suivantes permettent d'ouvrir un masque de saisie qui contient toutes les lignes de la même écriture. Pour ajouter une nouvelle écriture, plusieurs possibilité existent : - Faire Ajouter dans la barre d'outils ; - cliquer sur Saisir une nouvelle écriture dans la barre de tâches ; - sélectionner Saisir une nouvelle écriture dans le menu contextuel. 45 EBP Comptabilité Open Line Pro Pour modifier une ligne d'écriture déjà existante, il faut la sélectionner dans la liste puis, au choix : - Faire Modifier dans la barre d'outils ; - double cliquer sur la ligne de la liste ; - sélectionner Modifier dans le menu contextuel. Pour supprimer une ligne d'écriture déjà existante, il faut accéder à cette ligne d'écriture par les actions de modification puis, dans le masque, supprimer la ligne d'écriture qui convient. Seules les lignes d'écriture comptabilisées directement par la fonction Saisir une nouvelle écriture sont modifiables ou supprimables. Les lignes saisies dans une autre fonctionnalité (par exemple : Mes achats...) ne sont ni modifiables ni supprimables directement à partir de la liste : il est nécessaire d'accéder au masque de saisie qui a permis de la générer. Contenu du masque de saisie Ce masque permet de saisir une seule écriture à la fois. Vous pouvez obtenir ici des informations sur : - la présentation générale de la fenêtre, - son contenu, - et ses fonctions. Lorsque l'écriture saisie dans ce masque est sauvegardée, elle s'ajoute automatiquement au journal et au mois de destination défini dans la zone d'en-tête. Les journaux de Trésorerie avec contrepartie en pied ne peuvent pas être sélectionnés dans ce masque. Pour saisir sur ce type de journaux, il faut accéder directement à la saisie par journal. Corps de la fenêtre de saisie par écriture Accès : Quotidien - Saisie par journal - Nouvelle écriture comptable C'est à l'intérieur de la fenêtre de saisie que les opérations de saisie sont enregistrées. Cette page détaille les règles de navigation entre les lignes et les écritures, le contenu des différentes colonnes et leur comportement. La saisie est régie par des principes de comptabilisation (lignes d'écritures, écritures comptables, mentions obligatoires, équilibrage des journaux). La saisie par écriture est un mode de saisie qui permet de comptabiliser une écriture à la fois. Navigation dans la fenêtre de saisie La navigation entre les champs et les lignes peut se faire entre les différents champs grâce aux touches Tab et Shift+Tab, à la touche Entrée, à la souris ou encore avec les flèches directionnelles. La création d'une nouvelle écriture est proposée dès que l'écriture en cours de saisie est équilibrée. Colonnes obligatoires affichées par défaut pour tous les types de journaux Les colonnes sont listées de gauche à droite : Statut Les différents statuts : Le statut s'applique à une écriture et donc à toutes les lignes d'écriture qui la composent. - Ecritures non validées (ni validées, ni simulées) : Les écritures possèdent par défaut le statut "non validé" lors de leur création. Elles sont modifiables et possèdent un statut vierge. Ce statut reste modifiable. - Ecritures validées : Dans certains cas (validation, clôture mensuelle, clôture annuelle), il est nécessaire de valider les écritures comptables, c'est-à-dire de les rendre intangibles. Elles affichent alors un statut "V". Ce statut n'est plus modifiable. - Ecritures simulées : Dans d'autres cas (situation périodique), il peut être nécessaire de passer les écritures comptables en mode "Simulé". Elles sont alors facilement identifiables, restent modifiables et sont obligatoirement exclues des opérations de rapprochement bancaire. Elles affichent alors un statut "S". Ce statut reste modifiable. Changement de statut : Le statut d'une écriture peut être modifié grâce au menu Ecritures ou grâce au menu contextuel Menu contextuel = clic droit de la souris, sachant qu'une écriture ne peut posséder qu'un seul statut à la fois. Trois opérations sont possibles en fonction du statut en cours sur l'écriture sélectionnée : - Simuler : si l'écriture est de statut "Non validé", elle prend le statut "Simulé". 46 MANUEL - Confirmer : si l'écriture est de statut "Simulé", elle prend le statut "Non validé". - Valider : si l'écriture est de statut "Non validé", elle prend le statut "Validé". Cas particulier du journal de type Trésorerie avec contrepartie en pied de journal Le journal de type Trésorerie avec contrepartie en pied de journal est composé d'une seule et unique écriture, composée de toutes les lignes d'écriture du journal. Le même statut s'applique donc à toutes les lignes du journal sans distinction. N° de document Lorsque la pièce provient d'une autre application (par exemple : Gestion Commerciale), alors ce champ affiche le numéro que ce document possède dans son application d'origine. Lorsque la pièce provient de la saisie guidée, alors ce champ affiche le numéro de l'écriture guidée à l'origine de cette écriture. Dans tous les autres cas, ce champ reste vierge et librement saisissable. Compte * La liste des comptes existants sur l'exercice courant est disponible grâce à la liste déroulante. Un bouton situé à gauche de cette liste déroulante permet d'ouvrir la fiche du compte sélectionné. Pour obtenir les affichages des messages d'alerte sur les comptes saisis dans un mauvais journal, vous devez d'abord activer l'option Afficher en saisie les alertes sur les comptes dans les Options comptables. Les messages d'alerte affichés peuvent être : - bloquants et vous interdire de saisir le compte désiré, car ce compte est bloqué ; - non bloquants et vous permettre de poursuivre malgré tout votre saisie, quand le compte désiré n'est pas autorisé en saisie sur type de journal ou quand il fait partie des racines interdites de ce journal. Afin de vous faciliter la saisie des chaînes de comptes associés peuvent être créées. Libellé Le comportement du Libellé dépend du paramétrage effectué dans la fiche journal. Même si un libellé est proposé, il reste néanmoins modifiable par l'utilisateur. D'autre part, quelque soit le paramétrage de la fiche journal, il est possible de choisir dans la liste déroulante l'un des libellés type disponible et ainsi de remplacer le libellé proposé sans avoir à le resaisir manuellement. Débit / Crédit * Le positionnement par défaut du curseur dans le champ Débit ou Crédit dépend : - du sens par défaut paramétré sur la fiche compte, - de la nature du compte saisi, - du type de journal dans lequel la saisie est effectuée. Dans tous les cas, le sens par défaut proposé peut être modifié. Le montant peut être saisi directement dans le champ ou obtenu grâce à la calculatrice. Il ne peut pas être nul. Il peut être négatif. Néanmoins, si vous souhaitez limiter l'utilisation des montants négatifs, vous pouvez activer l'option Afficher en saisie les alertes sur les montants dans les Options comptables. Ainsi, à chaque saisie d'un montant négatif, un message d'alerte non bloquant sera affiché. Une écriture doit obligatoirement être équilibrée, c'est-à-dire que la somme des Débits de toutes les lignes qui la composent doit être égale à la somme des Crédits de toutes les lignes de la même écriture. Date d'échéance Cette colonne est uniquement présente dans les journaux de type Achats, Ventes et Opérations Diverses. Elle est accessible sur les comptes de natures Clients et Comptes rattachés et Fournisseurs et comptes rattachés. Elle affiche par défaut la première date d'échéance calculée en fonction du Mode de règlement présent dans la fiche du Tiers saisi. La date de l'échéance présentée peut être modifiée de plusieurs façons : - en saisissant directement dans le champ, - en sélectionnant une date dans le calendrier en cliquer sur le bouton d'accès à la liste déroulante,. - en modifiant l'échéancier, en cliquant sur le bouton "+" disponible dans le champ. Moyen de paiement Cette colonne est uniquement présente dans les journaux de type Trésorerie. Elle est accessible sur les comptes de natures Clients et Comptes rattachés et Fournisseurs et comptes rattachés. Elle est vierge par défaut et vous permet de renseigner le moyen de paiement par lequel vous avez réglé votre Fournisseur ou avez été réglé par votre Client. Présentation de la fenêtre de saisie comptable Accès : Quotidien - Saisie par journal OU Quotidien - Nouvelle écriture comptable 47 EBP Comptabilité Open Line Pro La gestion de la fenêtre de saisie est, dans les grandes lignes, commune à toutes les fiches. La fenêtre de saisie comptable s'applique à la saisie par journal et à la saisie par écriture. Cette page d'aide détaille les différents éléments dont la fenêtre de saisie comptable est composée. Barre de menus La barre de menus permet de réaliser un certain nombre d'actions liées au journal et au mois affiché. Les menus sont Fichier, Edition, Actions, Vues, ?. Barre d'outils La barre d'outils est représentée par des menus déroulants qui permettent de réaliser un certain nombre d'actions dans la fenêtre de saisie. Ces menus déroulants reprennent en partie les tâches disponibles dans la barre de menus, mais en facilitent l'utilisation : Sauvegarder : Permet de sauvegarder les saisies effectuées, sans fermer la fenêtre de saisie. La sauvegarde des écritures n'est pas automatique. Nous vous recommandons d'effectuer fréquemment leur sauvegarde ou de paramétrer les options du dossier, en cochant l'option Sauvegarde automatique dès l'équilibre de l'écriture, disponible dans Paramètres - Paramétrages - Options de saisie. Sauvegarder et Fermer : Permet de sauvegarder les saisies effectuées et de fermer la fenêtre de saisie. Fermer : Permet de fermer la fenêtre de saisie. Lorsque ce bouton est activée, un message de confirmation de sauvegarde apparait. Ce message concerne toutes les écritures saisies qui n'ont pas encore été sauvegardées et pas seulement la dernière écriture saisie ou modifiée. Annuler/Refaire : Permettent d'annuler et de refaire autant de fois que nécessaire les dernières actions réalisées et évite de devoir les reconstituer manuellement. Le logiciel mémorise les 15 dernières actions accomplies. Pour connaître les règles d'activation et de désactivation de ces options en saisie journal, il est nécessaire de se reporter aux Options Comptables du dossier. Précédent/Suivant : Permet de naviguer entre les différents masques de saisie sans être obligé de sortir de la saisie. Les règles de navigation dépendent de la liste à partir de laquelle la fenêtre de saisie a été ouverte. - Accès à la saisie journal, à partir de Quotidien - Saisie journal - Mois en cours : la navigation s'effectue d'un journal à un autre, mais reste sur le mois en cours. - Accès la saisie journal, à partir de Quotidien - Saisie par journal - Tous les mois : la navigation s'opère d'abord de journal en journal sur le même mois, puis passe seulement ensuite au mois suivant ou précédent. - Accès la saisie journal, à partir de Quotidien - Saisie par journal - Tous les journaux : la navigation s'opère d'abord de mois en mois sur le même journal, puis passe seulement ensuite au journal suivant ou précédent. - Accès à la saisie journal, à partir de Exercices/Clôtures - Gestionnaire de journaux : la navigation est impossible ; il faut fermer la saisie journal puis la rouvrir sur le journal/mois désiré. Consultation/Lettrage : Permet d'accéder à la fenêtre de consultation du compte saisi sur la ligne d'écriture sélectionnée. Voir document : Permet d'accéder au document ayant permis de comptabiliser l'écriture sélectionnée. il peut s'agir d'une facture provenant de la Gestion commerciale, d'une écriture provenant de la saisie guidée, d'une écriture provenant de la saisie pratique. Lorsque une écriture issue de la saisie guidée puis comptabilisée dans la saisie journal est modifiée, alors le lien est cassé et le bouton Voir le document devient inactif. Régler : 48 MANUEL Permet de créer un nouveau règlement, si l'écriture sélectionnée est une Facture ou Avoir Client ou Fournisseurs. Ajouter : - Pour la saisie journal : Quelque soit la ligne sélectionnée, cette fonction permet d'ajouter une nouvelle écriture à la fin du journal, à la suite des autres écritures déjà existantes. Cette nouvelle écriture reprend l'ensemble des critères définis pour cette écriture dans le journal (date, n° de pièce...). - Pour la saisie par écriture : Quelque soit la ligne sélectionnée, cette fonction permet d'ajouter une nouvelle ligne, à la suite des autres lignes déjà existantes. Insérer : - Pour la saisie journal : Si la ligne d'écriture sélectionnée dans le journal est la première ligne d'une écriture, alors cette fonction permet d'insérer une écriture entre l'écriture sélectionnée et l'écriture précédente. Cette nouvelle écriture reprend l'ensemble des critères définis pour cette écriture dans le journal (date, n° de pièce...) Si la ligne d'écriture sélectionnée dans le journal est une autre ligne que la première ligne de l'écriture, alors cette fonction permet d'insérer une ligne entre la ligne sélectionnée et la ligne précédente. Cette nouvelle ligne reprend alors l'ensemble des critères déjà définis pour les autres lignes de la même écriture. - Pour la saisie par écriture : Cette fonction permet d'insérer une ligne, dans la même écriture, au-dessus de la ligne sélectionnée. Supprimer l'écriture : Permet de supprimer une écriture (et donc toutes les lignes d'écriture qui la compose). En conséquence, l'équilibrage du journal n'est pas remis en question. Supprimer la ligne : Permet de supprimer une ligne d'écriture en particulier, sans modifier ni supprimer les autres lignes de la même écriture. La suppression d'une ligne d'écriture remet en cause l'équilibrage obligatoire de cette écriture. Equilibrer : Permet de calculer automatiquement le montant qui équilibre l'écriture en cours de saisie. Autres fonctions disponibles : Plusieurs autres fonctions sont disponibles, sous forme de boutons dans la barre d'outils, comme sous forme d'actions incluses dans les menus déroulants de la barre de menus ou encore dans le menu contextuel Menu contextuel = clic droit de la souris.. En-tête de la fenêtre de saisie Journal : La liste des journaux existants est accessible dans la liste déroulante. Période : La liste de périodes dépend de l'état de l'exercice courant. Si l'exercice courant est clôturé, alors seules les périodes de cet exercice clôturé sont accessibles. Si l'exercice courant est ouvert, alors toute les périodes des exercices ouverts sont accessibles. Une période ne s'entend pas obligatoirement comme un mois complet mais peut aussi être une période faisant partie d'un mois calendaire. Exercice courant : du 15/01/2008 au 14/01/2009 inclus, - La saisie est possible sur tous les journaux de l'exercice pour les mois entiers de février 2008 à décembre 2008 inclus. - La saisie est possible sur tous les journaux de l'exercice pour deux périodes inférieures aux mois calendaires, à savoir : * Période du 15 au 31 janvier 2009, affichée "janvier 2008" * Période du 01 au 14 janvier 2009, affichée "janvier 2009". Navigation dans la fenêtre de saisie : 49 EBP Comptabilité Open Line Pro La navigation entre les journaux et les mois est possible en fermant la fenêtre de saisie et en sélectionnant un autre journal et une autre période dans le cumul des journaux. Elle est également possible en sélectionnant directement le journal et/ou la période dans l'en-tête de la fenêtre de saisie grâce aux listes déroulantes. Corps de la fenêtre de saisie Vous pouvez obtenir ici plus de détail sur le corps de la fenêtre de saisie de la saisie par journal et sur le corps de la fenêtre de saisie de la saisie par écriture. Fermeture de la fenêtre de saisie La fenêtre de saisie peut être fermée, à la condition que l'écriture en cours de saisie soit équilibrée. La fenêtre de saisie peut être fermée : - directement par la croix rouge de la fenêtre, - par le menu Fichier - Fermer, - par le menu Fichier - Sauvegarder et Fermer, - par la combinaison de touches Alt + F4, - par le bouton Fermer, - par le bouton Sauvegarder et Fermer. Menu contextuel Le menu contextuel Menu contextuel = clic droit de la souris. reprend un certain nombre de tâches disponibles dans les menus et dans la barre d'outils. Colonnes optionnelles Plusieurs colonnes optionnelles sont disponibles en fonction du type de journal sélectionné. Pour ajouter ou supprimer une colonne optionnelle, il faut cliquer sur le bouton Editer les vues de la barre de tâche de la fenêtre de saisie. Certaines colonnes sont obligatoires. Il est donc impossible de les retirer de la fenêtre de saisie (par exemple : Débit, Crédit, Date...). Les colonnes optionnelles sont gérées par dossier. Si le même dossier est ouvert par plusieurs utilisateurs différents, alors tous auront le même affichage. Autres fonctions disponibles en saisie Accès : Quotidien - Saisie par journal OU Quotidien - Nouvelle écriture comptable A côté des fonctions de base disponibles en saisie, il existe d'autres fonctions qui peuvent faciliter la saisie par journal ou la saisie par écriture. Traitement sur les écritures Simuler / Confirmer l'écriture Le fonctionnement de cette fonction correspond aux principes décrits sur la simulation et aux règles décrites dans la colonne Statut de la fenêtre de saisie par journal . Valider l'écriture courante Cette fonction permet de valider l'écriture sélectionnée. La validation d'une écriture s'opère dans les conditions suivantes : - l'écriture sélectionnée doit être équilibrée ; - l'écriture sélectionnée doit être de statut Non validé (la colonne Statut doit être vierge) ; - dans un journal de Trésorerie avec contrepartie en pied, la validation s'appliquera à l'unique écriture du journal et empêchera ensuite toute nouvelle création de ligne d'écriture ; - la validation n'empêche pas la modification des échéanciers ; - la validation rend intangibles les écritures comptables et leur contenu. Valider tout Cette fonction permet de valider l'ensemble des écritures d'un même journal/mois. Les règles de validation sont les mêmes que celles décrites dans le paragraphe Valider l'écriture courante. Contrepasser l'écriture La contrepassation est une opération consistant à créer une écriture inverse à une écriture déjà existante, mais n'ayant aucune incidence sur cette écriture d'origine. Cette fonction, disponible dans la barre de menus Ecritures - Contrepasser l'écriture et dans le menu contextuel Menu contextuel = clic droit de la souris., nécessite un paramétrage passant par une boite de dialogue. L'écriture déjà existante peut être située : - dans n'importe quel type de journal, sauf le journal de Trésorerie avec contrepartie en pied et dans le journal de type A Nouveaux, 50 MANUEL - sur n'importe quel mois de l'exercice courant et même sur un mois clôturé. L'écriture contrepassée doit être affectée : - dans le journal d'origine ou dans un journal de type Opérations Diverses, - sur le mois d'origine s'il est non clôturé, ou à défaut sur le premier mois non clôturé de l'exercice. Le statut de l'écriture contrepassée dépend du statut de l'écriture déjà existante : - Si l'écriture d'origine possède le statut Simulé, alors l'écriture contrepassée possède le statut Simulé ; - Si l'écriture d'origine possède le statut Validé ou Non Validée, alors l'écriture contrepassée possède dans tous les cas le statut Non Validé. L'écriture contrepassée prend comme numéro le numéro de pièce qui lui est attribué en fonction du paramétrage du journal de destination. Une écriture saisie dans un journal de type Trésorerie avec contrepartie en pied ne peut pas être contrepassée. Transférer Le transfert d'une écriture est une opération consistant à transférer une écriture saisie dans un journal et un mois vers un autre journal et un autre mois. L'écriture disparaît donc du journal/mois dans lequel elle se trouvait à l'origine. Cette fonction, disponible dans la barre menu Ecritures - Transférer l'écriture et dans le menu contextuel Menu contextuel = clic droit de la souris , nécessite un paramétrage passant par une boite de dialogue. L'écriture à transférer doit être : - de statut Non validé ou Simulé, - située dans un journal de type autre que Trésorerie avec contrepartie en pied et A Nouveaux. Le journal et le mois de destination doivent être : - différents du journal et du mois d'origine, - des journaux de type autre que Trésorerie avec contrepartie en pied et A Nouveaux, - des mois non clôturés. L'écriture transférée conserve le numéro de pièce qui lui a été attribué à l'origine et cela quelque soit le paramétrage du journal de destination. Ecritures de régularisation Facture non parvenue ou à émettre Ce bouton permet d'accéder à la fenêtre de paramétrage Facture/Avoir à emettre ou Facture/Avoir à recevoir et de générer l'écriture d'extourne. Charge ou produit constaté d'avance Ce bouton permet d'accéder à la fenêtre de paramétrage Charges ou Produits constatés d'avance et de générer l'écriture de régularisation puis l'écriture d'extourne. Echéanciers Deux types d'échéanciers existent. Le logiciel détermine quel échéancier doit être ouvert, en fonction du compte, du journal, du sens et du signe de la ligne sélectionnée. Echéancier de la Facture Ce bouton permet d'accéder à un échéancier spécifique dans lequel sont créées les échéances de la facture sélectionnée. Pointages Ce bouton permet d'accéder à la fenêtre spécifique dans laquelle les pointages sont effectués. Fonctions spécifiques au menu contextuel Modifier la saisie guidée Une écriture saisie dans la saisie guidée puis comptabilisée en saisie journal n'est pas directement modifiable. Il faut d'abord sélectionner l'option Modifier la saisie guidée, disponible dans le menu contextuel. Lorsque ce bouton est activé, alors l'écriture devient supprimable ou modifiable en saisie journal. Les modifications ou suppressions effectuées dans la saisie journal sont sans incidence sur la saisie guidée d'origine. Seul le statut de cette saisie guidée est modifié, il affiche Modifié en comptabilité. Ce statut signifie que le lien existant entre la saisie guidée d'origine et l'écriture comptable modifiée est cassé. Le bouton Modifier la saisie guidée devient inactif dès lors que l'écriture provenant de la saisie guidée a été modifiée en compta. 51 EBP Comptabilité Open Line Pro Rafraîchir : Permet de mettre à jour l'affichage de la fenêtre de saisie, lorsque celui-ci a été modifié par une action effectuée dans une autre fenêtre (consultation, lettrage...). Cette fonction est indispensable pour prendre en compte les modifications effectuées dans les fenêtres de l'échéancier, du lettrage... La gestion des échéanciers et des pointages en saisie Accès : Quotidien - Saisie par journal OU Quotidien - Saisie par écriture L'échéancier est accessible à partir de la saisie journal et de la saisie par écriture. Comptes autorisés pour gérer les échéanciers Les échéanciers existent uniquement sur les comptes de nature "Fournisseurs et comptes rattachés", "Clients et comptes rattachés" et "Autres Tiers avec échéance". Dans la fiche de chacun des comptes de ces natures, il est ensuite possible d'affiner le mode de gestion (avec ou sans échéancier) et le mode d'affichage (ouverture automatique ou à la demande uniquement). Fonctionnement des échéanciers Deux types d'échéancier existent en fonction du compte, du journal, du sens et du signe de la ligne d'écriture sélectionnée dans la saisie journal. Il s'agit de l'échéancier de la facture et des Pointages. Echéancier de la facture L'Echéancier de la Facture est l'échéancier dans lequel sont déterminées les échéances de paiement de la facture en cours de saisie. Pour saisir une échéance sur une facture, plusieurs solutions existent : - saisir directement l'échéance dans la colonne Date de l'échéance, ce qui entraîne la modification de la première échéance disponible ; - ouvrir l'échéancier principal en cliquant sur le bouton Echéancier de la facture disponible dans la barre d'outils - ouvrir l'échéancier simplifié en cliquant sur le bouton "+" disponible dans la colonne Date d'échéance. Pour que les différents masques de saisie (Saisie journal, Echéancier Facture Principal, Echéancier Facture simplifié, Echéancier Pointages, Colonne Date de l'échéance) affichent les dernières modifications, nous vous invitons à procéder régulièrement à des sauvegardes (bouton Sauvegarder) et à des rafraîchissements (fonction Rafraîchir dans le menu contextuel). En-tête La zone d'en-tête est affichée uniquement lorsque l'échéancier est ouvert à partir du bouton Echéancier de la facture de la barre d'outils. Cette partie non saisissable reprend les éléments saisis sur la ligne d'écriture (compte, libellé du compte, date et le montant de la pièce) Corps Cette partie affiche par défaut toutes les échéances prévues qui résultent du respect du mode de règlement renseigné sur la fiche du compte saisi. Le nombre de lignes d'échéance pour une même ligne d'écriture est illimité : les boutons Ajouter et Supprimer permettent de créer et de supprimer des lignes d'échéances. La modification du contenu d'une ligne d'échéance est également possible en saisissant directement dessus. Quelques règles impératives doivent néanmoins être respectées : 52 MANUEL - La somme des pourcentages doit être égale à 100%. - La somme des montants doit être égale au montant de la pièce. Autres fonctions Répartir sur la sélection Ce bouton est disponible quelque soit le moyen d'affichage de l'échéancier. Il permet d'affecter à la ligne d'échéance sélectionnée la totalité du montant et du pourcentage non encore ventilés. Contenu de l'échéancier : Montant de la pièce : 400 Euros Echéance 1 : 30/06/2009 - 100 Euros - 25 % Echéance 2 : 31/07/2009 - 100 Euros - 25 % Echéance 3 : 31/08/2009 - Ni montant ni pourcentage renseignés Total des montants : 200 Euros Total des pourcentages : 50 % Lorsque je sélectionne Répartir sur la sélection, l'échéancier est recalculé ainsi, en renseignant automatiquement les valeurs de l'échéance 3 : Echéance 1 : 30/06/2009 - 100 Euros - 25 % Echéance 2 : 31/07/2009 - 100 Euros - 25 % Echéance 3 : 31/08/2009 - 200 Euros - 50 % Total des montants : 400 Euros Total des pourcentages : 100 % Régler l'échéance Ce bouton permet de créer un nouveau règlement du montant de l'échéance sélectionnée et, dans le même temps, de pointer ce règlement avec cette échéance. Régler la facture : Ce bouton permet de créer un nouveau règlement du montant total de la facture (toutes échéances confondues) et, dans le même temps, de pointer ce règlement avec ces échéances. Echéancier interactif : Ce bouton permet d'accéder à l'échéancier interactif. Visualiser les pointages Ce bouton permet d'afficher une nouvelle fenêtre listant toutes les lignes d'écritures avec lesquelles l'échéance sélectionnée a été pointée. Les lignes présentes dans cette fenêtre peuvent être des avoirs, des règlements et de remboursements. Pour consulter ou modifier le pointage exécuté entre l'échéance et n'importe laquelle de ces lignes, il vous suffit de cliquer sur Modifier. Choix des vues Une vue de l'échéancier Factures est proposé par défaut. Néanmoins les vues sont paramétrables afin de répondre aux besoins. Sauvegarder ou Fermer un échéancier Le bouton Sauvegarder permet de sauvegarder les dernières modifications faites dans l'échéancier sans le fermer. Le bouton Sauvegarder et Fermer permet à la fois de sauvegarder les dernières modifications et de le fermer. Le bouton Fermer entraîne la fermeture de l'échéancier sans sauvegarder les dernières modifications. Pointages La fenêtre Pointages permet d'effectuer les pointage entre les avoirs, les règlements, les remboursements et les échéances de facture. Pour effectuer le pointage d'une échéance, il suffit de cliquer sur le bouton Pointages disponible dans la barre de taches de la saisie journal. En-tête Cette partie non saisissable reprend les éléments saisis sur la ligne d'écriture (compte, date et le montant du règlement, Reste à affecter...). Le Reste à affecter se calcule automatiquement : il résulte automatiquement de la différence entre le montant du règlement et le montant total des échéances pointées. 53 EBP Comptabilité Open Line Pro Corps Cette partie affiche les échéances des factures et avoirs qui n'ont pas encore été totalement soldées. Aucune modification, aucune suppression ni aucun ajout de lignes d'échéances n'est possible dans cette zone. Seule la case à cocher Pointée ? est accessible : lorsqu'elle est cochée, elle permet d'imputer en totalité le montant affiché dans le champ Reste à affecter à une ligne d'échéance. Lorsqu'une échéance est rayée, cela signifie qu'elle a été "soldée" dans l'application de Gestion commerciale, c'est-à-dire que le règlement était supérieur ou inférieur au montant de l'échéance et qu'une écriture Perte ou Profit (comptes 658 ou 758) a été générée en comptabilité. Lorsqu'une échéance est en rouge, cela signifie qu'elle été pointée par une autre application et, donc, que ni pointage ni dépointage ne peuvent plus être effectués en comptabilité. La somme des Montants pointés de la grille ne peut être supérieure au montant du Reste à affecter de l'en-tête. Choix des vues Une vue de la fenêtre Pointages est proposée par défaut. Néanmoins les vues sont paramétrables afin de répondre aux besoins. Lors du transfert des factures d'acompte provenant d'autre module EBP, les échéances sur les comptes 4191 et/ou 4091, ne sont pas pointées. Il faudra donc faire le pointage en compta. Sauvegarder ou Fermer un échéancier Le bouton Sauvegarder permet de sauvegarder les dernières modifications faites dans l'échéancier sans le fermer. Le bouton Sauvegarder et Fermer permet à la fois de sauvegarder les dernières modifications et de le fermer. Le bouton Fermer entraîne la fermeture de l'échéancier sans sauvegarder les dernières modifications. Choix de l'échéance de l'avoir En Gestion commerciale, il est possible d'émettre des factures négatives possédant une ou plusieurs échéances. Lorsqu'elles sont transférées en comptabilité, ces factures négatives sont comptabilisées comme des avoirs mais conservent leurs échéances. Dans ce cas, lorsque vous cliquez sur le bouton Pointages d'une ligne d'avoir avec plusieurs échéances, la fenêtre Choix de l'échéance de l'avoir s'affiche : elle contient toutes les échéances de l'avoir sélectionné (= de la facture négative en Gestion commerciale). Il vous suffit de sélectionner l'une des échéances de cet avoir puis de cliquer sur Ok pour que la fenêtre de Pointages s'ouvre. Dès lors, le pointage d'une échéance de cet avoir avec une échéance de facture est possible de la même façon que pour un avoir ou un règlement (voir supra, paragraphe Pointages). Pour fermer cette fenêtre, sans traitement, il vous suffit de cliquer sur la croix rouge de la fenêtre. Règles d'accès aux échéances et aux pointages en fonction du type de ligne saisie Pour chaque ligne d'écriture saisie, le logiciel détermine automatiquement un type de ligne en analysant le compte, le sens de saisie et le type de journal. Ce type de ligne permet de définir quelle fenêtre est accessible (Echéancier de la facture ou Pointages), quelles lignes sont visibles et quelles actions y sont possibles. Ligne de type Facture Une ligne est de type Facture : - si le compte est de racine 411, qu'il est saisi au Débit, dans les journaux de type Ventes, Opérations ou A Nouveaux, - si le compte est de racine 401, qu'il est saisi au Crédit, dans les journaux de type Achats, Opérations Diverses et A Nouveaux. Sur une ligne de ce type, la saisie des échéances est possible soit en saisissant directement dans la colonne Date d'échéance, soit en cliquant sur le bouton Echéancier de la facture, soit en cliquant sur le bouton "+" de la colonne Date d'échéance. 54 MANUEL Seules les échéances de la facture en cours de saisie sont visibles. Aucun pointage n'est possible dans cette fenêtre. Ligne de type Avoir Une ligne est de type Avoir : - si le compte est de racine 411, qu'il est saisi au Crédit, dans les journaux de type Ventes ou A Nouveaux, - si le compte est de racine 401, qu'il est saisi au Débit, dans les journaux de type Achats ou A Nouveaux. Sur une ligne de ce type, la saisie des échéances est impossible. En revanche, en cliquant que le bouton Pointages, il est possible d'accéder à la fenêtre de pointage qui présente toutes les échéances de factures non encore soldées sur le compte. Il est possible de pointer un avoir avec des échéances factures jusqu'à ce que le Reste à affecter soit nul. Audelà tout nouveau pointage devient impossible. Ligne de type Règlement Une ligne est de type Règlement : - si le compte est de racine 411, qu'il est saisi au Crédit, dans les journaux de type Opérations Diverses ou Trésorerie, - si le compte est de racine 401, qu'il est saisi au Débit, dans les journaux de type Opérations Diverses ou Trésorerie. Sur une ligne de ce type, la saisie des échéances est impossible. En revanche, en cliquant que le bouton Pointages, il est possible d'accéder à la fenêtre de pointage qui présente toutes les échéances de factures et tous les avoirs non encore soldés sur le compte. Il est possible de pointer un règlement avec des échéances de facture jusqu'à ce que le Reste à affecter soit nul. Au-delà tout nouveau pointage d'échéance facture est impossible. Il est également possible de pointer un règlement avec des avoirs et cela sans limitation sur le Reste à affecter. Ligne de type Remboursement Une ligne est de type Remboursement : - si le compte est de racine 411, qu'il est saisi au Débit, dans les journaux de type Trésorerie, - si le compte est de racine 401, qu'il est saisi au Crédit, dans les journaux de type Trésorerie. Sur une ligne de ce type, la saisie des échéances est impossible. En revanche, en cliquant que le bouton Pointages, il est possible d'accéder à la fenêtre de Pointage qui présente toutes les échéances de factures et tous les avoirs non encore soldés sur le compte. Il est possible de pointer un règlement avec des avoirs et cela sans limitation sur le Reste à affecter. Il est également possible de pointer un remboursement avec des factures, à condition que le Reste à affecter soit positif (c'est-à-dire que le règlement a déjà été pointé avec des avoirs). BALANCE D'OUVERTURE Saisir la balance d'ouverture Accès : Quotidien - Saisie par journal - Saisir la balance d'ouverture OU Exercices/Clôtures - Exercices - Saisir la balance d'ouverture Cette fenêtre permet de saisir une reprise de balance au premier jour d'un exercice non clôturé. Il est donc ainsi possible de : - saisir des A Nouveaux qui proviendraient du même dossier mais qui auraient été saisis sur un autre logiciel ; - saisir manuellement sous la forme désirée les A Nouveaux d'un exercice à un autre, sans utiliser la fonction A Nouveaux prévue par le logiciel. Contenu de la fenêtre Vous pouvez obtenir ici des détails sur : - la présentation de cette fenêtre, - son contenu, - et ses fonctions. Néanmoins, vous trouverez ci-dessous quelques éléments primordiaux : Journal : Elle est obligatoirement comptabilisée sur un journal spécifique, créé par le logiciel. Seul le journal RAN de type A Nouveaux est disponible dans la liste. Mois : 55 EBP Comptabilité Open Line Pro Elle est obligatoirement comptabilisée sur le premier mois d'un exercice. Seul le premier mois du premier exercice non clôturé est donc disponible dans la liste. Jour : Elle ne peut être saisie qu'au premier jour de cet exercice. Coexistence d'un journal AN et d'un journal RAN sur le même exercice Il n'est pas possible de créer une balance d'ouverture sur un exercice dans lequel les A Nouveaux ont déjà été générés par le logiciel. Le journal RAN n'est pas automatiquement créé par défaut lors de la création du dossier : il n'apparaît dans le plan de journaux que lorsque qu'une écriture aura été sauvegardée dans cette fenêtre. Suppression de la balance d'ouverture Les lignes saisies dans la balance d'ouverture peuvent être modifiées ou supprimées une à une selon les mêmes règles que les autres lignes d'écritures. En revanche, en cas de besoin, il est possible de supprimer d'un seul geste les lignes saisies dans cette balance d'ouverture et ainsi que le journal RAN. Pour cela, il faut sélectionner l'exercice courant concerné puis sélectionner Outils - Balance d'ouverture - Supprimer la balance d'ouverture. Si la balance d'ouverture contient une écriture validée ou même si cette balance est clôturée mensuellement, alors sa suppression reste possible. Dans tous les cas, la suppression de la balance d'ouverture entraîne un enregistrement dans le journal des événements. RECHERCHE D'ÉCRITURES Recherche d'écritures Accès : Quotidien - Recherche d'écritures Cette liste présente toutes les lignes d'écriture comptabilisées dans la saisie journal, la saisie par écriture, la saisie pratique... Elle permet d'effectuer une recherche d'écriture, d'accéder à la saisie... Contenu de la liste Son contenu dépend de l'état de l'exercice courant : - si l'exercice courant est ouvert, alors toutes les lignes d'écritures des exercices ouverts sont visibles ; - si l'exercice courant est clôturé, alors seules les lignes d'écritures de cet exercice clôturé sont visibles. Les colonnes Jour, Pièce, N° de compte, Libellé, Débit, Crédit affichent pour chaque ligne les valeurs présentes en saisie. La colonne Origine informe du moyen par lequel la ligne a été comptabilisée : - Saisie journal : la ligne a été directement comptabilisée dans la saisie journal, - Mes achats : la ligne a été saisie par Mes achats, puis comptabilisée, - Mes ventes : la ligne a été saisie par Mes ventes, puis comptabilisée, - Saisie par guide : la ligne a été saisie par les guides, puis comptabilisée en saisie journal, Rechercher et trier des écritures Trois modes de tri et de recherche existent pour vous permettre de trouver une écriture. Chaque mode peut être utilisé indépendamment des autres, mais ils peuvent aussi être combinés : - Recherche dans la liste : Une zone existe dans la barre d'outils de la liste : elle est commune à toutes les listes de l'application. Vous pouvez saisir un caractère dans cette zone : instantanément, la liste se met à jour pour n'afficher que les lignes d'écritures comprenant votre recherche. - Recherche par les filtres : Un certain nombre de filtres vous sont proposés dans l'en-tête de la liste et en cliquant sur Filtrage avancé. Il vous suffit de sélectionner l'un de ces filtres, ou plusieurs d'entre eux, pour que toutes les lignes répondant aux critères sélectionnés soient affichées. 56 MANUEL Lorsque de nouveaux filtres sont définis, il est impératif de cliquer sur le bouton Actualiser la liste, de façon à mettre la liste à jour. - Tri par regroupement : Pour obtenir un résultat encoure plus précis, il est possible de procéder à des regroupements en glissant le titre des colonnes dans la zone grisée prévue à cet effet. Accéder à l'écriture comptable recherchée Lorsque vous avez sélectionné une ligne d'écriture dans la liste et que vous voulez accéder à l'écriture comptable, alors vous pouvez : - double cliquer sur la ligne désirée ; - faire Entrée sur la ligne désirée ; - sélectionner la tâche Modifier l'écriture comptable dans la barre de tâches ou le menu contextuel ; - sélectionner la tâche Saisie par journal dans la barre de tâches ou le menu contextuel. Créer une nouvelle écriture comptable Lorsque vous voulez créer une nouvelle écriture comptable, alors vous pouvez : - sélectionner Saisie par journal dans la barre de tâches ou le menu contextuel ; - sélectionner Nouvelle écriture comptable dans la barre de tâches ou le menu contextuel ; - sélectionner Saisir la balance d'ouverture dans la barre de tâches ou le menu contextuel. Contrôle des pointages Lors de la mise à jour du logiciel, il se peut que certains dépointages d'échéances aient été effectués d'office. Dans ce cas, une option Contrôle des pointages est automatiquement disponible dans l'en-tête de la liste. La case à cocher Lignes à contrôler permet d'afficher les lignes d'écriture contenant au moins une échéance qui a fait l'objet de ce type de dépointage. Sur chaque ligne, il est possible d'accéder à l'Echéancier de la facture ou à Pointages et de réaliser de nouveau les pointages en respectant les nouvelles règles. Après avoir accepter le pointage, les lignes disparaissent de la liste. Supprimer les écritures Pour supprimer une ou plusieurs écritures, il vous suffit de sélectionner une seule ligne des écritures que vous voulez supprimer puis d'activer la tâche Supprimer les écritures. Une fenêtre complémentaire, listant toutes les écritures que vous avez sélectionnées, s'affiche alors. Confirmer supprime définitivement toutes les écritures sélectionnées. Annuler vous permet d'abandonner purement et simplement l'opération de suppression. Enfin, une boîte de compte-rendu répertorie tous les traitements effectués. Certaines écritures ne peuvent en aucun cas être supprimées à partir de cette liste : - les écritures saisies dans des journaux de Trésorerie en pied de journal, - l'écriture présente dans le journal AN (A Nouveaux), - l'écriture saisie dans le journal RAN (Balance d'ouverture), - les écritures provenant de la saisie guidée ou de la saisie pratique. - les écritures validées, - les règlements provenant de l'application de Gestion commerciale. Conservation des filtres Tous les filtres sélectionnés dans la Recherche d'écritures sont conservés dans une même session et sur un même exercice. En revanche, si vous changez d'exercice courant ou fermez puis ré-ouvrez votre dossier, alors tous les filtres par défaut sont ré-appliqués. SAISIE AU KILOMETRE 57 EBP Comptabilité Open Line Pro Saisie au kilmomètre Accès : Quotidien – Saisie au kilomètre La Saisie au kilomètre vous permet de saisir très rapidement des opérations de nature et de mois différents sans changer de fenêtre : factures, règlements, opérations diverses … Il s’agit d’une fenêtre de saisie et non de consultation : une fois les écritures enregistrées, elles seront consultables et modifiables en Saisie par journal. La provenance des écritures sera visible en Recherche d’écritures. A l’ouverture de la Saisie au kilomètre, l’écran est vide : saisissez alors rapidement toutes les écritures souhaitées puis enregistrez à n’importe quel moment par Ctrl + S ou le bouton Sauvegarder, puis continuez à ajouter des écritures. Les écritures saisies restent visibles sur fond gris mais ne sont plus modifiables dans la fenêtre de Saisie au kilomètre. La Saisie au kilomètre vous permet également de saisir les dates d’échéance de vos factures, mais le pointage de l’échéancier devra s’effectuer en Saisie par journal ou dans l'échéancier interactif. Navigation dans la fenêtre de saisie La navigation entre les champs, les lignes et les écritures peut se faire entre les différents champs grâce aux touches Tab et Shift+Tab, à la touche Entrée, à la souris ou encore avec les flèches directionnelles. Choix de l’exercice Tous les exercices ouverts sont disponibles dans la saisie : choisissez l’exercice de saisie dans l’entête de la fenêtre. Colonnes par défaut • Journal : Vous pouvez saisir sur tous les types de journaux, sauf les journaux de type A Nouveaux et de type Trésorerie avec contrepartie pied de journal. • Date : La date est saisissable en totalité. Elle tient compte du paramétrage de la fiche du journal sélectionné (avec ou sans reprise de dates). • Pièce : La numérotation suit la numérotation paramétrée dans la fiche journal (avec ou sans reprise de pièce - en fonction du type de numérotation). Elle reste modifiable. Le numéro saisi dans la Saisie au kilomètre est un numéro "provisoire". En effet, il est possible qu'un autre utilisateur utilise ce même numéro avant que vous n'ayez sauvegardé votre travail. Si vous avez activé l'option Gestion des doublons dans les options du dossier, lorsque vous sauvegarderez votre saisie, alors un message vous signalera les doublons et vous proposera la renumérotation de vos pièces. Si vous n'avez pas activé cette option, vos numéros de pièces seront conservés en l'état. • Compte : Le compte peut être choisi dans le look-up ou crée directement en cours de saisie. Les comptes associés ne sont pas pris en compte en saisie au kilomètre. • Libellé : Un libellé est proposé par défaut en fonction de la règle définie sur le journal. Il reste modifiable. • Débit / Crédit : Le curseur est pré-positionné en fonction du sens de saisie défini sur la fiche du compte et du journal sélectionné. Vous pouvez équilibrer votre écriture en la soldant grâce à la touche F12 ou au bouton Equilibrer. • Date d’échéance : Cette colonne est renseignée sur les comptes de nature "Clients et comptes rattachés" et "Fournisseurs et comptes rattachés", lorsque vous saisissez dans un journal de type Achats, Ventes ou Opérations Diverses. Elle affiche la première date d'échéance calculée en fonction du Mode de règlement renseigné dans la fiche du compte. L'ouverture de l'échéancier peut être automatique (si vous avez sélectionné l'option Echéancier en cours de saisie dans la fiche du compte) ou manuelle (si vous cliquez sur le bouton "+" disponible dans le champ). • Moyen de paiement : Cette colonne est renseignée sur les comptes de nature "Clients et comptes rattachés" et "Fournisseurs et comptes rattachés", lorsque vous saisissez dans un journal de type Trésorerie. Ce champ est non obligatoire et vous permet de renseigner, si besoin, le moyen de paiement (chèque, virement...) par lequel vous réglez vos fournisseurs ou êtes réglés par vos clients. 58 MANUEL Champs obligatoires Pour passer à la ligne suivante, les champs suivants doivent obligatoirement être renseignés : • Journal • Date • Compte • Montant Tant que l'un de ces champs n’est pas renseigné, il vous sera impossible de passer à la ligne suivante. Affichage Un trait est automatiquement affiché à la fin d'une écriture dont l'équilibrage a été réalisé. Cet affichage a uniquement pour but de vous permettre de visualiser plus facilement votre Saisie au kilomètre. Tant que l'écriture courante n'est pas équilibrée, alors elle s'affiche en rouge. A l'équilibre, elle repasse en noir. Certains paramètres d'affichage peuvent être personnalisés dans Paramètres - Société - Général - Environnement de saisie, comme la grille horizontale, la grille verticale et la couleur des écritures déséquilibrées. Barre d’outils • Ajouter, insérer, supprimer : ces boutons vous permettent d'ajouter, d'insérer et de supprimer une ligne d'écriture. • Gestion des vues : ce bouton permet de modifier les vues et d'ajouter des colonnes optionnelles. • Monter, descendre : : ces boutons vous permettent de modifier l'ordre de priorité des lignes d'écritures. • Couper, coller, copier : ces boutons vous permettent de copier, couper et coller une ligne d'écriture. • Equilibrer (F12) : ce bouton et cette touche permettent de réaliser l'équilibre du journal. Sauvegarde La sauvegarde doit être une action volontaire de votre part. Elle s'effectue en cliquant sur le bouton Sauvegarder ou en utilisant la combinaison Ctrl+S. Elle ne tient pas compte de l'Option de saisie par journal activée dans Paramètres - Société - Options générales de saisie. Avertissements lors de l'enregistrement Les avertissements apparaissent uniquement lors de l'enregistrement de la Saisie au kilomètre. Ils sont de deux types. Avertissements non bloquants Ces avertissements vous signalent une anomalie, mais n'empêchent pas la génération de vos écritures en Saisie par journal. Montants négatifs : ce message apparaît si votre saisie contient des montants négatifs et que l'option Afficher en saisie les alertes sur les montants a été activée dans les options du dossier. Comptes non autorisés en saisie sur un type de journal / racines de comptes non autorisées dans un journal : ce message apparaît si votre saisie contient des "incohérences" entre les comptes et les journaux utilisés et que l'option Afficher en saisie les alertes sur les comptes a été activée dans les options du dossier. Gestion des doublons des numéros de pièces La gestion des doublons de numéros de pièce est effectuée lors de l'enregistrement de la Saisie au kilomètre, si l'option correspondante a été activée dans les options du dossier. A l'affichage de ces messages, les écritures s'enregistrent : toute modification devra donc s'effectuer en Saisie par journal. Avertissements bloquants Ces avertissements vous signalent une erreur, que vous devez d'abord corriger. Ils concernent : • Déséquilibre du journal • Ecriture composée d’une seule ligne • Compte bloqué • Mois clôturé • Champ obligatoire manquant 59 EBP Comptabilité Open Line Pro Totaux Une ligne de totalisation est présente en pied de masque : elle affiche le total des lignes débitrices et le total des lignes créditrices. Récapitulatif Un bouton Récapitulatif est disponible. Le récapitulatif présente une vue synthétique de votre Saisie au kilomètre : - il affiche les totaux des Débits, Crédits et Soldes pour chaque mois et chaque journal ; - il met en évidence les déséquilibres. Impression du brouillon Le bouton Impression du brouillon permet d'imprimer sous forme de brouillon les écritures saisies dans cette option. SAISIE PAR GUIDE Saisie guidée : principes Accès : Quotidien - Saisie par guide OU Paramètres - Modèles de guides de saisie La saisie par guide est une méthode qui permet d'automatiser la saisie et de comptabiliser une écriture dans un environnement comptable simple d'utilisation. Cette saisie s'articule autour de deux axes : - Modèles de guides : Un certain nombre de modèles de guide sont livrés par défaut : ils doivent permettre de répondre aux besoins les plus courants. Ils restent modifiables. La liste des modèles n'est pas exhaustive : vous pouvez créer autant de modèles que vous voulez, afin de répondre spécifiquement à vos besoins. Définir un modèle de guide, c'est : définir un modèle d'écriture, ayant ses caractéristiques propres. Ainsi lors de la saisie, il suffira d'appeler le modèle de guide désiré pour que tout ou partie de votre saisie soit automatisée. - Saisie par guide : Les écritures guidées sont les écritures qui ont été créées grâce aux modèles de guide. Elles peuvent être comptabilisés à la demande dans la saisie journal. Liste des écritures guidées Accès : Quotidien - Saisie par guides Les écritures guidées, déjà créées grâce à des modèles, sont affichées dans une liste dont le comportement est identique à celui défini dans toutes les listes. Les écritures guidées sont regroupées sous différents onglets : - Tous : cet onglet regroupe toutes les écritures guidées, quelque soit leur écriture de référence (Achats, Ventes, Trésorerie ou Opérations diverses) - Achats : cet onglet regroupe toutes les écritures guidées de type Achats. - Ventes : cet onglet regroupe toutes les écritures guidées de type Ventes. - Trésorerie : cet onglet regroupe toutes les écritures guidées de type Trésorerie. - Opérations diverses : cet onglet regroupe toutes les écritures guidées de types Opérations diverses. Chaque écriture guidée est précisément identifiée par un certain nombre de critères issus de l'écriture ellemême. 60 MANUEL Les écritures guidées Accès : Quotidien - Saisie par guides La saisie par guide est l'un des modes de saisie offerts par le logiciel. Elle peut être immédiatement utilisée, grâce aux modèles de guide livrés par défaut. Ces modèles de guide déterminent le schéma de l'écriture et les règles d'automatisation de la saisie. Choisir le bon modèle de guide ou créer un modèle de guide spécifique à des opérations particulières sont des opérations préalables indispensables pour profiter pleinement de ce mode de saisie automatisé. Les écritures guidées sont accessibles à partir de la liste des écritures guidées. Chaque écriture guidée se divise en deux onglets : Saisie et Notes Onglet Saisie En-tête de l'onglet Saisie Libellé Ce champ saisissable. Guide * Le choix du modèle de guide se fait au moyen de la liste déroulante, qui propose tous les modèles actifs existants. Type de journal Cette zone est grisée et non modifiable. Elle permet de savoir dans quel type de journaux le guide sera généré. Journal Cette zone est grisée et non modifiable. Elle permet de savoir dans quel type de journaux le guide sera généré. Mois * Ce champ propose par défaut le mois système Mois système = Mois de l'ordinateur ou le mois le plus proche de ce mois système dans l'exercice courant. Si votre exercice courant est ouvert, alors vous pourrez créer de nouvelles Saisies par guide sur cet exercice et sur tous les exercices ouverts. En revanche, si votre exercice courant est clôturé, alors vous ne pourrez plus créer de nouvelles Saisies par guide sur cet exercice et vous pourrez uniquement accéder aux Saisies pratiques comptabilisées sur cet exercice clôturé. Numéro Ce numéro est automatiquement géré par le logiciel. Il est unique à chaque type de guide (préfixe alphabétique), à chaque guide (suffixe numérique) et à chaque exercice. Lorsque le guide est comptabilisé en saisie par journal, alors ce numéro de guide est affiché dans la colonne n° de document. Etat Ce champ est automatiquement géré par le logiciel. - En cours : Le guide n'a pas encore été comptabilisé. C'est-à-dire que le contenu du guide reste à tout moment modifiable, que les lignes qui y sont enregistrées ne sont pas comptabilisées et qu'elles n'apparaissent donc dans aucune impression ni aucune consultation. - Comptabilisé : Le guide a été comptabilité. C'est-à-dire que les lignes qu'il contient ont été comptabilisées sous forme d'écriture dans la saisie par journal et qu'elles apparaissent donc dans les impressions et les consultations. Aucune modification ni suppression ne peut plus être faite dans le guide lui-même. En revanche les modifications et suppressions restent possibles dans le journal dans lequel l'écriture a été comptabilisée. - Modifié en saisie par journal : Le guide a été comptabilisé puis au moins l'une des lignes de ce guide a été modifié. Corps de l'onglet Saisie Le corps du guide est accessible uniquement si tous les champs obligatoires de l'en-tête ont été renseignés. Dès qu'une zone du guide est saisie dans le corps du guide, alors l'en-tête n'est plus modifiable. Le corps du guide se divise en différentes colonnes : - Date * : Ce champ permet de saisir ou de sélectionner un jour dans le mois de l'exercice courant. 61 EBP Comptabilité Open Line Pro - Compte : Ce champ propose une liste déroulante de comptes pré-sélectionnés en fonction du type de guide. - N° de pièce : Ce champ affiche par défaut la valeur définie dans le modèle du guide. Si le journal dans lequel vous voulez générer votre écriture est paramétré en numérotation automatique, vous pouvez être amené à utiliser un numéro de pièce déjà utilisé par un autre utilisateur ou dans un autre masque de saisie. Pour être informé des doublons éventuels, il vous suffit de sélectionner l'option Afficher les alertes sur les numéros de pièces en doublon dans les options du dossier. - Libellé * : Ce champ affiche par défaut la valeur définie dans le modèle du guide. - Montant débit : Le champ accepte les montants positifs avec décimales. - Montant crédit : Le champ accepte les montants positifs avec décimales. Outre toutes les fonctions disponibles dans les listes, il existe deux boutons spécifiques : - Sauvegarder : Ce bouton permet de sauvegarder un guide avec tout ce qu'il contient, tout en le laissant modifiable et sans générer aucune écriture en comptabilité. - Comptabiliser : Ce bouton permet de sauvegarder un guide mais aussi de générer l'écriture en comptabilité. Lorsque que le bouton Comptabiliser est activé, alors le guide ne peut plus être modifié et son état passe à Comptabilisé. Créer des formules sur les numéros de pièce, les libellés et les calculs dans les modèles de guide Des formules existent déjà par défaut dans les modèles de guide livrés par défaut. Néanmoins, pour répondre à des besoins spécifiques, vous pouvez créer les formules qui vous conviennent. Une fois créées, ces formules pourront être sélectionnées dans les modèles de guide et donc permettre de mieux automatiser la saisie guidée. N° Pièce et libellé Il est possible de créer des numéros de pièce et des libellés pour implémenter le modèle de guide de saisie. La modification ou la suppression est impossible dés qu'un guide est utilisé. Libellé : Ce champ saisissable permet d'identifier le n° pièce ou le libellé créé. Préfixe : Ce champ permet de sélectionner un des n° pièce ou libellé prédéfini. Suffixe : Ce champ permet d'identifier les lignes d'écriture d'un guide. Formules Sans Formule : Permet de saisir un montant dans le modèle de guide de saisie sans aucun calcul particulier. TVA à partir du HT : Permet de calculer la TVA à partir du HT de la ligne de dessus. TVA à partir du TTC : Permet de calculer la TVA à partir du TTC de la ligne de dessus. Solde : Permet de calculer le solde du guide. SAISIE PRATIQUE Mes achats, Mes ventes La saisie pratique est un mode de saisie non comptable qui permet de saisir facilement une écriture. Comment saisir une facture d’achat ? Accès : Quotidien – Mes achats Cliquez sur Ajouter ou utilisez la touche [Inser] : vous obtenez la fenêtre de saisie de la facture. - Indiquez la date de la facture. - Conservez le numéro de pièce proposé automatiquement ou indiquez le numéro de la facture. - Choisissez un fournisseur dans la liste. Si le fournisseur n’est pas présent, cliquez sur le bouton Nouveau fournisseur, indiquez son nom, éventuellement son adresse et sauvegardez la fiche. - Complétez la description si vous souhaitez apporter une précision. - Saisissez le total TTC. 62 MANUEL - Indiquez le type de TVA : le montant se calcule automatiquement. Vérifiez la cohérence avec la facture. Le montant doit être modifié s’il est différent de votre document. - Choisissez la nature d’achat correspondant au type de la facture et contrôlez le montant. - Un message vous propose ensuite d’effectuer une nouvelle saisie : répondez Oui pour continuer. Il est possible de solder automatiquement la facture en sélectionnant F12. Dans ce cas, le solde de la facture se place dans le champ Montant HT. Comment saisir une facture de vente ? Accès : Quotidien – Mes ventes Cliquez sur Ajouter ou utilisez la touche [Inser] : vous obtenez la fenêtre de saisie de la facture. Remplissez les différents champs de la même façon que pour la facture d’achat. Comment saisir un avoir, une remise ? Pour saisir un avoir, saisissez une facture avec des montants négatifs. Pour saisir une remise, utilisez la nature « Remises obtenues » ou « Remises accordées ». Création d'un nouveau compte Lors de la création d'un compta à partir d'un masque de saisie pratique, une fenêtre de création de compte simplifiée est proposée. Saisie sur plusieurs exercices Si votre exercice courant est ouvert, alors vous pourrez créer de nouvelles Saisies pratiques sur cet exercice et sur tous les exercices ouverts. En revanche, si votre exercice courant est clôturé, alors vous ne pourrez plus créer de nouvelles Saisies pratiques sur cet exercice et vous pourrez uniquement accéder aux Saisies pratiques comptabilisées sur cet exercice clôturé. Gestion des doublons de numéros de pièce Si le journal dans lequel vous voulez générer votre écriture est paramétré en numérotation automatique, vous pouvez être amené à utiliser un numéro de pièce déjà utilisé par un autre utilisateur ou dans un autre masque de saisie. Pour être informé des doublons éventuels, il vous suffit de sélectionner l'option Afficher les alertes sur les numéros de pièces en doublon dans les options du dossier. Ma trésorerie Comment saisir un encaissement client ? Accès : Quotidien – Ma trésorerie Cliquez sur Ajouter ou utilisez la touche [Inser] et choisissez Encaissement. - Sélectionnez Encaissement client. - Indiquez la date de l’encaissement. - Choisissez la banque ou la caisse concernée. - Indiquez un n° de pièce, une description, le montant de l’encaissement. - Choisissez un client dans la liste. Si le client n’est pas présent, cliquez sur le bouton Nouveau client, indiquez son nom, éventuellement son adresse et sauvegardez la fiche. - A la fin de la saisie, un message vous propose de saisir une nouvelle opération : répondez Oui pour continuer. Comment saisir un décaissement fournisseur ? Accès : Quotidien – Ma trésorerie Cliquez sur Ajouter ou utilisez la touche [Inser], et choisissez Décaissement. 63 EBP Comptabilité Open Line Pro Sélectionnez Décaissement fournisseur et remplissez les différents champs comme pour l’encaissement client. Comment saisir une autre opération ? Le bouton Ajouter vous permet de saisir quatre types d’opérations : - Les encaissements - Les décaissements - Les virements (de banque à banque, de banque à caisse …) - Les remises de chèques. Pour les encaissements et les décaissements, des sous-catégories vous permettent de choisir un type d’opération plus précis : encaissement client, encaissement d’effets avec frais, décaissement fournisseur, entretien, essence, frais bancaires, etc. Laissez-vous guider par le masque de saisie. Tous les champs ne sont pas obligatoires. Par exemple, si vous saisissez des frais bancaires sans TVA, laissez le champ du montant de TVA vide. Création d'un nouveau compte Lors de la création d'un compta à partir d'un masque de saisie pratique, une fenêtre de création de compte simplifiée est proposée. Saisie sur plusieurs exercices Si votre exercice courant est ouvert, alors vous pourrez créer de nouvelles Saisies pratiques sur cet exercice et sur tous les exercices ouverts. En revanche, si votre exercice courant est clôturé, alors vous ne pourrez plus créer de nouvelles Saisies pratiques sur cet exercice et vous pourrez uniquement accéder aux Saisies pratiques comptabilisées sur cet exercice clôturé. Gestion des doublons de numéros de pièce Si le journal dans lequel vous voulez générer votre écriture est paramétré en numérotation automatique, vous pouvez être amené à utiliser un numéro de pièce déjà utilisé par un autre utilisateur ou dans un autre masque de saisie. Pour être informé des doublons éventuels, il vous suffit de sélectionner l'option Afficher les alertes sur les numéros de pièces en doublon dans les options du dossier. CONSULTATION/LETTRAGE Consultation de compte Accès : Quotidien - Consultation/Lettrage OU Consultation - Consultation/Lettrage La consultation de compte permet d'afficher l'ensemble des lignes d'écritures enregistrées sur un compte de type Détail et sur un seul exercice. Cette consultation permet aussi bien de connaître le solde réel d'un compte à un instant donné, que de procéder aux lettrages qui s'imposent ou encore d'effectuer des recherches... La combinaison de différents filtres permet d'affiner la sélection des lignes d'écritures à afficher. Filtres Ces filtres sont mémorisés : Les dernières sélections effectuées sont conservées ; elles seront reprises à l'identique lors du prochain affichage de la fenêtre de consultation. Filtre sur les comptes, Filtre sur la période, Filtre sur le statut des lignes, Filtre sur le type de ligne. Sélection de l'exercice Les dates d'exercice proposées par défaut sont celles de l'exercice courant. 64 MANUEL Lorsque cet exercice courant est ouvert, alors tous les exercices ouverts sont accessibles. Vous pouvez donc sélectionner l'exercice que vous voulez consulter sans être obligé de changer d'exercice courant. Pour cela, il vous suffit d'ouvrir la liste déroulante disponible dans le champ Exercice. Lorsque l'exercice courant est clôturé, alors seul l'exercice courant est accessible. Sélection du compte La sélection du compte se fait dans l'en-tête de la fenêtre de consultation, champ Identification - Compte. Le compte peut être saisi directement dans ce champ ou sélectionné dans la liste déroulante qui reprend l'intégralité des comptes existants sur l'exercice courant. Un bouton situé à gauche de cette liste déroulante permet d'ouvrir la fiche du compte sélectionné. Dès que le numéro du compte est renseigné, alors les données de base de ce compte sont automatiquement mises à jour : - Intitulé du compte, - Cumul de tous les montants débiteurs saisis sur ce compte pendant tout l'exercice courant, - Cumul de tous les montants créditeurs saisis sur ce compte pendant tout l'exercice courant, - Solde de ce compte au dernier jour de l'exercice courant. Ces données de base sont totalement indépendantes des choix effectués sur les filtres comme de la date système (= date et heure de l'ordinateur). Affichage des lignes d'écriture L'affichage des lignes d'écritures dans la consultation reprend la majorité des informations renseignées dans le masque de saisie (Journal, Date, Pièce, Libellé, Débit/Crédit). En revanche, à l'inverse de la saisie, les lignes d'écritures sont par défaut affichées dans l'ordre chronologique. L'affichage des lignes d'écritures est directement dépendant des choix effectués sur les filtres. Certaines lignes peuvent apparaître grisées et en italique : il s'agit des lignes qui répondent aux critères de filtrage sur l'exercice courant mais qui ont été lettrées sur un exercice postérieur. Le délettrage de ces lignes n'est d'ailleurs uniquement possible que sur l'exercice au cours duquel elles ont été lettrées. Dans le pied de la zone d'affichage, une ligne de totalisation est affichée : elle cumule en temps réel la somme des montants débiteurs et des montants créditeurs des lignes affichées. Enfin, le Solde progressif est recalculé en temps réel en fonction des seules lignes affichées. Lettrage et délettrage manuel Il est possible de lettrer ou delettrer des lignes d'écritures d'un compte directement dans la fenêtre de Consultation sans être obligé d'accéder à la fenêtre de Lettrage ; pour cela, il faut que cette option soit paramétrée dans la fiche compte. Le fonctionnement du lettrage, la sélection des lignes, l'utilisation de la ligne de totalisation, l'attribution du code lettrage... sont les mêmes que dans ceux définis dans la fenêtre de Lettrage à proprement parler. Lettrage automatique Une fonction permet d'effectuer le lettrage automatique des lignes d'écritures d'un compte. Autres actions possibles à partir de la consultation Accès à la saisie par journal : En double cliquant sur une ligne d'écriture, en sélectionnant Saisie par journal dans le menu contextuel Menu contextuel = clic droit de la souris. ou en cliquant sur le bouton, il est possible d'être automatiquement positionné sur cette ligne d'écriture dans la saisie journal ayant servie à l'enregistrer. Voir document : Il est possible d'accéder au document d'origine ayant permis l'enregistrement de la ligne d'écriture : il peut s'agir, par exemple, de la facture transférée par la Gestion commerciale. 65 EBP Comptabilité Open Line Pro Cacher le filtre/Afficher le filtre : En cliquant sur le bouton Cacher le filtre ou Afficher le filtre, il est possible d'afficher ou de masquer une ligne de filtre qui se positionne immédiatement avant les lignes d'écritures. Ce filtre contient des champs saisissables et permet d'affiner les sélections effectuées grâce aux filtres comptables mentionnés dans les paragraphes précédents. Rafraîchir : Ce bouton permet de mettre à jour l'affichage de la fenêtre de consultation, lorsque celui-ci a été modifié par une action effectuée dans une autre fenêtre (lettrage, saisie journal...). Facture non parvenue ou à émettre Ce bouton permet d'accéder à la fenêtre de paramétrage Facture/Avoir à emettre ou Facture/Avoir à recevoir et de générer l'extourne de l'écriture à laquelle cette ligne appartient. Charge ou produit constaté d'avance Ce bouton permet d'accéder à la fenêtre de paramétrage Charges ou Produits constatés d'avance et de générer la régularisation puis l'extourne de la ligne sélectionnée. Principes de lettrage et de délettrage Accès : Le lettrage est possible à partir la fenêtre de Consultation comme à partir de la fenêtre de Lettrage. Principes du lettrage Le lettrage consiste à : - sélectionner sur un compte au moins deux lignes d'écritures dont les montants s'équilibrent et qui ont trait à une opération commune, - puis à appliquer un même code alphanumérique appelé "code lettrage" ainsi qu'une même date de lettrage à ces lignes. Une facture n° 1234 de 1000 € est émise le 18/02/2008 au client DUPONT. Le 25/02/2008, le client Dupont adresse un chèque de 500 €, référencé 1234. Le 10/03/2008, le client Dupont adresse un nouveau chèque de 500 €, référence 1234. Ces deux règlements peuvent être identifiés comme venant solder la facture émise. Dès lors, ses trois lignes d'écriture peuvent être sélectionnées dans le compte du client DUPONT pour être identifiées par un même code et une même date de lettrage. La date de lettrage est la date système Date système = date et heure de l'ordinateur. à laquelle le lettrage a été effectué. Le lettrage peut être effectué aussi bien dans la fenêtre de Consultation que dans la fenêtre de Lettrage simplifié. Activer l'option sur le compte Pour que le lettrage ou le délettrage soient possibles, il faut que le compte soit de type Détail et que l'option "Autoriser le lettrage" soit activée sur sa fiche compte. Sélection des lignes La sélection des lignes peut se faire de deux façons différentes : - Soit grâce à la souris seule, en cochant la case située sur chaque ligne à l'extrême gauche de la fenêtre. - Soit en combinant le clavier et la souris (touche Ctrl + clic gauche). - Soit encore en combinant différentes touches du clavier (touche Ctrl + barre d'espace). Dans tous les cas, les lignes sélectionnées sont mises en surbrillance. En pied de masque, un "total des lignes sélectionnées" apparaît. - Cette ligne de totalisation est calculée en temps réel au fur et à mesure des sélections des lignes d'écritures. - Elle permet de contrôler immédiatement l'équilibrage de ces lignes qui conditionne l'exécution du traitement. Choix des boutons Le choix des boutons dépend du type des lignes sélectionnées. Si aucune des lignes sélectionnées n'est lettrée et que ces lignes sont équilibrées, alors le bouton "Lettrer" est accessible. 66 MANUEL Dans tous les autres cas, seul le bouton "Délettrer" est accessible. Option de lettrage automatique Une fonction de lettrage automatique est disponible. Gestion du code lettrage lors du lettrage de lignes d'écriture Lorsque des lignes non lettrées dont les montants s'équilibrent sont sélectionnées et que le lettrage est demandé, alors le "Prochain code lettrage" renseigné sur la fiche compte est proposé par défaut. Si le code lettrage proposé est accepté, alors : - le code lettrage proposé et la date de lettrage sont affectés à chacune des lignes sélectionnées, - un prochain code lettrage est calculé puis est reporté sur la fiche compte. Si le code lettrage proposé par défaut est modifié, alors : - le code lettrage saisi et la date de lettrage sont affectés à chacune des lignes sélectionnées, - un prochain code lettrage est calculé par rapport au code lettrage saisi puis est reporté sur la fiche compte. Gestion du code lettrage lors du délettrage des lignes d'écriture Lorsque des lignes lettrées dont les montants s'équilibrent et dont les codes lettrage sont identiques sont sélectionnées et que le délettrage est demandé, alors le code lettrage et la date de lettrage sont supprimés de toutes les lignes sélectionnées. La suppression de ce lettrage est sans impact sur le champ "Prochain code lettrage" de la fiche compte. Options de délettrage Le délettrage s'opère : - sur toutes les lignes sélectionnées déjà lettrées, - mais aussi sur les toutes lignes non sélectionnées possédant le même code lettrage. Pour faciliter le délettrage, trois options sont disponibles en cliquant sur le bouton "Délettrer" de la barre d'outils : Délettrer par compte : cette action permet de délettrer en une seule opération toutes les lignes déjà lettrées sur ce compte. Délettrer par code : cette action permet de définir une fourchette de codes lettrage puis de délettrer toutes les lignes d'écritures déjà lettrées sur lesquelles ces codes lettrage apparaissent et, cela, quelque soit leur date de lettrage. Délettrer par date : cette action permet de définir une fourchette de dates de lettrage puis de délettrer toutes les lignes d'écritures déjà lettrées sur lesquelles ces dates apparaissent et, cela, quelque soit leur code de lettrage. RELEVÉ BANCAIRE Liste des relevés bancaires Accès : Quotidien - Relevé bancaire La gestion des relevés est commune à toutes les listes. La liste des relevés permet d'accéder aux relevés. Les relevés bancaires permettent d’effectuer le rapprochement bancaire automatique, par l’import des fichiers bancaires à la norme Etebac 3. Ils nécessitent au préalable la création des banques. La création de la fiche Relevé bancaire est également possible directement dans l’option de rapprochement bancaire automatique. Il est possible de supprimer les anciens relevés ou les relevés entièrement pointés. La suppression d’un relevé n’entraînera aucun dépointage dans votre comptabilité. 67 EBP Comptabilité Open Line Pro Fiche relevé bancaire Accès : Quotidien – Relevé bancaire La gestion de la fiche relevé bancaire est commune à l’ensemble des fiches. La fiche de relevé bancaire est accessible à partir de la liste des relevés. Créer une fiche de relevé bancaire est une opération préalable obligatoire, lorsque que vous souhaitez effectuer des rapprochements bancaires automatiques. En-tête de la fiche relevé bancaire • Banque La banque peut être saisie ou sélectionnée grâce à la liste déroulante. Il s’agit de la banque à laquelle appartient le relevé bancaire. Ce champ est obligatoire. • N° Le numéro ne peut pas être saisi par l’utilisateur et sera calculé automatiquement par le logiciel à l’enregistrement de la fiche : il reprend le code de la banque auquel s’ajoute un numéro sur 5 chiffres, automatiquement incrémenté. BQ00001 • Date de l’ancien solde, Ancien solde, Date du nouveau solde, Nouveau solde Ces informations seront automatiquement renseignées après l’import du fichier de relevé bancaire. Dans le cas contraire, les champs restent saisissables. Ils ne sont présents qu’à titre informatif. Importer un fichier de relevé bancaire Format bancaire Si vous souhaitez importer un fichier de relevé bancaire à la norme Etebac 3 (norme bancaire), cliquez sur Importer + Importer un relevé bancaire et sélectionnez le fichier à importer. L’import du fichier permet de remplir les champs de l’entête "Date de l’ancien solde", "Ancien solde", "Date du nouveau solde", "Nouveau solde" ainsi que les lignes de relevé. Import paramétrable Si vous souhaitez importer un fichier sans format particulier, cliquez sur Importer + Import paramétrable. Etape : Destination et source de l’import Choisissez le type de fichier à importer : - Relevé bancaire avec colonnes « Débit » et « Crédit » signifie que les montants au débit et les montants au crédit sont dans 2 colonnes différenciées. - Relevé bancaire avec colonnes « Montant » signifie que les montants sont dans une seule colonne, et c’est le sens (positif ou négatif) qui détermine si le montant est un débit ou un crédit. - Relevé bancaire avec colonnes « Montant » et « Sens » signifie les montants sont dans une seule colonne, et qu’une colonne supplémentaire indique le sens, « D » pour débit et « C » pour crédit. Sélectionnez le fichier à importer. Choisissez un paramétrage précédemment effectué et enregistré. Etape : Codage du fichier Champs délimités ou Champs en largeur fixe : le choix est automatique en fonction du contenu fichier. - "Champs délimités" signifie que les champs du fichier sont séparés par un caractère (par exemple le pointvirgule, la virgule, l’espace, la tabulation …). - "Champs en largeur fixe" signifie que les champs du fichier sont alignés en colonne. Commencer l’import à la ligne … permet d’indiquer le n° de la 1ère ligne à importer (dans le cas où les fichiers contiennent une entête à ignorer). Ligne d’entête : la première ligne contient le nom des champs : à cocher lorsque le fichier contient une ligne d’entête avec le nom des champs à importer, ce qui facilitera l’association des colonnes et des champs. Etape : Largeur des champs : uniquement avec des champs en largeur fixe Grâce à la souris, tracez des traits pour séparer les champs. Pour vous aider, une règle affiche le nombre de caractères. Etape : Séparateurs / Identificateurs : uniquement avec des champs délimités Indiquez le caractère séparateur des champs. Indiquez si besoin le caractère délimitant les champs (l’identificateur guillemet par exemple). 68 MANUEL Etape : Association Associez chaque champ avec la colonne correspondante. Indiquez un nom au paramétrage si vous souhaitez l’utiliser ultérieurement. Ainsi au prochain import d’un fichier de même structure, vous n’aurez pas à refaire tout le paramétrage, vous pourrez le sélectionner à l’étape de début. Ces différents formats de date sont acceptés : année sur 2 ou 4 caractères ; avec ou sans séparateur de type /. - JJMMAA - JJ/MM/AA - JJMMAAAA - JJ/MM/AAAA Lignes de relevé bancaire Il est possible de saisir les lignes de relevé en remplissant les différents champs. Vous pouvez également modifier ou supprimer des lignes importées ou saisies. Ces lignes n’ont pas d’impact sur votre comptabilité : elles restent néanmoins importantes pour pouvoir mener à bien vos rapprochements bancaires. La suppression d’une ligne de relevé pointée n’entraînera aucun dépointage dans votre comptabilité. RAPPROCHEMENT BANCAIRE Liste des rapprochements Accès : Quotidien - Rapprochement La gestion de la liste des rapprochements est commune à toutes les listes. Un compte peut faire l'objet d'un rapprochement s'il remplit toutes ces conditions simultanément : - Il est de nature Compte pour rapprochement. - Il est défini comme étant compte de contrepartie d'un journal de type Trésorerie. - L'option Type de rapprochement par compte ou Type de rapprochement par journal est sélectionnée dans la fiche de ce compte. Création d'un nouveau rapprochement Lors de la création d'un rapprochement, une boîte de dialogue s'affiche. Il faut obligatoirement y renseigner les trois champs suivants : Le compte à rapprocher, qui peut être saisi directement ou sélectionné grâce à la liste déroulante. Automatique : Lorsque la case est cochée alors il est possible de visualiser et pointer les relevés bancaires appartenant à la même banque que le compte à rapprocher. Il est ensuite possible d'effectuer au choix un pointage manuel ou un pointage automatique. Le libellé du rapprochement, qui est saisissable et laissé au libre choix de l'utilisateur. La date de rapprochement, qui peut être saisie ou sélectionnée grâce au calendrier, en veillant à respecter les conditions suivantes : - elle doit être comprise dans l'exercice courant ; - elle doit être postérieure à la dernière date de rapprochement utilisée pour créer un rapprochement sur le même compte. Deux actions sont possibles sur cette boîte de dialogue : Valider : Pour valider les éléments saisis ou sélectionnés dans la boîte de dialogue et accéder directement au rapprochement. Annuler : Pour fermer la boîte de dialogue sans créer le rapprochement. Les trois éléments constitutifs du rapprochement (compte, libellé et date de rapprochement) ne sont plus modifiables dès que le rapprochement est créé. 69 EBP Comptabilité Open Line Pro La date de rapprochement détermine l'extraction des lignes d'écriture : seules les lignes d'écriture possédant une date d'écriture antérieure ou égale à la date de rapprochement seront visibles dans le rapprochement créé. Les écritures simulées ne sont pas prises en compte dans cette extraction. Suppression d'un rapprochement La suppression d'un rapprochement est possible, même si des pointages ont déjà été effectués sur ce rapprochement. En revanche, seule la suppression du dernier rapprochement existant pour un compte sur tous les exercices du dossier est possible. Rapprochement bancaire manuel Accès : Quotidien - Rapprochement La gestion de la fenêtre de rapprochement est commune à toutes les fiches. Les rapprochements bancaires sont accessibles à partir de la liste des rapprochements. Principes du rapprochement bancaire Le rapprochement bancaire est un document qui permet de vérifier la concordance entre le compte "Banque" tenu par l'entreprise et le relevé bancaire adressé périodiquement par la banque. Ce document est obtenu en attribuant un code pointage et une date de pointage (correspondant à la date de rapprochement) à toutes les lignes d'écriture qui figurent à la fois dans le compte "Banque" de l'entreprise et dans le relevé bancaire. Le rapprochement bancaire doit être équilibré, c'est-à-dire que l'écart de rapprochement doit afficher un solde nul (0,00). La fenêtre de rapprochement est divisée en plusieurs parties Les Paramètres Les paramètres affichent des données dépendantes des éléments que vous avez saisis dans la boîte de création du rapprochement : Numéro de compte à rapprocher, Date de rapprochement, Solde du compte à rapprocher tel qu'il ressort de votre comptabilité à la Date du rapprochement. Dès que le rapprochement est créé, ces paramètres ne sont plus modifiables. La zone Ecart Solde du relevé : Dans ce champ doit être saisi le solde réel du compte à rapprocher à la date de rapprochement figurant sur le relevé de compte adressé par l'établissement bancaire. Si le solde final de ce relevé est créditeur, alors le montant à saisir doit être positif. Si le solde final de relevé est débiteur, alors le montant à saisir doit être négatif. Solde des lignes non pointées : Ce solde représente la différence entre la somme des montants débiteurs et la somme des montants créditeurs de toutes les lignes comptabilisées sur le compte à rapprocher, qui ne possèdent pas encore code pointage et, ce, jusqu'à la date de rapprochement. Ecart de rapprochement : Ce champ doit afficher un montant nul (0,00) pour que le rapprochement soit équilibré. Le montant calculé correspond à la différence existant entre le Solde du compte, le Solde du relevé et les Solde des lignes non pointées. Le filtre sur les lignes à afficher Trois options existent dans ce filtre, elles sont accessibles grâce à la liste déroulante : Toutes : Toutes les lignes d'écritures possédant ou non un code pointage et ayant une date d'écriture antérieure ou égale à la date de rapprochement sont affichées. Rapprochées : Seules les lignes d'écritures possédant un code pointage et ayant une date d'écriture antérieure ou égale à la date de rapprochement sont affichées. Non rapprochées : 70 MANUEL Seules les lignes d'écritures ne possédant pas de code pointage mais ayant une date d'écriture antérieure ou égale à la date de rapprochement sont affichées. Les lignes non rapprochées représentent toutes les opérations en suspens qui devront être pointées dans l'avenir. Ce filtre est proposé systématiquement lors de l'ouverture d'un rapprochement. Lors du pointage ou du dépointage d'une ligne d'écriture, l'affichage des lignes est mis à jour en temps réel. Ainsi, par exemple, si le filtre des lignes à afficher est à "Non rapprochées", alors chaque ligne "disparaît" de l'affichage au fur et à mesure de l'avancement du pointage. Chacune de ces lignes peut ensuite être retrouvée dans les filtres "Toutes" ou "Rapprochées" avec la mention du code et de la date de pointage qui leur a été attribués. Le prochain code pointage Le code pointage est par défaut à "Ok". Il peut être modifié de deux façons différentes : - Soit en saisissant directement dans le champ "Prochain code pointage". Dans ce cas, ce nouveau code pointage devient le code pointage par défaut et est proposé lors de tous les pointages ultérieurs. - Soit en saisissant directement ce code sur la ligne d'écriture en cours de pointage. Dans ce cas, le code saisi sur la ligne est recopié dans le champ "Prochain code pointage" et est proposé par défaut lors de tous les pointages ultérieurs. Dans tous les cas, la modification de ce code est sans impact sur les lignes d'écritures déjà pointées. Le corps du rapprochement Le corps du rapprochement affiche toutes les lignes d'écritures correspondant aux critères de filtrage définis dans la zone "Paramètres" et dans le filtre sur les "lignes à afficher". Le pointage et le dépointage dans un rapprochement Chaque ligne d'écriture peut être pointée ou dépointée indépendamment des autres lignes et cela de différentes façons : - Soit en double cliquant sur une ligne. - Soit en saisissant ou en supprimant les caractères du code pointage. - Soit en faisant "Entrée" sur la ligne désirée. - Soit en activant les boutons Pointer et Dépointer. Des groupes de lignes d'écritures peuvent être pointés en une seule opération en activant le bouton Pointer par Date qui ouvre la boîte de dialogue dans laquelle il faut renseigner : - Code pointage : Ce code pointage est par défaut le "Prochain code pointage" défini dans la fenêtre de rapprochement, mais peut être modifié. - Pointer toutes les lignes jusqu'au : La date de rapprochement est proposée par défaut mais peut être modifiée, soit en saisissant directement dans le champ, soit en sélectionnant la date dans le calendrier. - Si l'exécution du pointage est demandée, alors toutes les lignes d'écriture saisies à une date antérieure ou égale à la date limite et non encore pointées seront pointées avec le code pointage défini. Des groupes de lignes d'écritures peuvent être dépointés en une seule opération en activant le bouton Dépointer par code qui ouvre la boîte de dialogue dans laquelle il faut renseigner : - La fourchette de codes de pointage à supprimer : Par défaut, les codes proposés sont les codes pointage existants sur le rapprochement affiché. Ils peuvent être modifiés de façon à restreindre la fourchette proposée. - Si l'exécution du dépointage est demandée, alors toutes les lignes d'écritures affichées dans le rapprochement et possédant les codes pointage définis sont dépointées. Cette action est sans impact sur les lignes d'écritures pointées avec ces mêmes codes sur d'autres rapprochements que celui affiché. Les autres actions possibles dans un rapprochement Saisie : En sélectionnant une ligne d'écriture dans le rapprochement, il est possible d'accéder à la fenêtre de saisie en étant directement positionné sur la ligne d'origine. Consultation : En sélectionnant une ligne d'écriture dans le rapprochement, il est possible d'accéder à la fenêtre de consultation du compte concerné en étant directement positionné sur la ligne. Afficher/cacher le filtre : En cliquant sur ce bouton, il est possible de faire apparaître ou disparaître une ligne de filtre supplémentaire. Cette ligne se positionne juste avant la première ligne d'écriture dans le corps du rapprochement ; ces champs sont saisissables et permettent de faciliter la recherche des lignes. Vues : Une vue du rapprochement est proposée par défaut. Néanmoins, les vues sont paramétrables en fonction des besoins. Lignes affichées dans le rapprochement mais pointées sur un autre rapprochement 71 EBP Comptabilité Open Line Pro Des lignes d'écritures peuvent être affichées dans un rapprochement mais être pointées sur un rapprochement postérieur au rapprochement affiché. Dans ce cas, ces lignes sont affichées en grisé et en italique et mentionnent la date de rapprochement, le code de rapprochement et le libellé du rapprochement sur lequel le pointage a été effectué. Toute action sur ces lignes ne pourra évidemment se faire que sur le rapprochement concerné. Particularité du rapprochement par journal : récupération de toutes les lignes du journal RAN. Toutes les lignes saisies manuellement dans le journal RAN s'affichent dans le rapprochement bancaire, sauf les lignes mouvementant le compte à rapprocher. Pour effectuer un rapprochement correct, deux solutions sont possibles : - soit, pointer toutes les lignes provenant de RAN, car leur différence est égale au montant saisi sur le compte à rapprocher. - soit, revenir dans le journal RAN, remplacer le compte de banque à rapprocher par le compte de virements internes "580", puis saisir une Opération Diverses pour solder le "580" par le compte de banque à rapprocher. Cette seconde solution évite d'afficher dans le rapprochement des lignes d'A Nouveaux non pertinentes. Rapprochement bancaire automatique Accès : Quotidien - Rapprochement La gestion de la fenêtre de rapprochement est commune à toutes les fiches. Le rapprochement bancaire automatique est accessible à partir de la liste des rapprochements. Toutes les options disponibles dans le rapprochement bancaire manuel sont disponibles dans le rapprochement bancaire automatique : le principe est identique. Consultez la partie Rapprochement bancaire manuel. Comment procéder ? Pour effectuer le rapprochement bancaire automatique, vous devez suivre le cheminement suivant : • Créer les banques dans Paramètres – Banques. • Créer un relevé bancaire par le menu Tenue comptable. • Dans le relevé créé, procéder à l’import d’un fichier de relevé grâce au bouton Importer un relevé bancaire. Eventuellement ajouter, modifier et supprimer des lignes, ou importer un autre fichier. • Ajouter un nouveau rapprochement bancaire par le menu Tenue comptable, en cochant la case Automatique : les lignes d’écritures et les lignes de relevé s’affichent automatiquement. • Effectuer un pointage manuel en sélectionnant les lignes à relier, ou un pointage automatique grâce au bouton Rapprocher automatiquement. Les lignes de relevé Il s’agit des lignes des relevés appartenant à la même banque que le compte à rapprocher. Les filtres sur les lignes à afficher Les filtres s’appliquant sur les lignes d’écritures (Toutes, Rapprochées, Non rapprochées) s’appliquent également sur les lignes de relevé. Pointage • Manuel : Il suffit de sélectionner une ou plusieurs lignes d’écriture et une ou plusieurs lignes de relevé qui se compensent : le code pointage s’applique alors sur toutes ces lignes. • Automatique : Cliquez sur le bouton Rapprocher automatiquement : les lignes d’écriture et les lignes de relevé qui se compensent sont automatiquement pointées ensemble. Les lignes sont pointées une à une (une ligne d’écriture pour une ligne de relevé) en fonction du montant. Pour pointer plusieurs lignes ensemble, vous devez pointer manuellement. Les montants des relevés s’affichent comme sur un relevé papier, dans le sens de votre banque et non dans le sens de votre comptabilité. 72 MANUEL En rapprochement par compte, les montants à pointer ensemble sont de sens opposé : les débits sur les lignes d’écriture se pointent avec les crédits sur les lignes de relevé, et inversement. En rapprochement par journal, les montants à pointer ensemble sont dans le même sens. Dépointage Le dépointage s’effectue comme en rapprochement manuel et s’applique sur les lignes d’écriture et sur les lignes de relevé. Nouveau relevé Cette option permet de créer un nouveau relevé bancaire directement à partir de l’option de rapprochement bancaire. Voir relevé Cette option permet d’ouvrir la fiche relevé bancaire correspondant à la ligne de relevé sélectionnée. ÉCRITURES DE RÉGULARISATION Ecritures de régularisations : principes et exemples Principes généraux Il peut arriver que certains produits et certaines charges soient comptabilisés sur une période différente de la période comptable à laquelle ils doivent obligatoirement être rattachés. Il est donc nécessaire de saisir un certain nombre d’écritures de régularisation pour : - diminuer les charges et produits qui sont comptabilisés « à tort » dans une période, - augmenter les charges et produits qui appartiennent à une autre période. Une période s'entend aussi bien comme étant un exercice comptable (dans le cas standard de l'arrêté des comptes entre deux exercices) que comme une période comprise dans un seul exercice comptable (dans les cas de situations périodiques, en cours d'exercice). Les écritures de régularisation sont de deux types : - Les charges et produits à recevoir (c’est-à-dire : Factures à recevoir, Avoirs à recevoir, Factures à émettre, Avoirs à émettre). - Charges constatées d’avance et produits constatés d’avance. Dans l'application, le terme général "Facture à recevoir à ou émettre" est utilisé pour désigner toutes les opérations de type "Charges et produits à recevoir". Exemples d'écritures de régularisation Premier exercice : 01/01/2008 au 31/12/2008 Second exercice : 01/01/2009 au 31/12/2009. 1/ Exemple d'une facture non parvenue : 1.1/ FACTURE D'ACHAT Sur l'exercice 2009, je comptabilise une facture d’achat datée du 05/01/2009 : - Date : 05/01/2009 - 6011- Matières premières : 1000 - 445661 - Tva déductible : 196 - 401FRS - Fournisseurs : 1196 73 EBP Comptabilité Open Line Pro 1.2/ Je constate que cette pièce facture des marchandises livrées sur l’exercice 2008. 1.3/ ECRITURE DE REGULARISATION Je dois saisir manuellement une écriture de régularisation sur 2008 afin d'y enregistrer la charge qui lui appartient : - Date : 31/12/2008 - 6011 - Matières premières : 1000 - 44586 - Tva sur facture non parvenue : 196 - 408 - Fournisseurs Factures non parvenues : 1196 J'identifie cette écriture comme étant une "Facture non parvenue ou à émettre". 1.4/ ECRITURE D'EXTOURNE Je dois également annuler la charge comptabilisée sur 2009 en extournant l’écriture de régularisation de 2008. Pour cela, j'utilise la fonction "Générer l'extourne / Facture non parvenue ou à émettre" afin de générer une écriture d'extourne automatique. - Date : 05/01/2009 - 6011 - Matières premières : 1000 - 44586 - Tva sur facture non parvenue : 196 - 408 - Fournisseurs Factures non parvenues : 1196 2/ Exemple d'une charge constatée d’avance : 2.1/ FACTURE D'ACHAT Sur l’exercice 2008, je comptabilise un avis d’échéance d’assurance datée du 01/07/2008. - Date : 01/07/2008 - 616 - Assurances : 2000 - 401FRS - fournisseurs : 2000 J'identifie la ligne de charges comme étant une "Charge constatée d'avance" 2.2/ Je constate que cet avis d’échéance concerne la période du 01/07/2008 au 30/06/2009. 2.3/ ECRITURE DE REGULARISATION Je dois saisir une écriture de régularisation sur 2008 pour annuler la charge comptabilisée sur cet exercice mais relative à l’exercice 2009. Pour cela, j'utilise la fonction "Générer l'écriture de régularisation / Charge constatée d'avance" afin de générer une écriture de régularisation automatique. - Date : 31/12/2008 - 616 - Assurances : 1000 - 486- Charges constatées d'avance : 1000 2.4/ ECRITURE D'EXTOURNE Je dois également comptabiliser sur 2009 la charge qui revient à cet exercice, en extournant l’écriture de régularisation précédente. Pour cela,j'utilise la fonction "Générer l'écriture d'extourne / Charge constatée d'avance" afin de générer une écriture d'extourne automatique. - Date : 01/01/2009 - 616 - Assurances : 1000 74 MANUEL - 486- Charges constatées d'avance : 1000 Exploitation dans l'application En saisie journal, deux boutons sont disponibles "Facture non parvenue ou à émettre" et "Charge et produit constaté d'avance". Il suffit de sélectionner une ligne d'écriture et d'activer le bouton qui convient pour ouvrir la fenêtre de paramétrage : - Si la ligne sélectionnée mouvemente un compte Fournisseur ou un compte Client, alors il est possible de d'activer le bouton "Facture non parvenue ou à émettre". - Si la ligne sélectionnée mouvemente un compte de Charge ou un compte de Produit, alors il est possible d'activer le bouton "Charge ou Produit constaté d'avance". - Si la ligne mouvemente un autre compte que Fournisseur, Client, Charge ou Produit, alors aucun des boutons n'est actif. Le fait d'activer le bouton "Facture non parvenue ou à émettre" affiche une fenêtre de paramétrage spécifique. Il faut y sélectionner la date et le journal dans lesquels l'écriture d'extourne doit être comptabilisée (exemple 1.4 ci-dessus). Le fait d'activer le bouton "Charge et produit constaté d'avance" affiche une fenêtre de paramétrage spécifique. Il faut y sélectionner : - la date et le journal dans lesquels l'écriture de régularisation doit être comptabilisée (exemple 2.3 ci-dessus) - la date et le journal dans lesquels l'écriture d'extourne doit être comptabilisée (exemple 2.4 ci-dessus). Deux listes répertoriant toutes les écritures identifiées comme"Facture non parvenue ou à émettre" et "Charge ou produit constaté d'avance" existe. Elles permettent de suivre la vie d'une écriture de régularisation, d'accéder à l'écriture d'origine, de générer les écritures de régularisation et d'extourne... Charge ou produit constaté d'avance : fenêtre de paramétrage Principes Créer une écriture de charge ou de produit constaté d'avance, c'est créer une écriture de régularisation qui répond à certains principes. Un exemple de comptabilisation de ce type d'écriture est disponible (exemple 2). Accès Cette fenêtre de paramétrage est accessible : - soit à partir de la saisie journal ou de la saisie par écriture, en activant le bouton "Charge ou Produit constaté d'avance" sur une ligne d'écriture positive mouvementant un compte de Charge ou de Produit et dans un journal de type Ventes, Achats, Opérations Diverses ou Trésorerie. - soit à partir de la "liste des charges et produits constatés d'avance", lorsque l'écriture d'origine a déjà été identifiée. Le contenu de la fenêtre Les champs de l'en-tête : Code : Le code est attribué automatiquement par le logiciel à l'enregistrement de la fenêtre de paramétrage. Lorsque la ligne d'origine sélectionnée en saisie journal mouvemente un compte de Charges, alors le code commencera par CCA (pour Charge Constatée d'Avance). Lorsque la ligne d'origine sélectionnée en saisie journal mouvemente un compte Produits, alors le code commencera par PCA (pour Produit Constaté d'Avance). Type : Ce champ géré automatiquement par le logiciel explique pour quel type d'écriture la fenêtre de paramétrage est ouverte (Charge Constatée d'Avance ou Produit Constaté d'Avance). 75 EBP Comptabilité Open Line Pro Le type "Charge Constaté d'Avance" est appliqué lorsque la ligne d'écriture sélectionnée en saisie journal mouvemente un compte de charges (compte de classe 6). Le type "Produit Constaté d'Avance" est appliqué lorsque la ligne d'écriture sélectionnée en saisie journal mouvemente un compte de produits (compte de classe 7). Description : Un libellé est proposé par défaut : il s'agit du libellé de la ligne d'origine précédé de la notion "Régularisation". Il reste néanmoins modifiable. Ce libellé sera repris comme libellé de toutes les lignes de l'écriture de régularisation et de l'écriture d'extourne qui seront générées, et cela quelque soit le paramétrage du journal de destination. Montant de la charge ou du produit : Ce champ est renseigné automatiquement par le logiciel et n'est pas modifiable. Il présente le montant de la ligne d'origine qui a été identifiée en saisie journal comme une "charge ou produit constaté d'avance". Règle de calcul : La règle de calcul doit obligatoirement être définie. Trois modes de calcul sont disponibles : Par montant : Cette option permet d'accéder à un champ "Montant" saisissable. Il est ainsi possible de saisir directement le montant pour lequel l'écriture de régularisation va être comptabilisée. La ligne d'origine mouvemente le compte 616 (Prime d'assurance) pour 1000 Euros, enregistrée sur l'exercice 2008, mais couvrant la période de 01/07/2008 au 30/06/2009. Je peux définir que la charge à régulariser est de 500 Euros. Par Fraction : Cette option permet d'accéder à un champ "Numérateur" et à un champ "Dénominateur". Le montant de l'écriture de régularisation sera donc calculé à partir du montant de la ligne d'origine multiplié par le numérateur et divisé par le dénominateur. La ligne d'origine mouvemente le compte 616 (Prime d'assurance) pour 1000 Euros, enregistrée sur l'exercice 2008, mais couvrant la période de 01/07/2008 au 30/06/2009. Je peux définir que la charge à régulariser est de : 1000 Euros x 6 mois d'exercice 2008 / 12 mois de prestation. Par pourcentage : Cette option permet d'accéder à un champ "Pourcentage". Le montant de l'écriture de régularisation sera donc calculé à partir du montant de la ligne d'origine, multiplié par le pourcentage. La ligne d'origine mouvemente le compte 616 (Prime d'assurance) pour 1000 Euros, enregistrée sur l'exercice 2008, mais couvrant la période de 01/07/2008 au 30/06/2009. Je peux définir que la charge a régulariser est de 1000 Euros x 50 %. Montant de la régularisation : Ce champ dépend de la règle de calcul sélectionnée. Dans le cas du calcul "Par montant", le champ est directement saisissable. Dans le cas des calculs "Par fraction" et "Par Pourcentage", le champ est automatiquement calculé en fonction des formules. Dans les trois exemples précédents, le champ "Montant de la régularisation" affiche toujours 500 Euros. Compte de contrepartie : Un compte de contrepartie est proposé par défaut en fonction des options du dossier et du compte mouvementé sur la ligne d'origine. Lorsque que le compte mouvementé sur la ligne d'origine est un compte de charge débiteur, alors le compte de contrepartie proposé par défaut est le 486. Lorsque que le compte mouvementé sur la ligne d'origine est un compte de charge créditeur, alors le compte de contrepartie proposé par défaut est le 487. Lorsque que le compte mouvementé sur la ligne d'origine est un compte de produit créditeur, alors le compte de contrepartie proposé par défaut est le 487. Lorsque que le compte mouvementé sur la ligne d'origine est un compte de produit débiteur, alors le compte de contrepartie proposé par défaut est le 486. Le compte proposé par défaut reste modifiable, soit en saisissant directement dans le champ, soit en sélectionnant le compte désiré dans la liste déroulante. Onglet "Ecritures de régularisation" Ce cadre permet de déterminer : - la date et le journal dans lesquels l'écriture de régularisation doit être comptabilisée (Voir exemple 2.3) 76 MANUEL - ainsi que la date et le journal dans lesquels l'écriture d'extoune doit être comptabilisée (Voir exemple 2.4). Les mêmes règles de fonctionnement s'appliquent aux deux écritures à générer. Comptabilisé : Ce champ est géré automatiquement par le logiciel. Il est vierge par défaut. Une coche apparaît lorsque l'écriture de régularisation et/ou l'écriture d'extourne ont été générées. Journal : Le code du journal défini dans les options du dossier est proposé par défaut. Ce journal par défaut reste modifiable, soit en saisissant directement le code dans le champ soit en le sélectionnant dans la liste déroulante. Le journal de destination ne peut en aucun cas être un journal de type Trésorerie ou de type A Nouveaux. Date de génération : Une date de génération est proposée par défaut. - Dans le cas de l'écriture de régularisation : la date correspond par défaut au dernier jour de l'exercice dans lequel l'écriture d'origine est comptabilisée. - Dans le cas de l'écriture d'extourne : la date correspond par défaut au premier jour de l'exercice qui suit l'exercice dans lequel l'écriture de régularisation est comptabilisée. Cette date reste modifiable, soit en saisissant directement la date voulue dans la champ soit en la sélectionnant dans le calendrier. Onglet "Ecriture d'origine" : L'écriture d'origine servant de base à l'écriture d'extourne est affichée pour information. Elle n'est pas modifiable (Voir exemple 2.1). La ligne de charge ou de produit à partir de laquelle l'écriture de régularisation et d'extourne seront générées est affichée en gras. Onglet "Notes" : Cet onglet reste disponible à tout moment. Les actions possibles dans la fenêtre Générer l'écriture de régularisation : Ce bouton permet de générer l'écriture de régularisation à partir de l'écriture d'origine, en respectant le journal de destination, la date d'écriture sélectionnée, le mode de calcul et le compte de contrepartie. Générer l'écriture d'extourne : Ce bouton permet de générer l'écriture d'extourne de l'écriture de régularisation. Les autres boutons : - "Consultation/Lettrage" de l'écriture d'origine : Ce bouton permet d'accéder à la fenêtre de Consultation/Lettrage du compte qui a permis de créer une Charge ou un Produit constaté d'avance (c'est-àdire le compte Charge ou de le compte Produit de l'écriture d'origine). - "Saisie par journal" de l'écriture d'origine : Ce bouton permet d'accéder à la saisie journal et de se positionner sur l'écriture d'origine. - "Saisie par journal" de l'écriture de régularisation : Ce bouton permet d'accéder à la saisie journal et de se positionner sur l'écriture de régularisation. - "Saisie par journal" de l'écriture d'extourne : Ce bouton permet d'accéder à la saisie journal et de se positionner sur l'écriture d'extourne. Cas particuliers Cas du n° de pièce : Le numéro de pièce renseigné sur la ligne de l'écriture d'origine identifiée comme Charge ou Produit à recevoir est repris pour toutes les lignes de l'écriture de régularisation. Le numéro qui sera alors comptabilisé restera modifiable. Cas du statut des écritures de régularisation et d'extourne générées : 77 EBP Comptabilité Open Line Pro Les écritures de régularisation et d'extourne possèdent par défaut le statut non validé et, ce, quelque soit le statut de l'écriture d'origine. Ensuite, le statut de ces écritures pourra être modifié comme n'importe quelle autre écriture. Facture non parvenue ou Facture à émettre : fenêtre de paramétrage Principes Créer une facture non parvenue ou à émettre, c'est créer une écriture de régularisation qui répond à certains principes. Un exemple de comptabilisation de ce type d'écriture est disponible (exemple 1). Accès Cette fenêtre de paramétrage est accessible : - soit à partir de la saisie journal ou de la saisie par écriture, en activant le bouton "Facture non parvenue ou à émettre" sur une ligne d'écriture mouvementant un compte Client ou Fournisseur et dans un journal de type Ventes, Achats ou Opérations Diverses. - soit à partir de la liste des factures non parvenues ou à émettre, lorsque l'écriture d'origine a déjà été identifiée. Le bouton "Facture non parvenue ou à émettre" permet de gérer toutes les écritures de type "Charges à payer et produits à recevoir". Le même bouton convient donc pour les Factures non parvenues, les Factures à émettre, les Avoirs non parvenus et les Avoirs à émettre. Le contenu de la fenêtre Les champs de l'en-tête Code : Le code est attribué automatiquement par le logiciel à l'enregistrement de la fenêtre de paramétrage. Lorsque la ligne d'origine sélectionnée en saisie journal mouvemente un compte Fournisseurs, alors le code commencera par FNP (qu'il s'agisse d'une Facture Non Parvenue ou d'un Avoir Non parvenu). Lorsque la ligne d'origine sélectionnée en saisie journal mouvemente un compte Clients, alors le code commencera par FAE (qu'il s'agisse d'une Facture A Emettre ou d'un Avoir A Emettre). Type : Ce champ géré automatiquement par le logiciel explique pour quel type d'écriture la fenêtre de paramétrage est ouverte (Facture Non parvenue ou Facture A Emettre). Description : Une description est proposée par défaut : il s'agit du libellé de la ligne d'origine précédé de la notion "Régularisation". La proposition reste modifiable. Cette description sera reprise comme libellé de toutes les lignes de l'écriture d'extourne qui sera générée, et cela quelque soit le paramétrage du journal de destination. Onglet "Ecriture d'extourne" Ce cadre permet de déterminer la date et le journal dans lequel l'écriture d'extourne doit être comptabilisée (Voir exemple 1.4). - Comptabilisé : Ce champ est géré automatiquement par le logiciel. Il est vierge par défaut. Un marqueur apparaît lorsque l'écriture d'extoune a été générée. - Journal : Le code du journal défini dans les options du dossier est proposé par défaut. Ce journal reste modifiable, soit en saisissant directement le code dans le champ soit en le sélectionnant dans la liste déroulante. Le journal de destination ne peut en aucun cas être un journal de type Trésorerie ou de type A Nouveaux. 78 MANUEL - Date de génération : Une date de génération est proposée par défaut : elle correspond au premier jour de l'exercice suivant la date de l'écriture d'origine. Cette date reste modifiable, soit en saisissant directement la date voulue soit en la sélectionnant dans le calendrier. Généralement, la date d'extourne correspond soit à la date du premier jour de l'exercice suivant la comptabilisation de l'écriture d'origine, soit la date à laquelle la facture définitive est effectivement enregistrée. Onglet "Ecriture d'origine" : L'écriture d'origine servant de base à l'écriture d'extourne est affichée pour information. Elle n'est pas modifiable (Voir exemple 1.3). Onglet "Notes" : Cet onglet reste disponible à tout moment. Les actions possibles dans la fenêtre Générer l'écriture d'extourne : Ce bouton permet de générer l'écriture d'extourne à partir de l'écriture d'origine, en respectant le journal de destination et la date d'écriture sélectionnés. Les autres boutons : - "Consultation/Lettrage" de l'écriture d'origine : Ce bouton permet d'accéder à la fenêtre de Consultation/Lettrage du compte qui a permis de créer une Facrture non parvenue ou à émettre (c'est-à-dire le compte Fournisseur ou Client de l'écriture d'origine). - "Saisie par journal" de l'écriture d'origine : Ce bouton permet d'accéder à la saisie journal et de se positionner sur l'écriture d'origine. - "Saisie par journal" de l'écriture d'extourne : Ce bouton permet d'accéder à la saisie journal et de se positionner sur l'écriture d'extourne. Cas particuliers Cas du n° de pièce : Le numéro de pièce renseigné sur la ligne de l'écriture d'origine identifiée comme Facture non parvenue est repris pour toutes les lignes de l'extourne. Le numéro qui sera alors comptabilisé restera modifiable. Cas du statut des écritures d'extourne générées : Une écriture d'extourne possède par défaut le statut non validé et, ce, quelque soit le statut de l'écriture d'origine. Ensuite, le statut de cette écriture d'extourne pourra être modifié comme n'importe quelle autre écriture. Liste des Charges et Produits Constatés d'Avance Accès : Quotidien - Ecritures de régularisation Deux listes permettent de présenter les différentes écritures de régularisation. Le but de ces écritures et des exemples de comptabilisation sont décrits dans les principes. Dans ce sous-menu, deux listes distinctes séparent les Charges et Produits constatés d'avance et les Factures non parvenues ou à émettre. Mais le principe d'affichage et de fonctionnement reste le même dans les deux listes. Le contenu des listes est géré par l'application en fonction des actions effectuées (dans la barre de tâches, sur les écritures d'origine..), mais n'est pas directement ouvert à la modification. Liste des Charges et Produits Constatés d'Avance Cette liste répertorie toutes les écritures de régularisation identifiées comme étant de type Charges et Produits Constatés d'Avance. Elle est mise à jour automatiquement par le logiciel à chaque fois que : - une nouvelle fenêtre de paramétrage de Charges et Produits Constatés d'Avance est sauvegardée, - une écriture de régularisation est générée, 79 EBP Comptabilité Open Line Pro - une écriture d'extourne est générée. Elle présente, en colonnes, une sélection des éléments importants pour l'identification et le suivi de chaque écriture de régularisation. Mais des colonnes peuvent être ajoutées ou supprimées grâce aux vues en fonction des besoins. Un certain nombre d'actions sont possibles sur cette liste : - Pour accéder à la fenêtre de paramétrage (et aux options qu'elle contient), il suffit de double cliquer sur la ligne sélectionnée. - Voir l'écriture d'origine permet d'accéder à la saisie journal et à l'écriture d'origine qui a été identifiée comme écriture de régularisation. - Voir document permet de visualiser le document ayant permis la comptabilisation de l'écriture d'origine. Il peut donc s'agir d'une saisie guidée, d'une facture issue de la Gestion Commerciale... - Voir l'écriture d'OD permet d'accéder à la saisie journal dans laquelle l'écriture de régularisation a été comptabilisée. - Voir l'écriture d'extourne permet d'accéder à la saisie journal dans laquelle l'écriture d'extourne a été comptabilisée. - Générer l'écriture d'OD permet de générer l'écriture de régularisation, si elle ne l'a pas encore été. - Générer l'écriture d'extourne permet de générer l'écriture d'extourne, à condition que l'écriture de régularisation soit déjà comptabilisée et que l'écriture d'extourne ne le soit pas encore. - Suppression des paramétrages : Les Charges et Produits constatés d'avance peuvent être supprimés. Leur suppression permettra de revenir sur l'écriture d'origine et de générer à nouveau une nouvelle écriture de régularisation. Mais, les écritures de régularisation et d'extourne déjà générées ne seront pas supprimées. liste des Factures Non Parvenues ou A Emettre Accès : Quotidien - Ecritures de régularisation Deux listes permettent de présenter les différentes écritures de régularisation. Le but de ces écritures et des exemples de comptabilisation sont décrits dans les principes. Dans ce sous-menu, deux listes distinctes séparent les Charges et Produits constatés d'avance et les Factures non parvenues ou à émettre. Mais le principe d'affichage et de fonctionnement reste le même dans les deux listes. Le contenu des listes est géré par l'application en fonction des actions effectuées (dans la barre de tâches, sur les écritures d'origine..), mais n'est pas directement ouvert à la modification. Liste des Factures A Recevoir ou A Emettre Cette liste répertorie toutes les écritures de régularisation identifiées comme étant de type Factures A Recevoir ou A Emettre. Elle est mise à jour automatiquement par le logiciel à chaque fois que : - une nouvelle fenêtre de paramétrage de Facture A Recevoir ou A Emettre est sauvegardée, - une écriture d'extourne est générée. Elle présente, en colonnes, une sélection des éléments importants pour l'identification et le suivi de chaque écriture de régularisation. Mais des colonnes peuvent être ajoutées ou supprimées grâce aux vues en fonction des besoins. Un certain nombre d'actions sont possibles sur cette liste : - Pour accéder à la fenêtre de paramétrage (et aux options qu'elle contient), il suffit de double cliquer sur la ligne sélectionnée. - Voir l'écriture d'origine permet d'accéder à la saisie journal sur l'écriture d'origine qui a été identifiée comme écriture de régularisation. - Voir document permet de visualiser le document ayant permis la comptabilisation de l'écriture d'origine. Il peut donc s'agir d'une saisie guidée, d'une facture issue de la Gestion Commerciale... 80 MANUEL - Voir l'écriture d'extourne permet d'accéder à la saisie journal dans laquelle l'écriture d'extourne a été comptabilisée. - Générer l'écriture d'extourne permet de générer l'écriture d'extourne, si elle ne l'a pas encore été. - Suppression de paramétrages : Des Factures Non Parvenues ou A Emettre peuvent être supprimées. Leur suppression permettra de revenir sur l'écriture d'origine et de générer à nouveau une nouvelle écriture d'extourne. Mais, les écritures extourne déjà générées ne seront pas supprimées. Compte-rendu de l'opération Lorsque vous générez des écritures de régularisation ou des écritures d'extourne à partir de la liste des Charges/Produits Constatés d'Avance ou de la liste des Factures Non Parvenues ou A Emettre, les traitements qui peuvent l'être sont d'abord exécutés puis une boîte de compte-rendu d'opération s'affiche. Cette boîte, affichée uniquement pour information, liste : - le codes des FNP ou CCA sur lesquels un traitement a été demandé, - le résultat du traitement pour chacun de ces codes. Ce résultat peut être de deux types : Ok : si tous les contrôles ont été exécutés avec succès et le traitement a pu être effectué. Echec : si un contrôle bloquant a échoué et que le traitement n'a pas pu être effectué. Pour connaître les raisons de cet échec, il suffit de cliquer sur le + situé à l'extrême gauche de la ligne. Enfin, pour fermer cette fenêtre, il suffit de cliquer sur Ok. DÉCLARATION DE TVA Liste des déclarations de TVA Accès : Quotidien - Déclarations de TVA La gestion de la liste des déclarations de TVA est commune à toutes les listes. Cette liste affiche toutes les déclarations créées et sauvegardées sur l'exercice courant. Les modifications et suppressions de déclarations de TVA sont possibles. Néanmoins, ces opérations risquent d'entraîner des incohérences avec les déclarations suivantes déjà sauvegardées et auront un impact sur les déclarations à créer. Création d'une nouvelle déclaration de TVA Une boîte de dialogue permet de choisir les paramétrages de la déclaration à créer. Déclaration * : La liste des déclarations proposées dépend du régime choisi dans les options du dossier. En régime ST (Régime Simplifié Annuel), seule la déclaration 3517 CA12 est disponible. Pour les autres régimes, la déclaration 3310 CA3 ainsi que l'annexe 3310A sont disponibles. Période * : Une liste déroulante affiche les périodes selon le régime défini dans les options du dossier. En régime ST (Régime Simplifié Annuel), seul l'exercice courant est disponible. En régime mensuel, tous les mois de l'exercice sont disponibles. En régime trimestriel, tous les trimestres de l'exercice sont disponibles. Si plusieurs régimes ont été définis dans les options du dossier, c'est le dernier régime de l'exercice courant qui est pris en compte. Choisissez les feuillets que vous désirez inclure dans la déclaration Dans cette partie, vous pouvez choisir d'ajouter des feuillets supplémentaires à la déclaration que vous avez déjà choisie. Ainsi, lorsque vous réaliserez l'aperçu de la déclaration de TVA, vous verrez afficher tous les feuillets sélectionnés et tous les montants qui doivent l'être seront automatiquement reportés d'un feuillet à l'autre. Ces choix restent réversibles grâce à un bouton existant dans la fenêtre de déclaration de TVA. 81 EBP Comptabilité Open Line Pro Fenêtre de la déclaration de TVA Accès : Quotidien - Déclaration de TVA Cette fenêtre est découpée en quatre onglets : Lignes sur débits Cet onglet permet de visualiser toutes les lignes saisies sur des comptes de TVA ayant l'option de calcul "Sur Débits" et toutes les lignes saisies sur des comptes soumis à TVA inclus dans les mêmes écritures. Il est possible d'accéder à la saisie journal comptabilisant cette écriture , soit en double-cliquant sur une ligne présente dans l'onglet, soit en cliquant sur le bouton Saisie par journal. Lignes sur encaissements Cet onglet permet de visualiser l'ensemble des lignes de règlement saisies sur des comptes de nature Tiers, dont l'échéance est affectée à une facture qui possède un compte de TVA ayant l'option de calcul "Sur Encaissements". Il est possible d'accéder à la saisie journal comptabilisant cette écriture, soit en double-cliquant sur une ligne présente dans l'onglet, soit en cliquant sur le bouton Saisie par journal. Aperçu Cet onglet permet de visualiser la déclaration de TVA à proprement parler (déclaration sous forme CERFA). De nombreux boutons vous permettent de naviguer dans votre déclaration (Page précédente / Page suivante) de l'imprimer, d'effectuer des recherches... Lignes non déclarées Contenu de l'onglet Cet onglet présente toutes les lignes d'écriture non incluses dans la déclaration de TVA. Il peut s'agir : - de lignes d'écriture saisies sur des comptes non correctement paramétrés, - de lignes d'écriture saisies sur des comptes paramétrés correctement mais dont le code taxe est inexistant sur le dossier, - de règlements non affectés à une échéance. Compte non correctement paramétré : Compte 701 (Ventes de produits finis) Territorialité : France Type d'opération : Biens et prestations de services Nature de taxe : (non renseignée) (>>>> ce paramétrage manquant doit être complété) Compte correctement paramétré, mais donc le code taxe est inexistant : Compte 627 (Services bancaires et assimilés) Territorialité : France Type d'opération : Biens et prestations de services Nature de taxe : Exonéré Interpréter et corriger les lignes de cet onglet Les lignes d'écritures saisies sur des comptes non correctement paramétrés apparaîtront dans le seul onglet Lignes non déclarées. Il convient donc de paramétrer correctement le compte problématique puis de relancer le calcul de la déclaration. Les lignes d'écriture concernées sont alors transférées dans l'onglet Lignes sur les Débits et incluses dans la déclaration. Les lignes d'écritures saisies sur des comptes correctement paramétrés (mais dont le code taxe est inexistant) apparaîtront à la fois dans l'onglet Lignes sur Débits et dans l'onglet Lignes non déclarées. Il convient uniquement de s'assurer que ces lignes d'écritures n'ont effectivement pas à être incluses dans une déclaration de TVA. 82 MANUEL Les lignes de règlements non affectés à une échéance apparaîtront dans le seul onglet Lignes non déclarées. Il convient d'affecter ces règlements à des échéances puis de relancer le calcul de la déclaration. Les lignes de règlements sont alors transférées dans l'onglet Lignes sur encaissements et incluses dans la déclaration. Autres fonctions Recalculer : Ce bouton permet de recalculer la déclaration de TVA après une nouvelle saisie ou une modification d'écriture. Le recalcul de la déclaration s'applique à tous les champs sur lesquels un calcul automatique est effectué, mais n'impacte pas les champs sans calcul. Sur la ligne 08 de la déclaration de TVA 3310 CA3 (année 2008), la Base Hors taxe est calculée automatiquement et affiche un montant de 5000 Euros. Vous choisissez de modifier ce montant et de le remplacer par 5002 Euros : votre saisie est prise en compte dans la déclaration. Si vous lancez le recalcul, alors le montant initial de 5000 Euros est réaffiché. En revanche, sur la ligne 25 de la déclaration de TVA 3310 CA3 (année 2008), le crédit de TVA est sans calcul. Vous choisissez d'y saisir un montant de 1000 Euros. Si vous lancez le recalcul, alors le montant saisi reste affiché. Valider : Ce bouton permet de valider définitivement la déclaration de TVA et empêche dorénavant toute modification de la déclaration de TVA concernée. En revanche, la suppression d'une déclaration de TVA validée reste possible. Dans ce cas, un événement avec justificatif sera enregistré. Ajouter / Retirer des feuillets : Lors de la création de la déclaration de TVA, si vous avez oublié d'ajouter certains feuillets ou, au contraire, si vous en avez ajouté à tort, alors ce bouton vous permet d'ajouter le feuillet manquant ou de retirer le feuillet inutile. Aperçu de la déclaration de TVA Accès : Quotidien - Déclaration de TVA La déclaration de TVA se décompose en deux parties : En-tête Les champs de l'en-tête recopient la période de déclaration sélectionnée dans la liste ainsi que l'adresse du Centre des Impôts, du dossier et toutes les informations administratives nécessaires, déjà renseignées sur le dossier. Ces champs ne sont pas modifiables. La zone "Paiement, Date et Signature" est accessible et doit être renseignée avant envoi. Corps de la déclaration de TVA Les différents champs de la déclaration de TVA sont renseignés en fonction des écritures incluses dans la période et des paramètres choisis sur les comptes de nature Comptes soumis à TVA et de nature Comptes de TVA. La liaison entre les lignes d'écriture et les champs de la déclaration de TVA se fait grâce aux codes taxes. La plupart des champs sont modifiables (champs grisés). Les saisies effectuées directement sur les déclarations dans les champs saisissables n'ont aucun impact sur la comptabilité. Case Néant : Cocher la case Néant permet de vider le formulaire mais n'empêche pas d'y saisir des montants. D'autre part, les lignes restent rattachées à la déclaration : elles ne seront donc pas présentées dans la déclaration suivante. 83 EBP Comptabilité Open Line Pro Un document répertorie un grand nombre de paramétrage de comptes ainsi que des schémas d'écritures en fonction du type d'opération à comptabiliser : pour le consulter, cliquer ici. Un document répertorie également un certain nombre de régularisations à saisir, lorsque la déclaration contient des montants négatifs : pour le consulter, cliquer ici. Régularisation d'une déclaration de TVA Dans certains cas, il peut s'avérer que votre déclaration de TVA présente des valeurs erronées ou non admissibles par l'administration. Ci-dessous sont listés un certains nombres de cas qui peuvent vous aidés à régulariser votre déclaration de TVA. TVA : Montants négatifs La déclaration de TVA ne doit pas contenir de montants négatifs. Or, un montant de TVA à déclarer peut être négatif dans le cas où la somme des avoirs pour un type de TVA est supérieure à la somme des factures pour le même type de TVA. Ces cas doivent être gérés en régularisation. CA3 : Saisie des régularisations Ligne 02 négative (Autres opérations imposables) Vous êtes dans le cas suivant : la somme des avoirs de ventes sur autres opérations imposables est supérieure à la somme des factures de ventes sur autres opérations imposables. Vous devez saisir : - Ligne 02 : montant des factures de ventes sur autres opérations imposables. - Ligne 3C : montant des avoirs de ventes sur autres opérations imposables (sans signe -). - Lignes 08 à 14 (taxe) : vous devez répercuter la modification de la ligne 02 sur une ou plusieurs de ces lignes (les avoirs de la ligne 3C ne doivent pas être repris sur ces lignes). - Ligne 21 : montant de la TVA des avoirs de ventes sur autres opérations imposables (sans signe -). Ligne 03 négative (Acquisitions intracommunautaires) Vous êtes dans le cas suivant : la somme des avoirs d’achats en UE est supérieure à la somme des factures d’achats en UE. Vous devez saisir : - Ligne 03 : montant des factures d’achats en UE. - Ligne 3C : montant des avoirs d’achats en UE (sans signe -). - Lignes 08 à 14 (taxe) : vous devez répercuter la modification de la ligne 03 sur une ou plusieurs de ces lignes (les avoirs de la ligne 3C ne doivent pas être repris sur ces lignes). - Ligne 17 : montant de la TVA des factures d’achats en UE. - Ligne 21 : montant de la TVA des avoirs d’achats en UE (sans signe -). Voir aussi le paragraphe Ligne 20 négative si nécessaire. Ligne 3A négative (Livraisons de gaz naturel ou d’électricité imposables en France) Vous êtes dans le cas suivant : la somme des avoirs d’achats de gaz imposables est supérieure à la somme des factures d’achats de gaz imposables. Vous devez saisir : - Ligne 3A : montant des factures d’achats de gaz imposables. - Ligne 3C : montant des avoirs d’achats de gaz imposables (sans signe -). - Lignes 08 à 14 (taxe) : vous devez répercuter la modification de la ligne 3A sur une ou plusieurs de ces lignes (les avoirs de la ligne 3C ne doivent pas être repris sur ces lignes) - Ligne 21 : montant de la TVA des avoirs d’achats de gaz imposables (sans signe -). Voir aussi le paragraphe Ligne 20 négative si nécessaire. Ligne 3B négative (Achats de biens ou services auprès d’un assujetti non établi en France) Vous êtes dans le cas suivant : la somme des avoirs d’achats auprès d’un assujetti non établi en France est supérieure à la somme des factures d’achats auprès d’un assujetti non établi en France. 84 MANUEL Vous devez saisir : - Ligne 3B : montant des factures d’achats auprès d’un assujetti non établi en France. - Ligne 3C : montant des avoirs d’achats auprès d’un assujetti non établi en France (sans signe -). - Lignes 08 à 14 (taxe) : vous devez répercuter la modification de la ligne 3B sur une ou plusieurs de ces lignes (les avoirs de la ligne 3C ne doivent pas être repris sur ces lignes) - Ligne 21 : montant de la TVA des avoirs d’achats auprès d’un assujetti non établi en France (sans signe -). Voir aussi le paragraphe Ligne 20 négative si nécessaire. Ligne 04 négative (Exportations hors CE) Vous êtes dans le cas suivant : la somme des avoirs d’exportations hors CE est supérieure à la somme des factures d’exportations hors CE. Vous devez saisir : - Ligne 04 : montant des factures d’exportations hors CE. - Ligne 7B : montant des avoirs d’exportations hors CE (sans signe -). Ligne 05 négative (Autres opérations non imposables) Vous êtes dans le cas suivant : la somme des avoirs de ventes sur autres opérations non imposables est supérieure à la somme des factures de ventes sur autres opérations non imposables. Vous devez saisir : - Ligne 05 : montant des factures de ventes sur autres opérations non imposables. - Ligne 7B : montant des avoirs de ventes sur autres opérations non imposables (sans signe -). Ligne 06 négative (Livraisons intracommunautaires) Vous êtes dans le cas suivant : la somme des avoirs de ventes en UE est supérieure à la somme des factures de ventes en UE. Vous devez saisir : - Ligne 06 : montant des factures de ventes en UE. - Ligne 7B : montant des avoirs de ventes en UE (sans signe -). Ligne 6A négative (Livraisons de gaz naturel ou d’électricité non imposables en France) Vous êtes dans le cas suivant : la somme des avoirs de ventes de gaz non imposables est supérieure à la somme des factures de ventes de gaz non imposables. Vous devez saisir : - Ligne 6A : montant des factures de ventes de gaz non imposables. - Ligne 7B : montant des avoirs de ventes de gaz non imposables (sans signe -). Ligne 07 négative (Achats en franchise) Vous êtes dans le cas suivant : la somme des avoirs d’achats en franchise est supérieure à la somme des factures d’achats en franchise. Vous devez saisir : - Ligne 07 : montant des factures d’achats en franchise. - Ligne 7B : montant des avoirs d’achats en franchise (sans signe -). Ligne 7A négative (Ventes de biens ou services auprès d’un assujetti non établi en France) Vous êtes dans le cas suivant : la somme des avoirs de ventes auprès d’un assujetti non établi en France est supérieure à la somme des factures de ventes auprès d’un assujetti non établi en France. Vous devez saisir : - Ligne 7A : montant des factures de ventes auprès d’un assujetti non établi en France. - Ligne 7B : montant des avoirs de ventes auprès d’un assujetti non établi en France (sans signe -). Ligne 08 négative (Opérations réalisées en France à 19,60 %) 85 EBP Comptabilité Open Line Pro Vous êtes dans le cas suivant : la somme des avoirs de ventes France à 19,60 % est supérieure à la somme des factures de ventes France à 19,60 %. Vous devez saisir : - Ligne 3C : montant des avoirs de ventes France à 19,60 % (sans signe -). - Lignes 08 (taxe) : montant de la TVA des factures de ventes France à 19,60 %. - Ligne 21 : montant de la TVA des avoirs de ventes France à 19,60 % (sans signe -). Ligne 09 négative (Opérations réalisées en France à 5,50 %) Vous êtes dans le cas suivant : la somme des avoirs de ventes France à 5,50 % est supérieure à la somme des factures de ventes France à 5,50 %. Vous devez saisir : - Ligne 3C : montant des avoirs de ventes France à 5,50 % (sans signe -) - Lignes 09 (taxe) : montant de la TVA des factures de ventes France à 5,50 % - Ligne 21 : montant de la TVA des avoirs de ventes France à 5,50 % (sans signe -). Ligne 10 négative (Opérations réalisées dans les DOM à 8,50 %) Vous êtes dans le cas suivant : la somme des avoirs de ventes DOM à 8,50 % est supérieure à la somme des factures de ventes DOM à 8,50 %. Vous devez saisir : - Ligne 3C : montant des avoirs de ventes DOM à 8,50 % (sans signe -). - Lignes 10 (taxe) : montant de la TVA des factures de ventes DOM à 8,50 %. - Ligne 21 : montant de la TVA des avoirs de ventes DOM à 8,50 % (sans signe -). Ligne 11 négative (Opérations réalisées dans les DOM à 2,10 %) Vous êtes dans le cas suivant : la somme des avoirs de ventes DOM à 2,10 % est supérieure à la somme des factures de ventes DOM à 2,10 %. Vous devez saisir : - Ligne 3C : montant des avoirs de ventes DOM à 2,10 % (sans signe -). - Lignes 11 (taxe) : montant de la TVA des factures de ventes DOM à 2,10 %. - Ligne 21 : montant de la TVA des avoirs de ventes DOM à 2,10 % (sans signe -). Ligne 13 négative (Opérations imposables à un ancien taux) Vous êtes dans le cas suivant : la somme des avoirs de ventes à un ancien taux est supérieure à la somme des factures de ventes à un ancien taux. Vous devez saisir : - Ligne 3C : montant des avoirs de ventes à un ancien taux (sans signe -). - Lignes 13 (taxe) : montant de la TVA des factures de ventes à un ancien taux. - Ligne 21 : montant de la TVA des avoirs de ventes à un ancien taux (sans signe -). Ligne 14 négative (Opérations imposables à un taux particulier) Vous êtes dans le cas suivant : la somme des avoirs de ventes à un taux particulier est supérieure à la somme des factures de ventes à un taux particulier. Vous devez saisir : - Ligne 3C : montant des avoirs de ventes à un taux particulier (sans signe -). - Lignes 14 (taxe) : montant de la TVA des factures de ventes à un taux particulier. - Ligne 21 : montant de la TVA des avoirs de ventes à un taux particulier (sans signe -). Ligne 19 négative (TVA sur biens constituant des immobilisations) Vous êtes dans le cas suivant : la somme des avoirs sur immobilisations est supérieure à la somme des factures sur immobilisations. Vous devez saisir : - Ligne 3C : montant des avoirs d’immobilisations (sans signe -). - Ligne 15 : montant de la TVA des avoirs d’immobilisations (sans signe -). - Ligne 19 : montant de la TVA des factures d’immobilisations. 86 MANUEL Ligne 20 négative (TVA sur autres biens et services) Vous êtes dans le cas suivant : la somme des avoirs d’achats est supérieure à la somme des factures d’achats. Vous devez saisir : - Ligne 3C : montant des avoirs d’achats (sans signe -). - Ligne 15 : montant de la TVA des avoirs d’achats (sans signe -). - Ligne 20 : montant de la TVA des factures d’achats. CA12 : Saisie des régularisations Lignes 01, 02, 03, 04, 4B ou 4D négatives (TVA collectée non imposable) Pour ces lignes, vous n’avez aucune régularisation à saisir. Ligne 05 négative (Opérations réalisées en France à 19,60 %) Vous êtes dans le cas suivant : la somme des avoirs de ventes France à 19,60 % est supérieure à la somme des factures de ventes France à 19,60 %. Vous devez saisir : - Ligne 05 (taxe) : montant de la TVA des factures de ventes France à 19,60 %. - Ligne 25 : montant de la TVA des avoirs de ventes France à 19,60 % (sans signe -). Ligne 06 négative (Opérations réalisées en France à 5,50 %) Vous êtes dans le cas suivant : la somme des avoirs de ventes France à 5,50 % est supérieure à la somme des factures de ventes France à 5,50 %. Vous devez saisir : - Ligne 06 (taxe) : montant de la TVA des factures de ventes France à 5,50 %. - Ligne 25 : montant de la TVA des avoirs de ventes France à 5,50 % (sans signe -). Ligne 07 négative (Opérations réalisées dans les DOM à 8,50 %) Vous êtes dans le cas suivant : la somme des avoirs de ventes DOM à 8,50 % est supérieure à la somme des factures de ventes DOM à 8,50 %. Vous devez saisir : - Ligne 07 (taxe) : montant de la TVA des factures de ventes DOM à 8,50 %. - Ligne 25 : montant de la TVA des avoirs de ventes DOM à 8,50 % (sans signe -). Ligne 08 négative (Opérations réalisées dans les DOM à 2,10 %) Vous êtes dans le cas suivant : la somme des avoirs de ventes DOM à 2,10 % est supérieure à la somme des factures de ventes DOM à 2,10 %. Vous devez saisir : - Ligne 08 (taxe) : montant de la TVA des factures de ventes DOM à 2,10 % - Ligne 25 : montant de la TVA des avoirs de ventes DOM à 2,10 % (sans signe -). Ligne 09 négative (Opérations imposables à un taux particulier) Vous êtes dans le cas suivant : la somme des avoirs de ventes à un taux particulier est supérieure à la somme des factures de ventes à un taux particulier. Vous devez saisir : - Ligne 09 (base) : montant des factures de ventes à un taux particulier. - Ligne 09 (taxe) : montant de la TVA des factures de ventes à un taux particulier. - Ligne 25 : montant de la TVA des avoirs de ventes à un taux particulier (sans signe -). Ligne 10 négative (Opérations imposables à un ancien taux) Vous êtes dans le cas suivant : la somme des avoirs de ventes à un ancien taux est supérieure à la somme des factures de ventes à un ancien taux. 87 EBP Comptabilité Open Line Pro Vous devez saisir : - Ligne 10 (base) : montant des factures de ventes à un ancien taux. - Ligne 10 (taxe) : montant de la TVA des factures de ventes à un ancien taux - Ligne 25 : montant de la TVA des avoirs de ventes à un ancien taux (sans signe -). Ligne AA négative (Livraisons de gaz naturel ou d’électricité imposables en France) Vous êtes dans le cas suivant : la somme des avoirs d’achats de gaz imposables est supérieure à la somme des factures d’achats de gaz imposables. Vous devez saisir : - Ligne AA (base) : montant des factures d’achats de gaz imposables. - Ligne AA (taxe) : montant de la TVA des factures d’achats de gaz imposables. - Ligne 25 : montant de la TVA des avoirs d’achats de gaz imposables (sans signe -). Voir aussi le paragraphe Ligne 20 négative si nécessaire. Ligne AB négative (Achats de biens ou services auprès d’un assujetti non établi en France) Vous êtes dans le cas suivant : la somme des avoirs d’achats auprès d’un assujetti non établi en France est supérieure à la somme des factures d’achats auprès d’un assujetti non établi en France. Vous devez saisir : - Ligne AB (base) : montant des factures d’achats auprès d’un assujetti non établi en France - Ligne AB (taxe) : montant de la TVA des factures d’achats auprès d’un assujetti non établi en France - Ligne 25 : montant de la TVA des avoirs d’achats auprès d’un assujetti non établi en France (sans signe -). Voir aussi le paragraphe Ligne 20 négative si nécessaire. Ligne 13 négative (Autres opérations imposables) Vous êtes dans le cas suivant : la somme des avoirs de ventes sur autres opérations imposables est supérieure à la somme des factures de ventes sur autres opérations imposables. Vous devez saisir : - Ligne 13 (base) : montant des factures de ventes sur autres opérations imposables. - Ligne 13 (taxe) : montant de la TVA des factures de ventes sur autres opérations imposables. - Ligne 25 : montant de la TVA des avoirs de ventes sur autres opérations imposables (sans signe -). Ligne 14 négative (Acquisitions intracommunautaires) Vous êtes dans le cas suivant : la somme des avoirs d’achats en UE est supérieure à la somme des factures d’achats en UE. Vous devez saisir : - Ligne 14 (base) : montant des factures d’achats en UE. - Ligne 14 (taxe) : montant de la TVA des factures d’achats en UE. - Ligne 25 : montant de la TVA des avoirs d’achats en UE (sans signe -). Voir aussi le paragraphe Ligne 20 négative si nécessaire. Ligne 15 négative (Acquisitions intracommunautaires d’immobilisations) Vous êtes dans le cas suivant : la somme des avoirs d’immobilisations en UE est supérieure à la somme des factures d’immobilisations en UE. Vous devez saisir : - Ligne 14 (base) : montant des factures d’achats et immobilisations en UE. - Ligne 14 (taxe) : montant de la TVA des factures d’achats et immobilisations en UE. - Ligne 15 : montant de la TVA des factures d’immobilisations en UE. - Ligne 25 : montant de la TVA des avoirs d’immobilisations en UE (sans signe -). Voir aussi le paragraphe Ligne 23 négative si nécessaire. Ligne 20 négative (Déductions sur factures) 88 MANUEL Vous êtes dans le cas suivant : la somme des avoirs d’achats est supérieure à la somme des factures d’achats. Vous devez saisir : - Ligne 18 : montant de la TVA des avoirs d’achats (sans signe -). - Ligne 20 : montant de la TVA des factures d’achats. Ligne 23 négative (TVA déductible sur immobilisations) Vous êtes dans le cas suivant : la somme des avoirs sur immobilisations est supérieure à la somme des factures sur immobilisations. Vous devez saisir : - Ligne 18 : montant de la TVA des avoirs d’immobilisations (sans signe -). - Ligne 23 : montant de la TVA des factures d’immobilisations. Paramétrage des comptes de TVA et schémas d'écritures Ce document présente un certain nombre de types d'opérations soumises à TVA. Pour chacun de ces types d'opération, il répertorie le paramétrage des comptes de TVA et des comptes soumis à TVA à utiliser, le schéma d'écriture à comptabiliser ainsi que les déclarations et numéros de lignes impactés par ces comptabilisations. Achats de marchandises - pour un dossier ayant son établissement en France 1 - Achats France 19.6 % Déclarations concernées et lignes impactées : J'identifie cette écriture comme étant une "Facture non parvenue ou à émettre" : - CA3 : Lignes 01 et 08 - CA12 : Ligne 05 Comptes à utiliser et leur paramétrage : - 401xxx - Fournisseurs : sans paramétrage - 44566xxx - TVA : Territorialité : France Nature de taxe : France continentale 19.6 %. - 607xxx - Achats de marchandises : Territorialté : France Nature de taxe : France continentale 19.6 % Type d'opération : Biens et prestations de services Schéma d'écriture : 401xxxxx - Crédit - 1.196.00 € 44566xxx - Débit - 196.00 € 607xxxxx - Débit - 1.000.00 € 2 - Achats France 5.5 % Déclarations concernées et lignes impactées : - CA3 : Lignes 01 et 09 - CA12 : Ligne 06 Comptes à utiliser et leur paramétrage : - 401xxx - Fournisseurs : sans paramétrage - 44566xxx - TVA : Territorialité : France Nature de taxe : France continentale 5.5 %. - 607xxx - Achats de marchandises : Territorialté : France Nature de taxe : France continentale 5.5 % Type d'opération : Biens et prestations de services Schéma d'écriture : 401xxxxx - Crédit - 1.055.00 € 44566xxx - Débit - 55.00 € 607xxxxx - Débit - 1.000.00 € 3 - Achats UE à 19.6 % (acquisition intracommunautaire) 89 EBP Comptabilité Open Line Pro Déclarations concernées et lignes impactées : - CA3 : Lignes 03, 08, 17 et 20 - CA12 : Lignes 14 et 20 Comptes à utiliser et leur paramétrage : - 401xxx - Fournisseurs : sans paramétrage - 4452xxx - Tva due intracommunautaire : sans paramétrage - 44566xxx - TVA : Territorialité : Intracommunautaire Nature de taxe : Intracommunaitaire 19.6 % - 607xxx - Achats de marchandises : Territorialté : Intracommunautaire Nature de taxe : Intracommunautaire 19.6 % Type d'opération : Biens et prestations de services Schéma d'écriture : 401xxxxx - Crédit - 1.000.00 € 4452xxxx - Crédit - 196.00 € 44566xxx - Débit - 196.00 € 607xxxxx - Débit - 1.000.00 € 4 - Achats UE à 5.5 % (acquisition intracommunautaire) Déclarations concernées et lignes impactées : - CA3 : Lignes 03, 09, 17 et 20 - CA12 : Lignes 14 et 20 Comptes à utiliser et leur paramétrage : - 401xxx - Fournisseurs : sans paramétrage - 4452xxx - Tva due intracommunautaire : sans paramétrage - 44566xxx - TVA : Territorialité : Intracommunautaire Nature de taxe : Intracommunaitaire 5.5 % - 607xxx - Achats de marchandises : Territorialté : Intracommunautaire Nature de taxe : Intracommunautaire 5.5 % Type d'opération : Biens et prestations de services Schéma d'écriture : 401xxxxx - Crédit - 1.000.00 € 4452xxxx - Crédit - 55.00 € 44566xxx - Débit - 55.00 € 607xxxxx - Débit - 1.000.00 € 5 - Achats France de gaz ou électricité imposable à 19.6 % Déclarations concernées et lignes impactées : - CA3 : Lignes 3A, 09 et 20 - CA12 : Lignes AA et 20 Comptes à utiliser et leur paramétrage : - 401xxx - Fournisseurs : sans paramétrage - 4455xxx - Tva à décaisser en France : sans paramétrage - 44566xxx - TVA : Territorialité : France Nature de taxe : France continentale 19.6 % - 607xxx - Achats de marchandises : Territorialté : France Nature de taxe : France continentale 19.6 % Type d'opération : Livraisons gaz/électricité imposables Schéma d'écriture : 401xxxxx - Crédit - 1.000.00 € 4455xxxx - Crédit - 196.00 € 44566xxx - Débit - 196.00 € 607xxxxx - Débit - 1.000.00 € 6 - Achats en franchise 90 MANUEL Déclarations concernées et lignes impactées : - CA3 : Ligne 07 - CA12 : Ligne 01 Comptes à utiliser et leur paramétrage : - 401xxx - Fournisseurs : sans paramétrage - 607xxx - Achats de marchandises : Territorialté : France Nature de taxe : Exonération Type d'opération : Achats en franchise Schéma d'écriture : 401xxxxx - Crédit - 1.000.00 € 607xxxxx - Débit - 1.000.00 € 7 - Achats à 19.6 % auprès d'un assujetti non établi en France Déclarations concernées et lignes impactées : - CA3 : Lignes 3B, 08 et 20 - CA12 : Lignes AB et 20 Comptes à utiliser et leur paramétrage : - 401xxx - Fournisseurs : sans paramétrage - 4455xxx - Tva à décaisser en France : sans paramétrage - 44566xxx - TVA : Territorialité : Assujetti établi hors de France Nature de taxe : Assujetti hors de France 19.6 % - 607xxx - Achats de marchandises : Territorialté : Assujetti hors de France Nature de taxe : Assujetti établi hors de France 19.6 % Type d'opération : Biens et prestations de services Schéma d'écriture : 401xxxxx - Crédit - 1.000.00 € 4455xxxx - Crédit - 196.00 € 44566xxx - Débit - 196.00 € 607xxxxx - Débit - 1.000.00 € 8 - Facture d'acompte d'achat à 19.6 % Comptes à utiliser et leur paramétrage : - 401xxx - Fournisseurs : sans paramétrage - 44586xxx - Tva sur le chiffre d'affaires sur factures non parvenues : sans paramétrage - 44566xxx - TVA : Territorialité : France Nature de taxe : France continentale 19.6 % - 4091xxx - Fournisseurs - Avances et acomptes versés sur commandes sans paramétrage Schéma d'écriture : 401xxxxx - Crédit - 1.196.00 € 44586xxx - Crédit - 196.00 € 44566xxx - Débit - 196.00 € 4091xxxx - Débit - 1.196.00 € Dans ce cas-là, le montant de la TVA déductible n'est pas intégré à la déclaration, il est donc nécessaire de corriger manuellement le montant qui y est affiché. Ces lignes d'écriture sont visibles sur l'onglet "Lignes non déclarées" de la fenêtre de déclaration de TVA. Prestations de service UE à 19.6 % (client assujetti en France, fournisseur UE) 9 - Prestations de service UE à 19.6 % (client assujetti en France, fournisseur UE) Déclarations concernées et lignes impactées : - CA3 : Lignes 2A, 08, 17 et 20 - CA12 : Lignes AC et 20 Comptes à utiliser et leur paramétrage : - 401xxx - Fournisseurs : 91 EBP Comptabilité Open Line Pro Sans paramétrage - 4452xxx - Tva due intracommunautaire : Sans paramétrage - 44566xxx - TVA : Territorialité : Intracommunautaire Nature de taxe : Intracommunaitaire 19.6 % - 604xxx - Achats de marchandises : Territorialté : Intracommunautaire Nature de taxe : Intracommunautaire 19.6 % Type d'opération : Achats de prestations de services intracommunautaires Schéma d'écriture : 401xxxxx - Crédit - 1.000.00 € 4452xxxx - Crédit - 196.00 € 44566xxx - Débit - 196.00 € 604xxxxx - Débit - 1.000.00 € Achats d'immobilisations - pour un dossier ayant son établissement en France Les comptes à utiliser pour les achats d'immobilisations sont des comptes : - de nature "Comptes d'immobilisation" pour les comptes soumis à TVA - de nature "TVA sur achats d'immobilisation" pour les comptes de TVA. Leur paramétrage est sensiblement identique à celui des Achats de marchandises (établissement en France), à la différence que le type d'opération devient "Immobilisations de biens et prestations de services" pour les comptes soumis à TVA. D'autre part, les lignes de déclarations impactées par ces achats sont différentes des exemples précédents. Ventes de marchandises - pour un dossier ayant son établissement en France 10 - Ventes France 19.6 % Déclarations concernées et lignes impactées : - CA3 : Lignes 01 et 08 - CA12 : Ligne 05 Comptes à utiliser et leur paramétrage : - 411xxx - Client : sans paramétrage - 44571xxx - TVA : Territorialité : France Nature de taxe : France continentale 19.6 %. - 707xxx - Ventes de marchandises : Territorialté : France Nature de taxe : France continentale 19.6 % Type d'opération : Biens et prestations de services Schéma d'écriture : 411xxxxx - Débit - 1.196.00 € 44571xxx - Crédit - 196.00 € 707xxxxx - Crédit - 1.000.00 € 11 - Ventes France 5.5 % Déclarations concernées et lignes impactées : - CA3 : Lignes 01 et 09 - CA12 : Ligne 06 Comptes à utiliser et leur paramétrage : - 411xxx - Client : sans paramétrage - 44571xxx - TVA : Territorialité : France Nature de taxe : France continentale 5.5 %. - 707xxx - Ventes de marchandises : Territorialté : France Nature de taxe : France continentale 5.5 % Type d'opération : Biens et prestations de services Schéma d'écriture : 411xxxxx - Débit - 1.055.00 € 44571xxx - Crédit - 55.00 € 707xxxxx - Crédit - 1.000.00 € 92 MANUEL 12 - Ventes UE Déclarations concernées et lignes impactées : - CA3 : Ligne 06 - CA12 : Ligne 04 Comptes à utiliser et leur paramétrage : - 411xxx - Clients : sans paramétrage - 707xxx - Ventes de marchandises : Territorialté : Intracommunautaire Nature de taxe : Intracommunautaire exonération Type d'opération : Biens et prestations de services Schéma d'écriture : 411xxxxx - Débit - 1.000.00 € 707xxxxx - Crédit - 1.000.00 € 13 - Ventes autres opérations imposables à 19.6 % Déclarations concernées et lignes impactées : - CA3 : Lignes 02 et 08 - CA12 : Ligne 13 Comptes à utiliser et leur paramétrage : - 411xxx - Fournisseurs : sans paramétrage - 44571xxx - TVA : Territorialité : France Nature de taxe : France continentale 19.6 % - 707xxx - Ventes de marchandises : Territorialté : France Nature de taxe : France continentale 19.6 % Type d'opération : Autres opérations imposables Schéma d'écriture : 411xxxxx - Débit - 1.196.00 € 44571xxx - Crédit - 196.00 € 707xxxxx - Crédit - 1.000.00 € 14 - Autres ventes non imposables Déclarations concernées et lignes impactées : - CA3 : Ligne 05 - CA12 : Ligne 03 Comptes à utiliser et leur paramétrage : - 411xxx - Client : sans paramétrage - 707xxx - Ventes de marchandises : Territorialté : France Nature de taxe : Exonération Type d'opération : Autres opérations non imposables Schéma d'écriture : 411xxxxx - Débit - 1.000.00 € 707xxxxx - Crédit - 1.000.00 € 15 - Ventes de gaz ou d'électricité non imposables Déclarations concernées et lignes impactées : - CA3 : Ligne 6A - CA12 : Ligne 4D Comptes à utiliser et leur paramétrage : - 411xxx - Clients : sans paramétrage - 707xxx - Ventes de marchandises : Territorialté : France Nature de taxe : Exonération Type d'opération : Livraisons gaz/électricité non imposables Schéma d'écriture : 411xxxxx - Débit - 1.000.00 € 707xxxxx - Crédit - 1.000.00 € 93 EBP Comptabilité Open Line Pro 16 - Ventes auprès d'un assujetti non établi en France Déclarations concernées et lignes impactées : - CA3 : Ligne 7A - CA12 : Ligne 4B Comptes à utiliser et leur paramétrage : - 411xxx - Clients : sans paramétrage - 707xxx - Ventes de marchandises : Territorialté : Assujetti hors de France Nature de taxe : Assujetti établi hors de France exonération Type d'opération : Biens et prestations de services Schéma d'écriture : 411xxxxx - Débit - 1.000.00 € 707xxxxx - Crédit - 1.000.00 € 17 - Facture d'acompte de ventes à 19.6 % Comptes à utiliser et leur paramétrage : - 411xxx - Clients : sans paramétrage - 44587xxx - Tva sur le chiffre d'affaires sur factures à établir sans paramétrage - 44571xxx - TVA : Territorialité : France Nature de taxe : France continentale 19.6 % - 4191xxx - Clients - Avances et acomptes reçus sur commandes sans paramétrage Schéma d'écriture : 411xxxxx - Débit - 1.196.00 € 44587xxx - Débit - 196.00 € 44571xxx - Crédit - 196.00 € 4191xxxx - Crédit - 1.196.00 € Dans ce cas-là, le montant de la TVA collectée n'est pas intégré à la déclaration, il est donc nécessaire de corriger manuellement le montant affiché dans la déclaration. Ces lignes d'écriture sont visibles sur l'onglet "Lignes non déclarées" de la fenêtre de déclaration de TVA. Cas particuliers : Les opérations faites sous le régime de TVA non perçue et récupérable Vendeur établi en France métropolitaine et acheteur en DOM 18 - Comptabilité du vendeur (Territorialité du dossier France) Déclarations concernées et lignes impactées : - CA3 : Ligne 04 - CA12 : Ligne 02 Comptes à utiliser et leur paramétrage : - 411xxx - Clients : sans paramétrage - 7079xxx - Ventes de marchandises : Territorialité : Importation/exportation Nature de taxe : Importation/exportation Exonération Type d'opération : Biens et prestations de services Schéma d'écriture : 411xxxxx - Débit - 1.000.00 € 707xxxxx - Crédit - 1.000.00 € 19 - Comptabilité de l'acheteur (Territorialité du dossier DOM) Déclarations concernées et lignes impactées : - CA3 : Lignes 19, 24 - CA12 : Ligne 20, 27 Comptes à utiliser et leur paramétrage : - 401xxx - Fournisseurs : sans paramétrage - 4456xxx - TVA : Territorialité : DOM Nature de la taxe : DOM 8.5 % ou 2.10 % Option de calcul : en fonction du fournisseur - 441xxx - Etat subvention à recevoir : 94 MANUEL sans paramétrage - 607xxx - Achats de marchandises : Territorialité : Importation/exportation Nature de taxe : Importation/exportation Exonération Type d'opération : Biens et prestations de services Schéma d'écriture : 401xxxxx - Crédit - 1.000.00 € 441xxx - Crédit - 85.00 € 4456xxx - Débit - 85.00 € 607xxxxx - Débit - 1.000.00 € Dans ce cas-là, le montant de la TVA déductible n'est pas intégré à la déclaration, il est donc nécessaire de corriger manuellement le montant qui y est affiché. Vendeur établi en DOM et acheteur en France métropolitaine 20 - Comptabilité du vendeur (Territorialité du dossier DOM) Déclarations concernées et lignes impactées : - CA3 : Ligne 04 - CA12 : Ligne 02 Comptes à utiliser et leur paramétrage : - 411xxx - Clients : sans paramétrage - 7079xxx - Ventes de marchandises : Territorialité : Importation/exportation Nature de taxe : Importation/exportation Exonération Type d'opération : Biens et prestations de services Schéma d'écriture : 411xxxxx - Débit - 1.000.00 € 7079xxxxx - Crédit - 1.000.00 € 21 - Comptabilité de l'acheteur (Territorialité du dossier France) Déclarations concernées et lignes impactées : - CA3 : aucune ligne - CA12 : aucune ligne Comptes à utiliser et leur paramétrage : - 401xxx - Fournisseurs : sans paramétrage - 607xxx - Ventes de marchandises : Territorialité : Importation/exportation Nature de la taxe : Importation/exportation Exonération Type d'opération : Biens et prestations de services Schéma d'écriture : 401xxxxx - Crédit - 1.000.00 € 607xxxxx - Débit - 1.000.00 € Vendeur établi en Guyane et acheteur établi en Réunion, ou vice-versa 22 - Comptabilité du vendeur (Territorialité du dossier DOM) Déclarations concernées et lignes impactées : - CA3 : Ligne 04 - CA12 : Ligne 02 Comptes à utiliser et leur paramétrage : - 411xxx - Clients : sans paramétrage - 7079xxx - Ventes de marchandises : Territorialté : Importation/exportation Nature de taxe : Importation/exportation Exonération Type d'opération : Biens et prestations de services Schéma d'écriture : 411xxxxx - Débit - 1.000.00 € 7079xxxxx - Crédit - 1.000.00 € 23 - Comptabilité de l'acheteur (Territorialité du dossier DOM) Déclarations concernées et lignes impactées : - CA3 : aucune ligne - CA12 : aucune ligne Comptes à utiliser et leur paramétrage : - 401xxx - Fournisseurs : sans paramétrage - 607xxx - Achats de marchandises : Territorialité : Importation/exportation 95 EBP Comptabilité Open Line Pro Nature de la taxe : Importation/exportation Exonération Type d'opération : Biens et prestations de services Schéma d'écriture : 401xxxxx - Crédit - 1.000.00 € 607xxxxx - Débit - 1.000.00 € Vendeur établi en Guadeloupe ou Martinique et acheteur établi en Guyane ou Réunion, ou vice-versa 24 - Comptabilité du vendeur (Territorialité du dossier DOM) Déclarations concernées et lignes impactées : - CA3 : Ligne 04 - CA12 : Ligne 02 Comptes à utiliser et leur paramétrage : - 411xxx - Clients : sans paramétrage - 7079xxx - Ventes de marchandises : Territorialité : Importation/exportation Nature de taxe : Importation/exportation Exonération Type d'opération : Biens et prestations de services Schéma d'écriture : 411xxxxx - Débit - 1.000.00 € 7079xxxxx - Crédit - 1.000.00 € 25 - Comptabilité de l'acheteur (Territorialité du dossier DOM) Déclarations concernées et lignes impactées : - CA3 : aucune ligne - CA12 : aucune ligne Comptes à utiliser et leur paramétrage : - 401xxx - Fournisseurs : sans paramétrage - 607xxx - Achats de marchandises : Territorialité : Importation/exportation Nature de la taxe : Importation/exportation Exonération Type d'opération : Biens et prestations de services Schéma d'écriture : 401xxxxx - Crédit - 1.000.00 € 607xxxxx - Débit - 1.000.00 € Vendeur établi en Guadeloupe et acheteur établi en Martinique, ou vice-versa 26 - Comptabilité du vendeur (Territorialité du dossier DOM) Déclarations concernées et lignes impactées : - CA3 : Lignes 01, 2, 10, 11 - CA12 : Lignes 07, 08 Comptes à utiliser et leur paramétrage : - 411xxx - Clients : sans paramétrage - 4457xxx - TVA : Territorialté : DOM Nature de taxe : DOM en fonction du taux - 707xxx - Ventes de marchandises : Territorialté : DOM Nature de taxe : DOM en fonction du taux Type d'opération : Biens et prestations de services ou autres opérations imposables Schéma d'écriture : 411xxxxx - Débit - 1.085.00 € 4457xxxx - Crédit - 85.00 € 7079xxxx - Crédit - 1.000.00 € 27 - Comptabilité de l'acheteur (Territorialité du dossier DOM) Déclarations concernées et lignes impactées : - CA3 : Lignes 19, 20 - CA12 : Lignes 23, 20 Comptes à utiliser et leur paramétrage : - 401xxx - Fournisseurs : sans paramétrage - 44566xx - TVA : Territorialité : DOM Nature de la taxe : DOM en fonction du taux - 607xxx - Achats de marchandises : Territorialité : DOM Nature de la taxe : DOM 8.5 % ou 2.10 % 96 MANUEL Type d'opération : Biens et prestations de services Schéma d'écriture : 401xxxxx - Crédit - 1.085.00 € 44566xxx - Débit - 85.00 € 607xxxxx - Débit - 1.000.00 € Cas particuliers : Les prestations de service localisables (article 259A du CGI) Vendeur établi en France Métropolitaine (territorialité du dossier France) 28 - Prestation facturée en DOM mais réalisée en France métropolitaine Déclarations concernées et lignes impactées : - CA3 : lignes 01, 08, 09 - CA12 : lignes 05, 06 Comptes à utiliser et leur paramétrage : - 411xxx - Fournisseurs : sans paramétrage - 44571xx - TVA : Territorialité : France Nature de la taxe : France en fonction du taux, mais normalement 19.6 % - 707xxx - Ventes de marchandises : Territorialité : France Nature de la taxe : France en fonction du taux, mais normalement 19.6 % Type d'opération : Biens et prestations de services Schéma d'écriture : 411xxxxx - Débit - 1.085.00 € 44571xxx - Crédit - 85.00 € 707xxxxx - Crédit - 1.000.00 € 29 - Prestation facturée en DOM et réalisée en DOM Déclarations concernées et lignes impactées : - CA3 : lignes 01, 10, 11 - CA12 : lignes 07, 08 Comptes à utiliser et leur paramétrage : - 411xxx - Clients : sans paramétrage - 44571xx - TVA : Territorialité : DOM Nature de la taxe : DOM en fonction du taux, mais normalement 8.5 % - 707xxx - Ventes de marchandises : Territorialité : DOM Nature de la taxe : DOM en fonction du taux, mais normalement 8.5 % Type d'opération : Biens et prestations de services Schéma d'écriture : 411xxxxx - Débit - 1.085.00 € 44571xxx - Crédit - 85.00 € 707xxxxx - Crédit - 1.000.00 € Acheteur établi en DOM (territorialité du dossier DOM) 30 - Prestation facturée en DOM mais réalisée en France métropolitaine Déclarations concernées et lignes impactées : - CA3 : ligne 20 - CA12 : ligne 20 Comptes à utiliser et leur paramétrage : - 401xxx - Fournisseurs : sans paramétrage - 44566xx - TVA : Territorialité : France Nature de la taxe : France en fonction du taux, mais normalement 19.6 % - 607xxx - Achats de marchandises : Territorialité : France Nature de la taxe : France en fonction du taux, mais normalement 19.6 % Type d'opération : Biens et prestations de services Schéma d'écriture : 401xxxxx - Crédit - 1.085.00 € 44566xxx - Débit - 85.00 € 607xxxxx - Débit - 1.000.00 € 31 - Prestation facturée en DOM et réalisée en DOM Déclarations concernées et lignes impactées : - CA3 : ligne 20 97 EBP Comptabilité Open Line Pro - CA12 : ligne 20 Comptes à utiliser et leur paramétrage : - 401xxx - Fournisseurs : sans paramétrage - 44566xx - TVA : Territorialité : DOM Nature de la taxe : DOM en fonction du taux, mais normalement 8.5 % - 607xxx - Achats de marchandises : Territorialité : DOM Nature de la taxe : DOM en fonction du taux, mais normalement 8.5 % Type d'opération : Biens et prestations de services Schéma d'écriture : 401xxxxx - Crédit - 1.085.00 € 44566xxx - Débit - 85.00 € 607xxxxx - Débit - 1.000.00 € Cas particuliers : les prestations immatérielles (article 259B du CGI) Vendeur établi en France métropolitaine : exemples de comptabilité du vendeur en Territorialité France 32 - Client situé en DOM, donc facturation taux DOM Déclarations concernées et lignes impactées : - CA3 : lignes 01, 10, 11 - CA12 : lignes 07, 08 Comptes à utiliser et leur paramétrage : - 411xxx - Clients : sans paramétrage - 44571xx - TVA : Territorialité : DOM Nature de la taxe : DOM en fonction du taux, mais normalement 8.5 % - 707xxx - Ventes de marchandises : Territorialité : DOM Nature de la taxe : DOM en fonction du taux, mais normalement 8.5 % Type d'opération : Biens et prestations de services Schéma d'écriture : 411xxxxx - Débit - 1.085.00 € 44571xxx - Crédit - 85.00 € 707xxxxx - Crédit - 1.000.00 € 33 - Client situé en France, donc facturation taux France Déclarations concernées et lignes impactées : - CA3 : lignes 01, 08, 09 - CA12 : lignes 05, 06 Comptes à utiliser et leur paramétrage : - 411xxx - Clients : sans paramétrage - 44571xx - TVA : Territorialité : France Nature de la taxe : France en fonction du taux, mais normalement 19.6 % - 707xxx - Ventes de marchandises : Territorialité : France Nature de la taxe : France en fonction du taux, mais normalement 19.6 % Type d'opération : Biens et prestations de services Schéma d'écriture : 411xxxxx - Débit - 1.196.00 € 44571xxx - Crédit - 196.00 € 707xxxxx - Crédit - 1.000.00 € Vendeur établi en France métropolitaine : exemples de comptabilité de l'acheteur 34 - Client situé en DOM, donc facturation taux DOM Déclarations concernées et lignes impactées : - CA3 : ligne 20 - CA12 : ligne 20 Comptes à utiliser et leur paramétrage : - 401xxx - Fournisseurs : sans paramétrage - 44566xx - TVA : Territorialité : DOM Nature de la taxe : DOM en fonction du taux, mais normalement 8.5 % - 607xxx - Achats de marchandises : 98 MANUEL Territorialité : DOM Nature de la taxe : DOM en fonction du taux, mais normalement 8.5 % Type d'opération : Biens et prestations de services Schéma d'écriture : 401xxxxx - Crédit - 1.085.00 € 44566xxx - Débit - 85.00 € 607xxxxx - Débit - 1.000.00 € 35 - Client situé en France, donc facturation taux France Déclarations concernées et lignes impactées : - CA3 : ligne 20 - CA12 : ligne 20 Comptes à utiliser et leur paramétrage : - 401xxx - Fournisseurs : sans paramétrage - 44566xx - TVA : Territorialité : France Nature de la taxe : France en fonction du taux, mais normalement 19.6 % - 607xxx - Achats de marchandises : Territorialité : France Nature de la taxe : France en fonction du taux, mais normalement 19.6 % Type d'opération : Biens et prestations de services Schéma d'écriture : 401xxxxx - Crédit - 1.196.00 € 44566xxx - Débit - 196.00 € 607xxxxx - Débit - 1.000.00 € Vendeur établi en DOM : exemples de comptabilité du vendeur en Territorialité DOM 36 - Client situé en DOM, donc facturation taux DOM Déclarations concernées et lignes impactées : - CA3 : lignes 01, 10, 11 - CA12 : lignes 07, 08 Comptes à utiliser et leur paramétrage : - 411xxx - Clients : sans paramétrage - 44571xx - TVA : Territorialité : DOM Nature de la taxe : DOM en fonction du taux, mais normalement 8.5 % - 707xxx - Ventes de marchandises : Territorialité : DOM Nature de la taxe : DOM en fonction du taux, mais normalement 8.5 % Type d'opération : Biens et prestations de services Schéma d'écriture : 411xxxxx - Débit - 1.085.00 € 44571xxx - Crédit - 85.00 € 707xxxxx - Crédit - 1.000.00 € 37 - Client situé en France, donc facturation taux France Déclarations concernées et lignes impactées : - CA3 : lignes 01, 08, 09 - CA12 : lignes 05, 06 Comptes à utiliser et leur paramétrage : - 411xxx - Clients : sans paramétrage - 44571xx - TVA : Territorialité : France Nature de la taxe : France en fonction du taux, mais normalement 19.6 % - 707xxx - Ventes de marchandises : Territorialité : France Nature de la taxe : France en fonction du taux, mais normalement 19.6 % Type d'opération : Biens et prestations de services Schéma d'écriture : 411xxxxx - Débit - 1.196.00 € 44571xxx - Crédit - 196.00 € 707xxxxx - Crédit - 1.000.00 € Vendeur établi en DOM : exemple de comptabilité de l'acheteur 38 - Client situé en DOM, donc facturation taux DOM Déclarations concernées et lignes impactées : - CA3 : ligne 20 99 EBP Comptabilité Open Line Pro - CA12 : ligne 20 Comptes à utiliser et leur paramétrage : - 401xxx - Fournisseurs : sans paramétrage - 44566xx - TVA : Territorialité : DOM Nature de la taxe : DOM en fonction du taux, mais normalement 8.5 % - 607xxx - Achats de marchandises : Territorialité : DOM Nature de la taxe : DOM en fonction du taux, mais normalement 8.5 % Type d'opération : Biens et prestations de services Schéma d'écriture : 401xxxxx - Crédit - 1.085.00 € 44566xxx - Débit - 85.00 € 607xxxxx - Débit - 1.000.00 € 39 - Client situé en France, donc facturation taux France Déclarations concernées et lignes impactées : - CA3 : ligne 20 - CA12 : ligne 20 Comptes à utiliser et leur paramétrage : - 401xxx - Fournisseurs : sans paramétrage - 44566xx - TVA : Territorialité : France Nature de la taxe : France en fonction du taux, mais normalement 19.6 % - 607xxx - Achats de marchandises : Territorialité : France Nature de la taxe : France en fonction du taux, mais normalement 19.6 % Type d'opération : Biens et prestations de services Schéma d'écriture : 401xxxxx - Crédit - 1.196.00 € 44566xxx - Débit - 196.00 € 607xxxxx - Débit - 1.000.00 € Cas particuliers : Achats et ventes d'immobilisation Les comptes à utiliser pour les achats d'immobilisations sont des comptes : - de nature "Comptes d'immobilisation" pour les comptes soumis à TVA - de nature "TVA sur achats d'immobilisation" pour les comptes de TVA. Leur paramétrage est sensiblement identique à celui des Achats de marchandises définis dans les cas particuliers, à la différence que le type d'opération devient "Immobilisations de biens et prestations de services" pour les comptes soumis à TVA. D'autre part, les lignes de déclarations impactées par ces achats sont différentes des exemples précédents. Impression - Fenêtre principale de navigation La fenêtre principale de navigation de l'impression est divisée en 3 zones : Catégorie des modèles, Modèles d'impression disponibles, Image de l'aperçu du modèle sélectionné. Catégories Les catégories permettent de classer les modèles en fonction des types de documents et des données de bases, des éléments financiers... Le logiciel est livré avec un classement par défaut, présent dans l'onglet Catégorie. Dans la partie catégorie, vous pouvez avoir : Catégorie principale : Etats standards Sous catégorie : Journal Sous catégorie : Grand Livre Sous catégorie : Balance .... Catégorie principale : Etats de gestion Sous catégorie : Echéancier Sous catégorie : Balance âgée par échéances Sous catégorie : Balance âgée par Lettrage Catégorie principale : Etats fiscaux... 100 MANUEL Pour voir un modèle, il faut impérativement se situer dans la catégorie ou la sous-catégorie à laquelle il appartient. Vous avez la possibilité de personnaliser ces catégories en créant des mots-clés. Modèles disponibles Cette partie contient la liste des modèles proposés pour chaque catégorie. Ces modèles peuvent être modifiés avec l'éditeur de modèles à l'aide du bouton "Modifier le modèle". A partir d'un modèle, dans la barre d'outils ou par le menu contextuel/clic droit, vous pouvez : imprimer le modèle (ouverture de la page de filtres et aperçus), affecter un mot clé, définir le modèle à utiliser par défaut pour les fiches, définir le modèle à utiliser par défaut pour les listes. Pour passer un modèle en modèle par défaut, vous devez sélectionner un modèle, puis cliquer dans la barre d'outils Modèle par défaut ou clic droit sur le modèle puis Modèle par défaut. Image de l'aperçu du modèle Cette partie permet de visualiser le modèle que vous avez sélectionné. Cette visualisation est une image, elle ne contient pas les informations concernant votre dossier. Filtres et aperçu de l'édition En double-cliquant sur le modèle, vous accédez à la fenêtre de sélection des filtres et visualisation de l'aperçu. CONSULTATION Consultation - Démarrer une tâche Accès : Consultation - Démarrer une tâche Pour chaque menu du volet de navigation, vous disposez en début des fonctions associées d'une entrée de menu Démarrer une tâche. Cette entrée permet de visualiser l'enchaînement des fonctions disponibles dans chaque menu. Les actions ci-dessous sont associées à cette entrée : Consultation/Lettrage : permet d'ouvrir la fenêtre de consultation ou de lettrage sur le compte consulté ou lettré en dernier. Grand Livre interactif : permet d'accéder à la fenêtre de consultation d'une série de comptes. Balance interactive : permet d'accéder à la fenêtre de consultation de la balance. Impressions : permet d'accéder à la fenêtre des impressions. CONSULTATION/LETTRAGE Consultation de compte Accès : Quotidien - Consultation/Lettrage OU Consultation - Consultation/Lettrage La consultation de compte permet d'afficher l'ensemble des lignes d'écritures enregistrées sur un compte de type Détail et sur un seul exercice. Cette consultation permet aussi bien de connaître le solde réel d'un compte à un instant donné, que de procéder aux lettrages qui s'imposent ou encore d'effectuer des recherches... La combinaison de différents filtres permet d'affiner la sélection des lignes d'écritures à afficher. Filtres Ces filtres sont mémorisés : 101 EBP Comptabilité Open Line Pro Les dernières sélections effectuées sont conservées ; elles seront reprises à l'identique lors du prochain affichage de la fenêtre de consultation. Filtre sur les comptes, Filtre sur la période, Filtre sur le statut des lignes, Filtre sur le type de ligne. Sélection de l'exercice Les dates d'exercice proposées par défaut sont celles de l'exercice courant. Lorsque cet exercice courant est ouvert, alors tous les exercices ouverts sont accessibles. Vous pouvez donc sélectionner l'exercice que vous voulez consulter sans être obligé de changer d'exercice courant. Pour cela, il vous suffit d'ouvrir la liste déroulante disponible dans le champ Exercice. Lorsque l'exercice courant est clôturé, alors seul l'exercice courant est accessible. Sélection du compte La sélection du compte se fait dans l'en-tête de la fenêtre de consultation, champ Identification - Compte. Le compte peut être saisi directement dans ce champ ou sélectionné dans la liste déroulante qui reprend l'intégralité des comptes existants sur l'exercice courant. Un bouton situé à gauche de cette liste déroulante permet d'ouvrir la fiche du compte sélectionné. Dès que le numéro du compte est renseigné, alors les données de base de ce compte sont automatiquement mises à jour : - Intitulé du compte, - Cumul de tous les montants débiteurs saisis sur ce compte pendant tout l'exercice courant, - Cumul de tous les montants créditeurs saisis sur ce compte pendant tout l'exercice courant, - Solde de ce compte au dernier jour de l'exercice courant. Ces données de base sont totalement indépendantes des choix effectués sur les filtres comme de la date système (= date et heure de l'ordinateur). Affichage des lignes d'écriture L'affichage des lignes d'écritures dans la consultation reprend la majorité des informations renseignées dans le masque de saisie (Journal, Date, Pièce, Libellé, Débit/Crédit). En revanche, à l'inverse de la saisie, les lignes d'écritures sont par défaut affichées dans l'ordre chronologique. L'affichage des lignes d'écritures est directement dépendant des choix effectués sur les filtres. Certaines lignes peuvent apparaître grisées et en italique : il s'agit des lignes qui répondent aux critères de filtrage sur l'exercice courant mais qui ont été lettrées sur un exercice postérieur. Le délettrage de ces lignes n'est d'ailleurs uniquement possible que sur l'exercice au cours duquel elles ont été lettrées. Dans le pied de la zone d'affichage, une ligne de totalisation est affichée : elle cumule en temps réel la somme des montants débiteurs et des montants créditeurs des lignes affichées. Enfin, le Solde progressif est recalculé en temps réel en fonction des seules lignes affichées. Lettrage et délettrage manuel Il est possible de lettrer ou delettrer des lignes d'écritures d'un compte directement dans la fenêtre de Consultation sans être obligé d'accéder à la fenêtre de Lettrage ; pour cela, il faut que cette option soit paramétrée dans la fiche compte. Le fonctionnement du lettrage, la sélection des lignes, l'utilisation de la ligne de totalisation, l'attribution du code lettrage... sont les mêmes que dans ceux définis dans la fenêtre de Lettrage à proprement parler. Lettrage automatique Une fonction permet d'effectuer le lettrage automatique des lignes d'écritures d'un compte. Autres actions possibles à partir de la consultation 102 MANUEL Accès à la saisie par journal : En double cliquant sur une ligne d'écriture, en sélectionnant Saisie par journal dans le menu contextuel Menu contextuel = clic droit de la souris. ou en cliquant sur le bouton, il est possible d'être automatiquement positionné sur cette ligne d'écriture dans la saisie journal ayant servie à l'enregistrer. Voir document : Il est possible d'accéder au document d'origine ayant permis l'enregistrement de la ligne d'écriture : il peut s'agir, par exemple, de la facture transférée par la Gestion commerciale. Cacher le filtre/Afficher le filtre : En cliquant sur le bouton Cacher le filtre ou Afficher le filtre, il est possible d'afficher ou de masquer une ligne de filtre qui se positionne immédiatement avant les lignes d'écritures. Ce filtre contient des champs saisissables et permet d'affiner les sélections effectuées grâce aux filtres comptables mentionnés dans les paragraphes précédents. Rafraîchir : Ce bouton permet de mettre à jour l'affichage de la fenêtre de consultation, lorsque celui-ci a été modifié par une action effectuée dans une autre fenêtre (lettrage, saisie journal...). Facture non parvenue ou à émettre Ce bouton permet d'accéder à la fenêtre de paramétrage Facture/Avoir à emettre ou Facture/Avoir à recevoir et de générer l'extourne de l'écriture à laquelle cette ligne appartient. Charge ou produit constaté d'avance Ce bouton permet d'accéder à la fenêtre de paramétrage Charges ou Produits constatés d'avance et de générer la régularisation puis l'extourne de la ligne sélectionnée. Principes de lettrage et de délettrage Accès : Le lettrage est possible à partir la fenêtre de Consultation comme à partir de la fenêtre de Lettrage. Principes du lettrage Le lettrage consiste à : - sélectionner sur un compte au moins deux lignes d'écritures dont les montants s'équilibrent et qui ont trait à une opération commune, - puis à appliquer un même code alphanumérique appelé "code lettrage" ainsi qu'une même date de lettrage à ces lignes. Une facture n° 1234 de 1000 € est émise le 18/02/2008 au client DUPONT. Le 25/02/2008, le client Dupont adresse un chèque de 500 €, référencé 1234. Le 10/03/2008, le client Dupont adresse un nouveau chèque de 500 €, référence 1234. Ces deux règlements peuvent être identifiés comme venant solder la facture émise. Dès lors, ses trois lignes d'écriture peuvent être sélectionnées dans le compte du client DUPONT pour être identifiées par un même code et une même date de lettrage. La date de lettrage est la date système Date système = date et heure de l'ordinateur. à laquelle le lettrage a été effectué. Le lettrage peut être effectué aussi bien dans la fenêtre de Consultation que dans la fenêtre de Lettrage simplifié. Activer l'option sur le compte Pour que le lettrage ou le délettrage soient possibles, il faut que le compte soit de type Détail et que l'option "Autoriser le lettrage" soit activée sur sa fiche compte. Sélection des lignes La sélection des lignes peut se faire de deux façons différentes : - Soit grâce à la souris seule, en cochant la case située sur chaque ligne à l'extrême gauche de la fenêtre. - Soit en combinant le clavier et la souris (touche Ctrl + clic gauche). - Soit encore en combinant différentes touches du clavier (touche Ctrl + barre d'espace). Dans tous les cas, les lignes sélectionnées sont mises en surbrillance. En pied de masque, un "total des lignes sélectionnées" apparaît. - Cette ligne de totalisation est calculée en temps réel au fur et à mesure des sélections des lignes d'écritures. 103 EBP Comptabilité Open Line Pro - Elle permet de contrôler immédiatement l'équilibrage de ces lignes qui conditionne l'exécution du traitement. Choix des boutons Le choix des boutons dépend du type des lignes sélectionnées. Si aucune des lignes sélectionnées n'est lettrée et que ces lignes sont équilibrées, alors le bouton "Lettrer" est accessible. Dans tous les autres cas, seul le bouton "Délettrer" est accessible. Option de lettrage automatique Une fonction de lettrage automatique est disponible. Gestion du code lettrage lors du lettrage de lignes d'écriture Lorsque des lignes non lettrées dont les montants s'équilibrent sont sélectionnées et que le lettrage est demandé, alors le "Prochain code lettrage" renseigné sur la fiche compte est proposé par défaut. Si le code lettrage proposé est accepté, alors : - le code lettrage proposé et la date de lettrage sont affectés à chacune des lignes sélectionnées, - un prochain code lettrage est calculé puis est reporté sur la fiche compte. Si le code lettrage proposé par défaut est modifié, alors : - le code lettrage saisi et la date de lettrage sont affectés à chacune des lignes sélectionnées, - un prochain code lettrage est calculé par rapport au code lettrage saisi puis est reporté sur la fiche compte. Gestion du code lettrage lors du délettrage des lignes d'écriture Lorsque des lignes lettrées dont les montants s'équilibrent et dont les codes lettrage sont identiques sont sélectionnées et que le délettrage est demandé, alors le code lettrage et la date de lettrage sont supprimés de toutes les lignes sélectionnées. La suppression de ce lettrage est sans impact sur le champ "Prochain code lettrage" de la fiche compte. Options de délettrage Le délettrage s'opère : - sur toutes les lignes sélectionnées déjà lettrées, - mais aussi sur les toutes lignes non sélectionnées possédant le même code lettrage. Pour faciliter le délettrage, trois options sont disponibles en cliquant sur le bouton "Délettrer" de la barre d'outils : Délettrer par compte : cette action permet de délettrer en une seule opération toutes les lignes déjà lettrées sur ce compte. Délettrer par code : cette action permet de définir une fourchette de codes lettrage puis de délettrer toutes les lignes d'écritures déjà lettrées sur lesquelles ces codes lettrage apparaissent et, cela, quelque soit leur date de lettrage. Délettrer par date : cette action permet de définir une fourchette de dates de lettrage puis de délettrer toutes les lignes d'écritures déjà lettrées sur lesquelles ces dates apparaissent et, cela, quelque soit leur code de lettrage. LETTRAGE AUTOMATIQUE Lettrage automatique Accès : Sur un compte : le lettrage est possible à partir la fenêtre de Consultation comme à partir de la fenêtre de Lettrage ; sur une série de comptes : Consultation - Lettrage automatique Le lettrage automatique est une fonction permettant de lettrer automatiquement des lignes d'écritures d'un compte ou de plusieurs comptes, sans avoir à les présélectionner manuellement dans la fenêtre de lettrage. 104 MANUEL Les principes et règles de lettrage sur un compte restent les mêmes que celles déjà définies dans le lettrage, le lettrage approché et la fenêtre de lettrage. Un assistant est affiché : Il permet de sélectionner les comptes lettrables à traiter, les lignes d'écritures non lettrées à rechercher, la méthode de lettrage ainsi que de définir les éléments liés au lettrage approché. Période du ... au ... : Ce champs permet de sélectionner les dates des lignes d'écritures à analyser. Type de comptes : Une liste déroulante permet de sélectionner une série de comptes en fonction de leur nature. Du compte ... au compte au ... : Une fourchette de comptes dépendant du choix du type de comptes est proposée. La sélection peut encore affinée, à la condition de rester dans les limites de la fourchette définie. Options : Une liste déroulante permet de sélectionner la méthode de lettrage à appliquer. - N° de pièce : Toutes les lignes d'écritures non encore lettrées dans un même compte, qui portent un numéro de pièce identique peuvent être lettrées entre elles, quelque soient leur montant respectif ou le nombre de lignes concernées. - N° de document : Toutes les lignes d'écritures non encore lettrées dans un même compte, qui portent un numéro de document identique peuvent être lettrées entre elles, quelque soient leur montant respectif ou le nombre de lignes concernées. - Solde progressif : Toutes les lignes d'écritures non lettrées dans un même compte peuvent être lettrées entre elles, à condition qu'un solde progressif nul, égal ou inférieur à l'écart autorisé sur ce compte soit obtenu et cela quelque soit le nombre de lignes concernées, leur numéro ou leur montant respectif. - Montant exact : Les lignes d'écritures non lettrées d'un même compte peuvent être lettrées à condition qu'elles s'équilibrent exactement entre elles. Au maximum, cinq lignes d'écritures peuvent permettent de réaliser cet équilibre. Lignes : Trois cases à cocher permettent d'affiner la sélection des lignes d'écritures en fonction de leur statut. Régularisation : La zone est accessible pour toutes les méthodes de lettrage, sauf la méthode "Montant exact". - Autoriser le lettrage approché : Si la case est cochée, alors les valeurs relatives au lettrage approché renseignées sur la fiche compte seront appliquées. - N° de pièce : Le champ est accessible si la case "Autoriser le lettrage approché" est cochée. Un numéro de pièce est proposé, mais il reste modifiable. Si le journal de destination est en numérotation manuelle, alors le numéro de pièce déterminé dans l'assistant sera utilisé pour comptabiliser l'écriture de régularisation. Si le journal de destination est en numérotation automatique, alors le numéro de pièce utilisé pour comptabiliser l'écriture de régularisation sera le prochain numéro de pièce défini dans la fiche journal. - Libellé : Le champs est accessible si la case Autoriser le lettrage approché est cochée. Un libellé est proposé, mais il reste modifiable Le même libellé sera repris sur toutes les écritures de régularisation qui seront créées. Démarrer : Ce bouton commande l'exécution du traitement en fonction des filtres choisis et de la méthode de lettrage. Annuler : Ce bouton permet de fermer l'assistant sans lancer le traitement. Deux accès différents : un choix de comptes différent Un bouton "Lettrage automatique" est disponible dans la fenêtre de Lettrage. Dans ce cas, le lettrage automatique est possible uniquement sur le compte affiché. Une entrée "Lettrage automatique" est disponible dans le menu Consultation/Lettrage. Dans ce cas, le lettrage automatique est possible sur tous les comptes définis comme lettrables sur l'exercice. LETTRAGE SIMPLIFIÉ 105 EBP Comptabilité Open Line Pro Principes de lettrage et de délettrage Accès : Le lettrage est possible à partir la fenêtre de Consultation comme à partir de la fenêtre de Lettrage. Principes du lettrage Le lettrage consiste à : - sélectionner sur un compte au moins deux lignes d'écritures dont les montants s'équilibrent et qui ont trait à une opération commune, - puis à appliquer un même code alphanumérique appelé "code lettrage" ainsi qu'une même date de lettrage à ces lignes. Une facture n° 1234 de 1000 € est émise le 18/02/2008 au client DUPONT. Le 25/02/2008, le client Dupont adresse un chèque de 500 €, référencé 1234. Le 10/03/2008, le client Dupont adresse un nouveau chèque de 500 €, référence 1234. Ces deux règlements peuvent être identifiés comme venant solder la facture émise. Dès lors, ses trois lignes d'écriture peuvent être sélectionnées dans le compte du client DUPONT pour être identifiées par un même code et une même date de lettrage. La date de lettrage est la date système Date système = date et heure de l'ordinateur. à laquelle le lettrage a été effectué. Le lettrage peut être effectué aussi bien dans la fenêtre de Consultation que dans la fenêtre de Lettrage simplifié. Activer l'option sur le compte Pour que le lettrage ou le délettrage soient possibles, il faut que le compte soit de type Détail et que l'option "Autoriser le lettrage" soit activée sur sa fiche compte. Sélection des lignes La sélection des lignes peut se faire de deux façons différentes : - Soit grâce à la souris seule, en cochant la case située sur chaque ligne à l'extrême gauche de la fenêtre. - Soit en combinant le clavier et la souris (touche Ctrl + clic gauche). - Soit encore en combinant différentes touches du clavier (touche Ctrl + barre d'espace). Dans tous les cas, les lignes sélectionnées sont mises en surbrillance. En pied de masque, un "total des lignes sélectionnées" apparaît. - Cette ligne de totalisation est calculée en temps réel au fur et à mesure des sélections des lignes d'écritures. - Elle permet de contrôler immédiatement l'équilibrage de ces lignes qui conditionne l'exécution du traitement. Choix des boutons Le choix des boutons dépend du type des lignes sélectionnées. Si aucune des lignes sélectionnées n'est lettrée et que ces lignes sont équilibrées, alors le bouton "Lettrer" est accessible. Dans tous les autres cas, seul le bouton "Délettrer" est accessible. Option de lettrage automatique Une fonction de lettrage automatique est disponible. Gestion du code lettrage lors du lettrage de lignes d'écriture Lorsque des lignes non lettrées dont les montants s'équilibrent sont sélectionnées et que le lettrage est demandé, alors le "Prochain code lettrage" renseigné sur la fiche compte est proposé par défaut. Si le code lettrage proposé est accepté, alors : - le code lettrage proposé et la date de lettrage sont affectés à chacune des lignes sélectionnées, - un prochain code lettrage est calculé puis est reporté sur la fiche compte. 106 MANUEL Si le code lettrage proposé par défaut est modifié, alors : - le code lettrage saisi et la date de lettrage sont affectés à chacune des lignes sélectionnées, - un prochain code lettrage est calculé par rapport au code lettrage saisi puis est reporté sur la fiche compte. Gestion du code lettrage lors du délettrage des lignes d'écriture Lorsque des lignes lettrées dont les montants s'équilibrent et dont les codes lettrage sont identiques sont sélectionnées et que le délettrage est demandé, alors le code lettrage et la date de lettrage sont supprimés de toutes les lignes sélectionnées. La suppression de ce lettrage est sans impact sur le champ "Prochain code lettrage" de la fiche compte. Options de délettrage Le délettrage s'opère : - sur toutes les lignes sélectionnées déjà lettrées, - mais aussi sur les toutes lignes non sélectionnées possédant le même code lettrage. Pour faciliter le délettrage, trois options sont disponibles en cliquant sur le bouton "Délettrer" de la barre d'outils : Délettrer par compte : cette action permet de délettrer en une seule opération toutes les lignes déjà lettrées sur ce compte. Délettrer par code : cette action permet de définir une fourchette de codes lettrage puis de délettrer toutes les lignes d'écritures déjà lettrées sur lesquelles ces codes lettrage apparaissent et, cela, quelque soit leur date de lettrage. Délettrer par date : cette action permet de définir une fourchette de dates de lettrage puis de délettrer toutes les lignes d'écritures déjà lettrées sur lesquelles ces dates apparaissent et, cela, quelque soit leur code de lettrage. Lettrage simplifié Accès : Consultation - Lettrage simplifié La fenêtre de lettrage permet d'afficher l'ensemble des lignes d'écritures enregistrées sur un compte de type Détail et sur un seul exercice. Cette fenêtre permet aussi bien de connaître le solde réel d'un compte à un instant donné, que de procéder aux lettrages qui s'imposent ou encore d'effectuer des recherches... Elle est complémentaire de la fenêtre de consultation. La combinaison de différents filtres permet d'affiner les lignes d'écriture à afficher. Filtres Les filtres affichés sont mémorisés : les dernières sélections effectuées sont conservées ; elles seront reprises à l'identique lors du prochain affichage de la fenêtre de lettrage. Filtre sur les comptes, Filtre sur la période, Filtre sur le statut des lignes, Filtre sur le type de ligne. Sélection de l'exercice Les dates d'exercice proposées par défaut sont celles de l'exercice courant. Lorsque cet exercice courant est ouvert, alors tous les exercices ouverts sont accessibles. Vous pouvez donc sélectionner l'exercice que vous voulez consulter sans être obligé de changer d'exercice courant. Pour cela, il vous suffit d'ouvrir la liste déroulante disponible dans le champ Exercice. Lorsque l'exercice courant est clôturé, alors seul l'exercice courant est accessible. Sélection du compte 107 EBP Comptabilité Open Line Pro La sélection du compte se fait dans l'en-tête de la fenêtre de lettrage, champ Identification - Compte. Le compte peut être saisi directement dans ce champ ou sélectionné dans la liste déroulante qui reprend l'intégralité des comptes existants sur l'exercice courant. Un bouton situé à gauche de cette liste déroulante permet d'ouvrir la fiche du compte sélectionné. Dès que le numéro du compte est renseigné, alors les données de base de ce compte sont automatiquement mises à jour : Intitulé du compte Cumul de tous les montants débiteurs saisis sur ce compte pendant tout l'exercice courant, Cumul de tous les montants créditeurs saisis sur ce compte pendant tout l'exercice courant, Solde de ce compte au dernier jour de l'exercice courant. Ces données de base sont totalement indépendantes des choix effectués sur les filtres comme de la date système (= date et heure de l'ordinateur). Affichage des lignes d'écritures L'affichage des lignes d'écritures dans la fenêtre de lettrage reprend la majorité des informations renseignées dans le masque de saisie (Journal, Date, Pièce, Libellé, Débit/Crédit). En revanche, à l'inverse de la saisie, les lignes d'écritures sont par défaut affichées dans l'ordre chronologique. L'affichage de ces lignes d'écritures est directement dépendant des choix effectués sur les filtres. Certaines lignes peuvent apparaître grisées et en italique : il s'agit des lignes qui répondent aux critères de filtrage sur l'exercice courant mais qui ont été lettrées sur un exercice postérieur. Le délettrage de ces lignes n'est d'ailleurs uniquement possible que sur l'exercice au cours duquel elles ont été lettrées. La fenêtre de lettrage est séparée en deux tableaux qui regroupent les lignes d'écritures : - Le premier tableau affiche les Factures et les Remboursements. - Le second tableau affiche les Avoirs et les Règlements. Dans le pied de la zone d'affichage, une ligne de totalisation est affichée : elle cumule en temps réel la somme des montants débiteurs et des montants créditeurs des lignes affichées. Enfin, le Solde progressif est recalculé en temps réel en fonction des seules lignes affichées. Lettrage et délettrage Le lettrage est possible à condition que cette option soit paramétrée dans la fiche compte. Le fonctionnement du lettrage, la sélection des lignes, l'utilisation de la ligne de totalisation, l'attribution du code lettrage... sont les mêmes que dans ceux définis dans la fenêtre de Consultation. Lettrage et délettrage manuel Il est possible de lettrer ou délettrer des lignes d'écritures d'un compte directement dans la fenêtre de Consultation sans être obligé d'accéder à la fenêtre de Lettrage ; pour cela, il faut que cette option soit paramétrée dans la fiche compte. Le fonctionnement du lettrage, la sélection des lignes, l'utilisation de la ligne de totalisation, l'attribution du code lettrage... sont les mêmes que dans ceux définis dans la fenêtre de Lettrage à proprement parler. Lettrage automatique Une fonction permet d'effectuer le lettrage automatique des lignes d'écritures d'un compte. Autres actions possibles à partir de la fenêtre de lettrage Accès à la saisie par journal : En double cliquant sur une ligne d'écriture, en sélectionnant Saisie par journal dans le menu contextuel Menu contextuel = clic droit de la souris. ou en cliquant sur le bouton, il est possible d'être automatiquement positionné sur cette ligne d'écriture dans la saisie journal ayant servie à l'enregistrer. 108 MANUEL Voir document : Il est possible d'accéder au document d'origine ayant permis l'enregistrement de la ligne d'écriture : il peut s'agit, par exemple, de la facture transférée par la Gestion Commerciale. Cacher le filtre/Afficher le filtre : En cliquant sur le bouton Cacher le filtre ou Afficher le filtre, il est possible d'afficher ou de masquer une ligne de filtre qui se positionne immédiatement avant les lignes d'écritures. Ce filtre contient des champs saisissables et permet d'affiner les sélections effectuées grâce aux filtres comptables mentionnés dans un paragraphe précédent. Rafraîchir : Ce bouton permet de mettre à jour l'affichage de la fenêtre de lettrage, lorsque celui-ci a été modifié par une action effectuée dans une autre fenêtre (consultation, lettrage...). Facture non parvenue ou à émettre Ce bouton permet d'accéder à la fenêtre de paramétrage Facture/Avoir à emettre ou Facture/Avoir à recevoir et de générer l'extourne de l'écriture à laquelle cette ligne appartient. Charge ou produit constaté d'avance Ce bouton permet d'accéder à la fenêtre de paramétrage Charges ou Produits constatés d'avance et de générer la régularisation puis l'extourne de la ligne sélectionnée. GRAND LIVRE INTERACTIF Grand Livre interactif Accès : Consultation - Grand Livre Interactif Le Grand Livre interactif permet d'afficher à l'écran un compte ou une série de comptes selon différents critères de filtrage. Il permet une visualisation rapide du contenu des comptes et permet d'obtenir à l'écran en temps réel le résultat des recherches. Cette fenêtre est divisée en plusieurs zones. Un en-tête Filtre sur la période Filtre sur les natures de comptes Les natures de comptes disponibles dans la sélection sont : - Tous, soit tous les comptes du plan comptable de racine 1 à 9zzzzz sans distinction. - Bilan, soit tous les comptes du plan comptable de racine 1 à 5zzzzz. - Gestion, soit tous les comptes du plan comptable de racine 6 et 7zzzz. - Fournisseurs, soit tous les comptes du plan comptable de racine 40 à 40zzzz. - Clients, soit tous les comptes du plan comptable de racine 41 à 41zzzz. - Fournisseurs et Clients, soit tous les comptes du plan comptable de racine 40 à 41zzzz. - Comptes spéciaux, soit tous les comptes du plan comptable de racine 8 à 9zzzz. Filtre sur les comptes Ce filtre permet de sélectionner une fourchette de comptes. Les comptes peuvent être saisis ou sélectionnés dans la liste déroulante. Un bouton situé à gauche de cette liste déroulante permet d'ouvrir la fiche du compte sélectionné. A l'inverse du comportement standard, en consultation par exemple, tous les comptes (quelque soit leur type) peuvent être saisis. En effet, ici, il s'agit moins de sélectionner précisément un compte que de déterminer un intervalle. Ces comptes doivent néanmoins toujours être inclus dans la fourchette de départ déterminée par le choix de la nature de comptes. Option de centralisation des Fournisseurs/Clients Cette option de centralisation est liée aux seules natures de comptes Clients, Fournisseurs et Clients et Fournisseurs. Elle permet de cumuler entre eux, sur deux lignes uniquement, tous les comptes de nature Fournisseurs puis tous les comptes de nature Clients. Cette option permet donc d'alléger l'affichage. Filtre avancé sur le type des lignes Filtre avancé sur le statut des écritures Conservation des filtres : Tous les filtres sélectionnés dans le Grand Livre interactif sont conservés dans une même session et sur un même exercice. 109 EBP Comptabilité Open Line Pro En revanche, si vous changez d'exercice courant ou fermez puis ré-ouvrez votre dossier, alors tous les filtres par défaut sont ré-appliqués. Actualiser L'utilisation de ce bouton est nécessaire pour que l'affichage soit mis à jour en fonction des filtres. Corps de la fenêtre Comme pour la consultation, les lignes affichées sont les seules lignes qui répondent aux critères de filtrage ; elles reprennent l'ensemble des éléments de la saisie comptable. Actions possibles Consultation / Lettrage : Accès à la page de consultation du compte de la ligne sélectionnée Saisie par journal : Accès au journal d'origine de la ligne sélectionnée Voir le document : Accès direct au document qui a permis de générer cette ligne (document venant de la Gestion Commerciale, de la saisie par Guide...) Echéancier : Accès direct à l'échéancier de la ligne sélectionnée Lettrage automatique : Accès à l'assistant de lettrage automatique sur le compte de la ligne sélectionnée. BALANCE INTERACTIVE Balance interactive Accès : Consultation - Balance interactive La balance interactive permet d'afficher à l'écran le cumul des mouvements débiteurs, le cumul des mouvements créditeurs et le solde d'un compte ou d'une série de comptes selon différents critères de filtrage. Elle permet d'éviter les impressions d'une balance et d'obtenir à l'écran en temps réel le résultat des recherches. Cette fenêtre est divisée en plusieurs zones. Un en-tête Filtre sur la période Filtre sur les natures de comptes Les natures de comptes disponibles dans la sélection sont : - Tous, soit tous les comptes du plan comptable de racine 1 à 9zzzzz sans distinction. - Bilan, soit tous les comptes du plan comptable de racine 1 à 5 zzzzz. - Gestion, soit tous les comptes du plan comptable de racine 6 et 7zzzz. - Fournisseurs, soit tous les comptes du plan comptable de racine 40 à 40zzzz. - Clients, soit tous les comptes du plan comptable de racine 41 à 41zzzz. - Fournisseurs et Clients, soit tous les comptes du plan comptable de racine 40 à 41zzzz. - Comptes spéciaux, soit tous les comptes du plan comptable de racine 8 à 9zzzz. Filtre sur les comptes Ce filtre permet de sélectionner une fourchette de comptes. Les comptes peuvent être saisis ou sélectionnés dans la liste déroulante. Un bouton situé à gauche de cette liste déroulante permet d'ouvrir la fiche du compte sélectionné. A l'inverse du comportement standard, en consultation par exemple, tous les comptes, quelque soit leur type peuvent être saisis. En effet, ici, il s'agit moins de sélectionner précisément un compte que de déterminer un intervalle. Ces comptes doivent néanmoins toujours être inclus dans la fourchette de départ déterminée par le choix de la nature de comptes. Option de centralisation des Fournisseurs/Clients Cette option de centralisation est liée aux seules natures de comptes Clients, Fournisseurs et Clients et Fournisseurs. 110 MANUEL Elle permet de cumuler entre eux, sur deux lignes uniquement, tous les comptes de nature Fournisseurs puis tous les comptes de nature Clients. Cette option permet donc d'alléger l'affichage. Filtre avancé sur les comptes mouvementés Filtre avancé sur le statut des écritures Conservation des filtres : Tous les filtres sélectionnés dans la Balance interactive sont conservés dans une même session et sur un même exercice. En revanche, si vous changez d'exercice courant ou fermez puis ré-ouvrez votre dossier, alors tous les filtres par défaut sont ré-appliqués. Actualiser L'utilisation de ce bouton est nécessaire pour que l'affichage soit mis à jour en fonction des filtres. Corps de la fenêtre Chaque compte est affiché avec son numéro, son intitulé, la somme de tous les mouvements débiteurs puis la somme de tous les mouvements créditeurs intervenus sur ces comptes, en fonction des critères de filtrage sélectionnés. Actions possibles Consultation / Lettrage : Accès à la page de consultation du compte de la ligne sélectionnée. Lettrage automatique : Accès à l'assistant de lettrage automatique sur le compte de la ligne sélectionnée. Impression - Fenêtre principale de navigation La fenêtre principale de navigation de l'impression est divisée en 3 zones : Catégorie des modèles, Modèles d'impression disponibles, Image de l'aperçu du modèle sélectionné. Catégories Les catégories permettent de classer les modèles en fonction des types de documents et des données de bases, des éléments financiers... Le logiciel est livré avec un classement par défaut, présent dans l'onglet Catégorie. Dans la partie catégorie, vous pouvez avoir : Catégorie principale : Etats standards Sous catégorie : Journal Sous catégorie : Grand Livre Sous catégorie : Balance .... Catégorie principale : Etats de gestion Sous catégorie : Echéancier Sous catégorie : Balance âgée par échéances Sous catégorie : Balance âgée par Lettrage Catégorie principale : Etats fiscaux... Pour voir un modèle, il faut impérativement se situer dans la catégorie ou la sous-catégorie à laquelle il appartient. Vous avez la possibilité de personnaliser ces catégories en créant des mots-clés. Modèles disponibles Cette partie contient la liste des modèles proposés pour chaque catégorie. Ces modèles peuvent être modifiés avec l'éditeur de modèles à l'aide du bouton "Modifier le modèle". A partir d'un modèle, dans la barre d'outils ou par le menu contextuel/clic droit, vous pouvez : imprimer le modèle (ouverture de la page de filtres et aperçus), 111 EBP Comptabilité Open Line Pro affecter un mot clé, définir le modèle à utiliser par défaut pour les fiches, définir le modèle à utiliser par défaut pour les listes. Pour passer un modèle en modèle par défaut, vous devez sélectionner un modèle, puis cliquer dans la barre d'outils Modèle par défaut ou clic droit sur le modèle puis Modèle par défaut. Image de l'aperçu du modèle Cette partie permet de visualiser le modèle que vous avez sélectionné. Cette visualisation est une image, elle ne contient pas les informations concernant votre dossier. Filtres et aperçu de l'édition En double-cliquant sur le modèle, vous accédez à la fenêtre de sélection des filtres et visualisation de l'aperçu. ÉCHÉANCIER / REGLEMENTS Echéanciers / Règlements - Démarrer une tâche Accès : Echéanciers / Règlements - Démarrer une tâche Pour chaque menu du volet de navigation, vous disposez en début des fonctions associées d'une entrée de menu Démarrer une tâche. Cette entrée permet de visualiser l'enchaînement des fonctions disponibles dans chaque menu. Les actions ci-dessous sont associées à cette entrée : Consultation/Lettrage : permet d'ouvrir la fenêtre de consultation ou de lettrage sur le compte consulté ou lettré en dernier. Echéancier clients : permet d'accéder à l'échéancier interactif des clients. Echéancier fournisseurs : permet d'accéder à l'échéancier interactif des fournisseurs. Règlements clients : permet d'accéder à la liste des règlements clients. Règlements fournisseurs : permet d'accéder à la liste des règlements fournisseurs. CONSULTATION Consultation de compte Accès : Quotidien - Consultation/Lettrage OU Consultation - Consultation/Lettrage La consultation de compte permet d'afficher l'ensemble des lignes d'écritures enregistrées sur un compte de type Détail et sur un seul exercice. Cette consultation permet aussi bien de connaître le solde réel d'un compte à un instant donné, que de procéder aux lettrages qui s'imposent ou encore d'effectuer des recherches... La combinaison de différents filtres permet d'affiner la sélection des lignes d'écritures à afficher. Filtres Ces filtres sont mémorisés : Les dernières sélections effectuées sont conservées ; elles seront reprises à l'identique lors du prochain affichage de la fenêtre de consultation. Filtre sur les comptes, Filtre sur la période, Filtre sur le statut des lignes, Filtre sur le type de ligne. Sélection de l'exercice Les dates d'exercice proposées par défaut sont celles de l'exercice courant. 112 MANUEL Lorsque cet exercice courant est ouvert, alors tous les exercices ouverts sont accessibles. Vous pouvez donc sélectionner l'exercice que vous voulez consulter sans être obligé de changer d'exercice courant. Pour cela, il vous suffit d'ouvrir la liste déroulante disponible dans le champ Exercice. Lorsque l'exercice courant est clôturé, alors seul l'exercice courant est accessible. Sélection du compte La sélection du compte se fait dans l'en-tête de la fenêtre de consultation, champ Identification - Compte. Le compte peut être saisi directement dans ce champ ou sélectionné dans la liste déroulante qui reprend l'intégralité des comptes existants sur l'exercice courant. Un bouton situé à gauche de cette liste déroulante permet d'ouvrir la fiche du compte sélectionné. Dès que le numéro du compte est renseigné, alors les données de base de ce compte sont automatiquement mises à jour : - Intitulé du compte, - Cumul de tous les montants débiteurs saisis sur ce compte pendant tout l'exercice courant, - Cumul de tous les montants créditeurs saisis sur ce compte pendant tout l'exercice courant, - Solde de ce compte au dernier jour de l'exercice courant. Ces données de base sont totalement indépendantes des choix effectués sur les filtres comme de la date système (= date et heure de l'ordinateur). Affichage des lignes d'écriture L'affichage des lignes d'écritures dans la consultation reprend la majorité des informations renseignées dans le masque de saisie (Journal, Date, Pièce, Libellé, Débit/Crédit). En revanche, à l'inverse de la saisie, les lignes d'écritures sont par défaut affichées dans l'ordre chronologique. L'affichage des lignes d'écritures est directement dépendant des choix effectués sur les filtres. Certaines lignes peuvent apparaître grisées et en italique : il s'agit des lignes qui répondent aux critères de filtrage sur l'exercice courant mais qui ont été lettrées sur un exercice postérieur. Le délettrage de ces lignes n'est d'ailleurs uniquement possible que sur l'exercice au cours duquel elles ont été lettrées. Dans le pied de la zone d'affichage, une ligne de totalisation est affichée : elle cumule en temps réel la somme des montants débiteurs et des montants créditeurs des lignes affichées. Enfin, le Solde progressif est recalculé en temps réel en fonction des seules lignes affichées. Lettrage et délettrage manuel Il est possible de lettrer ou delettrer des lignes d'écritures d'un compte directement dans la fenêtre de Consultation sans être obligé d'accéder à la fenêtre de Lettrage ; pour cela, il faut que cette option soit paramétrée dans la fiche compte. Le fonctionnement du lettrage, la sélection des lignes, l'utilisation de la ligne de totalisation, l'attribution du code lettrage... sont les mêmes que dans ceux définis dans la fenêtre de Lettrage à proprement parler. Lettrage automatique Une fonction permet d'effectuer le lettrage automatique des lignes d'écritures d'un compte. Autres actions possibles à partir de la consultation Accès à la saisie par journal : En double cliquant sur une ligne d'écriture, en sélectionnant Saisie par journal dans le menu contextuel Menu contextuel = clic droit de la souris. ou en cliquant sur le bouton, il est possible d'être automatiquement positionné sur cette ligne d'écriture dans la saisie journal ayant servie à l'enregistrer. Voir document : Il est possible d'accéder au document d'origine ayant permis l'enregistrement de la ligne d'écriture : il peut s'agir, par exemple, de la facture transférée par la Gestion commerciale. Cacher le filtre/Afficher le filtre : En cliquant sur le bouton Cacher le filtre ou Afficher le filtre, il est possible d'afficher ou de masquer une ligne de filtre qui se positionne immédiatement avant les lignes 113 EBP Comptabilité Open Line Pro d'écritures. Ce filtre contient des champs saisissables et permet d'affiner les sélections effectuées grâce aux filtres comptables mentionnés dans les paragraphes précédents. Rafraîchir : Ce bouton permet de mettre à jour l'affichage de la fenêtre de consultation, lorsque celui-ci a été modifié par une action effectuée dans une autre fenêtre (lettrage, saisie journal...). Facture non parvenue ou à émettre Ce bouton permet d'accéder à la fenêtre de paramétrage Facture/Avoir à emettre ou Facture/Avoir à recevoir et de générer l'extourne de l'écriture à laquelle cette ligne appartient. Charge ou produit constaté d'avance Ce bouton permet d'accéder à la fenêtre de paramétrage Charges ou Produits constatés d'avance et de générer la régularisation puis l'extourne de la ligne sélectionnée. Principes de lettrage et de délettrage Accès : Le lettrage est possible à partir la fenêtre de Consultation comme à partir de la fenêtre de Lettrage. Principes du lettrage Le lettrage consiste à : - sélectionner sur un compte au moins deux lignes d'écritures dont les montants s'équilibrent et qui ont trait à une opération commune, - puis à appliquer un même code alphanumérique appelé "code lettrage" ainsi qu'une même date de lettrage à ces lignes. Une facture n° 1234 de 1000 € est émise le 18/02/2008 au client DUPONT. Le 25/02/2008, le client Dupont adresse un chèque de 500 €, référencé 1234. Le 10/03/2008, le client Dupont adresse un nouveau chèque de 500 €, référence 1234. Ces deux règlements peuvent être identifiés comme venant solder la facture émise. Dès lors, ses trois lignes d'écriture peuvent être sélectionnées dans le compte du client DUPONT pour être identifiées par un même code et une même date de lettrage. La date de lettrage est la date système Date système = date et heure de l'ordinateur. à laquelle le lettrage a été effectué. Le lettrage peut être effectué aussi bien dans la fenêtre de Consultation que dans la fenêtre de Lettrage simplifié. Activer l'option sur le compte Pour que le lettrage ou le délettrage soient possibles, il faut que le compte soit de type Détail et que l'option "Autoriser le lettrage" soit activée sur sa fiche compte. Sélection des lignes La sélection des lignes peut se faire de deux façons différentes : - Soit grâce à la souris seule, en cochant la case située sur chaque ligne à l'extrême gauche de la fenêtre. - Soit en combinant le clavier et la souris (touche Ctrl + clic gauche). - Soit encore en combinant différentes touches du clavier (touche Ctrl + barre d'espace). Dans tous les cas, les lignes sélectionnées sont mises en surbrillance. En pied de masque, un "total des lignes sélectionnées" apparaît. - Cette ligne de totalisation est calculée en temps réel au fur et à mesure des sélections des lignes d'écritures. - Elle permet de contrôler immédiatement l'équilibrage de ces lignes qui conditionne l'exécution du traitement. Choix des boutons Le choix des boutons dépend du type des lignes sélectionnées. Si aucune des lignes sélectionnées n'est lettrée et que ces lignes sont équilibrées, alors le bouton "Lettrer" est accessible. Dans tous les autres cas, seul le bouton "Délettrer" est accessible. 114 MANUEL Option de lettrage automatique Une fonction de lettrage automatique est disponible. Gestion du code lettrage lors du lettrage de lignes d'écriture Lorsque des lignes non lettrées dont les montants s'équilibrent sont sélectionnées et que le lettrage est demandé, alors le "Prochain code lettrage" renseigné sur la fiche compte est proposé par défaut. Si le code lettrage proposé est accepté, alors : - le code lettrage proposé et la date de lettrage sont affectés à chacune des lignes sélectionnées, - un prochain code lettrage est calculé puis est reporté sur la fiche compte. Si le code lettrage proposé par défaut est modifié, alors : - le code lettrage saisi et la date de lettrage sont affectés à chacune des lignes sélectionnées, - un prochain code lettrage est calculé par rapport au code lettrage saisi puis est reporté sur la fiche compte. Gestion du code lettrage lors du délettrage des lignes d'écriture Lorsque des lignes lettrées dont les montants s'équilibrent et dont les codes lettrage sont identiques sont sélectionnées et que le délettrage est demandé, alors le code lettrage et la date de lettrage sont supprimés de toutes les lignes sélectionnées. La suppression de ce lettrage est sans impact sur le champ "Prochain code lettrage" de la fiche compte. Options de délettrage Le délettrage s'opère : - sur toutes les lignes sélectionnées déjà lettrées, - mais aussi sur les toutes lignes non sélectionnées possédant le même code lettrage. Pour faciliter le délettrage, trois options sont disponibles en cliquant sur le bouton "Délettrer" de la barre d'outils : Délettrer par compte : cette action permet de délettrer en une seule opération toutes les lignes déjà lettrées sur ce compte. Délettrer par code : cette action permet de définir une fourchette de codes lettrage puis de délettrer toutes les lignes d'écritures déjà lettrées sur lesquelles ces codes lettrage apparaissent et, cela, quelque soit leur date de lettrage. Délettrer par date : cette action permet de définir une fourchette de dates de lettrage puis de délettrer toutes les lignes d'écritures déjà lettrées sur lesquelles ces dates apparaissent et, cela, quelque soit leur code de lettrage. LETTRAGE AUTOMATIQUE Lettrage automatique Accès : Sur un compte : le lettrage est possible à partir la fenêtre de Consultation comme à partir de la fenêtre de Lettrage ; sur une série de comptes : Consultation - Lettrage automatique Le lettrage automatique est une fonction permettant de lettrer automatiquement des lignes d'écritures d'un compte ou de plusieurs comptes, sans avoir à les présélectionner manuellement dans la fenêtre de lettrage. Les principes et règles de lettrage sur un compte restent les mêmes que celles déjà définies dans le lettrage, le lettrage approché et la fenêtre de lettrage. Un assistant est affiché : Il permet de sélectionner les comptes lettrables à traiter, les lignes d'écritures non lettrées à rechercher, la méthode de lettrage ainsi que de définir les éléments liés au lettrage approché. Période du ... au ... : Ce champs permet de sélectionner les dates des lignes d'écritures à analyser. Type de comptes : Une liste déroulante permet de sélectionner une série de comptes en fonction de leur nature. 115 EBP Comptabilité Open Line Pro Du compte ... au compte au ... : Une fourchette de comptes dépendant du choix du type de comptes est proposée. La sélection peut encore affinée, à la condition de rester dans les limites de la fourchette définie. Options : Une liste déroulante permet de sélectionner la méthode de lettrage à appliquer. - N° de pièce : Toutes les lignes d'écritures non encore lettrées dans un même compte, qui portent un numéro de pièce identique peuvent être lettrées entre elles, quelque soient leur montant respectif ou le nombre de lignes concernées. - N° de document : Toutes les lignes d'écritures non encore lettrées dans un même compte, qui portent un numéro de document identique peuvent être lettrées entre elles, quelque soient leur montant respectif ou le nombre de lignes concernées. - Solde progressif : Toutes les lignes d'écritures non lettrées dans un même compte peuvent être lettrées entre elles, à condition qu'un solde progressif nul, égal ou inférieur à l'écart autorisé sur ce compte soit obtenu et cela quelque soit le nombre de lignes concernées, leur numéro ou leur montant respectif. - Montant exact : Les lignes d'écritures non lettrées d'un même compte peuvent être lettrées à condition qu'elles s'équilibrent exactement entre elles. Au maximum, cinq lignes d'écritures peuvent permettent de réaliser cet équilibre. Lignes : Trois cases à cocher permettent d'affiner la sélection des lignes d'écritures en fonction de leur statut. Régularisation : La zone est accessible pour toutes les méthodes de lettrage, sauf la méthode "Montant exact". - Autoriser le lettrage approché : Si la case est cochée, alors les valeurs relatives au lettrage approché renseignées sur la fiche compte seront appliquées. - N° de pièce : Le champ est accessible si la case "Autoriser le lettrage approché" est cochée. Un numéro de pièce est proposé, mais il reste modifiable. Si le journal de destination est en numérotation manuelle, alors le numéro de pièce déterminé dans l'assistant sera utilisé pour comptabiliser l'écriture de régularisation. Si le journal de destination est en numérotation automatique, alors le numéro de pièce utilisé pour comptabiliser l'écriture de régularisation sera le prochain numéro de pièce défini dans la fiche journal. - Libellé : Le champs est accessible si la case Autoriser le lettrage approché est cochée. Un libellé est proposé, mais il reste modifiable Le même libellé sera repris sur toutes les écritures de régularisation qui seront créées. Démarrer : Ce bouton commande l'exécution du traitement en fonction des filtres choisis et de la méthode de lettrage. Annuler : Ce bouton permet de fermer l'assistant sans lancer le traitement. Deux accès différents : un choix de comptes différent Un bouton "Lettrage automatique" est disponible dans la fenêtre de Lettrage. Dans ce cas, le lettrage automatique est possible uniquement sur le compte affiché. Une entrée "Lettrage automatique" est disponible dans le menu Consultation/Lettrage. Dans ce cas, le lettrage automatique est possible sur tous les comptes définis comme lettrables sur l'exercice. CLIENTS Echéancier interactif Accès : Echéancier / Règlements - Clients - Echéancier interactif ET Echéancier / Règlements - Fournisseurs - Echéancier interactif L'échéancier interactif permet d'afficher à l'écran les échéances d'un compte ou d'une série de comptes selon différents critères de filtrage. Il permet une visualisation rapide des échéances et permet d'obtenir à l'écran en temps réel le résultat des recherches, sans passer par les impressions. Cette fenêtre est divisée en plusieurs zones. La liste affichée n'est pas directement modifiable. 116 MANUEL Un en-tête Filtre sur les dates d'échéance Ce filtre est indépendant de l'exercice courant comme des exercices existants : vous pouvez donc rechercher toutes les échéances que vous avez saisies dans votre dossier, sans avoir à changer d'exercice courant. Filtre sur les comptes Ce filtre permet de sélectionner une fourchette de comptes. Les comptes peuvent être saisis ou sélectionnés dans la liste déroulante. Un bouton situé à gauche de cette liste déroulante permet d'ouvrir la fiche du compte sélectionné. A l'inverse du comportement standard, comme en consultation par exemple, tous les comptes (quelque soit leur type) peuvent être saisis. En effet, ici, il s'agit moins de sélectionner précisément un compte que de déterminer un intervalle. Ces comptes doivent néanmoins toujours être inclus dans la fourchette de départ : - Dans la barre de navigation, si vous avez sélectionné Clients - Echéancier interactif, alors vous pourrez uniquement interroger les échéances enregistrées sur les comptes de nature Clients et comptes rattachés. - Dans la barre de navigation, si vous avez sélectionné Fournisseurs - Echéancier interactif, alors vous pourrez uniquement interroger les échéances enregistrées sur les comptes de nature Fournisseurs et comptes rattachés + Autres Tiers avec échéances. Options : Type d'échéance Ce filtre vous permet de rechercher plus précisément les échéances en isolant les factures des avoirs. Seulement les comptes autorisant l'échéancier Toutes les factures et tous les avoirs enregistrés sur des comptes Clients, Fournisseurs, Comptes rattachés et Autres Tiers avec échéances génèrent des échéances et, cela, même lorsque le compte n'autorise pas la gestion de l'échéancier. Lorsque cette option est activée, alors seules les échéances enregistrées sur des comptes autorisant l'échéancier sont visibles. Lorsque cette option est désactivée, alors toutes les échéances enregistrées sur tous les comptes sont visibles. Conservation des filtres : Les filtres sélectionnés dans l'échéancier interactif sont conservés dans une même session et même si vous changez d'exercice courant. En revanche, si vous fermez et ré-ouvrez votre dossier, alors tous les filtres par défaut sont ré-appliqués. Actualiser L'utilisation de ce bouton est nécessaire pour que l'affichage soit mis à jour en fonction des filtres. Onglets Toutes les échéances Cet onglet affiche toutes les échéances répondant aux critères de filtrage définis dans l'en-tête, et cela quelque soit le solde restant sur chaque échéance. Echéances réglées Cet onglet affiche toutes les échéances répondant aux critères de filtrage de l'en-tête et ayant été intégralement pointées. Le solde restant sur ces échéances est donc nul. Echéances non réglées Cet onglet affiche toutes les échéances répondant aux critères de filtrage de l'en-tête et n'ayant pas été intégralement pointées. Le solde restant sur ces échéances est donc différent de zéro. Corps de la fenêtre Comme pour les autres états interactifs, les lignes affichées sont les seules lignes qui répondent aux critères de filtrage ; elles reprennent l'ensemble des éléments de la saisie comptable. Les lignes affichées sont des lignes d'échéance de type Facture et de type Avoir. Toutes les informations importantes existant sur ces échéances ou sur les lignes d'écritures auxquelles elles se rapportent sont disponibles dans la liste : elles sont identiques à celles déjà affichées dans les échéanciers (Date d'échéance, Code Tiers, Montant de l'échéance, Solde de l'échéance...) Dans la colonne Pointée en dehors de la comptabilité, une coche apparaît sur l'échéance lorsque celle-ci a été pointée dans une autre application, par exemple en Gestion Commerciale. Cette information vous rappelle qu'il est impossible de modifier cette échéance en comptabilité. 117 EBP Comptabilité Open Line Pro Actions possibles Saisie par journal : Permet d'accéder à la saisie par journal et à l'écriture d'origine. Nouvelle écriture comptable : Permet de créer une nouvelle écriture comptable. Voir le document : Permet d'accéder directement au document qui a permis de générer l'écriture contenant l'échéance sélectionnée (document venant de la Gestion Commerciale, de la saisie par Guide...). Consultation / Lettrage : Permet d'accéder à la consultation du compte de la ligne sélectionnée. Régler la(les) échéances : Permet d'accéder à une fiche de règlement permettant de créer l'écriture comptable de règlement et proposant un pointage entre ce nouveau règlement et l'échéance sélectionnée. Pointer l'Avoir avec des échéances de facture : Permet d'accéder directement à l'échéancier de la ligne sélectionnée, afin de pointer un avoir avec une facture. Visualiser les pointages : Cette action vous permet de d'accéder à la liste de toutes les écritures qui ont permis de pointer cette échéance; il peut s'agir d'un avoir, présent dans l'Echéancier intéractif ou d'un règlement présent dans la liste des règlements. Vues Plusieurs vues par défaut vous sont proposées. Elles présentent des affichages différents de la même liste : Sans détail des pointages : Cette liste affiche les échéances en ligne, par ordre chronologique des dates d'échéances. Sans détail des pointages par Tiers : Cette liste affiche toutes les échéances, en triant les échéances d'abord par n° de compte puis par date d'échéance. Avec détails des pointages : Si un pointage a été exécuté sur une échéance, il vous suffit de cliquer sur le bouton "+" située à l'extrême gauche de la liste afin de connaître la ligne de règlement avec laquelle l'échéance a été pointée. D'autre part, vous pouvez bien-sûr modifier ou créer vos propres vues. Ecritures saisies sur les Autres Tiers avec échéances antérieurement à la version 2.1 Antérieurement à la version 2.1, la gestion de l'échéancier s'effectuait sur les comptes de nature Clients et Fournisseurs et Comptes rattachés. A partir de la version 2.1, la gestion de l'échéancier est étendue aux comptes de nature Autres Tiers avec échéances. Aussi, toutes les écritures saisies à partir de cette version sur des comptes de nature Autres Tiers avec échéances permettent la gestion de l'échéancier et seront visibles dans l'échéancier interactif. En revanche, afin de ne pas alourdir la consultation, les impressions, les opérations de pointage..., les écritures saisies antérieurement sur les comptes de nature Autres Tiers avec échéances ne permettent pas la gestion de l'échéancier et ne sont donc pas visibles dans l'échéancier interactif. Pour pouvoir gérer des échéances sur ces écritures, vous devrez au moins y effectuer une modification mineure (par exemple : n° de document, ajout dans le libellé...) Liste des règlements des Tiers Accès : Echéanciers / Règlements - Clients - Règlements Clients ET Echéanciers / Règlements - Fournisseurs - Règlements Fournisseurs La liste des règlements des Tiers est commune à toutes les listes. Elle permet d'accéder au détail des règlements, de consulter / modifier / générer un pointage entre un règlement et une échéance et de créer un nouveau règlement. Cette liste est alimentée automatiquement dès que vous saisissez une écriture de type Règlement dans un journal de type Trésorerie ou Opérations Diverses. Cette fenêtre est divisée en plusieurs zones. 118 MANUEL Un en-tête Filtre sur la période Ce filtre concernent les dates des écritures de règlement. Filtre sur les comptes Ce filtre permet de sélectionner une fourchette de comptes. Les comptes peuvent être saisis ou sélectionnés dans la liste déroulante. Un bouton situé à gauche de cette liste déroulante permet d'ouvrir la fiche du compte sélectionné. A l'inverse du comportement standard, comme en consultation par exemple, tous les comptes (quelque soit leur type) peuvent être saisis. En effet, ici, il s'agit moins de sélectionner précisément un compte que de déterminer un intervalle. Ces comptes doivent néanmoins toujours être inclus dans la fourchette de départ : - Dans la barre de navigation, si vous avez sélectionné Clients - Règlements clients, alors vous pourrez uniquement visualiser les règlements enregistrés sur les comptes de nature Clients et comptes rattachés. - Dans la barre de navigation, si vous avez sélectionné Fournisseurs - Règlements Fournisseurs , alors vous pourrez uniquement interroger les règlements enregistrés sur les comptes de nature Fournisseurs et comptes rattachés et Autres Tiers avec échéances. Conservation des filtres : Les filtres sélectionnés dans la liste des règlements sont conservés dans une même session et même si vous changez d'exercice courant. En revanche, si vous fermez et ré-ouvrez votre dossier, alors tous les filtres par défaut sont ré-appliqués. Actualiser L'utilisation de ce bouton est nécessaire pour que l'affichage soit mis à jour en fonction des filtres. Corps de la fenêtre Comme pour les autres états interactifs, les lignes affichées sont les seules lignes qui répondent aux critères de filtrage ; elles reprennent l'ensemble des éléments de la saisie comptable. Actions possibles Saisie par journal : Permet d'accéder au journal d'origine de la ligne sélectionnée. Nouveau règlement : Permet d'accéder à une nouvelle fiche de règlement. Consultation / Lettrage : Permet d'accéder à la consultation du compte de la ligne sélectionnée. Pointer le Règlement avec des échéances : Permet d'accéder au règlement déjà comptabilisé, afin de consulter ou de modifier le pointage entre le règlement et une échéance. Vues Plusieurs vues par défaut vous sont proposées. Elles présentent des affichages différents de la même liste : Avec détails des échéances pointées : Si un pointage a été exécuté entre un règlement et une échéance, il vous suffit de cliquer sur le bouton "+" située à l'extrême gauche de la liste afin de connaître l'échéance avec laquelle le règlement a été pointé. Sans détail des échéances pointées : Cette liste affiche tous les règlements, par ordre chronologique et par numéro de compte, regroupés par Banque. D'autre part, vous pouvez bien-sûr modifier ou créer vos propres vues. Ecritures saisies sur les Autres Tiers avec échéances antérieurement à la version 2.1 Antérieurement à la version 2.1, la fonctionnalité Règlements s'appliquait aux comptes de nature Clients et Fournisseurs et Comptes rattachés. A partir de la version 2.1, cette fonctionnalité est étendue aux comptes de nature Autres Tiers avec échéances. Aussi, tous les règlements saisis à partir de cette version sur des comptes de nature Autres Tiers avec échéances et dans des journaux de Trésorerie alimentent la liste des règlements. 119 EBP Comptabilité Open Line Pro En revanche, afin de ne pas alourdir la consultation, les impressions, les opérations de pointage..., les règlements saisis antérieurement sur les comptes de nature Autres Tiers avec échéances n'alimentent pas la liste des règlements. Pour voir les règlements sur ces écritures, vous devrez au moins y effectuer une modification mineure (par exemple : n° de document, ajout dans le libellé...) Fiche de Règlement Accès : Echéanciers / Règlements - Clients - Règlements Clients ET Echéanciers / Règlements - Fournisseurs - Règlements Fournisseurs Cette fonctionnalité a pour but de vous permettre de créer facilement un règlement sur un Tiers, sans passer systématiquement par la saisie par journal ou la saisie par écriture, et tout en exécutant le pointage des échéances. Création d'un nouveau règlement Tiers * : Vous devez saisir ou sélectionner dans la liste déroulante le compte de nature Clients et comptes rattachés, Fournisseurs et comptes rattachés ou Autres Tiers avec échéances sur lequel vous voulez enregistrer le règlement. Montant de règlement * : Vous devez saisir le montant du règlement à comptabiliser. Dans ce champ, vous pouvez : - saisir un valeur positive, pour enregistrer un règlement, - saisir une valeur négative, pour enregistrer un remboursement. Journal de banque * : Seuls sont autorisés les journaux de type Trésorerie et possédant un compte de contrepartie dans leur fiche journal. Libellé : Par défaut, ce champ affiche l'intitulé du compte sélectionné, mais il reste modifiable. Ce libellé sera ensuite repris sur toutes les lignes de l'écriture comptable et, cela, quelque soit le paramétrage du libellé dans la fiche du journal de banque sélectionné. Date de règlement * : Les règles sur les dates sont les mêmes que dans tous les autres masque de saisie : - si votre exercice courant est ouvert, alors vous pouvez créer un nouveau règlement sur n'importe quel exercice ouvert, - si votre exercice courant est clôturé, alors ne pourrez plus créer de nouveau règlement. Reste à affecter : Ce champ est calculé automatiquement. Il affiche la différence existant entre le montant du règlement saisi et les pointages effectués sur les échéances. Moyen de paiement : Ce champ affiche le Moyen de paiement par défaut défini dans les options du dossier, mais il reste modifiable. Il peut être renseigné à titre d'information, afin de conserver le moyen (chèque, traite, virement...) par lequel vous avez payé votre fournisseur ou avez été payé par votre client. Numéro de pièce : Le numéro de pièce dépend du journal de banque sélectionné et du paramétrage sur le numéro de pièce effectué dans ce journal. Il reste modifiable. Echéances à pointer : Les échéances affichées sont les échéances non soldées (non intégralement réglées) existant sur le compte. Leur affichage et les modes de pointage restent les mêmes que ceux définis dans Pointages. Actions possibles dans la fiche - Consultation/Lettrage : Ce bouton permet d'accéder à la consultation du compte de Tiers saisi dans le règlement, à condition qu'il soit sauvegardé. - Saisie par journal : Ce bouton permet d'accéder à la saisie par journal et à l'écriture comptable correspondante au règlement sauvegardé. 120 MANUEL - Echéancier interactif : Ce bouton permet d'affficher, en arrière plan, l'échéancier interactif. Sauvegarde La sauvegarde d'une fiche règlement entraîne automatiquement : - la création d'une nouvelle ligne de règlement dans la liste des Règlements, - la création d'une écriture comptable dans la saisie journal, - la mise à jour de l'échéancier Facture et de Pointages, - la mise à jour de l'échéancier interactif. Modification d'un règlement Ces modifications concernent les règlement sauvegardés. Modifications possibles La modification d'un règlement est possible si l'écriture a été générée à partir : - d'un import Communication Entreprise-Expert, - des Règlements des Tiers, - de la saisie au kilomètre, - de la saisie journal, - de la saisie par écriture, - ou des écritures de régularisation. Dans ces cas-là, le règlement est modifiable sur tous les champs, sauf : - Date, - Montant, - Journal. Enfin, la modification est possible même si cette écriture est simulée, lettrée, rapprochée, participe à une déclaration de TVA, pointe une échéance. Modifications impossibles La modification d'un règlement est impossible si l'écriture : - est issue de la Gestion Commerciale, - est générée à partir de la saisie pratique, - est générée à partir de la saisie guidée, - possède le statut Validé. Dans ces cas-là, toute modification est interdite, sauf celle liée au pointage/dépointage des échéances. Pour modifier un règlement, vous devez accéder à la saisie journal et y effectuer vos modifications. Celles-ci se répercuteront ensuite sur la fiche du règlement. Cas d'une écriture guidée : Une écriture issue de la saisie guidée n'est pas modifiable, à priori. Pourtant, il est possible pour la rendre modifiable. Pour cela, il faut : sélectionner l'écriture en saisie journal, ouvrir le menu contextuel, sélectionner Modifier l'écriture guidée. A partir de là, le règlement est modifiable car il n'est plus lié au masque de saisie qui a permis de le générer. Suppression d'un règlement Les règles de suppression sont les mêmes que celles de la modification : elles dépendent de la provenance de l'écriture et de son statut. FOURNISSEURS ET AUTRES TIERS Echéancier interactif Accès : Echéancier / Règlements - Clients - Echéancier interactif ET Echéancier / Règlements - Fournisseurs - Echéancier interactif L'échéancier interactif permet d'afficher à l'écran les échéances d'un compte ou d'une série de comptes selon différents critères de filtrage. Il permet une visualisation rapide des échéances et permet d'obtenir à l'écran en temps réel le résultat des recherches, sans passer par les impressions. Cette fenêtre est divisée en plusieurs zones. La liste affichée n'est pas directement modifiable. 121 EBP Comptabilité Open Line Pro Un en-tête Filtre sur les dates d'échéance Ce filtre est indépendant de l'exercice courant comme des exercices existants : vous pouvez donc rechercher toutes les échéances que vous avez saisies dans votre dossier, sans avoir à changer d'exercice courant. Filtre sur les comptes Ce filtre permet de sélectionner une fourchette de comptes. Les comptes peuvent être saisis ou sélectionnés dans la liste déroulante. Un bouton situé à gauche de cette liste déroulante permet d'ouvrir la fiche du compte sélectionné. A l'inverse du comportement standard, comme en consultation par exemple, tous les comptes (quelque soit leur type) peuvent être saisis. En effet, ici, il s'agit moins de sélectionner précisément un compte que de déterminer un intervalle. Ces comptes doivent néanmoins toujours être inclus dans la fourchette de départ : - Dans la barre de navigation, si vous avez sélectionné Clients - Echéancier interactif, alors vous pourrez uniquement interroger les échéances enregistrées sur les comptes de nature Clients et comptes rattachés. - Dans la barre de navigation, si vous avez sélectionné Fournisseurs - Echéancier interactif, alors vous pourrez uniquement interroger les échéances enregistrées sur les comptes de nature Fournisseurs et comptes rattachés + Autres Tiers avec échéances. Options : Type d'échéance Ce filtre vous permet de rechercher plus précisément les échéances en isolant les factures des avoirs. Seulement les comptes autorisant l'échéancier Toutes les factures et tous les avoirs enregistrés sur des comptes Clients, Fournisseurs, Comptes rattachés et Autres Tiers avec échéances génèrent des échéances et, cela, même lorsque le compte n'autorise pas la gestion de l'échéancier. Lorsque cette option est activée, alors seules les échéances enregistrées sur des comptes autorisant l'échéancier sont visibles. Lorsque cette option est désactivée, alors toutes les échéances enregistrées sur tous les comptes sont visibles. Conservation des filtres : Les filtres sélectionnés dans l'échéancier interactif sont conservés dans une même session et même si vous changez d'exercice courant. En revanche, si vous fermez et ré-ouvrez votre dossier, alors tous les filtres par défaut sont ré-appliqués. Actualiser L'utilisation de ce bouton est nécessaire pour que l'affichage soit mis à jour en fonction des filtres. Onglets Toutes les échéances Cet onglet affiche toutes les échéances répondant aux critères de filtrage définis dans l'en-tête, et cela quelque soit le solde restant sur chaque échéance. Echéances réglées Cet onglet affiche toutes les échéances répondant aux critères de filtrage de l'en-tête et ayant été intégralement pointées. Le solde restant sur ces échéances est donc nul. Echéances non réglées Cet onglet affiche toutes les échéances répondant aux critères de filtrage de l'en-tête et n'ayant pas été intégralement pointées. Le solde restant sur ces échéances est donc différent de zéro. Corps de la fenêtre Comme pour les autres états interactifs, les lignes affichées sont les seules lignes qui répondent aux critères de filtrage ; elles reprennent l'ensemble des éléments de la saisie comptable. Les lignes affichées sont des lignes d'échéance de type Facture et de type Avoir. Toutes les informations importantes existant sur ces échéances ou sur les lignes d'écritures auxquelles elles se rapportent sont disponibles dans la liste : elles sont identiques à celles déjà affichées dans les échéanciers (Date d'échéance, Code Tiers, Montant de l'échéance, Solde de l'échéance...) Dans la colonne Pointée en dehors de la comptabilité, une coche apparaît sur l'échéance lorsque celle-ci a été pointée dans une autre application, par exemple en Gestion Commerciale. Cette information vous rappelle qu'il est impossible de modifier cette échéance en comptabilité. 122 MANUEL Actions possibles Saisie par journal : Permet d'accéder à la saisie par journal et à l'écriture d'origine. Nouvelle écriture comptable : Permet de créer une nouvelle écriture comptable. Voir le document : Permet d'accéder directement au document qui a permis de générer l'écriture contenant l'échéance sélectionnée (document venant de la Gestion Commerciale, de la saisie par Guide...). Consultation / Lettrage : Permet d'accéder à la consultation du compte de la ligne sélectionnée. Régler la(les) échéances : Permet d'accéder à une fiche de règlement permettant de créer l'écriture comptable de règlement et proposant un pointage entre ce nouveau règlement et l'échéance sélectionnée. Pointer l'Avoir avec des échéances de facture : Permet d'accéder directement à l'échéancier de la ligne sélectionnée, afin de pointer un avoir avec une facture. Visualiser les pointages : Cette action vous permet de d'accéder à la liste de toutes les écritures qui ont permis de pointer cette échéance; il peut s'agir d'un avoir, présent dans l'Echéancier intéractif ou d'un règlement présent dans la liste des règlements. Vues Plusieurs vues par défaut vous sont proposées. Elles présentent des affichages différents de la même liste : Sans détail des pointages : Cette liste affiche les échéances en ligne, par ordre chronologique des dates d'échéances. Sans détail des pointages par Tiers : Cette liste affiche toutes les échéances, en triant les échéances d'abord par n° de compte puis par date d'échéance. Avec détails des pointages : Si un pointage a été exécuté sur une échéance, il vous suffit de cliquer sur le bouton "+" située à l'extrême gauche de la liste afin de connaître la ligne de règlement avec laquelle l'échéance a été pointée. D'autre part, vous pouvez bien-sûr modifier ou créer vos propres vues. Ecritures saisies sur les Autres Tiers avec échéances antérieurement à la version 2.1 Antérieurement à la version 2.1, la gestion de l'échéancier s'effectuait sur les comptes de nature Clients et Fournisseurs et Comptes rattachés. A partir de la version 2.1, la gestion de l'échéancier est étendue aux comptes de nature Autres Tiers avec échéances. Aussi, toutes les écritures saisies à partir de cette version sur des comptes de nature Autres Tiers avec échéances permettent la gestion de l'échéancier et seront visibles dans l'échéancier interactif. En revanche, afin de ne pas alourdir la consultation, les impressions, les opérations de pointage..., les écritures saisies antérieurement sur les comptes de nature Autres Tiers avec échéances ne permettent pas la gestion de l'échéancier et ne sont donc pas visibles dans l'échéancier interactif. Pour pouvoir gérer des échéances sur ces écritures, vous devrez au moins y effectuer une modification mineure (par exemple : n° de document, ajout dans le libellé...) Liste des règlements des Tiers Accès : Echéanciers / Règlements - Clients - Règlements Clients ET Echéanciers / Règlements - Fournisseurs - Règlements Fournisseurs La liste des règlements des Tiers est commune à toutes les listes. Elle permet d'accéder au détail des règlements, de consulter / modifier / générer un pointage entre un règlement et une échéance et de créer un nouveau règlement. Cette liste est alimentée automatiquement dès que vous saisissez une écriture de type Règlement dans un journal de type Trésorerie ou Opérations Diverses. Cette fenêtre est divisée en plusieurs zones. 123 EBP Comptabilité Open Line Pro Un en-tête Filtre sur la période Ce filtre concernent les dates des écritures de règlement. Filtre sur les comptes Ce filtre permet de sélectionner une fourchette de comptes. Les comptes peuvent être saisis ou sélectionnés dans la liste déroulante. Un bouton situé à gauche de cette liste déroulante permet d'ouvrir la fiche du compte sélectionné. A l'inverse du comportement standard, comme en consultation par exemple, tous les comptes (quelque soit leur type) peuvent être saisis. En effet, ici, il s'agit moins de sélectionner précisément un compte que de déterminer un intervalle. Ces comptes doivent néanmoins toujours être inclus dans la fourchette de départ : - Dans la barre de navigation, si vous avez sélectionné Clients - Règlements clients, alors vous pourrez uniquement visualiser les règlements enregistrés sur les comptes de nature Clients et comptes rattachés. - Dans la barre de navigation, si vous avez sélectionné Fournisseurs - Règlements Fournisseurs , alors vous pourrez uniquement interroger les règlements enregistrés sur les comptes de nature Fournisseurs et comptes rattachés et Autres Tiers avec échéances. Conservation des filtres : Les filtres sélectionnés dans la liste des règlements sont conservés dans une même session et même si vous changez d'exercice courant. En revanche, si vous fermez et ré-ouvrez votre dossier, alors tous les filtres par défaut sont ré-appliqués. Actualiser L'utilisation de ce bouton est nécessaire pour que l'affichage soit mis à jour en fonction des filtres. Corps de la fenêtre Comme pour les autres états interactifs, les lignes affichées sont les seules lignes qui répondent aux critères de filtrage ; elles reprennent l'ensemble des éléments de la saisie comptable. Actions possibles Saisie par journal : Permet d'accéder au journal d'origine de la ligne sélectionnée. Nouveau règlement : Permet d'accéder à une nouvelle fiche de règlement. Consultation / Lettrage : Permet d'accéder à la consultation du compte de la ligne sélectionnée. Pointer le Règlement avec des échéances : Permet d'accéder au règlement déjà comptabilisé, afin de consulter ou de modifier le pointage entre le règlement et une échéance. Vues Plusieurs vues par défaut vous sont proposées. Elles présentent des affichages différents de la même liste : Avec détails des échéances pointées : Si un pointage a été exécuté entre un règlement et une échéance, il vous suffit de cliquer sur le bouton "+" située à l'extrême gauche de la liste afin de connaître l'échéance avec laquelle le règlement a été pointé. Sans détail des échéances pointées : Cette liste affiche tous les règlements, par ordre chronologique et par numéro de compte, regroupés par Banque. D'autre part, vous pouvez bien-sûr modifier ou créer vos propres vues. Ecritures saisies sur les Autres Tiers avec échéances antérieurement à la version 2.1 Antérieurement à la version 2.1, la fonctionnalité Règlements s'appliquait aux comptes de nature Clients et Fournisseurs et Comptes rattachés. A partir de la version 2.1, cette fonctionnalité est étendue aux comptes de nature Autres Tiers avec échéances. Aussi, tous les règlements saisis à partir de cette version sur des comptes de nature Autres Tiers avec échéances et dans des journaux de Trésorerie alimentent la liste des règlements. 124 MANUEL En revanche, afin de ne pas alourdir la consultation, les impressions, les opérations de pointage..., les règlements saisis antérieurement sur les comptes de nature Autres Tiers avec échéances n'alimentent pas la liste des règlements. Pour voir les règlements sur ces écritures, vous devrez au moins y effectuer une modification mineure (par exemple : n° de document, ajout dans le libellé...) Fiche de Règlement Accès : Echéanciers / Règlements - Clients - Règlements Clients ET Echéanciers / Règlements - Fournisseurs - Règlements Fournisseurs Cette fonctionnalité a pour but de vous permettre de créer facilement un règlement sur un Tiers, sans passer systématiquement par la saisie par journal ou la saisie par écriture, et tout en exécutant le pointage des échéances. Création d'un nouveau règlement Tiers * : Vous devez saisir ou sélectionner dans la liste déroulante le compte de nature Clients et comptes rattachés, Fournisseurs et comptes rattachés ou Autres Tiers avec échéances sur lequel vous voulez enregistrer le règlement. Montant de règlement * : Vous devez saisir le montant du règlement à comptabiliser. Dans ce champ, vous pouvez : - saisir un valeur positive, pour enregistrer un règlement, - saisir une valeur négative, pour enregistrer un remboursement. Journal de banque * : Seuls sont autorisés les journaux de type Trésorerie et possédant un compte de contrepartie dans leur fiche journal. Libellé : Par défaut, ce champ affiche l'intitulé du compte sélectionné, mais il reste modifiable. Ce libellé sera ensuite repris sur toutes les lignes de l'écriture comptable et, cela, quelque soit le paramétrage du libellé dans la fiche du journal de banque sélectionné. Date de règlement * : Les règles sur les dates sont les mêmes que dans tous les autres masque de saisie : - si votre exercice courant est ouvert, alors vous pouvez créer un nouveau règlement sur n'importe quel exercice ouvert, - si votre exercice courant est clôturé, alors ne pourrez plus créer de nouveau règlement. Reste à affecter : Ce champ est calculé automatiquement. Il affiche la différence existant entre le montant du règlement saisi et les pointages effectués sur les échéances. Moyen de paiement : Ce champ affiche le Moyen de paiement par défaut défini dans les options du dossier, mais il reste modifiable. Il peut être renseigné à titre d'information, afin de conserver le moyen (chèque, traite, virement...) par lequel vous avez payé votre fournisseur ou avez été payé par votre client. Numéro de pièce : Le numéro de pièce dépend du journal de banque sélectionné et du paramétrage sur le numéro de pièce effectué dans ce journal. Il reste modifiable. Echéances à pointer : Les échéances affichées sont les échéances non soldées (non intégralement réglées) existant sur le compte. Leur affichage et les modes de pointage restent les mêmes que ceux définis dans Pointages. Actions possibles dans la fiche - Consultation/Lettrage : Ce bouton permet d'accéder à la consultation du compte de Tiers saisi dans le règlement, à condition qu'il soit sauvegardé. - Saisie par journal : Ce bouton permet d'accéder à la saisie par journal et à l'écriture comptable correspondante au règlement sauvegardé. 125 EBP Comptabilité Open Line Pro - Echéancier interactif : Ce bouton permet d'affficher, en arrière plan, l'échéancier interactif. Sauvegarde La sauvegarde d'une fiche règlement entraîne automatiquement : - la création d'une nouvelle ligne de règlement dans la liste des Règlements, - la création d'une écriture comptable dans la saisie journal, - la mise à jour de l'échéancier Facture et de Pointages, - la mise à jour de l'échéancier interactif. Modification d'un règlement Ces modifications concernent les règlement sauvegardés. Modifications possibles La modification d'un règlement est possible si l'écriture a été générée à partir : - d'un import Communication Entreprise-Expert, - des Règlements des Tiers, - de la saisie au kilomètre, - de la saisie journal, - de la saisie par écriture, - ou des écritures de régularisation. Dans ces cas-là, le règlement est modifiable sur tous les champs, sauf : - Date, - Montant, - Journal. Enfin, la modification est possible même si cette écriture est simulée, lettrée, rapprochée, participe à une déclaration de TVA, pointe une échéance. Modifications impossibles La modification d'un règlement est impossible si l'écriture : - est issue de la Gestion Commerciale, - est générée à partir de la saisie pratique, - est générée à partir de la saisie guidée, - possède le statut Validé. Dans ces cas-là, toute modification est interdite, sauf celle liée au pointage/dépointage des échéances. Pour modifier un règlement, vous devez accéder à la saisie journal et y effectuer vos modifications. Celles-ci se répercuteront ensuite sur la fiche du règlement. Cas d'une écriture guidée : Une écriture issue de la saisie guidée n'est pas modifiable, à priori. Pourtant, il est possible pour la rendre modifiable. Pour cela, il faut : sélectionner l'écriture en saisie journal, ouvrir le menu contextuel, sélectionner Modifier l'écriture guidée. A partir de là, le règlement est modifiable car il n'est plus lié au masque de saisie qui a permis de le générer. Suppression d'un règlement Les règles de suppression sont les mêmes que celles de la modification : elles dépendent de la provenance de l'écriture et de son statut. DONNEES Moyens de paiement Accès : Paramètres - Divers - Moyens de paiement La gestion de la fiche "Moyen de paiement" est commune à toutes les fiches. La fiche "Moyen de paiement" se compose des éléments suivants : un code * Indiquez un code moyen de paiement. Ce code est limité à 6 caractères alphanumériques. un libellé * Saisissez le libellé du moyen de paiement (au maximum 60 caractères alphanumériques). 126 MANUEL une nature * Sélectionnez un type de nature dans la liste déroulante. Cette liste n'est pas paramétrable. une banque Ce champ correspond à la banque sélectionnée par défaut lorsque vous réalisez un règlement. La liste des banques est accessible par le menu Règlements - Données - Banques. Si la banque que vous souhaitez n'existe pas, vous avez la possibilité de créer une nouvelle fiche banque en sélectionnant Ajouter dans la liste déroulante accessible par l'icône . La création du dossier propose par défaut une liste de moyens de paiement. La banque par défaut n'est pas renseignée dans les fiches moyens de paiement. La gestion d'une "Note" est commune à toutes les fiches. Modes de règlement Accès : Paramètres - Divers - Modes de règlement La gestion de la fiche "Mode de règlement" est commune à toutes les fiches. La fiche "Modes de règlement" se compose des éléments suivants : Le code * Indiquez un code pour votre mode de règlement. Ce code est limité à 6 caractères alphanumériques. Le libellé * Saisissez le libellé du mode de règlement (au maximum 60 caractères alphanumériques). Nous vous conseillons d'indiquer un libellé explicite qui reprenne le type de paiement et l'échéance. La création du dossier propose par défaut une liste de modes de règlement. Onglet détail Cet onglet est divisé en 2 parties : Création des lignes "d'échéances" pour le mode de règlement Test des lignes créées Création des lignes Pour valider une fiche mode de règlement, vous devez avoir au minimum une ligne d'échéance. Une ligne contient les renseignement suivants : % Il sert à calculer le montant de l'échéance par rapport au montant TTC de la facture multiplié par le pourcentage défini. Par défaut, il est égal à 100%. Nbre de jours Saisissez le nombre de jours pour le calcul de l'échéance, à partir de la date du document (de 1 à 365). La zone nombre de jours n'est pas accessible pour un règlement de type Comptant. Type de Règlement Choisissez dans la liste proposée, le mode de calcul d'échéance que vous souhaitez appliquer. Jour de règlement Indiquez le jour pour lequel vous souhaitez le règlement (de 1 à 31). Cette zone est accessible uniquement pour les types de règlement : Fin de mois le ou Net le. Mois comptable Cochez cette case si vous souhaitez faire fonctionner le mode de règlement en mois comptable pour le calcul de la date d'échéance. 127 EBP Comptabilité Open Line Pro Cette fonction sert pour considérer un nombre de jours en nombre de mois (31 jours devient 1 mois, 60 jours devient 2 mois...). Moyen de paiement Cette liste déroulante est paramétrable depuis la liste des moyens de paiement. Vous pouvez modifier, créer plusieurs lignes d'échéances pour un mode de règlement. Pour cela, cliquez sur l'icône Ajouter pour insérer une ligne et saisissez les différents critères que vous souhaitez. La somme des % des lignes créées doit être égale à 100%. Test des lignes créées Pour tester les lignes que vous venez de créer, vous devez indiquer : une date qui corresponde à la date du document un montant qui corresponde au montant du document Dans le tableau à droite de ces zones, vous trouverez le résultat du calcul des échéances (Date échéance, Montant et Moyen de paiement) L'échéance, le règlement et le jour s'enchaînent pour le calcul de l'échéance de la facture. Exemple 1 Mode de règlement : CH30 Paramétrage d'une ligne échéance : % NB jours Type Jour Mois Moyen de règlement règlement comptable paiement 100 30 Net Chèque Date de facture : 01/01/2008, Montant : 100 Votre date d'échéance sera calculée ainsi : 01/01/2008 + 30J soit le 31/01/2008, puis Net, ce qui donnera le 31/01/2008, ce qui donnera une date d'échéance au 31/01/2008 pour un montant de 100. Exemple 2 Mode de règlement :Prel4 Paramétrage de 4 lignes d'échéances: % NB jours Type Jour Mois Moyen de règlement règlement comptable paiement 25 Comptant Prélèvement 25 30 Net le 15 Prélèvement 25 60 Net le 15 Prélèvement 25 90 Net le 15 Prélèvement Date de facture : 01/01/2008, Montant : 100 € Les dates d'échéance seront calculées ainsi : 1ère ligne : 01/01/2008 + 0J soit le 01/01/2008, puis Comptant, ce qui donnera le 01/01/2008 pour un montant de 25 (25% du montant soit 100). 2ème ligne : 01/01/2008 + 30J soit le 31/01/2008, puis Net le, 15, ce qui nous donne le 15/02/2008 pour un montant de 25 (25% du montant soit 100). 3ème ligne : 01/01/2008 + 60J soit le 01/03/2008, puis Net le, 15, ce qui nous donne le 15/03/2008 pour un montant de 25 (25% du montant soit 100). 4ème ligne : 01/01/2008 + 90J soit le 31/03/2008, puis Net le, 15, ce qui nous donne le 15/04/2008 pour un montant de 25 (25% du montant soit 100). 128 MANUEL Les actions possibles dans la liste Ajouter : permet d'ajouter une nouvelle ligne d'échéance à la fin de la liste. Insérer : permet d'insérer une nouvelle ligne d'échéance entre deux lignes déjà existantes. Supprimer : permet de supprimer une ligne d'échéance existante. Monter/Descendre : permet de modifier l'ordre des priorités des lignes d'échéances sans être obligé de les supprimer et de les recréer. Couper/Copier/Coller : ces trois boutons ont un comportement identique au comportement standard défini, par exemple, dans Word et Excel. Toutes les actions accomplies sur la liste des échéances avec ces boutons ne doivent pas empêcher de respecter les règles de cohérence définies dans les paragraphes précédents. Onglet Notes La gestion d'une "Note" est commune à toutes les fiches. Fiche Banques Accès : Paramètres - Banques La gestion de la fiche Banque est commune à toutes les fiches. Une fiche Banque est accessible à partir de la liste des Banques. Créer une fiche Banques est une opération qui peut être indispensable pour exécuter les transferts de règlements à partir de l'application de Gestion commerciale ou des rapprochements bancaires automatiques. Une banque s'identifie par les éléments suivants : • Le code banque * Saisissez un identifiant unique pour votre banque. Cet identifiant est limité à 5 caractères alphanumériques. • Le nom de la banque * Saisissez le nom de votre banque (au maximum 40 caractères alphanumériques). Onglet Adresse Les informations ci-dessous correspondent aux coordonnées de la banque. Adresse • Nom Champ saisissable, limité à 60 caractères alphanumériques. • Adresse Champ saisissable, limité à 40 caractères alphanumériques. • Adresse (Suite) Champ saisissable, limité à 40 caractères alphanumériques. • Adresse (Suite) Champ saisissable, limité à 40 caractères alphanumériques. • Adresse (Fin) Champ saisissable, limité à 40 caractères alphanumériques. • Code postal Champ saisissable, limité à 10 caractères alphanumériques. Lors de la saisie du code postal, - si celui-ci existe et est unique dans la table des codes postaux, alors la ville et le pays sont renseignés par défaut, - si celui-ci existe mais n’est pas unique, alors la liste des codes postaux est affichée, avec uniquement ceux répondant à la saisie, - si celui-ci n’existe pas, alors le code postal est conservé dans la fiche client mais n’est pas créé dans la table des codes postaux. Si le code postal que vous souhaitez n'existe pas, vous avez la possibilité de créer une nouvelle fiche code postal en sélectionnant Ajouter dans la liste déroulante. • Ville 129 EBP Comptabilité Open Line Pro Champ saisissable, limité à 35 caractères alphanumériques. Le champ Ville sera automatiquement rempli après la saisie d’un code postal existant dans la table des codes postaux. Il est toujours possible de modifier le libellé de la ville, par contre cela n'entraînera pas la création d’une nouvelle fiche code postal. • Département Champ saisissable, limité à 50 caractères alphanumériques. Le champ Département sera automatiquement rempli après la saisie d’un code postal existant dans la table des codes postaux. Si le département que vous souhaitez n'existe pas, vous avez la possibilité de créer une nouvelle fiche département en sélectionnant Ajouter dans la liste déroulante. • Pays Champ saisissable. Le champ Pays sera automatiquement rempli après la saisie d’un code postal existant dans la table des codes postaux. Si le pays que vous souhaitez n'existe pas, vous avez la possibilité de créer une nouvelle fiche pays en sélectionnant Ajouter dans la liste déroulante. • Site Web Champ saisissable, limité à 100 caractères alphanumériques. Ce champ permet de saisir le site web lié à cette adresse. Contact • Civilité Ce champ permet de saisir ou sélectionner la civilité de votre contact (au maximum 25 caractères alphanumériques). Si la civilité que vous souhaitez n'existe pas et que vous souhaitez la conserver dans votre fichier des civilités, vous avez la possibilité de créer une nouvelle fiche civilité en sélectionnant Ajouter dans la liste déroulante. • Nom Champ saisissable, limité à 60 caractères alphanumériques. • Fonction Champ saisissable, limité à 40 caractères alphanumériques. • Prénom Champ saisissable, limité à 60 caractères alphanumériques. • Téléphone fixe Champ saisissable, limité à 20 caractères alphanumériques. • Téléphone portable Champ saisissable, limité à 20 caractères alphanumériques. • Fax Champ saisissable, limité à 20 caractères alphanumériques. • Service/Bureau Champ saisissable, limité à 40 caractères alphanumériques. • E-mail Champ saisissable, limité à 100 caractères alphanumériques. Permet de saisir l'e-mail du contact. Onglet Comptabilité Cet onglet vous permet de saisir : • Le compte de banque * : Ce compte doit être un compte de type Détail. • Le journal de banque * : Ce journal doit être de type Trésorerie. 130 MANUEL Le journal de banque peut déjà être défini avec un compte de contrepartie. Dans ce cas : - si vous saisissez en premier le compte de banque, alors le journal associé sera automatiquement proposé et non modifiable ; - si vous saisissez en premier le journal de banque, alors le compte de contrepartie de ce journal sera automatiquement proposé et non modifiable. Onglet Coordonnées bancaires Cet onglet vous permet de définir les coordonnées bancaires de votre compte (RIB/BBAN, IBAN, BIC). Onglet Notes La gestion d'une Note est commune à toutes les fiches. Impression - Fenêtre principale de navigation La fenêtre principale de navigation de l'impression est divisée en 3 zones : Catégorie des modèles, Modèles d'impression disponibles, Image de l'aperçu du modèle sélectionné. Catégories Les catégories permettent de classer les modèles en fonction des types de documents et des données de bases, des éléments financiers... Le logiciel est livré avec un classement par défaut, présent dans l'onglet Catégorie. Dans la partie catégorie, vous pouvez avoir : Catégorie principale : Etats standards Sous catégorie : Journal Sous catégorie : Grand Livre Sous catégorie : Balance .... Catégorie principale : Etats de gestion Sous catégorie : Echéancier Sous catégorie : Balance âgée par échéances Sous catégorie : Balance âgée par Lettrage Catégorie principale : Etats fiscaux... Pour voir un modèle, il faut impérativement se situer dans la catégorie ou la sous-catégorie à laquelle il appartient. Vous avez la possibilité de personnaliser ces catégories en créant des mots-clés. Modèles disponibles Cette partie contient la liste des modèles proposés pour chaque catégorie. Ces modèles peuvent être modifiés avec l'éditeur de modèles à l'aide du bouton "Modifier le modèle". A partir d'un modèle, dans la barre d'outils ou par le menu contextuel/clic droit, vous pouvez : imprimer le modèle (ouverture de la page de filtres et aperçus), affecter un mot clé, définir le modèle à utiliser par défaut pour les fiches, définir le modèle à utiliser par défaut pour les listes. Pour passer un modèle en modèle par défaut, vous devez sélectionner un modèle, puis cliquer dans la barre d'outils Modèle par défaut ou clic droit sur le modèle puis Modèle par défaut. Image de l'aperçu du modèle Cette partie permet de visualiser le modèle que vous avez sélectionné. Cette visualisation est une image, elle ne contient pas les informations concernant votre dossier. Filtres et aperçu de l'édition En double-cliquant sur le modèle, vous accédez à la fenêtre de sélection des filtres et visualisation de l'aperçu. 131 EBP Comptabilité Open Line Pro EXERCICES/CLOTURES Exercices/Clôtures - Démarrer une tâche Accès : Exercices/Clôtures - Démarrer une tâche Pour chaque menu du volet de navigation, vous disposez en début des fonctions associées d'une entrée de menu Démarrer une tâche. Cette entrée permet de visualiser l'enchaînement des fonctions disponibles dans chaque menu. Les actions ci-dessous sont associées à cette entrée : Validation des écritures : permet d'accéder au gestionnaire de journaux, à partir duquel sont effectués les traitements liés à la validation des écritures. Clôture mensuelle : permet d'accéder au gestionnaire de journaux, à partir duquel sont effectués les traitements liés à la clôture mensuelle des journaux. Clôture annuelle : permet de lancer l'assistant de clôture annuelle. EXERCICES Liste des exercices Accès : Exercices/Clôture - Exercices La gestion de la liste des exercices est commune à toutes les listes. L’affichage de cette liste reprend les principaux éléments sélectionnés de chaque fiche exercice. Lors de la création du dossier, deux exercices sont systématiquement créés par défaut. Le nombre d'exercices n'est pas limité sur un même dossier. En revanche, un même dossier ne peut pas contenir plus de deux exercices non clôturés. Date de début Cette date est la date de début de chaque exercice comptable, qui doit être obligatoirement renseignée lors de la création d’un exercice. Date de fin Cette date est la date de fin de chaque exercice comptable, qui doit être obligatoirement renseignée lors de la création d’un exercice. Aucun trou de date ni aucun doublon de date ne peut exister entre deux exercices du même dossier. Date de clôture Cette date est renseignée automatiquement par l’application lorsque l’exercice a fait l’objet d’une clôture annuelle. Exercice courant L’exercice courant est indépendant de la date système Date système = date et heure de l'ordinateur ou de l'état de l'exercice (ouvert ou clôturé). Il correspond à l’exercice comptable sur lequel l'utilisateur doit être positionné pour effectuer toutes les opérations, de la saisie à la clôture annuelle. Si le dossier possède un seul et unique exercice, alors ce seul exercice est défini par défaut comme étant l’exercice courant. 132 MANUEL Si le dossier possède plusieurs exercices comptables, alors l’exercice courant doit être manuellement sélectionné en fonction des besoins. L’exercice courant peut être identifié : - dans la liste des exercices, dans laquelle l’exercice courant est affiché en gras ; - dans la barre de titre de l’application, qui affiche les dates de l’exercice courant. Pour définir un exercice courant, il faut : - se positionner sur l'exercice désiré dans la liste des exercices, - puis sélectionner «Définir un exercice courant» dans la barre de tâches du volet de navigation ou dans le menu contextuel Menu contextuel = clic droit de la souris. . Fiche exercice Accès : Exercices/Clôtures - Exercices La gestion de cette fiche Exercice est commune à l’ensemble des fiches. La fiche Exercice se décompose en : En-tête Période de l’exercice * : Affiche les dates de l’exercice sélectionné dans la liste. La modification des dates d’un exercice déjà créé peut se révéler impossible. Les quelques exemples ci-dessous illustrent les problèmes qui peuvent être rencontrés ; cette liste n'est pas exhaustive : 1/ Exercice du 01/01/2009 au 31/12/2009, avec une écriture non validée saisie au 02/01/2009. Il est possible d'avancer la date de début d'exercice au 01/12/2008. Il est possible de reculer la date de début d'exercice au 15/01/2009, à condition de supprimer d'abord l'écriture comprise dans la période à exclure. 2/ Exercice du 01/01/2009 au 31/12/2009, avec une écriture validée saisie au 02/01/2009. Il est possible d'avancer la date de début d'exercice au 01/12/2008. Il est impossible de reculer la date de début d'exercice au 15/01/2009, car il est impossible de supprimer l'écriture validée du 02/01/2009. 3/ Exercice au 01/01/2008 au 31/12/2009, tous les journaux/mois de cet exercice sont clôturés. Il est impossible d'avancer la date de début de cet exercice au 01/12/2008, car il est impossible de créer un mois antérieur à un mois clôturé. Il est impossible de reculer la date de début de cet exercice au 15/01/2009, car le journal est clôturé et contient des écritures validées non supprimables. Etat : Zone non modifiable renseignée par l’application en fonction de l’état de cet exercice. - Ouvert : la saisie est toujours possible sur cet exercice, la clôture annuelle n’ayant pas été effectuée. - Clôturé : La saisie est impossible sur cet exercice, car la clôture annuelle de cet exercice a été effectuée. Date de génération : Ce champ affiche, uniquement à titre d'information, la date système Date système = Date de l'ordinateur à laquelle les A Nouveaux de l'exercice affiché ont été générés sur l'exercice suivant. Onglet Notes La gestion de l'onglet Notes est commune à toutes les fiches. Comment générer les A Nouveaux ? A Nouveaux automatiques La génération des A Nouveaux vise à enregistrer automatiquement le résultat comptable d'un exercice. Cet enregistrement peut être : - provisoire, s'il est généré en cours d'exercice, - ou définitif, s'il est généré au cours de la clôture annuelle ou après celle-ci. 133 EBP Comptabilité Open Line Pro Dans les options du dossier, vous devez d'abord sélectionner le mode de génération des A Nouveaux, leur niveau de détail... Ensuite vous devez définir l'exercice destination ( = premier exercice suivant) comme étant l'exercice courant. Enfin, pour procéder à la génération des A Nouveaux, deux entrées sont disponibles : - menu Exercices/Clôtures - Exercices puis de la liste des exercices, - menu Quotidien - Exercices puis de la liste des exercices, De là, vous pouvez sélectionner Générer les A Nouveaux dans la barre de tâches. Lorsque la génération des A Nouveaux est demandée, un assistant s'ouvre : il est impératif que tous les contrôles qu'il contient soient exécutés avec succès pour que les A nouveaux soient effectivement générés. Pour information, les règles et accès valables pour la génération des A nouveaux sont également valables pour leur suppression. Balance d'ouverture Des A Nouveaux peuvent être saisis manuellement par l'intermédiaire de la Balance d'ouverture. Cette option s'avère particulièrement intéressante lorsque le dossier a d'abord été géré sur un autre logiciel puis que sa comptabilité est transférée sur Open Line. Pour créer cette balance d'ouverture, deux entrées existent : - menu Exercices/Clôtures - Exercices, - menu Quotidien - Saisie par journal, Sur un même exercice, il n'est pas recommandé de générer à la fois les A Nouveaux automatiques et une Balance d'ouverture. GESTIONNAIRE DE JOURNAUX Principes de simulation Le statut "Simulé" est symbolisé par un "S". Il s'applique à toutes les lignes d'une même écriture. Il est géré dans la saisie par journal, dans la saisie par écriture et dans le gestionnaire de journaux. L'utilisation de ce statut a un impact : - sur toutes les consultations et impressions, grâce au filtre, - sur les rapprochements, - sur la validation, - et sur les opérations de clôtures mensuelle et annuelle. Principes de validation Le statut "Validé" est symbolisé par un "V". Il s'applique à toutes les lignes d'une même écriture. Il est géré dans la saisie par journal, dans la saisie par écriture et dans le gestionnaire de journaux. L'utilisation de ce statut a un impact : - sur toutes les consultations et impressions, grâce au filtre, - sur les modifications des écritures en saisie, - et sur les opérations de clôtures mensuelle et annuelle. Principes de clôture mensuelle Accès : Exercices/Clôtures - Gestionnaire de journaux Le lancement de ce traitement est géré dans le gestionnaire de journaux. La clôture mensuelle s'applique à la totalité des écritures d'un journal et d'un mois et vise à en interdire la modification. 134 MANUEL Pour pouvoir être clôturé mensuellement : - toutes les écritures d'un journal et d'un mois doivent posséder le statut Validé. - tous les mois du journal sélectionné doivent déjà être clôturés mensuellement sur les exercices précédents. Tous les journaux et tous les mois de l'exercice courant doivent être clôturés mensuellement pour pouvoir faire l'objet d'une clôture annuelle. CLOTURE ANNUELLE Principes de clôture annuelle Accès : Exercices/Clôture - Clôture annuelle La clôture annuelle est une opération irréversible qui vise à rendre intangibles les éléments comptables de l’exercice courant. L’exécution de cette opération nécessite de vérifier au préalable le respect de certaines conditions ; la liste cidessous est non exhaustive et ne dispense pas des contrôles de comptabilité courants : - L’exercice à clôturer doit être le premier exercice non encore clôturé de tous les exercices existants sur le dossier. - Aucune écriture simulée ne doit plus exister sur cet exercice. - Toutes les écritures de cet exercice doivent être validées. - Tous les journaux/mois de l'exercice doivent être clôturés mensuellement. - Les comptes de caisse doivent être obligatoirement débiteurs au dernier jour de l'exercice courant. La clôture annuelle nécessite l'utilisation d'un assistant. Clôture annuelle Accès : Exercices/Clôtures - Clôture annuelle La clôture annuelle nécessite de respecter certains principes. Un assistant, se découpant en plusieurs pages, permet de lancer les contrôles préalables puis la clôture annuelle à proprement parler. Trois boutons de commande sont disponibles sur chaque page : Précédent et Suivant permettent la navigation d'une page à l'autre. Annuler permet de fermer l'assistant sans exécuter aucun traitement. Bienvenue dans l'assistant de clôture annuelle Un récapitulatif des opérations incluses dans ce traitement est affiché. Un bouton permet la sauvegarde du dossier. Page 1/4 : Clôture annuelle Cette page affiche les éléments relatifs à l'exercice à clôturer et reprend les valeurs définies dans les options du dossier. Les dates de cet exercice ne sont pas modifiables. Les comptes par défaut d'affectation du résultat restent modifiables, grâce à la liste déroulante. Néanmoins, le compte de bénéfice peut uniquement être un compte de nature "Résultat, bénéfice" et le compte de perte peut uniquement être un compte de nature "Résultat, perte". Le mode de génération des A Nouveaux n'est pas modifiable. Page 2/4 : Paramètres de l'exercice suivant Les dates de l'exercice suivant sont : - proposées et non modifiables si cet exercice suivant existe déjà, - proposées et modifiables si cet exercice n'existe pas encore. 135 EBP Comptabilité Open Line Pro Options : Le choix de l'option est modifiable. - Générer les A Nouveaux entraîne la génération automatique et irréversible des A Nouveaux sur l'exercice suivant. - Ne pas générer les A Nouveaux implique que la clôture annuelle sera effectuée sans génération des A Nouveaux, qui devront donc être saisis manuellement. Page 3/4 : Impressions Les impressions annuelles sont obligatoires et doivent être imprimées manuellement après la clôture d'un exercice. Elles doivent comprendre au minimum les états suivants : le Grand Livre, la Balance, tous les journaux et le journal centralisateur. Pour les imprimer, il faut accéder au menu Impressions qui convient. Le lancement des impressions définitives de l'exercice en cours de clôture est obligatoire. Il est recommandé de faire une copie de sauvegarde du dossier. Page 4/4 : Contrôles Le lancement des contrôles est obligatoire : le bouton Démarrer permet de les lancer. La réussite ou l'échec de chacun des contrôles est visible dans la colonne Statut. Echec : Si un contrôle bloquant échoue, alors le statut Echec est affiché au niveau du contrôle concerné. La clôture ne peut donc pas être exécutée. Il faut obligatoirement corriger les erreurs détectées avant de relancer le traitement. Il est possible d'obtenir des informations complémentaires sur les raisons de l'échec du contrôle en cliquant sur le "+" situé sur la ligne en erreur. Information : Si un contrôle non bloquant échoue, alors le statut Information es affiché au niveau du contrôle concerné. La clôture peut malgré tout être exécutée, sans avoir obligatoirement à corriger les erreurs détectées. Il est possible d'obtenir des informations complémentaires sur les raisons de l'échec du contrôle en cliquant sur le "+" situé sur la ligne en erreur. Ok : Si un contrôle réussit, alors un statut Ok est affiché pour chaque contrôle et la clôture annuelle peut continuer. Page : "Toutes les données ont nécessaires" ont été collectées. Cette page récapitule toutes les choix qui ont été effectués. Bouton : Lancer Ce bouton lance définitivement la clôture annuelle. L'exécution du traitement est symbolisée par une barre de défilement. Page : Opération terminée Une dernière page est affichée : elle rend compte du traitement exécuté. Le bouton Fermer permet de fermer l'assistant. L'exercice suivant est automatiquement affiché. Impression - Fenêtre principale de navigation La fenêtre principale de navigation de l'impression est divisée en 3 zones : Catégorie des modèles, Modèles d'impression disponibles, 136 MANUEL Image de l'aperçu du modèle sélectionné. Catégories Les catégories permettent de classer les modèles en fonction des types de documents et des données de bases, des éléments financiers... Le logiciel est livré avec un classement par défaut, présent dans l'onglet Catégorie. Dans la partie catégorie, vous pouvez avoir : Catégorie principale : Etats standards Sous catégorie : Journal Sous catégorie : Grand Livre Sous catégorie : Balance .... Catégorie principale : Etats de gestion Sous catégorie : Echéancier Sous catégorie : Balance âgée par échéances Sous catégorie : Balance âgée par Lettrage Catégorie principale : Etats fiscaux... Pour voir un modèle, il faut impérativement se situer dans la catégorie ou la sous-catégorie à laquelle il appartient. Vous avez la possibilité de personnaliser ces catégories en créant des mots-clés. Modèles disponibles Cette partie contient la liste des modèles proposés pour chaque catégorie. Ces modèles peuvent être modifiés avec l'éditeur de modèles à l'aide du bouton "Modifier le modèle". A partir d'un modèle, dans la barre d'outils ou par le menu contextuel/clic droit, vous pouvez : imprimer le modèle (ouverture de la page de filtres et aperçus), affecter un mot clé, définir le modèle à utiliser par défaut pour les fiches, définir le modèle à utiliser par défaut pour les listes. Pour passer un modèle en modèle par défaut, vous devez sélectionner un modèle, puis cliquer dans la barre d'outils Modèle par défaut ou clic droit sur le modèle puis Modèle par défaut. Image de l'aperçu du modèle Cette partie permet de visualiser le modèle que vous avez sélectionné. Cette visualisation est une image, elle ne contient pas les informations concernant votre dossier. Filtres et aperçu de l'édition En double-cliquant sur le modèle, vous accédez à la fenêtre de sélection des filtres et visualisation de l'aperçu. PARAMETRES Paramètres - Démarrer une tâche Accès : Paramètres - Démarrer une tâche Pour chaque menu du volet de navigation, vous disposez en début des fonctions associées d'une entrée de menu Démarrer une tâche. Cette entrée permet de visualiser l'enchaînement des fonctions disponibles dans chaque menu. Les actions ci-dessous sont associées à cette entrée : Ajouter un taux de TVA : Permet de créer un nouveau taux de TVA. Plan comptable : Permet d'accéder au plan comptable de l'exercice courant. Informations société : permet d'accéder au options du dossier telles que les coordonnées, les informations d'identification, le logo, les identifications de l'expert (cabinet, contacts) et le Trésor Public, les paramétrages généraux et de saisie, la police, le mot de passe... 137 EBP Comptabilité Open Line Pro JOURNAUX Plan de journaux Accès : Paramètres - Journaux La gestion du plan de journal est commune à toutes les listes. Il permet d'accéder aux fiches journal. Fonctionnement général : Le plan de journaux est unique pour tous les exercices du dossier. Ainsi, un journal OPERATIONS PAIE créé en 2009 sera automatiquement créé dans tous les exercices antérieurs non clôturés ou postérieurs, déjà créés ou à créer. De la même manière, il sera supprimé en même temps de tous les exercices non clôturés. Lors de la création du dossier et donc du premier exercice, un plan de journaux est créé par défaut. Il contient au moins un journal de chaque type de journaux et tous les journaux sont paramétrés par défaut : Plan de journaux livré par défaut : Un journal de Type ACHATS = AC, Achats Un journal de type VENTES = VE, Ventes Un journal de type Opérations Diverses = OD, Opérations Diverses Deux journaux de type Trésorerie = BP, Banque Principale + CA, Caisse Les paramètres par défaut des journaux restent modifiables, mais ces modifications se reporteront sur tous les exercices non clôturés du dossier. Cas des journaux de type A Nouveaux : Les journaux de type A Nouveaux ne sont pas créés automatiquement lors de la création du dossier, ils n'apparaissent donc pas dans le plan de journaux livré par défaut. En revanche, ces journaux sont gérés directement le logiciel. D'autre part, un journal d'A Nouveaux est créé uniquement sur l'exercice dans lequel il est utilisé. Lorsque les A Nouveaux sont générés par l'application, alors le journal "AN" est créé sur l'exercice dans lequel les A Nouveaux ont été comptabilisés. Lorsque qu'une écriture est sauvegardée dans le masque "Balance d'ouverture", alors le journal "RAN" est créé sur l'exercice dans lequel cette balance d'ouverture a été comptabilisée. Fiche journal Accès : Paramètres - Journaux La fiche journal est accessible à partir de la liste des journaux. La gestion de la fiche journal est commune à l'ensemble des fiches. La fiche journal est divisée en différentes parties : En-tête de la fiche journal Code * Ce code est unique pour tous les journaux et tous les types de journaux confondus. La saisie du code est laissée aux soins de l'utilisateur. Le champ accepte les caractères alphanumériques mais ni les caractères spéciaux ni les espaces. Le code est modifiable tant que la fiche journal est en cours de création. En revanche, si la fiche journal a déjà été sauvegardée au moins une fois, alors le code n'est plus modifiable. Type * 138 MANUEL Le type de journal est "Achats" par défaut. Le type doit être sélectionné dans la liste déroulante. Il est modifiable tant que la fiche journal est en cours de création. En revanche, si la fiche journal a déjà été sauvegardée au moins une fois, alors le type de journal n'est plus modifiable. Description * La description permet de saisir l'intitulé détaillé du journal. La saisie de la description est laissée aux soins de l'utilisateur. Le champ accepte les caractères alphanumériques, les caractères spéciaux et les espaces. Cette description reste modifiable à tout moment. Onglet saisie L'onglet Saisie regroupe les Racines non autorisées, la Numérotation des pièces, les Type et compte de contrepartie ainsi que la Reprise des dates dans une écriture. Onglet Notes La gestion de l'onglet Notes est commune à toutes les fiches. Modifications des paramètres et impact sur les autres exercices : Si un même journal existe sur plusieurs exercices et que les paramètres de ce journal sont modifiés sur l'exercice courant, alors : - les modifications de ces paramètres sont propagées sur tous les exercices suivants, - les modifications de ces paramètres ne sont propagées sur aucun des exercices antérieurs. PLAN COMPTABLE ENTREPRISE Plan comptable Accès : Quotidien - Plan comptable entreprise OU Paramètres - Plan comptable entreprise La gestion de la liste du plan comptable est commune à toutes les listes. Le plan comptable choisi par défaut lors de la création du dossier est importé sur le premier exercice comptable et son contenu reste modifiable à tout moment. Les créations, suppressions et modifications du plan comptable sont propagées automatiquement sur les exercices postérieurs à l’exercice courant, que ces exercices soient déjà créés ou à créer. En revanche, en aucun cas, les créations, suppressions et modifications intervenant dans le plan comptable ne sont rétroactives sur les exercices précédents. Un compte comptable peut être supprimé uniquement s’il n’a pas été mouvementé sur l’exercice duquel il est supprimé. La liste du plan comptable est divisée en onglets successifs : L’onglet « Tous » affiche tous les comptes du plan comptable sans distinction, du compte 1 au compte 9zzzzzzzzz. L’onglet « Capitaux » affiche tous les comptes de la classe 1 « Comptes de Capitaux », soit tous les comptes compris entre 1 et 1zzzzzzzzz. L’onglet «Immobilisations » affiche tous les comptes de la classe 2 « Comptes d’Immobilisations », soit tous les comptes compris entre 2 et 2zzzzzzzzz. L’onglet « Stocks » affiche tous les comptes de classe 3 « Comptes de Stocks et En-cours », soit tous les comptes compris entre 3 et 3zzzzzzzzz. L’onglet « Fournisseurs » affiche une partie des comptes de classe 4 « Comptes de Tiers », soit tous les comptes compris entre 40 et 40zzzzzzzzz. L’onglet « Clients » affiche une partie des comptes de classe 4 « Comptes de Tiers », soit tous les comptes compris entre 41 et 41zzzzzzzzz. 139 EBP Comptabilité Open Line Pro L’onglet « Autres Tiers » affiche tous les autres comptes de classe 4 « Comptes de Tiers », soit tous les comptes compris entre 4 et 4zzzzzzzzz et non déjà présents dans les onglets Fournisseurs et Clients. L’onglet « Financiers » affiche tous les comptes de classe 5 « Comptes Financiers», soit tous les comptes compris entre 5 et 5zzzzzzzzz. L’onglet « Charges » affiche tous les comptes de classe 6 « Comptes de Charges », soit tous les comptes compris entre 6 et 6zzzzzzzzz. L’onglet « Produits » affiche tous les comptes de classe 7 « Comptes de Produits », soit tous les comptes compris entre 7 et 7zzzzzzzzz. Les colonnes du plan comptable reprennent les valeurs principales des fiches comptes Les colonnes N° de compte et Intitulé affichent le numéro et l’intitulé de la fiche du compte créé. Les colonnes Echéancier et Bloqué affichent une coche si l’option correspondante a été activée dans la fiche de ce compte. Les colonnes Débit et Crédit et Solde affichent le montant cumulé des mouvements intervenus sur ce compte durant l’exercice courant. Une ligne de totalisation de tous les Débits et de tous les Crédits affichés est disponible en pied de la liste. La colonne Type de compte affiche le type du compte qui peut être soit Racine, soit Détail. Les colonnes A et V indiquent si le compte est autorisé à être utilisé en Saisie pratique sur Achats (A) et/ou sur Ventes (V). Les actions possibles dans la liste Outre, les actions standards possibles sur toutes les listes, quelques actions supplémentaires sont disponibles : Consultation/Lettrage : pour accéder à la consultation de compte sans changer de menu, il vous suffit de sélectionner un compte dans la liste puis de cliquer sur la tâche Consultation/Lettrage. Cette action est possible sur un seul compte à la fois. Nature d'achat saisie pratique / Nature de vente saisie pratique : pour autoriser ou interdire un compte en Saisie pratique, sans avoir à ouvrir la fiche de ce compte, il vous suffit de le sélectionner dans la liste puis de cliquer sur la tâche Nature d'achat saisie pratique ou sur la tâche Nature de vente saisie pratique. Cette action est également possible sur plusieurs comptes à la fois. Autoriser/interdire le lettrage approché : pour autoriser ou interdire le lettrage approché sur un compte, sans ouvrir la fiche de ce compte, il vous suffit de le sélectionner dans la liste puis de cliquer sur la tâche Autoriser/interdire le lettrage approché. Cette action est possible également sur plusieurs comptes à la fois. Fiche compte Accès : Quotidien - Plan comptable entreprise OU Paramètres - Plan comptable entreprise La gestion de la fiche compte est commune à l’ensemble des fiches. Cette fiche se décompose en plusieurs onglets. - un en-tête Description de l'en-tête - un onglet Paramétrage Lettrage et rapprochement Autoriser le lettrage Autoriser le lettrage approché Prochain code lettrage 140 MANUEL Type de rapprochement Règlement Gestion des échéanciers Mode de règlement Paramétrage de TVA Paramétrage de TVA Saisies pratiques Nature d'achat et Nature de vente - un onglet Paramétrage avancé Divers Comptes bloqués AN non détaillés Centralisation sur le Grand Livre Types de journaux autorisés et sens de saisie Type de journaux autorisés et sens de saisie Comptes associés Comptes associés - un onglet Coordonnées Cet onglet vous permet de renseigner l'adresse principale de facturation, le contact principal de facturation et les coordonnées bancaires principales du compte. Ces informations sont liées à la fiche Tiers : La modification de cet onglet entraînera la modification de la fiche Tiers et inversement. - un onglet Cumuls Description de l'onglet - un onglet Notes La gestion de l'onglet Notes est commune à toutes les fiches. - Autres actions possibles Certaines actions sont possibles sur un compte à partir de sa fiche : - Consultation du compte - Lettrage du compte - activation des saisies pratiques - Options diverses Un certain nombre de boutons sont disponibles dans la barre d'outils de la fiche compte. Ils permettent de faciliter la navigation entre l'application de comptabilité et l'application de Gestion Commerciale, ainsi que vers des sites internet. Fiche Tiers : Ce bouton permet d'accéder à la fiche Tiers et la totalité des contacts, adresses et coordonnées bancaires... d'un Tiers. La fiche Tiers ouverte dépend de l'application qui a créée le compte : - Lorsque le compte a été créé en Gestion commerciale, alors la fiche Tiers de la Gestion Commerciale est ouverte. - Lorsque le compte a été crée en Comptabilité, alors la fiche Tiers de la Comptabilité est ouverte. Solvabilité : Ce bouton permet d'accéder à une sélection de sites internet permettant de répondre aux questions de solvalibité. Plan : Ce bouton permet d'accéder à une sélection de sites internet fournissant des plans. Itinéraires : Ce bouton permet d'accéder à une sélection de sites internet fournissant des itinéraires. 141 EBP Comptabilité Open Line Pro BANQUES Liste des banques Accès : Paramètres - Banques La gestion des banques est commune à toutes les listes. Elle permet de gérer les fiches Banques. Les banques permettent de créer des relevés bancaires pour le rapprochement bancaire automatique. Fiche Banques Accès : Paramètres - Banques La gestion de la fiche Banque est commune à toutes les fiches. Une fiche Banque est accessible à partir de la liste des Banques. Créer une fiche Banques est une opération qui peut être indispensable pour exécuter les transferts de règlements à partir de l'application de Gestion commerciale ou des rapprochements bancaires automatiques. Une banque s'identifie par les éléments suivants : • Le code banque * Saisissez un identifiant unique pour votre banque. Cet identifiant est limité à 5 caractères alphanumériques. • Le nom de la banque * Saisissez le nom de votre banque (au maximum 40 caractères alphanumériques). Onglet Adresse Les informations ci-dessous correspondent aux coordonnées de la banque. Adresse • Nom Champ saisissable, limité à 60 caractères alphanumériques. • Adresse Champ saisissable, limité à 40 caractères alphanumériques. • Adresse (Suite) Champ saisissable, limité à 40 caractères alphanumériques. • Adresse (Suite) Champ saisissable, limité à 40 caractères alphanumériques. • Adresse (Fin) Champ saisissable, limité à 40 caractères alphanumériques. • Code postal Champ saisissable, limité à 10 caractères alphanumériques. Lors de la saisie du code postal, - si celui-ci existe et est unique dans la table des codes postaux, alors la ville et le pays sont renseignés par défaut, - si celui-ci existe mais n’est pas unique, alors la liste des codes postaux est affichée, avec uniquement ceux répondant à la saisie, - si celui-ci n’existe pas, alors le code postal est conservé dans la fiche client mais n’est pas créé dans la table des codes postaux. Si le code postal que vous souhaitez n'existe pas, vous avez la possibilité de créer une nouvelle fiche code postal en sélectionnant Ajouter dans la liste déroulante. • Ville Champ saisissable, limité à 35 caractères alphanumériques. 142 MANUEL Le champ Ville sera automatiquement rempli après la saisie d’un code postal existant dans la table des codes postaux. Il est toujours possible de modifier le libellé de la ville, par contre cela n'entraînera pas la création d’une nouvelle fiche code postal. • Département Champ saisissable, limité à 50 caractères alphanumériques. Le champ Département sera automatiquement rempli après la saisie d’un code postal existant dans la table des codes postaux. Si le département que vous souhaitez n'existe pas, vous avez la possibilité de créer une nouvelle fiche département en sélectionnant Ajouter dans la liste déroulante. • Pays Champ saisissable. Le champ Pays sera automatiquement rempli après la saisie d’un code postal existant dans la table des codes postaux. Si le pays que vous souhaitez n'existe pas, vous avez la possibilité de créer une nouvelle fiche pays en sélectionnant Ajouter dans la liste déroulante. • Site Web Champ saisissable, limité à 100 caractères alphanumériques. Ce champ permet de saisir le site web lié à cette adresse. Contact • Civilité Ce champ permet de saisir ou sélectionner la civilité de votre contact (au maximum 25 caractères alphanumériques). Si la civilité que vous souhaitez n'existe pas et que vous souhaitez la conserver dans votre fichier des civilités, vous avez la possibilité de créer une nouvelle fiche civilité en sélectionnant Ajouter dans la liste déroulante. • Nom Champ saisissable, limité à 60 caractères alphanumériques. • Fonction Champ saisissable, limité à 40 caractères alphanumériques. • Prénom Champ saisissable, limité à 60 caractères alphanumériques. • Téléphone fixe Champ saisissable, limité à 20 caractères alphanumériques. • Téléphone portable Champ saisissable, limité à 20 caractères alphanumériques. • Fax Champ saisissable, limité à 20 caractères alphanumériques. • Service/Bureau Champ saisissable, limité à 40 caractères alphanumériques. • E-mail Champ saisissable, limité à 100 caractères alphanumériques. Permet de saisir l'e-mail du contact. Onglet Comptabilité Cet onglet vous permet de saisir : • Le compte de banque * : Ce compte doit être un compte de type Détail. • Le journal de banque * : Ce journal doit être de type Trésorerie. 143 EBP Comptabilité Open Line Pro Le journal de banque peut déjà être défini avec un compte de contrepartie. Dans ce cas : - si vous saisissez en premier le compte de banque, alors le journal associé sera automatiquement proposé et non modifiable ; - si vous saisissez en premier le journal de banque, alors le compte de contrepartie de ce journal sera automatiquement proposé et non modifiable. Onglet Coordonnées bancaires Cet onglet vous permet de définir les coordonnées bancaires de votre compte (RIB/BBAN, IBAN, BIC). Onglet Notes La gestion d'une Note est commune à toutes les fiches. NATURES DE COMPTE Natures de comptes Accès : Paramètres - Natures de comptes Les natures de comptes permettent de regrouper entre eux plusieurs comptes de racines différentes pour lesquels il est possible de définir un comportement commun. La nature "Comptes de bilan" regroupent les comptes de racine 1+2+3+4+5 qui : - sont lettrables - ont un comportement identique sur certaines impressions - permettent de sélectionner le type d'A Nouveau désiré (détaillé ou non détaillé) -.... Les natures "Résultat, bénéfice" et "Résultat, perte" regroupent les comptes de racine 120 et 129 qui : - sont définies au niveau de la fiche exercice - sont validées/modifiées lors de la clôture annuelle. Les natures de comptes sont directement gérées par l'application et ne peuvent être ni modifiées ni supprimées. MODELES DE GUIDE Liste des modèles de guides de saisie Accès : Paramètres - Modèles de guides de saisie Les modèles de guides de saisie sont affichés dans une liste qui se comporte comme toutes les listes. Elle reprend les valeurs principales définies dans le modèle lui-même : - Type du modèle - Nom du modèle - Journal de destination - Modèle inactif Un certain nombre de modèles de guide sont livrés par défaut : ils doivent permettre de répondre aux besoins les plus courants. Ils restent modifiables. La liste des modèles n'est pas exhaustive : vous pouvez créer autant de modèles que vous voulez, afin de répondre spécifiquement à vos besoins. Les modèles de guides de saisie sont gérés sur l'ensemble du dossier. Ainsi un modèle crée sur l'exercice courant est utilisable sur tous les exercices précédents ou suivants non encore clôturés. Modèles de guides Accès : Paramètres - Modèles de guides L'affichage du contenu d'un guide de saisie se fait à partir de la liste des modèles, qui n'est pas exhaustive : vous pouvez créer autant de modèles que vous voulez, afin de répondre spécifiquement à vos besoins. 144 MANUEL Un certain nombre de modèles de guide sont livrés par défaut : ils doivent permettre de répondre aux besoins les plus courants et sont immédiatement utilisables. Ils restent modifiables. Définir un modèle de guide, c'est définir un modèle d'écriture, ayant ses caractéristiques propres. Ainsi lors de la saisie, il suffira d'appeler le modèle de guide désiré pour que tout ou partie de votre saisie soit automatisée. En-tête du modèle Type * : Une liste déroulante permet de sélectionner un type de journal. Nom * : Ce champ saisissable permet d'identifier distinctement les différents modèles. Journal de destination * : Une liste déroulante présente la liste de journaux de destination, établie en fonction du choix de guide précédemment effectué. Ce choix détermine précisément le journal dans lequel l'écriture saisie sera comptabilisée. Si le guide est de type Achats, alors seuls les journaux de type Achats sont affichés dans la liste. Inactif : Une case à cocher est disponible sur chaque modèle. Si cette option est cochée, alors le modèle devient inactif, c'est-à-dire qu'aucune écriture guidée ne pourra plus être créée d'après ce modèle. L'option peut être activée ou désactivée à tout moment. Corps du modèle Jour : Définit le jour de la date de l'écriture guidée. Compte : Permet de sélectionner un compte dans une liste déroulante ou de le saisir. Pièce : Permet de sélectionner une règle de numérotation de pièce prédéfinie dans une liste déroulante ou de saisir un numéro. Il est également possible de créer sa propre formule de numérotation de pièce. Libellé : Permet de sélectionner une règle de libellé prédéfinie dans une liste déroulante ou de saisir un libellé. Il est également possible de créer sa propre formule de libellé. Débit : Permet de sélectionner une formule ou de saisir un montant. Il est également de créer sa propre formule de calcul. Crédit : Permet de sélectionner une formule ou de saisir un montant. Il est également de créer sa propre formule de calcul. Si une formule est utilisée dans le modèle du guide, alors le calcul dans le guide se fera automatiquement. Mais, dans l'écriture guidée elle-même, si vous effectuez une modification sur la ligne comportant une formule, alors le calcul de cette formule ne se fera plus en automatique. Case à cocher : Chacune de ces colonnes est suivie d'une case à cocher. Lorsque la case est cochée alors, lors de la création d'une écriture guidée d'après ce guide, la valeur définie dans le modèle est présentée et reste modifiable. Lorsque la case est décochée alors, lors de la création d'une écriture guidée d'après ce guide, la valeur définie dans le modèle est présentée mais n'est plus modifiable. Les autres fonctions disponibles : - Ajouter : permet d'ajouter une nouvelle ligne après la dernière ligne saisie dans le guide. - Insérer : permet d'insérer une nouvelle ligne entre deux lignes déjà saisies dans le guide. - Supprimer : permet de supprimer une ligne existante. - Monter/Descendre : permet de modifier l'ordre des priorités des lignes sans être obligé de les supprimer et de les recréer. - Couper/Copier/Coller : ces trois boutons ont un comportement identique au comportement standard défini, par exemple, dans Word et Excel. Ces actions sont possibles uniquement sur les modèles de guide qui n'ont pas encore permis de créer des guides de saisie. MODELES DE LIBELLE 145 EBP Comptabilité Open Line Pro Libellé type Les libellés types ont pour but d'accélérer la saisie journal et la saisie par écriture, en affichant un modèle de libellé pré-existant et donc en évitant des saisies répétitives. Modèles de libellés Accès : Paramètres - Modèles de libellé Aucun modèle de libellé n'est livré par défaut. Les modèles de libellé doivent être créés en fonction de vos besoins. Ce sont ces modèles qui seront utilisables en saisie journal. Créer un Modèle de libellé Vous pouvez créer un nouveau modèle de libellé, à partir de la liste des modèles de libellés : - en cliquant sur le bouton Ajouter de la barre de tâches, - en cliquant sur le bouton Inser du clavier, - en sélectionnant Ajouter dans le menu contextuel (=clic droit). Dans la fiche du Libellé Type, vous devez saisir : - son code, - son Libellé, - le type de journal dans lequel vous souhaitez l'utiliser. La gestion de la fiche d'un Modèle de libellé est commune à l'ensemble des fiches. Rendre actif ou inactif un modèle de libellé Si la case Actif est cochée, alors le modèle de libellé est disponible en saisie journal. Si la case Actif est décochée, alors le modèle de libellé n'est plus disponible en saisie journal, mais il existe toujours. Cette option permet donc de masquer temporairement ou définitivement ce libellé et de limiter son utilisation. Il est possible d'activer ou de désactiver cette option à tout moment. Modifier ou supprimer un modèle de libellé La modification ou la suppression d'un modèle de libellé est toujours possible, que ce libellé ai déjà été utilisé ou non en saisie. La modification et la suppression de ces libellées sont bien-sûr sans incidence sur les écritures saisies. Utilisation des modèles de libellé en saisie journal ou en saisie par écriture Pour sélectionner un libellé type en saisie, il suffit de : - se positionner dans le champ Libellé de la ligne d'écriture et de cliquer sur le bouton d'accès à la liste déroulante, - ou de saisir l'un des caractères de ce libellé, pour que tous les libellés existants soient affichés. Seuls les modèles de libellé rattachés au type de journal en cours de saisie et Actif sont visibles. TAXES Taux de TVA Accès : Paramètres - Taxes La gestion de la liste des taux de TVA est commune à toutes les listes. La liste se décompose en deux onglets : Territorialité du dossier : Cet onglet affiche tous les taux autorisés sur la territorialité choisie sur le dossier. Taux de TVA : Cet onglet affiche tous les taux possibles qui permettront l'exploitation complète du dossier. L'ajout d'un taux de TVA est possible. Ces taux sont réglementés par l'Administration. En conséquence, pour les territorialités France, Corse, Dom et Monaco, seuls les types de TVA "Autre taux" et "Ancien taux" peuvent être utilisés pour créer de nouveaux taux. 146 MANUEL Les taux de TVA nouvellement créés ne seront pris en compte dans aucune déclaration de TVA, tant que la mise à jour des déclarations n'aura pas été effectuée par l'Administration. Types de TVA Accès : Paramètres - Taxes - Types de TVA La gestion de la fiche "Type de TVA" est commune à toutes les fiches. Une fiche "Type de TVA" contient : un champ Libellé *, un champ Nature *, une zone de Note. Cette notion de type de TVA sera reprise dans les fiches TVA. Les natures de TVA disponibles sont : Normal Réduit Super réduit Exonéré Ancien Autre La liste des natures de TVA est fixe, il n'est pas possible d'ajouter ou supprimer une nature de TVA. La gestion d'une "Note" est commune à toutes les fiches. A la création du dossier, le fichier des types de TVA est automatiquement créé. Il est possible de créer des types de TVA mais uniquement avec une nature Ancien ou Autre. Territorialités Accès : Paramètres - Taxes - Territorialité La gestion de la fiche "Territorialité" est commune à toutes les fiches. La territorialité définit une appartenance à un espace territorial mais surtout à un régime fiscal particulier. A la création du dossier, le fichier des territorialités est automatiquement créé. Une fiche Territorialité contient un champ Libellé et une zone de Note. La gestion d'une "Note" est commune à toutes les fiches. Il est impossible d'ajouter, de modifier ou supprimer le libellé de la fiche territorialité. Toutefois, vous pouvez Ajouter, Modifier ou Supprimer la note de la territorialité et enregistrer la fiche avec les nouvelles informations. Cette notion de territorialité est importante car elle sera reprise dans les options du dossier, les fiches tiers, les fiches TVA et les documents de ventes. Types d'opération Accès : Paramètres - Taxes La gestion de la liste des types d'opération est commune à toutes les listes. Cette liste aide à établir la déclaration de TVA. Tout ajout, correction ou suppression peut entraîner des incohérences sur les déclarations de TVA. Régimes de TVA Accès : Paramètres - Taxes 147 EBP Comptabilité Open Line Pro La gestion de la liste des régimes de TVA est commune à toutes les listes. Cette liste affiche tous les régimes existants définis par l'Administration française. Tout ajout peut entraîner des incohérences sur les états fiscaux. Les corrections et suppressions des régimes livrés par défaut sont impossibles. Déclarations livrées par défaut Liste Accès : Paramètres - Déclarations. La gestion de la liste des déclarations est commune à toutes les listes. Néanmoins aucun ajout, modification ni suppression n'est possible. Cette liste présente tous les types de déclarations autorisés et agréés par l'Administration, sans filtrage lié aux paramétrages choisis sur le dossier. Paramétrage Accès : Paramètres - Paramétrage des déclarations Aucun ajout ni aucune modification n'est possible dans ces fiches, qui représentent le contenu "système" de chaque déclaration. DIVERS Civilités Accès : Paramètres - Divers - Civilités La gestion de la fiche "Civilité" est commune à toutes les fiches. Saisissez le libellé * de la civilité (au maximum 25 caractères alphanumériques). La création du dossier propose par défaut une liste de civilités. Les civilités seront disponibles pour toutes les fiches relatives aux tiers (clients / fournisseurs...). La gestion d'une "Note" est commune à toutes les fiches. Codes postaux Accès : Paramètres - Divers - Codes postaux La gestion de la fiche "Code postal" est commune à toutes les fiches. Une fiche "Code postal" se compose de quatre zones à remplir : Le code postal * Saisissez le code postal. Ce code est limité à 10 caractères alphanumériques. La ville * Saisissez le nom de la ville (au maximum 35 caractères alphanumériques). Le pays * Sélectionnez le pays associé au code postal. Le département Sélectionnez le département associé au code postal. Lors de la saisie du département si celui-ci est associé à un pays différent de celui sélectionné précédemment, c'est le pays du département qui sera repris dans la fiche. 148 MANUEL La création du dossier propose par défaut une liste de codes postaux. La gestion d'une "Note" est commune à toutes les fiches. Départements Accès : Paramètres - Divers - Départements La gestion de la fiche "Département" est commune à toutes les fiches. La fiche "Département" se compose des champs suivants : Le Numéro * Saisissez le code du département. Ce numéro est limité à 3 caractères alphanumériques. Le Nom * Saisissez le nom ou le libellé du département (au maximum 50 caractères alphanumériques). Le Pays * Sélectionnez le pays associé au département. La création du dossier propose par défaut une liste de départements. La gestion d'une "Note" est commune à toutes les fiches. Pays Accès : Paramètres - Divers - Pays La gestion de la fiche "Pays" est commune à toutes les fiches. La fiche "Pays" se compose des éléments suivants : Le code ISO * Indiquez le code ISO du pays, sur 3 caractères. Le nom * Saisissez le nom du pays (au maximum 50 caractères alphanumériques). La création du dossier propose par défaut une liste de pays. Cette liste donne les noms de pays (formes courtes officielles des noms en français) par ordre alphabétique tels qu'ils sont donnés dans l'ISO 3166-1 et les codes alpha-2 correspondants de l'ISO 3166-1. Vous disposez également de 2 cases à cocher permettant des vues et classements rapides : Inactif Cliquez dans cette case si vous souhaitez ne pas afficher ce pays dans les vues standard, les listes déroulantes... UE Cliquez dans cette case pour noter que le pays appartient à l'union européenne. La gestion d'une "Note" est commune à toutes les fiches. Moyens de paiement Accès : Paramètres - Divers - Moyens de paiement La gestion de la fiche "Moyen de paiement" est commune à toutes les fiches. La fiche "Moyen de paiement" se compose des éléments suivants : un code * Indiquez un code moyen de paiement. Ce code est limité à 6 caractères alphanumériques. un libellé * 149 EBP Comptabilité Open Line Pro Saisissez le libellé du moyen de paiement (au maximum 60 caractères alphanumériques). une nature * Sélectionnez un type de nature dans la liste déroulante. Cette liste n'est pas paramétrable. une banque Ce champ correspond à la banque sélectionnée par défaut lorsque vous réalisez un règlement. La liste des banques est accessible par le menu Règlements - Données - Banques. Si la banque que vous souhaitez n'existe pas, vous avez la possibilité de créer une nouvelle fiche banque en sélectionnant Ajouter dans la liste déroulante accessible par l'icône . La création du dossier propose par défaut une liste de moyens de paiement. La banque par défaut n'est pas renseignée dans les fiches moyens de paiement. La gestion d'une "Note" est commune à toutes les fiches. Modes de règlement Accès : Paramètres - Divers - Modes de règlement La gestion de la fiche "Mode de règlement" est commune à toutes les fiches. La fiche "Modes de règlement" se compose des éléments suivants : Le code * Indiquez un code pour votre mode de règlement. Ce code est limité à 6 caractères alphanumériques. Le libellé * Saisissez le libellé du mode de règlement (au maximum 60 caractères alphanumériques). Nous vous conseillons d'indiquer un libellé explicite qui reprenne le type de paiement et l'échéance. La création du dossier propose par défaut une liste de modes de règlement. Onglet détail Cet onglet est divisé en 2 parties : Création des lignes "d'échéances" pour le mode de règlement Test des lignes créées Création des lignes Pour valider une fiche mode de règlement, vous devez avoir au minimum une ligne d'échéance. Une ligne contient les renseignement suivants : % Il sert à calculer le montant de l'échéance par rapport au montant TTC de la facture multiplié par le pourcentage défini. Par défaut, il est égal à 100%. Nbre de jours Saisissez le nombre de jours pour le calcul de l'échéance, à partir de la date du document (de 1 à 365). La zone nombre de jours n'est pas accessible pour un règlement de type Comptant. Type de Règlement Choisissez dans la liste proposée, le mode de calcul d'échéance que vous souhaitez appliquer. Jour de règlement Indiquez le jour pour lequel vous souhaitez le règlement (de 1 à 31). Cette zone est accessible uniquement pour les types de règlement : Fin de mois le ou Net le. Mois comptable Cochez cette case si vous souhaitez faire fonctionner le mode de règlement en mois comptable pour le calcul de la date d'échéance. 150 MANUEL Cette fonction sert pour considérer un nombre de jours en nombre de mois (31 jours devient 1 mois, 60 jours devient 2 mois...). Moyen de paiement Cette liste déroulante est paramétrable depuis la liste des moyens de paiement. Vous pouvez modifier, créer plusieurs lignes d'échéances pour un mode de règlement. Pour cela, cliquez sur l'icône Ajouter pour insérer une ligne et saisissez les différents critères que vous souhaitez. La somme des % des lignes créées doit être égale à 100%. Test des lignes créées Pour tester les lignes que vous venez de créer, vous devez indiquer : une date qui corresponde à la date du document un montant qui corresponde au montant du document Dans le tableau à droite de ces zones, vous trouverez le résultat du calcul des échéances (Date échéance, Montant et Moyen de paiement) L'échéance, le règlement et le jour s'enchaînent pour le calcul de l'échéance de la facture. Exemple 1 Mode de règlement : CH30 Paramétrage d'une ligne échéance : % NB jours Type Jour Mois Moyen de règlement règlement comptable paiement 100 30 Net Chèque Date de facture : 01/01/2008, Montant : 100 Votre date d'échéance sera calculée ainsi : 01/01/2008 + 30J soit le 31/01/2008, puis Net, ce qui donnera le 31/01/2008, ce qui donnera une date d'échéance au 31/01/2008 pour un montant de 100. Exemple 2 Mode de règlement :Prel4 Paramétrage de 4 lignes d'échéances: % NB jours Type Jour Mois Moyen de règlement règlement comptable paiement 25 Comptant Prélèvement 25 30 Net le 15 Prélèvement 25 60 Net le 15 Prélèvement 25 90 Net le 15 Prélèvement Date de facture : 01/01/2008, Montant : 100 € Les dates d'échéance seront calculées ainsi : 1ère ligne : 01/01/2008 + 0J soit le 01/01/2008, puis Comptant, ce qui donnera le 01/01/2008 pour un montant de 25 (25% du montant soit 100). 2ème ligne : 01/01/2008 + 30J soit le 31/01/2008, puis Net le, 15, ce qui nous donne le 15/02/2008 pour un montant de 25 (25% du montant soit 100). 3ème ligne : 01/01/2008 + 60J soit le 01/03/2008, puis Net le, 15, ce qui nous donne le 15/03/2008 pour un montant de 25 (25% du montant soit 100). 4ème ligne : 01/01/2008 + 90J soit le 31/03/2008, puis Net le, 15, ce qui nous donne le 15/04/2008 pour un montant de 25 (25% du montant soit 100). 151 EBP Comptabilité Open Line Pro Les actions possibles dans la liste Ajouter : permet d'ajouter une nouvelle ligne d'échéance à la fin de la liste. Insérer : permet d'insérer une nouvelle ligne d'échéance entre deux lignes déjà existantes. Supprimer : permet de supprimer une ligne d'échéance existante. Monter/Descendre : permet de modifier l'ordre des priorités des lignes d'échéances sans être obligé de les supprimer et de les recréer. Couper/Copier/Coller : ces trois boutons ont un comportement identique au comportement standard défini, par exemple, dans Word et Excel. Toutes les actions accomplies sur la liste des échéances avec ces boutons ne doivent pas empêcher de respecter les règles de cohérence définies dans les paragraphes précédents. Onglet Notes La gestion d'une "Note" est commune à toutes les fiches. Codes NAF Accès : Paramètres - Divers - Codes NAF La gestion de la fiche "NAF" est commune à toutes les fiches. Le code NAF est utilisé dans les Options/Identifications administratives. La création du dossier propose par défaut une liste de codes NAF. La fiche "Code NAF" se compose des zones : Code NAF * Ce code est limité à 8 caractères alphanumériques. Libellé * Indiquez le libellé du code NAF. Notes La gestion d'une "Note" est commune à toutes les fiches. SOCIÉTÉ Coordonnées Accès : Paramètres - Société - Coordonnées Les coordonnées à saisir sont celles de votre dossier-société. Il est important de les renseigner car ces informations seront reprises sur certaines impressions de vos documents (Grand Livre, Balance, Tva..). Identification Forme juridique ou civilité Champ saisissable, limité à 25 caractères alphanumériques. Si la forme juridique ou civilité que vous souhaitez n'existe pas et que vous souhaitez la conserver dans le fichier des civilités, vous avez la possibilité de créer une nouvelle fiche civilité en sélectionnant Ajouter dans la liste déroulante accessible par l'icône . Nom – Raison sociale Champ saisissable, limité à 60 caractères alphanumériques. Qualité de la personne Champ saisissable, limité à 40 caractères alphanumériques. Adresse de la société Adresse Champ saisissable, limité à 40 caractères alphanumériques. Adresse (suite) Champ saisissable, limité à 40 caractères alphanumériques. 152 MANUEL Adresse (suite) Champ saisissable, limité à 40 caractères alphanumériques. Adresse (fin) Champ saisissable, limité à 40 caractères alphanumériques. Code Postal Champ saisissable, limité à 10 caractères alphanumériques. Lors de la saisie du code postal, ° si celui-ci existe et est unique dans la table des codes postaux, la ville et le pays sont renseignés par défaut ° si celui-ci existe mais n’est pas unique, la liste des codes postaux est affichée avec uniquement ceux répondant à la saisie. ° si celui-ci n’existe pas, le code postal est conservé dans la fiche client mais n’est pas créé dans la table des codes postaux. Si le code postal que vous souhaitez n'existe pas, vous avez la possibilité de créer une nouvelle fiche code postal en sélectionnant Ajouter dans la liste déroulante accessible par l'icône . Ville Champ saisissable, limité à 35 caractères alphanumériques. Le champ ville sera automatiquement rempli après la saisie d’un code postal existant dans la table des codes postaux. Il est toujours possible de modifier le libellé de la ville, par contre cela n'entraînera pas la création d’une nouvelle fiche code postal. Département Champ saisissable, limité à 50 caractères alphanumériques. Le champ département sera automatiquement rempli après la saisie d’un code postal existant dans la table des codes postaux. Si le département que vous souhaitez, n'existe pas, vous avez la possibilité de créer une nouvelle fiche département en sélectionnant Ajouter dans la liste déroulante accessible par l'icône . Pays Champ saisissable, limité à 50 caractères alphanumériques. Le champ pays sera automatiquement rempli après la saisie d’un code postal existant dans la table des codes postaux. Si le pays que vous souhaitez, n'existe pas, vous avez la possibilité de créer une nouvelle fiche pays en sélectionnant Ajouter dans la liste déroulante accessible par l'icône . Autres informations Téléphone fixe Champ saisissable, limité à 20 caractères alphanumériques. Téléphone portable Champ saisissable, limité à 20 caractères alphanumériques. Télécopie/Fax Champ saisissable, limité à 20 caractères alphanumériques. e-mail Champ saisissable, limité à 100 caractères alphanumériques. Site Web Champ saisissable, limité à 100 caractères alphanumériques. Identification Saisissez les codes Siret, NAF, MSA, R.C.S et R.M de votre dossier-société. Ces informations pourront être imprimées en pied de certains de vos documents (Grand Livre...) Informations administratives Accès : Paramètres - Société - Informations administratives SIRET Le champ Siret permet de saisir un numéro de 14 caractères. Code NAF/APE Ce champ permet la sélection d’un Code NAF et affichage du libellé. 153 EBP Comptabilité Open Line Pro Si le code NAF que vous souhaitez n'existe pas, vous avez la possibilité de créer une nouvelle fiche code NAF en sélectionnant Ajouter dans la liste déroulante accessible par l'icône . MSA Ce champ permet de saisir le numéro de Mutuelle Santé Agricole et autorise 50 caractères alphanumériques. N° Identification RCS Ce champ permet de saisir le numéro d'identification au Registre du Commerce et des Sociétés ; il autorise 13 caractères alphanumériques. N° Identification RM Ce champ permet de saisir le numéro d'identification au Registre des Métiers ; il autorise 13 caractères alphanumériques. Capital Ce champ permet de saisir 18 caractères numériques avec décimales. Informations TVA Accès : Paramètres - Société - Informations de TVA Tous les champs de l'onglet "Informations de TVA" sont déterminants pour établir votre déclaration de TVA : leur paramétrage est donc indispensable. Paramétrage et gestion de la TVA sur le dossier Siret Accès : Paramètres - Société - Informations administratives. La mention du Siret est obligatoire pour pouvoir établir la déclaration de TVA : il est donc nécessaire de vérifier que cette information est bien renseignée. Centre des Impôts Accès : Paramètres - Société- Trésor Public - Centre des Impôts Dans cette fenêtre doivent être renseignées les informations relatives au Centre des Impôts dont dépend l'entreprise. S.I.E. Accès : Paramètres - Société- Trésor Public - S.I.E. Dans cette fenêtre doivent être renseignées les informations relatives au S.I.E S.I.E. = Service InterEntreprises.. dont dépend l'entreprise. Informations de TVA Accès : Paramètres - Société- Informations de TVA Dans cette fenêtre doivent être renseignées les informations relatives à la déclaration de TVA. Elles vont permettre de paramétrer les comptes mais également de générer la déclaration à proprement parler. Les différents champs de l'en-tête Ces champs (TVA intracommunautaire, SIE...) sont saisissables. Ils correspondent aux éléments devant obligatoirement apparaître dans une déclaration de TVA : ils seront donc imprimés en l'état dans les déclarations. Le contrôle de cohérence du paramétrage de TVA lors du transfert comptable Une option "Vérifier au moment du transfert comptable, la cohérence du paramétrage TVA sur les comptes" existe. Elle est inactive par défaut. Elle peut être activée (cochée) ou désactivée (décochée) à tout moment. Si cette option est activée alors, lors de chaque transfert comptable de la Gestion Commerciale vers la Comptabilité, la cohérence des paramétrages des comptes de TVA, des comptes soumis à TVA, des taux de TVA, des territorialités et des natures de taxes est vérifiée entre les deux applications. 154 MANUEL Lorsque tous les contrôles sont effectués avec succès alors le transfert comptable est effectué intégralement. Lorsqu'un contrôle est effectué sans succès, alors le transfert comptable est bloqué, générant une erreur de synchronisation, puis un message avertit de l'anomalie et rend possible la correction du paramétrage erroné. Si cette option est décochée alors aucun contrôle de cohérence n'est effectué entre la Gestion Commerciale et la Comptabilité. Toutes les écritures sont donc transférées en comptabilité sans information et cela même si les paramétrages des comptes de TVA, des comptes soumis à TVA, des taux de TVA, des territorialités et des natures de taxes sont divergents entre les deux applications. Les régimes Cette liste permet de sélectionner le code régime et le type de TVA dont l'entreprise relève. Ajouter : permet de créer la première ligne ou d'ajouter une nouvelle ligne dans le tableau de TVA. Supprimer : permet de supprimer la dernière ligne affichée, si aucune déclaration de TVA n'a été établie d'après ce code. Code Régime : Une liste déroulante permet de sélectionner le code régime de l'entreprise. Il gère à la fois le régime de TVA dont l'entreprise relève mais également la périodicité des déclarations. Périodicité : Ce champ non accessible dépend directement du code régime précédemment sélectionné et est affiché pour information uniquement. Option de calcul : Par défaut, l'option de calcul est "Sur les Débits", mais elle peut être modifiée par une sélection dans la liste déroulante. Date d'application : Une liste déroulante permet de sélectionner la date à partir de laquelle ce régime est appliqué à l'entreprise. Cette liste est directement dépendante du code régime et de la périodicité de déclaration qui lui est attaché. Une entreprise peut changer de code régime au cours de son existence : il est donc possible de déterminer un nouveau code régime en ajoutant une ligne dans le tableau. Néanmoins, il faut que la date d'application de ce nouveau régime soit postérieure à la dernière date d'application. Lors de la création des déclarations de TVA, c’est le dernier régime de l’exercice courant qui sera pris en compte. Logo de la société Accès : Paramètres - Société - Logo Vous pouvez insérer à cet emplacement le logo de votre société. Il sera automatiquement repris sur vos impressions de documents (Grand Livre, Balance...), sur les modèles de document avec logo. Pour insérer un logo, vous devez réaliser un clic droit puis Charger. Ensuite, utilisez l'icône pour rechercher le fichier qui contient votre image. Vous avez le possibilité de redimensionner celui-ci. Les principaux formats acceptés sont : BMP, GIF, JPG/JPEG et ICO. EXPERT Expert- Cabinet Accès : Paramètres - Société - Expert - Cabinet Vous pouvez saisir à cet emplacement les coordonnées du cabinet de votre expert comptable. Il est intéressant de les renseigner car ces informations seront reprises sur les documents qui lui sont destinés (Impressions - Dossier Expert Comptable). Cabinet Identification Forme Juridique ou Civilité Champ saisissable, limité à 25 caractères alphanumériques. Si la forme juridique ou civilité que vous souhaitez n'existe pas et que vous souhaitez la conserver dans le fichier des civilités, vous avez la possibilité de créer une nouvelle fiche civilité en sélectionnant Ajouter dans la liste déroulante accessible par l'icône . 155 EBP Comptabilité Open Line Pro Nom / Raison sociale Champ saisissable, limité à 60 caractères alphanumériques. SIRET Champ saisissable, limité à 14 caractères alphanumériques. Adresse du cabinet Adresse Champ saisissable, limité à 40 caractères alphanumériques. Adresse (suite) Champ saisissable, limité à 40 caractères alphanumériques. Adresse (suite) Champ saisissable, limité à 40 caractères alphanumériques. Adresse (fin) Champ saisissable, limité à 40 caractères alphanumériques. Code Postal Champ saisissable, limité à 10 caractères alphanumériques. Lors de la saisie du code postal, ° si celui-ci existe et est unique dans la table des codes postaux, la ville et le pays sont renseignés par défaut ° si celui-ci existe mais n’est pas unique, la liste des codes postaux est affichée, avec uniquement ceux répondant à la saisie. ° si celui-ci n’existe pas, le code postal est conservé dans la fiche client mais n’est pas créé dans la table des codes postaux. Si le code postal que vous souhaitez n'existe pas, vous avez la possibilité de créer une nouvelle fiche code postal en sélectionnant Ajouter dans la liste déroulante accessible par l'icône . Ville Champ saisissable, limité à 35 caractères alphanumériques. Le champ ville sera automatiquement rempli après la saisie d’un code postal existant dans la table des codes postaux. Il est toujours possible de modifier le libellé de la ville, par contre cela n'entraînera pas la création d’une nouvelle fiche code postal. Département Champ saisissable, limité à 50 caractères alphanumériques. Le champ département sera automatiquement rempli après la saisie d’un code postal existant dans la table des codes postaux. Si le département que vous souhaitez n'existe pas, vous avez la possibilité de créer une nouvelle fiche département en sélectionnant Ajouter dans la liste déroulante accessible par l'icône . Pays Champ saisissable, limité à 50 caractères alphanumériques. Le champ pays sera automatiquement rempli après la saisie d’un code postal existant dans la table des codes postaux. Si le pays que vous souhaitez n'existe pas, vous avez la possibilité de créer une nouvelle fiche pays en sélectionnant Ajouter dans la liste déroulante accessible par l'icône . Site web Champ saisissable, limité à 100 caractères alphanumériques. Expert - Contacts Accès : Paramètres - Société - Expert - Contacts Vous pouvez saisir à cet emplacement les coordonnées de votre expert comptable et d'un collaborateur. Il est intéressant de les renseigner car ces informations seront reprises sur les documents qui lui sont destinés (Impressions - Dossier Expert Comptable). Contacts Expert Comptable Civilité Champ saisissable, limité à 25 caractères alphanumériques. 156 MANUEL Si la civilité que vous souhaitez n'existe pas et que vous souhaitez la conserver dans le fichier des civilités, vous avez la possibilité de créer une nouvelle fiche civilité en sélectionnant Ajouter dans la liste déroulante accessible par l'icône . Nom Champ saisissable, limité à 60 caractères alphanumériques. Prénom Champ saisissable, limité à 60 caractères alphanumériques. Téléphone fixe Champ saisissable, limité à 20 caractères alphanumériques. Téléphone portable Champ saisissable, limité à 20 caractères alphanumériques. Fax Champ saisissable, limité à 20 caractères alphanumériques. e-mail Champ saisissable, limité à 100 caractères alphanumériques. Collaborateur Civilité Champ saisissable, limité à 25 caractères alphanumériques. Si la civilité que vous souhaitez n'existe pas et que vous souhaitez la conserver dans le fichier des civilités, vous avez la possibilité de créer une nouvelle fiche civilité en sélectionnant Ajouter dans la liste déroulante accessible par l'icône . Nom Champ saisissable, limité à 60 caractères alphanumériques. Prénom Champ saisissable, limité à 60 caractères alphanumériques. Téléphone fixe Champ saisissable, limité à 20 caractères alphanumériques. Téléphone portable Champ saisissable, limité à 20 caractères alphanumériques. Fax Champ saisissable, limité à 20 caractères alphanumériques. e-mail Champ saisissable, limité à 100 caractères alphanumériques. Paramétrage et gestion de la TVA sur le dossier Siret Accès : Paramètres - Société - Informations administratives. La mention du Siret est obligatoire pour pouvoir établir la déclaration de TVA : il est donc nécessaire de vérifier que cette information est bien renseignée. Centre des Impôts Accès : Paramètres - Société- Trésor Public - Centre des Impôts Dans cette fenêtre doivent être renseignées les informations relatives au Centre des Impôts dont dépend l'entreprise. S.I.E. Accès : Paramètres - Société- Trésor Public - S.I.E. 157 EBP Comptabilité Open Line Pro Dans cette fenêtre doivent être renseignées les informations relatives au S.I.E S.I.E. = Service InterEntreprises.. dont dépend l'entreprise. Informations de TVA Accès : Paramètres - Société- Informations de TVA Dans cette fenêtre doivent être renseignées les informations relatives à la déclaration de TVA. Elles vont permettre de paramétrer les comptes mais également de générer la déclaration à proprement parler. Les différents champs de l'en-tête Ces champs (TVA intracommunautaire, SIE...) sont saisissables. Ils correspondent aux éléments devant obligatoirement apparaître dans une déclaration de TVA : ils seront donc imprimés en l'état dans les déclarations. Le contrôle de cohérence du paramétrage de TVA lors du transfert comptable Une option "Vérifier au moment du transfert comptable, la cohérence du paramétrage TVA sur les comptes" existe. Elle est inactive par défaut. Elle peut être activée (cochée) ou désactivée (décochée) à tout moment. Si cette option est activée alors, lors de chaque transfert comptable de la Gestion Commerciale vers la Comptabilité, la cohérence des paramétrages des comptes de TVA, des comptes soumis à TVA, des taux de TVA, des territorialités et des natures de taxes est vérifiée entre les deux applications. Lorsque tous les contrôles sont effectués avec succès alors le transfert comptable est effectué intégralement. Lorsqu'un contrôle est effectué sans succès, alors le transfert comptable est bloqué, générant une erreur de synchronisation, puis un message avertit de l'anomalie et rend possible la correction du paramétrage erroné. Si cette option est décochée alors aucun contrôle de cohérence n'est effectué entre la Gestion Commerciale et la Comptabilité. Toutes les écritures sont donc transférées en comptabilité sans information et cela même si les paramétrages des comptes de TVA, des comptes soumis à TVA, des taux de TVA, des territorialités et des natures de taxes sont divergents entre les deux applications. Les régimes Cette liste permet de sélectionner le code régime et le type de TVA dont l'entreprise relève. Ajouter : permet de créer la première ligne ou d'ajouter une nouvelle ligne dans le tableau de TVA. Supprimer : permet de supprimer la dernière ligne affichée, si aucune déclaration de TVA n'a été établie d'après ce code. Code Régime : Une liste déroulante permet de sélectionner le code régime de l'entreprise. Il gère à la fois le régime de TVA dont l'entreprise relève mais également la périodicité des déclarations. Périodicité : Ce champ non accessible dépend directement du code régime précédemment sélectionné et est affiché pour information uniquement. Option de calcul : Par défaut, l'option de calcul est "Sur les Débits", mais elle peut être modifiée par une sélection dans la liste déroulante. Date d'application : Une liste déroulante permet de sélectionner la date à partir de laquelle ce régime est appliqué à l'entreprise. Cette liste est directement dépendante du code régime et de la périodicité de déclaration qui lui est attaché. Une entreprise peut changer de code régime au cours de son existence : il est donc possible de déterminer un nouveau code régime en ajoutant une ligne dans le tableau. Néanmoins, il faut que la date d'application de ce nouveau régime soit postérieure à la dernière date d'application. Lors de la création des déclarations de TVA, c’est le dernier régime de l’exercice courant qui sera pris en compte. Options comptables Saisie Accès : Paramètres - Société - Options comptables - Saisie Contrôles effectués en cours de saisie Ces contrôles sont actifs dans toutes les fenêtre de saisie. 158 MANUEL Alertes sur les montants : Lorsque cette option est cochée et qu'un montant négatif est saisi, alors un message d'alerte est automatiquement affiché. Sinon, aucun message n'apparaîtra en saisie. Cette alerte apparaît dans tous les masques de saisie. Alertes sur les comptes : Lorsque cette option est cochée, alors tous les messages d'alerte sur les comptes sont affichés (par exemple : racines non autorisées en saisie dans un journal, les comptes non autorisés en saisie dans un type de journal...). Sinon, aucun message n'apparaîtra en saisie quelque soit les paramétrages effectués sur les comptes et les journaux. Cette alerte apparaît dans tous les masques de saisie Afficher sur les doublons des numéros de pièce (hors saisie journal) : Cette option concerne la Saisie journal, la Saisie pratique, Saisie au kilomètre et la Saisie par guide. Elle concerne particulièrement les journaux avec numérotation continue sur la période ou sur l'exercice. Plusieurs utilisateurs peuvent saisir simultanément dans un même journal mais dans des masques de saisie différents (Saisie par journal, Saisie pratique, Saisie au kilomètre, Saisie par guide) ; si ces saisies ne sont pas enregistrées, alors les numéros de pièce sont donc identiques pour tous les utilisateurs. Si l'option est activée, alors dès qu’un autre utilisateur tentera d’enregistrer ses saisies, un message lui signalera les doublons et lui proposera une re-numérotation automatique des numéros déjà utilisés. Trois possibilités s’offrent alors à lui : o annuler l’enregistrement, afin de lui permettre de modifier ses numéros de pièce et de les enregistrer à nouveau ; o refuser la re-numérotation pour que les écritures s’enregistrent telles qu’elles ; o accepter la re-numérotation automatique. Le nouveau numéro de pièce est alors attribué, il est visible dans la fenêtre de saisie en cours. Cette alerte apparaît dans tous les masques de saisie lorsque vous tentez de générer les écritures en Saisie journal. En revanche, lorsque vous saisissez directement en Saisie par journal, le contrôle des doublons n'est pas effectué. Options de saisie par journal Sauvegarde automatique dès l'équilibre de l'écriture : Lorsqu'elle est cochée alors les écritures sont automatiquement sauvegardées lorsqu'elles sont équilibrées. Sinon, il est nécessaire de les sauvegarder manuellement, soit en utilisant la combinaison Ctrl+S, soit en utilisant le bouton Sauvegarder disponible dans la barre d'outils des fenêtres. Cette option concerne uniquement la saisie journal. Activer Annuler / Refaire : Cette option peut être cochée si vous rencontrez des lenteurs dues à un grand nombre d'écritures saisies par mois. L'activation de cette option supprime la possibilité d'annuler ou refaire les dernières actions en saisie journal. De plus, si un journal/mois contient plus de 5000 lignes, alors les actions Annuler / Refaire seront toujours désactivées en saisie journal et cela, quelque soit l'option sélectionnée dans les Paramètres Société. Règlements Accès : Paramètres - Société - Options comptables - Règlements Moyen de paiement par défaut Un moyen de paiement est proposé par défaut, mais il reste modifiable grâce à la liste déroulante. Il est automatiquement repris dans l'échéancier si aucun moyen de paiement n'est renseigné sur la fiche du compte concerné. Banque par défaut Ce champ permet de sélectionner la banque par défaut sur laquelle vous voulez émettre des règlements. Nombre de chèques par défaut Ce champ permet de sélectionner le nombre maximal de chèques disponibles dans les chéquiers. Saisie pratique Accès : Paramètres - Société - Options comptables - Saisie pratique 159 EBP Comptabilité Open Line Pro Cette page permet de définir le journal par défaut utilisé pour comptabiliser une saisie pratique sur Mes achats, Mes ventes ou Ma Trésorerie. Ecritures de régularisation Accès : Paramètres - Société - Options comptables - Ecritures de régularisation Cette page regroupe un certain nombre d'éléments qui déterminent les comptes et journaux à utiliser pour comptabiliser les écritures de régularisation. Charges/Produits constatés d'avance Journal de destination : Un journal de destination est proposé par défaut. Il correspond au premier journal de type Opérations Diverses disponible. Ce champ reste modifiable, soit en saisissant directement le code d'un autre journal dans le champ, soit en le sélectionnant dans la liste déroulante. Le journal par défaut défini dans ce champ sera repris dans la fenêtre de paramétrage des Charges et Produits constatés d'avance, aussi bien au niveau de l'écriture de régularisation que de l'écriture d'extourne. Compte de contrepartie Charges constatées d'avance : Un compte est proposé par défaut. Ce compte correspond au compte disponible dans le Plan Comptable Général pour ce type d'opération. Ce champ reste modifiable, soit en saisissant directement le nouveau numéro de compte dans le champ, soit en le sélectionnant dans la liste déroulante. Le compte par défaut défini dans ce champ sera repris dans la fenêtre de paramétrage des Charges et Produits constatés d'avance au niveau de l'écriture de régularisation. Comptes de contrepartie Produits constatés d'avance : Un compte est proposé par défaut. Ce compte correspond au compte disponible dans le Plan Comptable Général pour ce type d'opération. Ce champ reste modifiable, soit en saisissant directement le nouveau numéro de compte dans le champ, soit en le sélectionnant dans la liste déroulante. Le compte par défaut défini dans ce champ sera repris dans la fenêtre de paramétrage des Charges et Produits constatés d'avance au niveau de l'écriture de régularisation. Factures non parvenues ou à émettre Journal : Un journal de destination est proposé par défaut. Il correspond au premier journal de type Opérations Diverses disponible. Ce champ reste modifiable, soit en saisissant directement le code d'un autre journal dans le champ, soit en le sélectionnant dans la liste déroulante. Le journal par défaut défini dans ce champ sera repris dans la fenêtre de paramétrage des Factures non parvenues ou à émettre au niveau de l'écriture d'extourne. Fiche compte Accès : Paramètres - Société - Options comptables - Fiche compte Les valeurs par défaut permettent de déterminer certaines valeurs qui seront appliquées à toutes les fiches de comptes lors de leur création. Les valeurs par défaut sont modifiables à tout moment et sont sans incidence sur les comptes déjà créés. Si ces valeurs ne conviennent pas pour un nouveau compte à créer ou pour un compte déjà existant, il est possible de modifier ces valeurs directement dans la fiche du compte concerné. Rapprochement bancaire Une liste déroulante permet de sélectionner l’un des trois types de rapprochement qui sera renseigné par défaut dans tous les nouveaux comptes de nature Comptes pour rapprochement Aucun : aucun rapprochement n'est possible pour ces comptes. Par journal : le type de rapprochement par journal est possible pour ces comptes. 160 MANUEL Par compte : le type de rapprochement par compte est possible pour ces comptes. Echéancier Une liste déroulante permet de sélectionner l'un des trois modes de gestion des échéances qui sera renseigné par défaut dans tous les nouveaux comptes de nature Clients et Comptes rattachés, de nature Fournisseurs et Comptes rattachés ou encore de nature Autres Tiers avec Echéance. Aucun : Aucun échéancier n'est disponible sur ces comptes. Echéancier : Les échéanciers (Echéancier de la facture et Pointage) peuvent apparaître à la demande. Echéancier automatique en saisie : L'échéancier de la facture apparait systématiquement lors de la saisie de ces comptes. Lettrage Une liste déroulante permet de sélectionner l’un des trois types de lettrage qui sera renseigné par défaut dans tous les nouveaux comptes de nature Comptes de Bilan. Aucun : aucun lettrage n'est possible sur ces comptes. Lettrage : le lettrage est possible pour ces comptes entre plusieurs lignes d'écriture dont le montant s’équilibre au centime près. Lettrage approché : le lettrage sera possible pour ces comptes entre plusieurs lignes d'écriture dont le montant ne s’équilibre pas. Lettrage approché Accès : Paramètres - Société - Options comptables - Lettrage approché Ces valeurs par défaut sont reprises lors de l'activation du lettrage approché sur une fiche compte. Si des lignes d'écritures doivent être lettrées alors qu'elles ne sont pas équilibrées, alors le logiciel créera automatiquement une écriture d'équilibrage, selon les paramètres définis dans la zone : Ecart maximum : La valeur saisie doit être un montant positif avec décimales. Elle fixe le plafond de l'écart maximal autorisé entre plusieurs lignes d'écritures. Compte de régularisation au débit : Une liste déroulante affiche tous les comptes de nature Charges. Elle permet de choisir le compte à utiliser pour comptabiliser l'écart s'il est débiteur. Compte de régularisation au crédit : Une liste déroulante affiche tous les comptes de nature Produits. Elle permet de choisir le compte à utiliser pour comptabiliser l'écart s'il est créditeur. Journal de régularisation : Une liste déroulante affiche tous les journaux existants sur le dossier. Elle permet de choisir le journal de destination de l'écriture d'équilibrage. A Nouveaux Accès : Paramètres - Société - Options comptables - A Nouveaux La zone "A Nouveaux" permet de définir le paramétrage de comptabilisation du résultat des exercices. Certaines de ces informations seront reprises dans l'assistant de clôture annuelle. Type d'A Nouveaux : - Avec détails : Toutes les lignes d'écritures à reporter sur l'exercice suivant seront détaillées. La lecture des comptes peut donc en être facilitée. - Sans détails : toutes les lignes d'écritures appartenant à un même compte et qui doivent être reportées sur l'exercice suivant seront cumulées entre elles : une seule ligne apparaîtra donc dans chaque compte concerné. L'option choisie s'applique par défaut à tous les comptes de nature Bilan de l'exercice courant. Néanmoins, un choix différent peut être effectué sur chaque fiche compte. Mode de génération : - A la création d'un exercice : Lors de la création de l'exercice suivant, alors les A Nouveaux de l'exercice courant seront automatiquement reportés sur ce nouvel exercice. 161 EBP Comptabilité Open Line Pro - A la clôture d'un exercice : Lors de la clôture de l'exercice courant, les A Nouveaux de cet exercice seront automatiquement reportés sur l'exercice suivant. Mode de mise à jour : - Automatique au changement d'exercice courant : Si les A Nouveaux ont déjà été générés une première fois sur l'exercice suivant, alors leur mise à jour sera effectuée en temps réel à chaque changement d'exercice courant. - Manuelle : Les A Nouveaux ne seront pas mis à jour automatiquement. Pour les mettre à jour, il faut activer l'option Générer les A Nouveaux dans le menu Exercices/Clôtures. Compte de bénéfice / Compte de perte : Ces champs permettent de sélectionner dans une liste déroulante les comptes sur lesquels le résultat de l'exercice courant sera imputé. - Bénéfice : Seuls les comptes de nature "Résultat, bénéfice" sont autorisés. - Perte : Seuls les comptes de nature "Résultat, perte" sont autorisés. Situations de comptes - clients Accès : Paramètres - Société - Options comptables - Situations de comptes Clients Trois zones de texte sont disponibles. Des textes sont livrés par défaut. Ils sont modifiables et sont utilisés pour l'impression des situations de comptes. Ils concernent uniquement les comptes Clients. Situations de comptes - fournisseurs Accès : Paramètres - Société - Options comptables - Situations de comptes Fournisseurs Trois zones de texte sont disponibles. Des textes sont livrés par défaut. Ils sont modifiables et sont utilisés pour l'impression des situations de comptes. Ils concernent les comptes Fournisseurs et les Autres Tiers. GÉNÉRAL Environnement de saisie Accès : Paramètres - Société - Général Ces options permettent de définir les règles d'affichage du fond des grilles de saisie par journal et de saisie par écriture. Afficher la grille horizontale : permet d'afficher ou non un tracé horizontal sur les grilles de saisie. Afficher la grille verticale : permet d'afficher ou non un tracé vertical sur les grilles de saisie. Encadrer l'écriture courante : permet d'afficher ou non un encadré autour de l'écriture sur laquelle vous êtes positionné. Couleur de fond : permet de sélectionner la couleur de fond des grilles de saisie. Couleur des écritures déséquilibrées : permet de sélectionner la couleur à appliquer sur une écriture qui est déséquilibrée. Remettre l'environnement par défaut : permet de restituer l'environnement de saisie défini par défaut. Options - Général Police par défaut Les champs ci-dessous permettent de définir la police appliquée par défaut dans les champs de type texte (description commerciale de la fiche article, description dans les documents, onglet note...) : Police par défaut Taille par défaut 162 MANUEL UTILISATEURS Les Utilisateurs Accès : Paramètres - Utilisateurs - Utilisateurs Vous pouvez créer des utilisateurs, attacher ou non un groupe à chacun et définir une gestion de droits pour chaque utilisateur. Ainsi lors de l'ouverture du dossier, vous vous connecterez avec un nom d'utilisateur et son mot de passe. L'utilisateur connecté apparaît dans la barre d'état (statut). Un clic sur cet utilisateur permet de changer d'utilisateur. Création d'un utilisateur Pour définir un utilisateur, vous avez accès aux zones suivantes : Code * Saisissez un identifiant unique pour votre utilisateur. Ce code est limité à 10 caractères alphanumériques (A à Z et 0 à 9). Nom * Saisissez le nom de l'utilisateur (au maximum 100 caractères alphanumériques). Mot de passe Saisissez un mot de passe pour ouvrir le dossier avec cet utilisateur. Il sera demandé à chaque ouverture du logiciel. Confirmation Retapez le même mot de passe pour confirmation. Bloqué Si cette case est cochée, cet utilisateur ne pourra plus se connecter à la base que ce soit en Gestion Commerciale ou en Comptabilité. Cette sélection est reportée dans les bases des applications de Gestion commerciale et de Comptabilité. Connexion interdite dans cette application Si cette case est cochée, l'utilisateur ne pourra pas se connecter à l'application dans laquelle la case est cochée. Si la case est cochée sur la fiche utilisateur en Gestion, l'utilisateur pourra se connecter à la Comptabilité mais pas à la Gestion. Un message avertira l'utilisateur de ce fait. Groupes associés Cette partie vous permet de gérer les groupes d'utilisateurs rattachés à cet utilisateur à l'aide des boutons : o Ajouter : Cliquez sur ce bouton pour ajouter en fin de liste une nouvelle ligne Groupe utilisateurs. o Insérer : Cliquez sur ce bouton pour insérer une nouvelle ligne Groupe utilisateurs au dessus de celle sélectionnée. o Supprimer : Cliquez sur ce bouton pour effacer une ligne Groupe utilisateurs. o Vues : Cliquez sur ce bouton afin de personnaliser l'affichage de la grille. Saisissez le nom de la nouvelle vue puis sélectionner les colonnes que vous souhaitez, la position et la taille de chacune de celles-ci. Vous disposez également des fonctions : o Monter/Descendre : Ces boutons permettent de modifier la position des lignes. o Couper/Copier/Coller : Ces boutons permettent de modifier des données par un couper ou copier et un coller. L'utilisateur ADM ne peut être affecté à un groupe, car il a tous les droits par défaut. Si vous sélectionnez un groupe, les droits de l'utilisateur correspondront par défaut à ceux du groupe. Vous pouvez les modifier en sélectionnant ou en dé-sélectionnant les autorisations. Gestion des droits Cette partie permet de définir la gestion des droits par utilisateur. A la création d'une fiche, tous les droits sont autorisés par défaut. 163 EBP Comptabilité Open Line Pro La colonne Libellé contient les différents menus pour lesquels vous pouvez définir les droits. Vous pouvez visualiser les sous-menus, en cliquant sur le petit + qui apparaît devant chaque menu. La colonne Tous permet d'autoriser automatiquement "Tous les droits" au menu sélectionné. En fonction des droits autorisés, le marquage de la case à cocher est différentes : Tous les droits pour ce menu et ses sous-menus sont autorisés. Aucun droit ne sont autorisés pour ce menu et ses sous-menus. Une partie des droits est autorisé pour ce menu ou un/des sous-menus. La partie Autorisation permet de personnaliser les droits de chaque menu. La partie Autorisations héritées permet de visualiser les droits de chaque menu provenant du/des groupe/s associé/s à cet utilisateur. Vous pouvez cocher/ dé-cocher les autorisations que vous souhaitez accorder à l'utilisateur affiché. Dès changement d'une autorisation sur un droit, l'autorisation héritée sera automatiquement désélectionnée. Cliquez ici pour visualiser différents types de droits et exemples d'application des droits. Les Groupes d'utilisateurs Accès : Paramètres - Utilisateurs - Groupes d'utilisateurs Vous pouvez créer des groupes d'utilisateurs, définir une gestion de droits par groupe d'utilisateurs, et attacher ensuite un utilisateur à un groupe. Les droits que vous définissez pour un groupe d'utilisateurs prévalent sur les droits définis pour un utilisateur. Les groupes d'utilisateurs permettent de faciliter la saisie de la gestion des droits. On pourrait imaginer qu'un groupe corresponde à un service dans l'entreprise, qui a tels ou tels droits... La gestion de la fiche "Groupe d'utilisateurs" est communes à toutes les fiches. Création d'un groupe En en-tête de la fiche groupe, vous devez saisir les informations suivantes : Code * Saisissez un identifiant unique pour votre groupe d'utilisateurs. Ce code est limité à 10 caractères alphanumériques (A à Z et 0 à 9). Nom * Saisissez le nom du groupe (au maximum 100 caractères alphanumériques). Nom d'un service de votre société Utilisateurs associés Cette partie vous permet de gérer les utilisateurs rattachés à ce groupe à l'aide des boutons : o Ajouter : Cliquez sur ce bouton pour ajouter en fin de liste une nouvelle ligne utilisateur. o Insérer : Cliquez sur ce bouton pour insérer une nouvelle ligne utilisateur au dessus de celle sélectionnée. o Supprimer : Cliquez sur ce bouton pour effacer une ligne utilisateur. o Vues : Cliquez sur ce bouton afin de personnaliser l'affichage de la grille. Saisissez le nom de la nouvelle vue puis sélectionner les colonnes que vous souhaitez, la position et la taille de chacune de celles-ci. Vous disposez également des fonctions : o Monter/Descendre : Ces boutons permettent de modifier la position des lignes. o Couper/Copier/Coller : Ces boutons permettent de modifier des données par un couper ou copier et un coller. L'utilisateur ADM ne peut être affecté à un groupe, car il a tous les droits par défaut. Gestion des droits Cette partie permet de définir les droits pour ce groupe. 164 MANUEL A la création d'une fiche, les droits sont tous autorisés par défaut. La colonne Libellé contient les différents menus pour lesquels vous pouvez définir les droits. Vous pouvez visualiser les sous-menus, en cliquant sur le petit + qui apparaît devant chaque menu. La colonne Tous permet d'autoriser automatiquement "Tous les droits" au menu sélectionné. En fonction des droits autorisés, le marquage de la case à cocher est différente : Tous les droits pour ce menu et ses sous-menus sont autorisés. Aucun droit ne sont autorisés pour ce menu et ses sous-menus. Une partie des droits est autorisé pour ce menu ou un/des sous-menus. La partie Autorisation permet de personnaliser les droits de chaque menu. Cliquez ici pour visualiser différents types de droits et exemples d'application des droits. Les Droits utilisateurs Accès : Paramètres - Utilisateurs - Groupes d'utilisateurs ou Paramètres - Utilisateurs - Utilisateurs Les droits utilisateurs peuvent être affectés à un groupe d'utilisateurs ou un utilisateur particulier. Des droits peuvent être autorisés sur les menus principaux de chaque module. Types de droits Il existe 3 types de droit : Visualisation et Modification Si le droit de modifier est sélectionné, la visualisation est automatiquement cochée. Il est possible d'autoriser uniquement la visualisation. Ces droits concernent les fonctions : Général / Options Exécution Ce droit est présent essentiellement pour les assistants. Sauvegarde, Maintenance, Editions des modèles d’impression... Création, Visualisation, Modification, Suppression, Impression Pour ces droits, si on autorise : o la création, la visualisation est automatiquement cochée. o la création, la visualisation est automatiquement cochée. o la modification, la visualisation est automatiquement cochée. o la suppression, la visualisation est automatiquement cochée. o l’impression, la visualisation est automatiquement cochée. La "duplication d’une fiche" est concernée par le droit "Création". Le droit "impression" concerne l’impression de la liste/fiche à partir de la liste-page. Application des droits Quelques exemples d'application des droits : Gestion commerciale 1. Visualisation d'un type de document non autorisée. Dans l'onglet "Tous" de la liste des documents de ventes, ce type de document ne sera pas visible. 2. Création d'un document de type X non autorisée. Regroupement ou Transfert d'un document vers ce type de document, message d'information "Le regroupement est impossible car la création d’un document de "type X" n’est pas autorisé". Le document d'origine reste dans l'état initial. 3. Visualisation des clients non autorisée. Liste des documents de ventes, sélection d'une ligne et clic droit "Afficher le client". Message d'information : "L'utilisateur actuellement connecté n'a pas le droit suivant : Clients (Visualisation).". 165 EBP Comptabilité Open Line Pro 4. Réalisation d'une sauvegarde non autorisée. Appel de l'assistant de sauvegarde, message d'information : "L'utilisateur actuellement connecté n'a pas le droit suivant : Sauvegarde (Exécution).". Pour certaine fonction, si vous n'autorisez pas les droits le nombre d'onglets dans les fiches associées peut changer. Par exemple, pas de droit sur les tarifs, la fonction "Tarifs" ne sera pas accessible. De plus l'onglet "Tarifs" ne sera pas visible dans les fiches Articles, Clients, Catégories tarifaires... Comptabilité 1. Création d'une rapprochement bancaire. La création d'un nouveau rapprochement est impossible. Message d'information "L'utilisateur actuellement connecté n'a pas le droit suivant : Rapprochement bancaire (Création)". 2. Suppression des modèles de libellés. La suppression d'un modèle de libellé est impossible. Message d'information "L'utilisateur actuellement connecté n'a pas le droit suivant : modèle de libellé (Suppression)". 3. Autorisation de consultation/lettrage/lettrage automatique. L'utilisateur n'est pas autorisé à consulter les comptes, à les lettrer ou à procéder à des lettrages automatiques. Message d'information "L'utilisateur actuellement connecté n'a pas le droit suivant : Consultation/Lettrage/Lettrage automatique (autorisation)". Impression - Fenêtre principale de navigation La fenêtre principale de navigation de l'impression est divisée en 3 zones : Catégorie des modèles, Modèles d'impression disponibles, Image de l'aperçu du modèle sélectionné. Catégories Les catégories permettent de classer les modèles en fonction des types de documents et des données de bases, des éléments financiers... Le logiciel est livré avec un classement par défaut, présent dans l'onglet Catégorie. Dans la partie catégorie, vous pouvez avoir : Catégorie principale : Etats standards Sous catégorie : Journal Sous catégorie : Grand Livre Sous catégorie : Balance .... Catégorie principale : Etats de gestion Sous catégorie : Echéancier Sous catégorie : Balance âgée par échéances Sous catégorie : Balance âgée par Lettrage Catégorie principale : Etats fiscaux... Pour voir un modèle, il faut impérativement se situer dans la catégorie ou la sous-catégorie à laquelle il appartient. Vous avez la possibilité de personnaliser ces catégories en créant des mots-clés. Modèles disponibles Cette partie contient la liste des modèles proposés pour chaque catégorie. Ces modèles peuvent être modifiés avec l'éditeur de modèles à l'aide du bouton "Modifier le modèle". A partir d'un modèle, dans la barre d'outils ou par le menu contextuel/clic droit, vous pouvez : imprimer le modèle (ouverture de la page de filtres et aperçus), affecter un mot clé, définir le modèle à utiliser par défaut pour les fiches, définir le modèle à utiliser par défaut pour les listes. Pour passer un modèle en modèle par défaut, vous devez sélectionner un modèle, puis cliquer dans la barre d'outils Modèle par défaut ou clic droit sur le modèle puis Modèle par défaut. 166 MANUEL Image de l'aperçu du modèle Cette partie permet de visualiser le modèle que vous avez sélectionné. Cette visualisation est une image, elle ne contient pas les informations concernant votre dossier. Filtres et aperçu de l'édition En double-cliquant sur le modèle, vous accédez à la fenêtre de sélection des filtres et visualisation de l'aperçu. OUTILS Sauvegarde rapide Accès : Outils - Sauvegarde rapide La sauvegarde rapide est possible uniquement si une première sauvegarde classique a été réalisée. La sauvegarde rapide permet de sauvegarder le dossier avec les informations paramétrées dans la sauvegarde "classique" effectuée précédemment. Une seule étape "résumé des éléments" est affichée. Cliquez sur Lancer pour exécuter la sauvegarde rapide. Sauvegarde Accès : Outils - Sauvegarde La sauvegarde passe par un assistant. Entre chaque étape, utilisez les boutons Suivant et Précédent pour respectivement avancer et reculer dans l'assistant de sauvegarde des données. Bienvenue... ...dans l'assistant de sauvegarde des données. Cet écran vous indique, en autre, l'importance de la réalisation régulière d'une sauvegarde. Cliquez sur le bouton Suivant, pour poursuivre le paramétrage de la sauvegarde. Choix des informations à inclure dans la sauvegarde Par défaut, l'option Inclure la configuration et l'environnement n'est pas cochée. Si vous avez défini un affichage spécifique sur votre poste de travail, la sauvegarde des informations de configuration est nécessaire. Pour information, la sauvegarde des modèles s'effectue en même temps que la sauvegarde du dossier. L'option Sauvegarder en fichier texte (à restaurer avec un autre moteur de base de données) permet de réaliser une sauvegarde de la base dans un fichier zip contenant des fichiers CSV. Cliquez le bouton Suivant pour accéder à l'écran suivant de l'assistant de sauvegarde. Informations nécessaires à la sauvegarde Sur le serveur SQL, un répertoire doit être créé et partagé pour la sauvegarde. Ce répertoire doit être saisi dans la zone intitulée "Chemin réseau du dossier partagé sur le serveur". Sur le serveur, j'ai créé à partir du disque C, un répertoire Sauvegarde. Le chemin qui apparaît dans le "Chemin réseau partagé" correspond à \\NOMSERVEURSQL\Sauvegarde. Dans le "chemin local correspondant sur le serveur", il faut saisir : C:\Sauvegarde. Cliquez le bouton Suivant pour accéder à l'écran suivant de l'assistant de sauvegarde. Choix de la destination de la sauvegarde Sélectionnez le chemin du dossier de sauvegarde que vous souhaitez. 167 EBP Comptabilité Open Line Pro Nous vous conseillons d'effectuer régulièrement des sauvegardes sur un support externe. Si votre disque dur ou votre matériel est défectueux, vous aurez toujours possibilité de récupérer vos données sur un autre ordinateur. Sauvegarde en ligne Cochez cette option si vous souhaitez effectuer une sauvegarde en ligne. Cette option nécessite de souscrire un contrat particulier auprès de notre service commercial ou de votre revendeur. Elle permet de stocker les sauvegardes sur un serveur accessible par Internet et situé en dehors de vos locaux. Elle vous permet également d'échanger vos dossiers avec un partenaire comme votre expert comptable. Mot de passe Suite à la sélection de la case, vous devez indiquer le mot de passe pour pouvoir partager la sauvegarde avec un partenaire. Commentaire Le renseignement de ce champ est facultatif. Il permet de saisir un texte décrivant la sauvegarde. Envoi d'une sauvegarde à un partenaire Pour envoyer une sauvegarde à un partenaire, vous devez saisir un mot de passe partenaire dans l'assistant de sauvegarde. Pour récupérer une sauvegarde, le partenaire doit s'identifier sur le site EBP (pas d'obligation d'avoir une licence). Sur la page de Gestion des sauvegardes en ligne, le partenaire clique sur Vous souhaitez accéder à une sauvegarde en ligne en tant que partenaire ? et saisit la licence et la clé web puis son mot de passe partenaire. Résumé des paramètres Cette étape vous permet d'avoir un résumé des éléments que vous avez saisis précédemment. Cliquez sur Lancer pour exécuter la sauvegarde. Restauration Accès : Outils - Restauration La restauration de dossier passe par un assistant. Entre chaque étape, utilisez les boutons Suivant et Précédent pour respectivement avancer et reculer dans l'assistant de restauration des données. Bienvenue... ...dans l'assistant de restauration des données. Cette opération est à effectuer uniquement en cas de nécessité absolue. Le contenu de la sauvegarde va remplacer et écraser toutes vos données. Il est recommandé d'effectuer une sauvegarde du dossier avant de réaliser une restauration de celui-ci. Pour cela, cliquez sur le bouton Sauvegarder mon dossier maintenant. L'assistant de sauvegarde du dossier s'ouvre alors automatiquement. Suite à la réalisation de la sauvegarde, cliquez sur Suivant pour passer à l'étape suivante. Sélection de la sauvegarde à restaurer Cet écran permet de sélectionner le chemin du Fichier de sauvegarde du dossier que vous souhaitez restaurer. Aidez-vous de l'icône "..." pour sélectionner le fichier à restaurer. Cliquer sur Suivant pour passer à l'étape suivante. Choix des informations à inclure dans la restauration Sélectionnez les éléments que vous souhaitez restaurer (dossier ou informations de configuration). Cliquez sur le bouton Suivant pour accéder à l'écran suivant de l'assistant de restauration. Choix du type d'installation 168 MANUEL Sélectionnez le type d'installation (les données sont installées sur l'ordinateur ou elles sont sur un autre ordinateur). En fonction du type d'installation sélectionné, vous aurez des étapes différentes : - Pour la restauration avec les données sur un autre ordinateur, l'étape suivante consiste à : Saisir le nom du serveur, La case à cocher "Afficher les options de connexions avancées" permet de : Sélectionner le protocole, Saisir l'authentification de l'utilisateur. La suite de la restauration du dossier est identique à celle "les données sont sur l'ordinateur". - Pour la restauration avec les données installées sur l'ordinateur, vous devez ensuite choisir la destination de la restauration (voir paragraphe suivant) : La case à cocher "Spécifier les emplacement des fichiers de données qui seront restaurés" permet dans les étapes suivantes de définir l'emplacement de la base à restaurer. Cliquez sur Suivant pour passer à l'étape suivante. Choix de la destination de la restauration Sélectionnez le chemin du dossier ou vous souhaitez restaurer les données. Nom du dossier Cette zone permet de charger le nom de la base. Pour cela, décochez la case "utiliser le nom du dossier d'origine". Vous pouvez ainsi restaurer une base sous un autre nom. Elle correspond à une copie de la base d'origine. Cliquez sur Suivant pour passer à l'étape suivante. Résumé des paramètres Cette étape vous permet d'avoir un résumé des éléments que vous avez saisis précédemment. Cliquez sur Lancer pour exécuter la restauration des données. Historique de sauvegarde Accès : Outils - Historique de sauvegarde L'historique de sauvegarde stocke chaque information concernant : - la date de la sauvegarde, - le code de l'utilisateur qui a réalisé la sauvegarde, - le nom de l'ordinateur (poste), - la destination : l'emplacement du fichier ZIP qui contient la sauvegarde. Sauvegarde en ligne EBP Sauvegarde en ligne est un service supplémentaire vous permettant de réaliser vos sauvegardes sur Internet. Il vous offre une façon simple et sécurisée de réaliser des sauvegardes externes à l'entreprise. EBP sauvegarde est un service payant. La sauvegarde en ligne consiste à récupérer une sauvegarde normale et à l’envoyer sur un serveur. L’utilisateur se connecte ensuite sur le site EBP (ou sur http://sauvegarde.ebp.com) et dans son espace client, il télécharge ses sauvegardes s'il a besoin de faire une restauration. La sauvegarde en ligne se découpe en trois parties: les options, la sauvegarde et l’administration. o Par le menu Outils / Options / Services Internet, configurez votre sauvegarde en ligne. o Ensuite, lancez l'assistant de sauvegarde et sélectionnez Sauvegarde en ligne comme destination à la place de votre disque local. o Par le menu Outils / Administrer les sauvegardes en lignes, administrez les sauvegardes en ligne que vous avez ou allez réaliser. Cet accès est un lien vers le site http://Sauvegarde.ebp.com 169 EBP Comptabilité Open Line Pro Pour effectuer une sauvegarde en ligne, certaines informations sont obligatoires : Mot de passe, Application activée, Numéro de licence, Code d’activation, Clé web. Export du schéma de la base de données Accès : Outils - Exporter le schéma de l'application L'export du schéma de l'application passe par un assistant. Cet assistant permet de réaliser l'export de la liste de toutes les tables et champs de l'application. Entre chaque étape, utilisez les boutons Suivant et Précédent pour respectivement avancer et reculer dans l'assistant d'export du schéma de la base de données. Bienvenue... ... dans l'assistant d'export du/des schémas(s) de base(s) de données. Cet écran indique, entre autres, la structure du nom du fichier sauvegardé. Cliquer sur le bouton Suivant pour poursuivre l'export. Sélection des paramètres d'export du schéma Cet écran permet de : - définir le chemin du fichier généré, - le mode d'export. Deux modes d'export sont disponibles : - Simple : Le fichier contient les tables avec pour chacune le nom des champs, la traduction du champ, le type de données, la taille et si une valeur nulle est autorisée. La liste des tables associées est également présente. - Détaillé : Le fichier contient les tables avec pour chacune les options de la table et un descriptif détaillé des champs (exemple : champ système ou pas). La liste des tables associées est également présente. Le fichier généré sera au format XML. Une fois les paramètres définis, cliquez sur le bouton Suivant. Résumé des paramètres Cette étape vous permet d'avoir un résumé des éléments que vous avez saisis précédemment. Cliquez sur Lancer pour exécuter le traitement. Opération terminée Cet écran contient la liste des fichiers générés avec leurs emplacements. Cliquez sur Fermer pour terminer le traitement. Communication Entreprise-Expert Accès : Outils - Communication Entreprise-Expert Ce outil permet de : - Recevoir des données, c'est-à-dire de réaliser des importations d'écritures d'autres logiciels dans le logiciel EBP. - Transmettre des données, c'est-à-dire de réaliser des exportations d'écritures du logiciel EBP vers d'autres logiciels. Recevoir des données Création automatique des comptes La case "Création automatique des comptes" doit être cochée pour que tous les comptes inexistants soient créés automatiquement avec l'intitulé "Compte créé pendant le transfert". Ces libellés seront modifiables par la suite dans le plan comptable. 170 MANUEL Si la case n'est pas cochée, alors à chaque nouveau compte, une fiche de création de compte s'ouvrira afin de renseigner les paramètres. Création automatique des journaux La case "Création automatique des journaux" doit être cochée pour que tous les journaux inexistants soient créés automatiquement avec le libellé "Journal créé pendant le transfert". Ces libellés seront modifiables par la suite dans le plan de journaux. Si la case n'est pas cochée, alors à chaque nouveau journal, une fiche de création de journal s'ouvrira afin de renseigner les paramètres. Transmettre des données La case Exporter tout le dossier doit être cochée pour que la totalité des écritures comptables soit exportée. Sinon, les critères d'export peuvent être définis en indiquant la période et la fourchette de journaux à prendre en compte. Exporter les liasses fiscales Accès : Outils - Exporter les liasses fiscales Cet outil permet d'éditer les liasses fiscales du dossier et de l'exercice en cours. Pour cela, il faut exporter le fichier au format "Liasses Fiscales". Fichier d'export : Un chemin et un nom de fichier sont proposés par défaut. Ils identifient le fichier qui sera généré par l'export. Ils peuvent être modifiés en cas de besoin, tout en conservant l'extension du fichier ".bal" Période d'export : Les dates de l'exercice courant sont proposées par défaut. Elles sont modifiables, à condition d'être toujours comprises dans cet exercice. Exporter : Ce bouton permet d'exporter la balance dans le fichier référencé plus haut. Ce fichier devra ensuite être importé dans un logiciel de Liasses Fiscales EBP. Assistant de maintenance des données Accès : Outils - Maintenance de données Entre chaque étape de l'assistant, utilisez les boutons Suivant et Précédent pour respectivement avancer et reculer dans l'assistant de maintenance des données. Bienvenue... Avant tout traitement de maintenance, nous vous conseillons d'effectuer une sauvegarde de vos données en cliquant sur le bouton "Sauvegarder mon dossier maintenant !" Une fois la sauvegarde effectuée, cliquez sur le bouton Suivant. Choix du dossier Sélectionnez le dossier à maintenir à l'aide de l'icône "..." puis cliquez sur le bouton Suivant. Opérations de maintenance à effectuer Cochez les différentes opérations que vous souhaitez effectuer sur votre dossier. Base de données Permet de vérifier/réparer votre base en cas de problèmes et de l'optimiser en cas de lenteur inhabituelle (défragmenter les index, compacter). Verrous Permet de supprimer les verrous, notamment si vous avez quitté anormalement le logiciel et que vous n'arrivez plus à accéder à votre dossier (message : utilisateur déjà connecté..). Utilisateurs Permet de supprimer les connections de tous les utilisateurs. Recalculer Permet de recalculer tous les compteurs par exemple par rapport aux documents de vente saisis. 171 EBP Comptabilité Open Line Pro Configuration Permet de supprimer toutes les vues personnalisées (vues non système des listes et grilles) ainsi que la position des fenêtres. Base de démonstration L'opération Réinitialiser la base de démonstration est disponible uniquement si vous demandez une maintenance sur la base de démonstration. Permet de mettre à jour le dossier de démonstration avec les données initiales. Cette opération est équivalente à une restauration du dossier de démonstration. Cette opération peut être longue. Cumuls Permet de recalculer tous les soldes de comptes, les totaux des journaux... existants sur le dossier. Ecritures comptables Permet de trier, par date et par pièce, les écritures comptables présentes sur tous les exercices ouverts et tous les mois non clôturés. Numéros de compte comptable Il se peut que votre plan comptable contienne un même compte sous deux formes : avec des zéros non significatifs (par exemple, compte 626000) et sans zéro non significatif (par exemple, compte 626). Cette situation peut générer des conflits. Cette opération de maintenance résout les conflits de la manière suivante : Le compte 626 existe sans être mouvementé et le compte 626000 existe avec des mouvements, alors : - les lignes d'écritures et les lignes d'échéance sont transférées du compte 626000 vers le compte 626 ; - le compte 626000 est supprimé. Le compte 626 n'existe pas et le compte 626000 existe avec des mouvements, alors : - le compte 626 est créé ; - les lignes d'écritures et les lignes d'échéance sont transférées du compte 626000 vers le compte 626 ; - le compte 626000 est supprimé. Le compte 626 existe avec des mouvements et le compte 626000 existe avec des mouvements, alors : - le compte 626 est conservé en l'état ; - un compte 6261 est créé ; - les lignes d'écritures et les lignes d'échéance sont transférées du 626000 sur le compte 6261 - le compte 626000 est supprimé. Dans tous les cas, les modifications effectuées sur le plan comptable sont automatiquement reportées dans toutes les saisies, dans les options... Les lettrages, pointages et rapprochements sont conservés. Certaines options de la fiche du compte d'origine (compte 626000) ne sont pas recopiées dans la fiche du compte de destination (compte 626). Une fois les opérations sélectionnées, vous devez cliquer sur Suivant. Résumé des paramètres Cette étape vous permet d'avoir un résumé des opérations que vous avez sélectionnées précédemment. Cliquez sur Lancer pour exécuter le traitement. Traitement de la maintenance En fin de traitement, la liste des opérations effectuées est affichée. Dans le cas où la maintenance a échoué, un message contenant les raisons de l'échec est affiché. Il est possible de visualiser le rapport en cliquant sur le bouton Afficher le détail. Outil de requêtage Accès : Outils - Outil de requêtage Cet outil permet de réaliser une visualisation des données d’une table. Vous avez la possibilité de créer une nouvelle requête depuis un assistant ou saisir directement les instructions dans la zone Requête. 172 MANUEL Seule la commande SELECT… est acceptée. Suite à la saisie d’une requête, cliquer sur le bouton Exécuter pour visualiser le résultat. Il vous est possible de sauvegarder la requête ou de l’exporter. A la prochaine utilisation de l’outil, vous pouvez appeler la requête ou importer une autre requête. Pour vous aider dans la recherche des tables et champs, vous disposez de l’assistant Export de schéma de la base présent dans le menu Outils. Supprimer un dossier Accès : Outils - Supprimer Pour supprimer un dossier, il vous suffit de suivre les différentes étapes proposées par l'assistant. Entre chaque étape, utilisez les boutons Suivant et Précédent pour respectivement avancer et reculer dans l'assistant de suppression d'un dossier. Bienvenue... ...dans l'assistant suppression de dossier Avant toute suppression de dossier, nous vous recommandons de réaliser une sauvegarde du dossier par l'intermédiaire du bouton "Sauvegarder mon dossier maintenant". Cliquez sur le bouton Suivant, pour poursuivre le paramétrage. Choix du raccourci vers le dossier à supprimer Cette étape consiste à sélectionner le raccourci du dossier à supprimer. Par défaut, le dossier ouvert est sélectionné. Pour sélectionner le dossier à supprimer, vous devez cliquer sur l'icône "...", puis sélectionner le fichier raccourci (extension du fichier eha). Cliquez sur le bouton Suivant, pour poursuivre. Résumé des paramètres Cette étape vous permet d'avoir un résumé des éléments que vous avez saisis précédemment. Cliquez sur Lancer pour exécuter la suppression du dossier. Maintenance sur les journaux Accès : Outils - Maintenance sur les journaux Si une clôture mensuelle a été effectuée à tort sur l'exercice courant, il est possible d'en demander la déclôture. la déclôture mensuelle ne peut être demandée que si l'exercice courant n'a pas encore fait l'objet d'une clôture annuelle. Choisissez le journal à déclôturer : Ce champ permet, grâce à une liste déroulante, de sélectionner un seul journal sur tous les journaux existants sur l'exercice courant. Déclôturer à partir du mois de : ce champ permet de sélectionner le premier mois de l'exercice courant qu'il faut déclôturer. Exercice courant du 01/01/2008 au 31/12/2008, non encore clôturé annuellement. Tous les journaux et tous les mois de cet exercice ont été clôturés mensuellement. Si vous sélectionner le journal ACHATS et la déclôture à partir du mois de SEPTEMBRE 2008, alors les mois de septembre, octobre, novembre et décembre 2008 du journal d'achats seront déclôturés. Veuillez saisir la raison ... : Ce champs doit obligatoirement être renseigné pour que la déclôture demandée soit exécutée. 173 EBP Comptabilité Open Line Pro La déclôture mensuelle et le motif saisi dans le champ de justification seront portés dans le journal des événements. Purger le plan comptable Accès : Outils – Purger le plan comptable Cette option vous permet de supprimer plusieurs comptes en une seule manipulation. Seuls les comptes non mouvementés pourront être supprimés. Etape 1 Choisissez l’exercice non clôturé de votre choix. Si besoin, choisissez une nature de comptes ou une fourchette de comptes précise (par défaut, tous les comptes non mouvementés seront proposés). Etape 2 La liste des comptes non mouvementés correspondant aux critères de l’étape précédente s’affiche. Cochez les comptes à supprimer, ou cochez l’option Sélectionner tout. Lancez l’opération. Purger les relevés bancaires Accès : Outils – Purger les relevés bancaires [sous réserve] Cette option vous permet de supprimer plusieurs relevés bancaires en une seule manipulation. Seuls les relevés entièrement pointés par l’option de rapprochement automatique pourront être supprimés. Bien entendu, cela n’impactera en rien les rapprochements bancaires déjà effectués : les lignes d’écriture pointées ne seront pas dépointées. - La liste des relevés bancaires entièrement pointés s’affiche. Cochez les relevés à supprimer, ou cochez l’option Sélectionner tout. - Lancez l’opération. Vous pouvez supprimer un relevé bancaire dont les lignes n’ont pas été pointées directement à partir de la liste des relevés. Editeur de modèles Accès : Outils - Editeur de modèles OU Tous menus - Impressions EBP Comptabilité est livré avec un puissant générateur d'état. Grâce à cet outil, vous pourrez personnaliser tous les modèles d'impression que nous vous proposons dans le logiciel et en créer de nouveaux, en vous aidant de ceux existants. Pour ouvrir l'éditeur de modèles à partir d'un modèle existant, positionnez-vous dans la fenêtre principale d'impression, sélectionnez le modèle désiré puis accédez au générateur d'état en cliquant sur le bouton Modifier le modèle disponible dans la barre d'outils : vous arrivez alors automatiquement sur le paramétrage de ce modèle. Etant donné que les possibilités offertes par cet outil sont très importantes, le niveau de complexité peut varier en fonction de ce que vous souhaitez obtenir. Dans ce cas, notre service technique peut créer vos modèles : nous vous invitons à contacter notre service commercial pour connaître les tarifs de cette prestation. Plan de regroupement Le logiciel vous permet d'accéder, consulter et modifier le plan de regroupement de votre Bilan et de votre Compte de résultat. Liste des plans de regroupements Accès : Outils - Plan de regroupement 174 MANUEL Quatre plans de regroupement sont disponibles : ils correspondent aux différents feuillets du Bilan et du Compte de résultat (2050, 2051, 2052 et 2053). Cette liste n'est pas modifiable : aucun plan de regroupement ne peut être ajouté ou supprimé. Pour accéder à l'un des plans de regroupements, il vous suffit de sélectionner l'un des plans puis, au choix : - de double cliquer dessus, - de cliquer sur Modifier dans la barre de tâches, - de sélectionner Modifier dans le menu contextuel, - de faire F2. Plan de regroupement Accès : Outils - Plan de regroupement Un plan de regroupement est accessible à partir de la liste des plans de regroupement. Affichage du plan de regroupement Il se présente sous forme de tableau avec différentes colonnes : Variable : La variable est unique. Elle n'est ni supprimable, ni modifiable. Elle se retrouve dans chaque cellule du Bilan et du Compte de Résultat imprimés. Les variables finissant par 3 (AA3, AB3..) sont les variables de la colonne Net de l'exercice N. Formule système : La formule système est la formule de calcul définie par défaut pour chaque variable. Elle n'est ni supprimable, ni modifiable. Formule utilisateur : La formule utilisateur est le seul champ qui peut être modifié. Par défaut, les formules utilisateur recopient les formules système. C'est la modification des formules utilisateur qui modifiera votre Bilan et votre Compte de résultat. Lorsque la formule utilisateur reprend à l'identique à la formule système, alors le champ affiche . Lorsque la formule utilisateur est vide, alors le champ affiche . Dans tous les autres cas, la formule utilisateur que vous aurez saisie sera directement visible dans le champ. Modifier une formule utilisateur Accès : Outils - Plan de regroupement Pour modifier une formule utilisateur, vous devez sélectionner une ligne puis, au choix : - double cliquer dessus, - sélectionner Modifier la formule utilisateur dans la barre d'outils, - sélectionner Modifier la formule utilisateur dans le menu contextuel, - faire F2. Dans tous les cas, cela entraîne l'ouverture de l'éditeur de formules. Vous pouvez alors saisir la formule qui vous convient, la supprimer... Afin de connaître le résultat de votre formule, il vous suffit de cliquer sur Calculer. Pour valider votre formule et l'intégrer au plan de regroupement, il vous suffit de cliquer sur OK. Pour annuler vos modifications et conserver la formule utilisateur précédente, il vous suffit de cliquer sur Annuler. Réinitialiser la formule Ce bouton vous permet de recopier instantanément la formule système dans la formule utilisateur, en écrasant toutes les modifications que vous auriez faites. Cacher/afficher le filtre Ce bouton affiche ou masque la ligne de filtre. Comme dans de nombreux masques, cette ligne permet d'effectuer des recherches sur toutes colonnes. 175 EBP Comptabilité Open Line Pro Règles de syntaxe Cette liste des règles de syntaxe n'est pas exhaustive. Règles de nommage Tout nom de fonction commence par une majuscule puis s'écrit en minuscule. Si le nom est composé de plusieurs mots, alors chaque mot commence par une majuscule. Les noms de fonctions ne doivent pas être accentués. DebitBalance ; CreditFlow Opérations + : Additionne les valeurs des données - : Soustarit les valeurs de données * : Multiplie les valeurs de données / : Divise les valeurs de données % : Permet d'obtenir un modulo Tests < : Inférieur <= : Inférieur ou égal > : Supérieur >= : Supérieur ou égal = : Egal != : Différent & : ET logique | : OU logique ! : NON logique NULL : cellule sans résultat Format des paramètres Les fonctions comptables nécessitent, pour la plupart, l'utilisation de numéros de compte ou de racines de comptes. D'autre part , la syntaxe du moteur de calcul impose les guillemets. DebitFlow ("707") : Appliqué sur les comptes de 707 à 707ZZZ DebitFlow ("707+708") : Appliqué sur les comptes de 707 à 707ZZZ et de 708 à 708ZZZ DebitFlow ("707-7074-7079") : Appliqué sur les comptes de 707 à 707ZZZ sauf de 7074 à 7074ZZZ et de 7079 à 7079ZZZ DebitFlow ("707…709") : Appliqué sur les comptes de 707 à 709ZZZ Il est aussi possible de combiner ces notations : DebitFlow ("707-7074…7079") : Appliqué sur les comptes de 707 à 707ZZZ sauf de 7074 à 7079ZZZ Liste des fonctions comptables Les fonctions suivantes sont nécessaires afin de couvrir l’ensemble des cas : Balance : Reprend le solde du compte peut importe qu’il soit débiteur ou créditeur (valeur absolue). Debit : Reprend le solde du compte s’il est débiteur de 100 alors debit (compte) =100 ; Reprend le solde du compte s’il est créditeur de 100 alors debit (compte) = -100. Credit : Reprend le solde du compte s’il est débiteur de 100 alors credit (compte) = -100 ; Reprend le solde du compte s’il est créditeur de 100 alors credit (compte) = 100. DebitBalance : Reprend le solde du compte uniquement si celui ci est débiteur sinon la valeur est égale à 0. CreditBalance : Reprend le solde du compte uniquement si celui ci est créditeur sinon la valeur est égale à 0. DebitFlow : Sommes des lignes d’un compte au débit. CreditFlow : Somme des lignes d’un compte au crédit. PreviousValue : Reprend la valeur d’une cellule N-1. Il convient d’écrire l’appel de la façon suivante : PreviousValue ("2035.AA"). Seules les cellules de N-1 sont accessibles. Accès aux données d’un autre feuillet Les données sont organisées en Paragraphes au sein du moteur de calcul. 176 MANUEL Ainsi la formule « AB + 10 » accède à la valeur de la variable « AB » présente dans le feuillet courant. Si la variable n’existe pas, cela génère une erreur. Pour accéder aux valeurs des variables des autres feuillets, il faut utiliser la notation pointée : « 2035.AB + 10 ». Il faut noter que le moteur de calcul ne supporte qu’un seul niveau de hiérarchie. Exercice N-1 L'exercice de N-1 est calculé d'après les formules utilisateur des variables finissant par 3 (AA3, AB3..) : l'exercice N-1 est donc calculé de la même façon que la colonne Net de l'exercice N. Imprimer le bilan et le compte de résultat Toutes les modifications effectuées dans les plans de regroupement sont immédiatement prises en compte lorsque vous lancez l'impression du Bilan ou du Compte de résultat. Mises à jour de versions Mettre à jour votre logiciel dans une version supérieure entraînera la modification de : - toutes les formules système, - toutes les formules utilisateur qui sont restées identiques aux formules système. En revanche, cette opération ne modifiera pas les formules utilisateur que vous avez modifiées. Import/Export de la configuration Accès : Outils - Import/Export de la configuration Cet assistant vous permet d'importer dans un dossier ou d'exporter d'un dossier des modèles d'impressions et des vues personnalisées. Bienvenue... Avant tout traitement d'import ou d'export nous vous conseillons d'effectuer une sauvegarde de vos données en cliquant sur le bouton "Sauvegarder mon dossier maintenant !" Une fois la sauvegarde effectuée, cliquez sur le bouton Suivant. Choix de l'opération à effectuer L'assistant affiche par défaut le dossier ouvert, vous pouvez changer de dossier et indiquer le dossier sur lequel vous souhaitez effectuer le traitement, ainsi que l'opération souhaitée (import ou export). Une fois les paramètres définis, cliquez sur le bouton Suivant. Emplacement du fichier Cette étape vous permet d'indiquer : en import, l'emplacement du fichier à importer ; en export, l'emplacement et le nom du fichier à exporter. Une fois les emplacements définis, cliquez sur le bouton Suivant. Eléments à traiter Les éléments à traiter sont les modèles d'impression et les vues personnalisées. Choisissez le ou les éléments et cliquez sur le bouton Suivant Résumé des paramètres Cette étape vous permet d'avoir un résumé des éléments que vous avez saisis précédemment. Cliquez sur Lancer pour exécuter le traitement. Archivage Accès : Outils - Archivage L'archivage permet de conserver toutes les données de votre dossier dans un seul fichier à un moment choisi. Nous vous rappelons, d’après les articles 95 et 98 du bulletin officiel des impôts du 24/01/2006, que l’archivage des données est une opération préconisée pour la conservation de vos documents, et que les sauvegardes ne sauraient se substituer à cette opération. 177 EBP Comptabilité Open Line Pro Selon l’article 99 du Bulletin Officiel des impôts du 24/01/2006, c’est lors de la clôture de l’exercice ou la période comptable que la procédure d’archivage doit intervenir. Traitement de l'archivage L'archivage passe par un assistant. Entre chaque étape, utilisez les boutons Suivant et Précédent pour respectivement avancer et reculer dans l'assistant d'archivage des données. Bienvenue... Cette page est une page d'accueil, elle peut vous informer sur les obligations légales, les traitements que l'assistant va réaliser.... Suite à la lecture de ces informations, cliquez sur le bouton Suivant. Choix du dossier Cette étape permet de choisir le dossier à archiver et l'emplacement de l'archivage. • Sélectionnez le dossier à archiver Vous pouvez sélectionner le dossier à archiver à l'aide des icônes "...". Par défaut, le dernier dossier ouvert s'affiche. • Emplacement du dossier d'archivage sur votre disque dur. Vous devez indiquer l'emplacement du fichier archive (ZIP) à générer. Par défaut, le logiciel vous propose d'archiver vos données sur le disque dur, dans le répertoire du logiciel. Vous pouvez utiliser l'icône "..." pour changer l'emplacement du fichier sur votre disque dur. Cliquez ensuite sur le bouton Suivant, Résumé des paramètres Cette étape vous permet d'avoir un résumé des répertoires que vous avez saisis précédemment. Cliquez sur Lancer pour exécuter le traitement. L'archivage de données est une opération qui peut être longue. Format du fichier d'archive Toutes les données de votre dossier sont archivées dans des fichiers au format texte (csv). Les fichiers sont ensuite compressés dans un fichier du type : Archives_Nomdel'application_Nomdudossier_datedujour.zip Le descriptif des fichiers se trouve dans le fichier Dictionary.xls, disponible dans l'archive. Les fichiers texte (csv) contiennent en premières lignes la description des champs, et les champs RTF (notes) apparaissent en clair. Si deux archives sont lancées le même jour, le premier fichier sera écrasé. Journal des événements Accès : Outils - Journal des événements Le journal des événements recense l'ensemble des événements qui nécessitent d'être tracés sur un même dossier. Ces événements sont de deux types : les événements sans justificatif et les événements avec justificatif. - Evénement sans justificatif : L'événement est automatiquement enregistré par l'application et sa génération est invisible à l'utilisateur. C'est le cas, par exemple, lorsque vous effectuez une clôture mensuelle - Evénement avec justificatif : L'événement est automatiquement créé par l'application, mais vous devez saisir une justification. C'est le cas, par exemple, lorsque vous demandez à modifier le type de numérotation d'un journal. 178 MANUEL 179 Dans tous les cas, il est possible d'éditer à tout moment le journal récapitulant tous les événements intervenus sur un dossier, et cela quelque soit l'exercice courant. OPTIONS Options - Services Internet Accès : Outils- Options Ces informations sont nécessaires pour réaliser la sauvegarde en ligne. Proxy HTTP / FTP Les parties FTP et HTTP servent à renseigner vos paramètres de connexion à Internet (pour la sauvegarde en ligne), notamment dans le cas où vous utilisez un proxy. Nous vous invitons à contacter votre installateur/Revendeur pour insérer les paramètres correspondants à votre installation. Sauvegarde en ligne Cette partie permet de définir : Mot de passe : mot de passe servant à créer/utiliser le compte de sauvegarde. Celui-ci est différent du mot de passe pour accéder au site EBP. Lors de la 1ère sauvegarde, le compte sera créé avec ce mot de passe, ensuite il sera utilisé pour s’identifier. E-Mail de notification : adresse à laquelle sera envoyé le rapport de sauvegarde 181 INFORMATIONS SOCIÉTÉ Assistance technique L'achat du logiciel en version complète donne droit à l'usage de notre service technique*. Pour y accéder, munissez-vous de votre numéro de licence, puis, au choix: • Par téléphone, au 0811 65 20 00 (Coût d'un appel local) : Un standard vous accueille. Si aucun technicien n'est disponible, veuillez patienter, vous êtes sur une file d'attente. Nos services sont accessibles du lundi au jeudi de 8h à 19h et de 8h à 18h le vendredi. • Par e-mail, à l'adresse suivante : openline.support.fr@ebp.com. Nous nous engageons à vous répondre dans les 48h. *Ce droit à l'assistance technique dépend de la date d'achat de votre logiciel, de la version achetée et du contrat souscrit. Nous vous invitons à contacter notre service commercial pour connaître les différents types de contrats d'assistance que nous proposons et choisir celui qui vous convient le mieux. Nous contacter EBP Informatique SA ZA Du Bel Air BP 95 Rue de Cutesson 78513 Rambouillet Cedex Tel : 01.34.94.80.00. Fax: 01.34.85.62.07. Retrouvez-nous sur le www.ebp.com : Vous pourrez consulter la liste de nos produits, activer en ligne votre produit, télécharger les dernières mises à jour, nous laisser un message, consulter les dernières promotions, etc... Glossaire Ce chapitre contient les définitions de termes principaux d'une gestion commerciale. Pour consulter la définition d'un terme précis, cliquer sur la 1er lettre de ce terme puis sur le terme. A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z A A Echoir Le terme A échoir s'applique à des dettes et à des créances dont la date d'échéance (=la date de paiement) prévue n'est pas encore dépassée. B Balance La balance est un élément de contrôle permettant de s'assurer que les mouvements ont été enregistrés en respectant les principes de la comptabilisation en partie double. Elle permet également de contrôler la somme des mouvements de chaque compte ainsi que leur solde, sans entrer dans le détail des lignes d'écritures comme le Grand Livre. C Chiffre d'affaires Le chiffre d'affaires correspond au cumul de tous les comptes de ventes (comptes de racine 70). Clôture annuelle La clôture annuelle est une opération périodique qui vise à rendre intangibles tous les mouvements intervenus durant un exercice comptable et à présenter le résultat de cet exercice. Clôture mensuelle La clôture mensuelle est un traitement périodique et volontaire qui vise à rendre intangible le contenu d'un journal et d'un mois. Après une clôture mensuelle, si certains champs peuvent rester modifiables, d'autres sont définitivement figés et plus aucune nouvelle ligne ou écriture ne peut plus être créée ou supprimée. Comptes Le compte est la plus petite entité nécessaire au classement et à l'enregistrement des mouvements comptables. Tous les comptes d'un exercice sont regroupés dans le Plan Comptable et y sont regroupés par classe, puis par racines communes... Contrepartie Un journal de Trésorerie peut posséder deux types de contrepartie automatique. La contrepartie ligne à ligne : pour chaque ligne d'écriture saisie, le logiciel propose une autre ligne d'écriture mouvementant le compte de contrepartie du journal et équilibrant ainsi l'écriture. Plusieurs écritures distinctes existent donc au sein d'un même journal. La contrepartie en pied de journal : pour chaque ligne d'écriture saisie, le logiciel mouvemente la ligne de contrepartie située en pied de journal qui cumule tous les montants saisis. Une seule écriture existe donc au sein d'un même journal. Contrepassation La contrepassation est une opération qui vise à annuler une écriture comptable en inversant les sens de saisie. Créances Droit permettant à une entreprise (créancier) d'exiger d'une autre personne l'exécution d'une obligation (par exemple : paiement d'une somme d'argent par un client). Créditeurs Personne physique ou morale qui dispose d'une somme d'argent sur son compte bancaire ou sur son compte courant postal ou dans les livres de comptabilité d'une entreprise. D 183 EBP Comptabilité Open Line Pro Date système La date système est la date et l'heure de l'ordinateur. Débiteurs Personne physique ou morale qui doit une somme d'argent à un tiers. Dettes Les dettes d'une entreprise sont tous les moyens de financement externes qui sont mis à sa disposition des tiers (banques, fournisseurs, organismes sociaux...) et dont elle devra s'acquitter. E Échéances Correspond à une date à laquelle un règlement sera exigible au titre d'une facture. Elle pourra faire référence au net à payer de la facture ou à une partie seulement (dans ce cas la facture se compose de plusieurs échéances). La gestion d'un échéancier constitue la base de votre gestion financière et de votre trésorerie. Échéancier Document où figurent, dans l'ordre chronologique des échéances : - les dettes à payer (montants et créanciers) - les règlements à recevoir (montants et débiteurs) Echues Le terme Echus s'applique à des dettes et à des créances dont la date d'échéance (=la date de paiement) prévue est dépassée Ecritures Une écriture comptable est un ensemble de lignes d'écritures saisies dans un journal et dont la totalité des montants débiteurs et des montants créditeurs s'équilibrent. Exercice L'exercice comptable est une période de vie du dossier qui s'écoule entre l'établissement des comptes annuels et permet de déterminer un résultat. Un exercice comptable est le plus souvent d'une durée de 12 mois consécutifs, mais cette durée peut exceptionnellement être réduite à 1 jour ou augmentée jusqu'à 23 mois. Exercice courant L'exercice courant est l'exercice de travail sélectionné parmi tous les exercices existants sur le dossier. Définir un exercice courant peut être déterminant pour exécuter un certain nombre d'opérations. Extourne L'extourne est un terme comptable qui désigne un certain type d'écriture d'annulation. Il s'agit alors d'utiliser les mêmes comptes et mêmes montants que l'écriture d'origine en inversant le sens de saisie (Débit devient Crédit et Crédit devient Débit). Ce terme d'extourne s'utilise particulièrement dans le cadre des écritures de régularisation. F G Grand Livre Le Grand Livre est un document comptable qui regroupe tous les comptes existants sur l'exercice et détaille l'intégralité des mouvements qui les composent. Il est constitué par le report des lignes d'écritures mouvementées sur tous les journaux. Ainsi, la somme de tous les mouvements du Grand Livre doit être égale à la somme de tous les mouvements des journaux. I INSEE Institut National de la Statistique et des Etudes Economiques publie études et enquêtes statistiques sur la population, l'emploi, les salaires, les prix, les entreprises, la conjoncture économique, les comptes ... 184 Glossaire Source INSEE J Journal des événements Le journal des événements est un journal système qui répertorie toutes les informations, traitements ou changements de méthode importants intervenus sur un dossier. Journaux Un journal est un document comptable obligatoire sur lequel sont enregistrés tous les mouvements du dossier. Chacun de ces mouvements se comptabilise sous forme d'écritures, dont le solde doit obligatoirement être nul. Plusieurs journaux peuvent coexister sur un même exercice, ils sont regroupés dans le plan de journaux. L Ligne d'écriture Une ligne d'écriture est un élément constitutif d'une écriture comptable saisie dans un journal. Chaque ligne doit mentionner une date, un numéro de compte, un libellé faisant référence au document ayant servi de base à l'enregistrement, un montant débiteur ou un montant créditeur. Lettrage Le lettrage est un traitement disponible pour certains comptes qui vise à attribuer un même code et une même date de lettrage à plusieurs lignes d'écritures dont la somme des montants débiteurs et des montants créditeurs s'équilibre et que l'on considère comme liées à une même opération. M Marge Brute Une marge est, d'une façon générale, la différence entre un prix de vente et un coût. La marge brute permet de calculer la différence existant entre : - tous les comptes de ventes (comptes de racine 70), de production stockée (comptes de racine 71), de production immobilisée (comptes de racine 72), de produits nets partiels (comptes de racine 73) et de transfert de charges d'exploitation (comptes de racine 791) - et tous les comptes d'achats (comptes de racine 60). Menu contextuel Le menu contextuel est le menu disponible sur certains masques grâce au clic droit de la souris. Modes de règlement Définissent de quelle manière et dans quels délais les clients procéderont aux règlements des factures établies en leur nom. Montant négatif Les montants négatifs sont peu utilisés en comptabilité. Néanmoins, s'ils le sont, ils seront ensuite soustraits des montants positifs, ce qui pourra avoir des incidences sur le Bilan et le compte de résultat Les annulations d'écriture doivent normalement être faites en saisissant la même écriture dans les sens inverses à ceux de l'écriture d'origine (Débit devient Crédit - Crédit devient Débit). N NAF Nomenclature des Activités Françaises qui permet la codification de l'APE, c'est-à-dire de l'activité principale exercée dans l'entreprise ou l'association. Le code NAF est l'un des codes INSEE. Cette nomenclature d'activités françaises a été instaurée par le décret n 92-1129 du 2 octobre 1992. Le code NAF est apposé par l'INSEE lors de son enregistrement auprès du Registre des Greffes du Tribunal du 185 EBP Comptabilité Open Line Pro Commerce. On parle de code APE de 1973 à 1992 et de code NAF depuis le 1er janvier 1993. La nomenclature d'activités française révision 1 (NAF rév. 1, 2003) est la nouvelle nomenclature statistique nationale d'activités qui se substitue depuis le 1er janvier 2003 à la NAF de 1993. La NAF rév. 1 reprend tous les niveaux de la NACE rév. 1.1 (nomenclature d'activités de la communauté européenne) et y ajoute un niveau national qui éclate (ou non) les classes de la NACE (niveau le plus détaillé) pour tenir compte des spécificités et des habitudes nationales. La nomenclature d'activités française révision 2 (NAF rév. 2, 2008) est la nouvelle nomenclature statistique nationale d'activités qui se substitue depuis le 1er janvier 2008 à la NAF rév. 1 datant de 2003. Depuis le 1er janvier 2008 (révision 2-2008), le code NAF est composé de 4 chiffres et une lettre. Exemple d'utilisation du code NAF : On le trouve sur le bulletin de salaire, c'est un élément obligatoire. N° TVA intracommunautaire Créé, le 1er janvier 1993, pour garantir les échanges commerciaux intracommunautaires. Pour la France, il est composé des lettres FR ajoutées d'une clé de deux chiffres attribuée par le centre des impôts du lieu d'exercice de l'entreprise, et du numéro SIREN.* Par exemple d'un N° d'entreprise : FR 74 451 784 746. Source INSEE O Opérations Diverses Un journal d'Opérations Diverses est un journal destiné à comptabiliser des mouvements qui ne peuvent pas être rattachés aux autres types de journaux existants sur l'exercice (achats, ventes, trésorerie) P R Rapprochement Un rapprochement est un état périodique permettant de vérifier la concordance entre un compte "Banque" tenu sur le dossier et le relevé bancaire adressé par cette banque. Règlements Opération permettant de solder une transaction financière. C'est l'acte par lequel s’éteint une obligation liée à une vente ou un achat entre deux ou plusieurs parties. Régularisation La vie d'une entreprise est découpée en exercices. Cela entraîne l'obligation de corriger les charges et produits afin que le résultat de chaque exercice soit déterminé de la façon la plus exacte possible. Pour ce faire, il est nécessaire de comptabiliser un certain nombre d'écritures de régularisation afin que chaque exercice enregistre uniquement ce qui lui incombe et rien d'autre. Ce type de régularisation doit être exécutée au moins une fois par exercice (avant de procéder à la clôture annuelle). Les écritures de régularisation répondent à des règles précises. Elles comprennent deux grands groupes (Charges à payer ou Produits à recevoir / Charge ou Produits constatés d'avance). Report A Nouveaux Le Report A Nouveaux est destiné à enregistrer le résultat de l'exercice. Il peut être bénéficiaire ou déficitaire. Résultat comptable Le résultat comptable est la différence existant entre la somme de tous les comptes de produits (comptes de racine 7) et tous les comptes de charges (comptes de racine 6). 186 Glossaire S Sens de saisie Une ligne d'écriture possède un seul et unique sens de saisie : il peut être débiteur (si le montant est saisi au débit) ou créditeur (si le montant est saisi au crédit). S.I.E Service Inter-Entreprise du Trésor Public dont dépend le dossier et auquel doit être adressée la déclaration de TVA. Simulation La simulation est un statut qui peut être attribué à une écriture pour la distinguer des autres écritures du dossier (écritures non validées ou validées). Ce statut peut être attribué temporairement et modifié à la demande. SIREN Système d’Identification du Répertoire des Entreprises qui est un code INSEE. Il est attribué aux entreprises françaises lors de leur immatriculation quelle que soit leur forme juridique. Le SIREN identifie de façon unique chaque entreprise. Les SIREN existent au sein d'un répertoire géré par l'INSEE, SIRENE. Il est national, invariable et dure le temps de la vie de l'entreprise. Il correspond au NIR (n° de sécurité sociale) des personnes physiques. Il est composé de neuf chiffres, les huit premiers sont attribués séquentiellement, sauf pour les organismes publics commençant par 1 ou 2, le neuvième est une clé de contrôle. Il sert de base pour le numéro d'inscription au Registre du Commerce et des Sociétés (RCS), pour le numéro d'inscription au Répertoire des Métiers (RM) et pour le numéro d'opérateur sur le marché intracommunautaire (TVA) N° Siren : 732 829 320. Source INSEE SIRET Le numéro SIRET est un identifiant d'établissement. Cet identifiant numérique de 14 chiffres est articulé en deux parties : - la première est le numéro SIREN de l'entreprise (ou unité légale ou personne juridique) à laquelle appartient l'unité SIRET ; - la seconde, habituellement appelée NIC (Numéro Interne de Classement), se compose d'un numéro d'ordre à quatre chiffres attribué à l'établissement et d'un chiffre de contrôle, qui permet de vérifier la validité de l'ensemble du numéro SIRET. Source INSEE T Taux de TVA Les taux de TVA sont régis par l'Etat, qui distingue les taux applicables en France continentale (19,6 %, 5,5 % et 2,1 %) et des taux spécifiques à la Corse et aux DOM. Territorialité de la TVA Le choix de la territorialité permet de déterminer si une opération est soumise à la TVA française, à la TVA d'un autre Etat membre de l'Union Européenne ou n'y est pas soumise. Transfert le transfert comptable est une opération qui vise supprimer une écriture comptable d'un journal/mois d'origine et de la transférer sur un autre journal/mois. TVA Taxe sur la valeur ajoutée Impôt indirect qui, à chaque stade de la production et de la commercialisation, frappe la différence entre le prix d'achat d'un produit à un stade et son prix de vente au stade suivant. Sauf exception, sont concernés tous les biens et les services consommés ou utilisés en France, qu'ils soient d'origine française ou étrangère. La TVA est payée par les entreprises, ou par les personnes physiques assujetties, sur la base du montant facturé en France à leurs clients après déduction des montants de TVA qui ont grevé leurs propres acquisitions de biens ou de services. 187 EBP Comptabilité Open Line Pro 188 Institué en France en 1954, cet impôt, dont le taux varie suivant les types de biens et de services, a été progressivement adopté à l'étranger, notamment par les États membres de l'Union européenne. Source INSEE V Validation La validation est opération qui vise à rendre intangible une écriture comptable ou un ensemble d'écritures comptables. Index 2 Clôture annuelle .............................. 27, 132, 135 2050 ........................................................... 174 Clôture mensuelle ............................ 26, 132, 134 2051 ........................................................... 174 Code lettrage ........................... 66, 103, 106, 114 2052 ........................................................... 174 Code NAF .................................................... 152 2053 ........................................................... 174 Code régime ......................................... 154, 157 A Codes postaux ............................................. 148 A 32, 139 Colonnes ....................................................... 12 A Nouveaux ...................................... 26, 55, 133 Colonnes optionnelles ..................................... 36 A Nouveaux automatiques ........................ 26, 133 Commencer ................................................... 17 A Nouveaux manuels ............................... 26, 133 Communication Entreprise Expert ................... 170 AAE ........................................................ 80, 81 Compararatif des résultats cumulés .................. 30 Accéder à la saisie .......................................... 35 Comparatif chiffre d'affaire, résultat comptable et Actions ............................................................ 9 marge brute ................................................ 30 Activer Annuler Refaire .................................. 158 Comparatif entre deux exercices ....................... 27 Afficher le tableau de bord ............................... 30 Compléter à droite par des zéros .................... 158 Ajouter une écriture .................................. 38, 47 Compte de banque ................................ 129, 142 Ajouter une ligne ...................................... 38, 47 Compte de régularisation au crédit ................. 158 Alerte sur les doublons des numéros de pièce .. 158 Compte de régularisation au débit .................. 158 Alerte sur les numéros de pièces .................... 158 Compte de résultat .................................. 27, 174 Alertes sur les comptes ................................. 158 Compte rendu d'opérations .............................. 81 Alertes sur les montants ................................ 158 Comptes ............ 19, 26, 32, 33, 89, 139, 140, 144 Annuler ............................................ 38, 47, 158 Configuration requise ........................................ 5 ANP ........................................................ 80, 81 Confirmation d'une écriture .............................. 24 Aperçu des impressions .... 100, 111, 131, 136, 166 Confirmer l'écriture ................................... 40, 50 Archivage .................................................... 177 Consultation ..........7, 19, 32, 42, 52, 64, 101, 112 Assistance technique ..................................... 181 Consultation / Lettrage .................................... 31 Assistant de clôture annuelle .......................... 135 Consultation de compte .......................... 109, 110 Autoriser/interdire le lettrage approché ...... 32, 139 Contact et adresse sur une fiche compte .... 33, 140 Autres fonctions en saisie .......................... 40, 50 Contacts ...................................................... 156 Autres Tierrs ........................................... 32, 139 Contenu système des déclarations .................. 148 Avoir .................................................. 42, 52, 62 Contrepasser l'écriture .............................. 40, 50 Avoirs à émettre ..................... 25, 73, 78, 80, 158 Contrôles des pointages .................................. 56 Avoirs non parvenus ............... 25, 73, 78, 80, 158 Convention utilisation EBP ................................. 3 Avoirt avec échéances ............................... 42, 52 Coordonnées ................................... 33, 140, 152 B Coordonnées bancaires .......................... 129, 142 Balance ......................................................... 27 Couleur de fond ............................................ 162 Balance Clients et Fournisseurs ........................ 31 Cumul des journaux/mois ................................ 35 Balance d'ouverture ................................. 26, 133 D Balance interactive ................................ 101, 110 Date de génération des A Nouveaux................ 133 Balance mensuelle .......................................... 27 Date de l'échéance ................................... 42, 52 Balance standard ............................................ 27 Date d'échéance ....................................... 36, 46 Balance trimestrielle ....................................... 27 Dates des exercices ...................................... 133 Banque par défaut ........................................ 158 Décaissement ..................................... 31, 32, 63 Banques .................................... 67, 68, 129, 142 Décaissement fournisseur ................................ 63 Barre de navigation .......................................... 7 Déclaration de TVA . 26, 31, 32, 81, 82, 83, 84, 89, Barre de tâches ................................................ 7 146, 147, 148 Barres d'outils ................................................ 10 Déclarations ................................................... 81 Base de données .......................................... 170 Déclôture mensuelle ..................................... 173 BBAN ................................................... 129, 142 Déletttrage .............................. 66, 103, 106, 114 BIC ...................................................... 129, 142 Démarrer Consultation .................................. 101 Bilan ...................................................... 27, 174 Démarrer Exercices/Clôtures .......................... 132 C Démarrer Paramètres .................................... 137 Capital ................................................... 32, 139 Démarrer une tâche ........... 32, 101, 112, 132, 137 Case Néant .................................................... 83 Démonstration ................................................. 5 Catégorie d'impression ..... 100, 111, 131, 136, 166 Départements .............................................. 149 CCA ................................. 25, 73, 75, 79, 81, 158 Différents modes de saisie ............................... 20 Centres des Impôts ................................ 154, 157 Disponibiltés .................................................. 30 Champs de saisie .............................................. 9 Données de base ............................................ 18 Changer d'exercice ......................................... 19 Données principales ........................................ 17 Charge ou produit constaté d'avance........... 40, 50 Dossier ....... 26, 152, 153, 154, 155, 156, 157, 158 Charges .................................................. 32, 139 Doublons des numéros de pièce ................. 62, 63 Charges à recevoir .................. 25, 73, 78, 79, 158 Doublons des numéros de pièces ...................... 61 Charges constatées d'avance .... 25, 73, 75, 79, 81, 158 E Ecart maximum ............................................ 158 Charges ou produits constatés d'avance 25, 73, 75, 79, 158 Echéance en rouge ................................... 42, 52 Echéance rayée ........................................ 42, 52 Choix de l'échéance de l'avoir .................... 42, 52 Echéances .... 25, 56, 116, 118, 120, 121, 123, 125 Civilités ....................................................... 148 Echéances non réglées ........................... 116, 121 Clients ................................................... 32, 139 Echéances non soldées ........................... 116, 121 189 EBP Comptabilité Open Line Pro Echéances réglées ................................. 116, 121 Formules des guides de saisie .......................... 62 Echéances soldées ................................. 116, 121 Fournisseurs ........................................... 32, 139 Echéancier .................... 25, 27, 56, 116, 121, 158 G Echéancier / Réglement ................................... 31 Génération des AN ........................................ 133 Echéancier clients ......................................... 112 Gestion de la TVA .................................. 154, 157 Echéancier de la facture ....................... 25, 40, 50 Gestion des doublons ......................... 22, 58, 158 Echéancier du compte ............................... 40, 50 Glossaire ..................................................... 183 Echéancier Factures .................................. 42, 52 Grand Livre .................................................... 27 Echéancier fournisseurs ................................. 112 Grand Livre Interactif ............................. 101, 109 Echéancier interactif ....................... 112, 116, 121 Grille horizontale .......................................... 162 Echéancier Règlements ............................. 42, 52 Grille verticale .............................................. 162 Echéanciers ........................... 40, 42, 50, 52, 112 I Echéanciers / Règlements .................................. 7 IBAN .................................................... 129, 142 Ecran de démarrage ........................................ 31 Identification ................................................ 153 Ecriture de régularisation .... 25, 73, 75, 78, 79, 80, Immbobilisations ..................................... 32, 139 158 Impirmer un comparatif entre deux exercices .... 27 Ecritures de régularisation .. 25, 40, 50, 73, 75, 79, Import ........................................................ 170 80 Import/Export de la configuration ................... 177 Ecritures déséquilibrées ................................. 162 Importer des relevés bancaires ........................ 68 Ecritures guidées .......................... 60, 61, 62, 144 Impressions 27, 100, 101, 111, 131, 136, 166, 174 Editeur de filtres ............................................. 13 Imprimer ....................................................... 27 Editeur de modèle .......................................... 27 Imprimer le Grand Livre .................................. 27 Editeur de modèles ....................................... 174 Imprimer un bilan ........................................... 27 Encadrer l'écriture courante ........................... 162 Imprimer un compte de résultat ....................... 27 Encaissement ...................................... 31, 32, 63 Imprimer un échéancier .................................. 27 Encaissement client ........................................ 63 Imprimer un journal ........................................ 27 Environnement de saisie ................................ 162 Imprimer un journal centralisateur ................... 27 Environnement par défaut ............................. 162 Imprimer un rapprochement ............................ 27 Equilibrage .................................................. 158 Imprimer une balance ..................................... 27 Equilibrer l'écriture ................................... 38, 47 Informations société ..................................... 137 Etat ............................................................ 133 Informations sur une fiche compte ............. 33, 140 Etat de l'exercice .......................................... 133 Insérer une ligne ...................................... 38, 47 Etat de rapprochement ......................... 20, 70, 72 Installation ...................................................... 5 Etat des créances et dettes .............................. 30 Interface ......................................................... 7 Evolution des recettes et des dépenses par mois 30 Internet ....................................................... 179 Exemples d'écritures de régularisation .............. 73 Introduction ..................................................... 1 Exercice ........................................................ 19 Itinéraire ................................................ 33, 140 Exercice courant ...................................... 19, 132 J Exercices comptables ....................... 18, 132, 133 journal .......................................................... 27 Exercices/Clôtures .................................... 7, 132 Journal centralisateur ...................................... 27 Expert Cabinet ............................................. 155 Journal de banque ................................. 129, 142 Export ......................................................... 170 Journal de régularisation ............................... 158 Export du schéma de la base de données ........ 170 Journal des évènements ........................... 28, 178 Exporter ........................................................ 13 Journaux ................................................ 19, 138 Exporter la base de données .......................... 170 L Lettrage 19, 25, 31, 42, 52, 64, 66, 101, 103, 106, 107, 112, 114, 158 F Facture............................................... 42, 52, 80 Facture Client ........................................... 31, 32 Lettrage approché ........................................ 158 Facture d'achat .............................................. 62 Lettrage automatique ...................... 101, 104, 115 Facture de vente ............................................ 62 Liasse fiscaile ............................................... 171 Facture Fournisseur .................................. 31, 32 Libellés des écritures guidées ........................... 60 Facture négative ....................................... 42, 52 Libellés type ................................................ 146 Facture non parvenue .......................... 40, 50, 80 Lignes non déclarées ....................................... 82 Facture non parvenue ou à émettre 25, 73, 78, 80, Lignes sur Débits ............................................ 82 158 Lignes sur Encaissements ................................ 82 Factures à émettre ............ 25, 73, 78, 80, 81, 158 Liste déroulante ............................................... 9 Factures non parvenues ..... 25, 73, 78, 80, 81, 158 Liste des déclarations de TVA sauvegardées ....... 81 FAE .................................. 25, 73, 78, 80, 81, 158 Liste des déclarations par défaut .................... 148 Fenêtre de saisie ...................................... 38, 47 Liste des écritures guidées ............................... 60 Fenêtre d'impression ....................................... 27 Liste des exercices ........................................ 132 Fenêtre principale de navigation ................. 11, 13 Liste des rapprochements ................................ 69 Fermer .......................................................... 30 Liste des Règlements ............................. 118, 123 Fermer la saisie ........................................ 38, 47 Liste page ................................................ 11, 13 Feuillest à inclure dans une déclaration de TVA... 81 Logo ........................................................... 155 Feuillets ...................................................... 174 Logs ........................................................... 178 Fiche ............................................................. 14 Longueur des comptes généraux .................... 158 Fiche de règlement ................................ 120, 125 Longueur des numéros de pièce ..................... 158 Fiche Tiers .............................................. 33, 140 M Filtre automatique .......................................... 13 Ma trésorerie ................................................. 63 Filtres ...................... 13, 100, 111, 131, 136, 166 Maintenance de données ............................... 171 Filtres et aperçus ............................................ 27 Maintenance sur les journaux ......................... 173 FNP .................................. 25, 73, 78, 80, 81, 158 Menu contextuel ............................................. 12 190 Index Menus ............................................................. 7 Purger les relevés bancaires ........................... 174 Mes achats .................................................... 62 Q Mes écritures comptables ..................... 45, 46, 56 Quel mode de saisie choisir ? ........................... 20 Mes ventes .................................................... 62 Quitter .......................................................... 30 Message des situations de comptes ................. 158 Quotidien................................................... 7, 32 Messages..................................................... 158 R Mise à jour d'une fenêtre ........... 64, 101, 107, 112 Raccourci ....................................................... 29 Modèles de guide ............................................ 60 RAN .............................................................. 55 Modèles de guides ........................................ 144 Rapprochement .............................................. 27 Modèles de libellé ......................................... 146 Rapprochement automatique ..... 20, 67, 68, 69, 72 Rapprochement bancaire .... 20, 31, 32, 67, 68, 69, 70, 72, 158 Modèles d'impression . 27, 100, 111, 131, 136, 166 Modes de règlement............................... 127, 150 Modes de saisie .............................................. 20 Rapprochement manuel ........................ 20, 69, 70 Modifier la saisie guidée ............................ 40, 50 Rayé ....................................................... 42, 52 Modifier l'écriture comptable ............................ 56 Recalcul ...................................................... 171 Mois en cours ................................................. 35 Recalculer la déclaration de TVA ....................... 82 Montants négatifs ......................................... 158 Recherche d'écritures ........................... 31, 32, 56 Mots clés ....................................................... 27 Refaire ............................................. 38, 47, 158 Moyen de paiement .................................. 36, 46 Régimes de TVA ........................................... 147 Moyen de paiement par défaut ....................... 158 Règlement ............................................... 42, 52 Moyens de paiement ............... 126, 127, 149, 150 Règlements.................................................. 112 N Règlements Clients ......................... 112, 118, 123 Nature d'achats saisie pratique .................. 32, 139 Règlements des Tiers ............................. 118, 123 Nature de vente saisie pratique ................. 32, 139 Règlements Fournisseurs ................. 112, 118, 123 Natures de comptes ...................................... 144 Régler ..................................................... 38, 47 Natures de taxes ................................... 154, 157 Régler la facture ......................... 42, 52, 120, 125 Ne plus afficher le tableau de bord .................... 30 Régler l'échéance ........ 42, 52, 116, 120, 121, 125 Néant ............................................................ 83 Régler les échéances ............... 116, 120, 121, 125 Nombre de chèques par chéquier .................... 158 Régler une facture .................................... 38, 47 Notes ............................................................ 15 Règles de libellés des guides de saisie ............... 62 Nous contacter ............................................. 181 Règles de numérotation des guides de saisie ...... 62 Nouveau dossier ............................................. 29 Régularisation d'une déclaration de TVA ............ 26 Nouveau règlement ..... 42, 52, 118, 120, 123, 125 Régularisations d'une déclaration de TVA ........... 84 Nouvelle écriture comptable ............ 35, 45, 46, 56 Relevés bancaires ................... 32, 67, 68, 72, 174 O Remboursement ....................................... 42, 52 Options ................... 152, 153, 155, 156, 158, 179 Rembourser un avoir ................................. 38, 47 Options de base ............................................. 17 Remise .......................................................... 62 Options de calcul ................................... 154, 157 Remise de chèques ................................... 32, 63 Options de saisie par journal .......................... 158 Répartir sur la sélection ............................. 42, 52 Outils ....... 158, 167, 168, 171, 172, 173, 174, 177 Répartir sur toutes les échéances ............... 42, 52 Outils de requêtage ...................................... 172 Restauration .................................................. 28 Ouvrir ........................................................... 30 Restauration de dossier ................................. 168 P Reste à affecter ........................................ 42, 52 Paramétrage avancé d'un compte .............. 33, 140 RIB ...................................................... 129, 142 Paramétrage des comptes pour la TVA .............. 89 Rouge ..................................................... 42, 52 Paramétrage d'un compte ......................... 33, 140 S Paramètres ................................ 7, 146, 147, 148 S.I.E .................................................... 154, 157 Pays ........................................................... 149 Saisie ... 35, 36, 38, 40, 42, 45, 46, 47, 50, 52, 146 PCA ................................. 25, 73, 75, 79, 81, 158 Saisie au kilomètre ......................................... 20 Périodicité de la déclaration de TVA ......... 154, 157 Saisie comptable ................................. 20, 35, 45 Plan ....................................................... 33, 140 Saisie d'une seule écriture ............................... 45 Plan comptable ......................... 32, 137, 139, 174 Saisie kilomètre ........................................ 22, 58 Plan de journaux .......................................... 138 Saisie mois courant ......................................... 31 Plan de regroupement ................................... 174 Saisie non comptable ...................................... 20 Pointage ............................................. 25, 42, 52 Saisie par classeur .......................................... 20 Pointage bancaire ..................................... 31, 32 Saisie par écriture ......... 38, 40, 42, 46, 47, 50, 52 Pointages ........................................... 25, 42, 52 Saisie par écriture comptable ........................... 20 Pointages bancaires .................................. 31, 32 Saisie par guide ............................ 20, 21, 60, 144 Pointée ? ................................................. 42, 52 Saisie par guides .......................... 60, 61, 62, 144 Pointer des échéances ............................ 116, 121 Saisie par journal ... 20, 21, 32, 35, 36, 38, 40, 42, Précédent ................................................ 38, 47 47, 50, 52, 56 Présentation de la fenêtre de saisie ............. 38, 47 Saisie pratique .................................... 20, 62, 63 Présentation des vues ..................................... 13 Saisir la balance d'ouverture ...... 35, 42, 52, 55, 56 Principes de clôture annuelle .......................... 135 Saisir une balance d'ouverture ................... 38, 47 Principes de la saisie par guide ......................... 60 Sauvegarde .................................... 28, 167, 169 Principes des écritures de régularisation ...... 73, 80 Sauvegarde à l'équilibre ................................ 158 Produits .................................................. 32, 139 Sauvegarde automatique dès l'équilibre de Produits à recevoir .................. 25, 73, 78, 79, 158 l'écriture ................................................... 158 Produits constatés d'avance 25, 73, 75, 79, 81, 158 Sauvegarde en fichier texte ........................... 167 Proxy .......................................................... 179 Sauvegarde en ligne ....................... 167, 169, 179 Purge du plan comptable ............................... 174 Sauvegarde rapide ........................................ 167 Purger le plan comptable ............................... 174 Sauvegarder et Fermer la saisie ................. 38, 47 191 EBP Comptabilité Open Line Pro 192 Sauvegarder la saisie ................................ 38, 47 Schémas d'écritures ........................................ 89 Schémas d'écritures pour la TVA ...................... 89 Services Internet .......................................... 179 Simuiler l'écriture ..................................... 40, 50 Simulation ................................................... 134 Simulation d'une écriture ................................. 24 Situation de compte ........................................ 27 Situation de comptes .................................... 158 Situation de trésorerie ..................................... 30 Situations de comptes ............................... 27, 31 Solde porgressif ........................................... 107 Solde progressif .............................. 64, 101, 112 Solvabilité .............................................. 33, 140 Statut des lignes ...................................... 36, 46 Statut Non validé ............................................ 24 Statut Simulé .......................................... 24, 134 Statut Validé ........................................... 24, 134 Stocks .................................................... 32, 139 Suivant ................................................... 38, 47 Suppression d'écritures ................................... 56 Supprimer les écritures ................................... 56 Supprimer un dossier .................................... 173 Supprimer une écriture ............................. 38, 47 Supprimer une ligne.................................. 38, 47 Syntaxe ....................................................... 174 T Tabbleau de bord ............................................ 31 Tableau de bord ............................................. 30 Taux de TVA ......................................... 137, 146 Taxes .......................................................... 147 Territorialité ................................... 147, 154, 157 Textes enrichis ............................................... 10 Tous les journaux ........................................... 35 Tous les mois ................................................. 35 Tout est prêt .................................................. 18 Traitements sur les écritures ...................... 40, 50 Transférer l'écriture .................................. 40, 50 Trier les écritures ........................................... 56 TVA .... 26, 81, 82, 83, 84, 89, 146, 147, 148, 154, 157 Type d'opération ................................... 154, 157 Types de TVA ............................................... 147 Types d'opérations ........................................ 147 V V 32, 139 Valeurs par défaut ........................................ 158 Validation des écritures .......................... 132, 134 Validation d'une écriture .................................. 24 Valider la déclaration de TVA ............................ 82 Valider l'écriture courante .......................... 40, 50 Valider tout .............................................. 40, 50 Virement ....................................................... 63 Visualiser les pointages ............................. 42, 52 Voir document .......................................... 38, 47 Volet de navigation ........................................... 7 Vues ....................................................... 13, 70 GUIDE D’UTILISATION « MECA PRO » Etude de l’équilibre d’un solide soumis à trois forces Etude de l’équilibre d’un solide soumis à trois forces non parallèles Si un solide soumis à l'action de 3 forces A r , B r etC r est en équilibre, la somme vectorielle des forces est nulle. A r + B r +C r = 0 r Cette somme nulle se traduit graphiquement pour un dynamique fermé (en choisissant une échelle appropriée pour les intensités) Une force est caractérisée par trois paramètres : - sa direction - son sens - son intensité On voit sur le dessin du dynamique que les angles α, β et γ caractérisent les directions des forces les unes par rapport aux autres. Le dynamique est un triangle déterminé dés que l'on connaît trois éléments : - trois côtés - deux angles et un côté - deux cotés et un angle La longueur d'un côté correspond moyennant la connaissance de l'échelle à l'intensité de la force. Un angle fournit une indication sur la direction de la force. ©2005 Texas Instruments - Jean Winther 1 Tout problème de mécanique traitant de l'équilibre d'un solide soumis à trois forces non parallèles se résume à la connaissance de 3 caractéristiques des forces et à la détermination des 3 autres caractéristiques. - trois intensités : on détermine trois directions - deux directions et une intensité : on détermine une direction et deux intensités - deux intensités et une direction : on détermine une intensité et deux directions Dans les exercices de mécanique la résolution se fait par différentes méthodes ou graphiques. Le plus souvent on ne propose que des situations particulières faisant appel à des relations trigonométriques dans un triangle rectangle. A l'aide d'une calculatrice il est possible de systématiser la résolution de ces problèmes. Principe Comme on l’a mis en évidence plus haut le dynamique des forces, fermé, traduit graphiquement la relation vectorielle : 0 r r r r CBA =++ Le triangle du dynamique a trois côtés dont les longueurs sont A, B, C et trois angles α, β, γ. Il est entièrement déterminé si on connaît trois de ces éléments. Nous allons nous placer dans un cas général où le triangle est quelconque ce qui inclura les cas particuliers. On démontre en mathématiques que dans un triangle quelconque : α+ β + γ = 180° sin sin sin γβα BA C = = cos2 α 222 −+= BCCBA cos2 β 222 −+= ACCAB cos2 γ 222 −+= ABBAC A l’aide de ces relations il est possible de calculer trois des caractéristiques des forces en connaissant les trois autres. Les programmes pour l’étude de l’équilibre d’un solide soumis à trois forces La théorie L’outil de résolution L’exerciseur Mise en œuvre Les élèves et les programmes évoluent sur deux niveaux. Toutes les résolutions effectuées par les élèves seront faites graphiquement et les programmes prendront en charge ces résolutions numériquement. Les équilibres à 3 forces, en LP peuvent se traiter entièrement sous une forme graphique. En effet tous les exercices posés en LP peuvent se résumer à 3 cas : ©2005 Texas Instruments - Jean Winther 2 On connaît les intensités des 3 forces --> on cherche les 3 directions On connaît 2 intensités et 1 direction--> on cherche l'intensité de la 3ème force et les 2 autres directions On connaît 1 intensité et 2 directions--> on cherche les intensités des 2 autres forces et la 3ème direction Pourquoi une méthode graphique ? Elle permet de résoudre tous les cas quels que soient les intensités et les angles. La méthode numérique (basée sur la trigonométrie) n'est applicable en LP que si on a des angles particuliers (90°, 45°...) Elle est en rapport direct avec le schéma du montage et donc plus concrète pour les élèves. La théorie Ce programme explique aux élèves le principe de la résolution graphique d’un problème d’équilibre à trois forces. 1°) On connaît les 3 intensités des forces On trace F1 à l’échelle. En pointant un compas sur l’extrémité de F1 avec une ouverture égale à l’intensité de F2 on trace un arc de cercle. En pointant un compas sur l’origine de F1 avec une ouverture égale à l’intensité de F3 on trace un arc de cercle. On relie le point de concourance des 2 arcs à l’origine et à l’extrémité de F1. On obtient le dynamique des forces. Il suffit ensuite de mesurer les 3 angles manquants. 2°) On connaît 1 intensité et 2 directions On trace F1 à l’échelle. A l’extrémité on trace la direction de F2. ©2005 Texas Instruments - Jean Winther 3 A l’origine on trace la direction de F3. On mesure les intensités de F2 et F3. 3°) On connaît 2 intensités et 1 direction On trace F1 à l’échelle. A l’extrémité on trace la force F2. On relie l’origine de la force F1 et l’extrémité de la force F2. On mesure l’intensité de F3 et les angles manquants. L’outil de résolution Ce programme aide les élèves à résoudre graphiquement un problème d’équilibre soumis à trois forces. L’exerciseur Ce programme propose aux élèves des exercices types d’équilibre soumis à trois forces. ©2005 Texas Instruments - Jean Winther 4 Etude de l’équilibre d’un solide soumis à trois forces parallèles Pour qu’un solide soumis à N forces soit en équilibre il faut que la somme vectorielle des forces soit nulle : 0...321r r r r FFF =+++ et que la somme algébrique des moments par rapport à un point de référence soit nulle : A A A FMFMFM =+++ 0...321r r r Dans le cas particulier des forces parallèles on oriente arbitrairement les forces. Ce qui permet de transformer la somme vectorielle en somme algébrique : F1 – F2 +F3 = 0 ©2005 Texas Instruments - Jean Winther 5 Puis on oriente les moments. Pour donner un signe à un moment on considère chaque force séparément. Si la force était seule et si un axe passait par le point de référence et si la force faisait tourner le solide dans le sens positif choisi alors on lui attribue le signe +, dans le cas contraire on lui attribue le signe -. Dans l’exemple choisi : - BA * F1+ CA * F2 – DA *F3 = 0 La théorie Ce programme explique aux élèves le principe de la résolution graphique d’un problème d’équilibre à trois forces parallèles. Il reprend les deux conditions : • la somme vectorielle des forces doit être nulle (vectoriellement) : 0...321r r r r FFF =+++ • la somme algébrique des moments par rapport à un point de référence doit être nulle (algébriquement) : A A A FMFMFM =+++ 0...321r r r L’outil de résolution Ce programme aide les élèves à résoudre graphiquement un problème d’équilibre soumis à trois forces parallèles. L’exerciseur Ce programme propose aux élèves des exercices types d’équilibre soumis à trois forces parallèles. ©2005 Texas Instruments - Jean Winther 6 Les exercices Exercice 1 Etude de l’équilibre d’une sphère sur un plan incliné Dans cet exercice on connaît une intensité et deux directions. ©2005 Texas Instruments - Jean Winther 7 Une construction graphique permet de déterminer les angles des directions de T et R par rapport à P. On remarque que les côtés des angles du plan incliné et (CGD) sont perpendiculaires deux à deux donc ils sont égaux. Il en résulte que direction de RÆ30°, direction de TÆ60°. On obtient : On fait varier l’angle du plan incliné. ©2005 Texas Instruments - Jean Winther 8 Exercice 2 Etude de l’équilibre de 3 masses accrochées sur des fils coulissant sur 2 poulies 1ère partie de l’exercice Dans cet exercice on connaît une intensité et deux directions. ©2005 Texas Instruments - Jean Winther 9 2ème partie de l’exercice Dans cet exercice on connaît 3 intensités. ©2005 Texas Instruments - Jean Winther 10 Exercice 3 Etude d’une barre en équilibre sous l’action de 3 forces parallèles L’exercice comporte 3 situations ©2005 Texas Instruments - Jean Winther 11 1ère situation 2ème situation ©2005 Texas Instruments - Jean Winther 12 3ème situation Exemples d’exercices classiques traités avec le programme d’aide à la résolution Exercice 1 Quelles sont les masses des objets marqués d’un point d’interrogation ? M2 ? M1 ? 45 ° 30 ° A Conseils : 1. bilan des forces sur le noeud A 2. tracé du dynamique des forces (échelle conseillée : 2cm pour 1 N). Ce tracé se construit à l’aide du vecteur représentant la force exercée par le dynamomètre, et des directions des deux autres vecteurs données par les angles 3. lecture graphique du poids des objets M1 et M2 4. calcul des masses correspondantes On prendra g = 10 N/kg Attention à l’échelle du dynamomètre ! ©2005 Texas Instruments - Jean Winther 13 M1 =4 kg M2= 3,6 kg ©2005 Texas Instruments - Jean Winther 14 Exercice 2 Sciences BEP 2004 Exercice n ° 4 (7 pts) G B O 60 ° A Echelle des forces : 1 cm représente 200 N Mécanique « Stabilité d’une échelle » Un peintre effectue le ravalement d’une façade de maison. On note m1 la masse du peintre et du bidon de peinture. m1 = 80 kg. Il appuie contre le mur son échelle de longueur AB = 4 m, de masse m2 = 20 kg et monte sur celle-ci pour travailler. Le centre de gravité de l’ensemble est le point G (voir dessin ci-contre) L’angle aigu que fait le plan de l’échelle (AB) avec le sol, a pour mesure 60°, 1. Calculer la valeur du poids total P de l’ensemble (peintre et échelle). 2. Représenter le poids P sur le dessin en respectant l’échelle indiquée. (la position de G ne pouvant se mesurer que sur le document distribué aux candidats nous indiquons pour ce document que AG=2,768m) Le mur est lisse et la réaction, RB, du mur en B est une force ayant sa droite d’action horizontale. B La réaction du sol en A sur l’échelle, est une force notée RA. 3. L’échelle étant en équilibre, déterminer le point de concours des droites d’action des trois forces sur le dessin. Ce point est nommé C. 4. Construire le dynamique des forces sur le dessin. 5. Compléter le tableau des forces ci-après Force Point d’application Droite d’action Sens Intensité (N) ⎯⎯→ P ⎯⎯→ RA α = .......... ⎯⎯→ RB α Dans la réalité, la nature du contact entre l’échelle et le sol en A fait que l’échelle ne glisse pas tant que l’angle entre ⎯→ RA et l’horizontale est au moins égal à 75°. 6. Cette condition est-elle réalisée? Justifier. Comment peut-on augmenter la stabilité de l’échelle ? Donnée g = 10 N/kg ©2005 Texas Instruments - Jean Winther 15 Correction Exercice n ° 4 (7 pts) Mécanique « Stabilité d’une échelle » Un peintre effectue le ravalement d’une façade de maison. On note m1 la masse du peintre et du bidon de peinture. m1 = 80 kg. Il appuie contre le mur son échelle de longueur AB = 4 m, de masse m2 = 20 kg et monte sur celle-ci pour travailler. Le centre de gravité de l’ensemble est le point G (voir dessin ci-contre) L’angle aigu que fait le plan de l’échelle (AB) avec le sol, a pour mesure 60°, 7. Poids total P : P = (m1 + m2) x g = (80 + 20) x 10 = 1000 N 8. Représenter le poids P (le vecteur est vertical, dirigé vers le bas, et mesure 5 cm) 9. Le point C se situe à l’intersection de la verticale passant par G et de l’horizontale passant par B. 10. Dynamique des forces : on le construit à partir du vecteur à l’aide de parallèles aux deux droites d’action (BC) et (AC). La mesure des vecteurs donne 5,5 cm et 2 cm, ce qui, traduit de l’échelle du dessin, nous donne RA = 5,5 x 200 = 1 100 N et RB = 2 x 200 = 400 N G B O 60 ° A → P C B 11. Compléter le tableau des forces ci-après Force Point d’application Droite d’action Sens Intensité (N) 1 000 ⎯⎯→ P G ⎯⎯→ RA A α = 65 ° α 1 100 ⎯⎯→ RB B 400 12. Cette condition est-elle réalisée ? Non, l’angle est de 65° < 75° Pour augmenter la stabilité de l’échelle il suffit de la rapprocher du mur. ©2005 Texas Instruments - Jean Winther 16 Résolution générale de ce type d’exercice 1°) Dans le cas d’une échelle appuyée sur un mur le centre de gravité G est au milieu de AB D’après la figure on peut écrire les relations suivantes : tan β =KB/KC=(L/2)/H β = arc tang((L/2)/H) P=R2 cos β R2=P/ cos β R1= P tan β =P * (L/2)/H 2°) Dans le cas où une personne monte sur l’échelle le centre de gravité est déplacé et dépend de la position de cette personne sur l’échelle et G n’est pas, en général, au milieu de AB. ©2005 Texas Instruments - Jean Winther 17 Les relations du premier cas sont modifiées comme suit : tan β =KB/KC=KB/H β = arc tang(KB/H) P=R2 cos β R2=P/ cos β R1= P tan β =P * (L/2)/H Retour à l’exercice de BEP Dans cet exercice on est dans le cas où l’on connaît une force et deux directions. R1=RB et R2=RA G n’est pas au milieu de AB AG=2,768m. Il faut déterminer l’angle β pour ensuite déterminer RA et RB. Il est possible de faire toutes ces opérations graphiquement. Pour des raisons évidentes nous procèderons numériquement. L’angle α de notre figure n’est pas celui demandé dans le tableau de l’exercice ici α=60° Calcul de KB KB =AG cos 60° = 2,768 * cos 60°=1,384m Calcul de H H=AB sin 60° = 4*sin 60° = 3,46m tan β = KB/H= 1,384/3,46=0,4 β = 21,8° ©2005 Texas Instruments - Jean Winther 18 Calcul de l’angle α de l’exercice x=180 – (90+ α)- β=90-60-21,8= 8,2° L’angle cherché est 68,2° ©2005 Texas Instruments - Jean Winther 19 Un autre problème classique : étude de l’équilibre d’une console 1er cas : la console est de poids négligeable. Les directions des 3 forces sont concourantes à l’extrémité de la console. On connaît une force P et 2 directions. 2ème cas : la console n’est pas de poids négligeable. Les directions des 3 forces sont concourantes au centre de gravité de la barre. ©2005 Texas Instruments - Jean Winther 20 Un exemple d’une erreur dans un sujet d’examen (académie de Rennes) ©2005 Texas Instruments - Jean Winther 21 ©2005 Texas Instruments - Jean Winther 22 Rectification Tel qu’il est l’énoncé est faux car les directions des 3 forces ne sont pas concourantes ! Il faudrait que F2 ait la position suivante : ©2005 Texas Instruments - Jean Winther 23 Cisco Unified Communications Manager Express System Administrator Guide Last Modified: 2017-11-30 Americas Headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 USA http://www.cisco.com Tel: 408 526-4000 800 553-NETS (6387) Fax: 408 527-0883 THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS. THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY. The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California. NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS" WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE. IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figuresincluded in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbersin illustrative content is unintentional and coincidental. Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: http:// www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R) © 2017 Cisco Systems, Inc. All rights reserved. CONTENTS CHAPTER 1 Cisco Unified CME Features Roadmap 1 Obtaining Documentation, Obtaining Support, and Security Guidelines 65 CHAPTER 2 Cisco Unified CME Overview 67 Important Information about Cisco IOS XE 16 Denali 67 Introduction 67 Licenses 69 Cisco Unified CME Permanent License 69 Collaboration Professional Suite License 70 Cisco Smart License 70 Licensing Modes 72 Restrictions 72 PBX or Keyswitch 73 PBX Model 73 Keyswitch Model 74 Hybrid Model 75 Call Detail Records 75 Additional References 76 Management Information Base 77 CHAPTER 3 Before You Begin 79 Prerequisites for Configuring Cisco Unified CME 79 Restrictions for Configuring Cisco Unified CME 80 Information About Planning Your Configuration 81 System Design 81 Toll Fraud Prevention 82 Cisco Unified CME Workflow 83 Install Cisco Voice Services Hardware 87 Cisco Unified Communications Manager Express System Administrator Guide iii Install Cisco IOS Software 89 Configure VLANs on a Cisco Switch 90 Network Assistant 90 Cisco IOS Commands 91 Internal Cisco Ethernet Switching Module 94 Using Cisco IOS Commands 95 Voice Bundles 97 Cisco Unified CME GUI 98 CHAPTER 4 Install and Upgrade Cisco Unified CME Software 101 Prerequisites for Installing Cisco Unified CME Software 101 Cisco Unified CME Software 101 Basic Files 102 GUI Files 102 Phone Firmware Files 102 XML Template 104 Music-on-Hold (MOH) File 104 Script Files 104 Bundled TSP Archive 104 File Naming Conventions 105 Install and Upgrade Cisco Unified CME Software 105 Install Cisco Unified CME Software 105 Upgrade or Downgrade SCCP Phone Firmware 107 Upgrade or Downgrade SIP Phone Firmware 108 Phone Firmware Conversion from SCCP to SIP 112 Phone Firmware Conversion from SIP to SCCP 115 Remove SIP Configuration Profile 116 Generate SCCP XML Configuration File to Upgrade from SIP to SCCP 117 Example 119 What to Do Next 119 Verify SCCP Phone Firmware Version 119 Troubleshooting Tips for Cisco Phone Firmware 120 CHAPTER 5 Network Parameters 121 Prerequisites for Defining Network Parameters 121 Cisco Unified Communications Manager Express System Administrator Guide iv Contents Restrictions for Defining Network Parameters 122 Information About Defining Network Parameters 122 DHCP Service 122 Network Time Protocol for the Cisco Unified CME Router 122 Olson Timezones 122 DTMF Relay 123 SIP Register Support 124 Define Network Parameters 125 Enable Calls in Your VoIP Network 125 Configure DHCP 127 Configure Single DHCP IP Address Pool 127 Configure Separate DHCP IP Address Pool for Each DHCP Client 129 Configure DHCP Relay 131 Enable Network Time Protocol 133 Set Olson Timezone for SCCP Phones 134 Set Olson Timezone for SIP Phones 137 Configure DTMF Relay for H.323 Networks in Multisite Installations 141 Configure SIP Trunk Support 142 Verify SIP Trunk Support Configuration 144 Change the TFTP Address on a DHCP Server 144 Configuration Examples for Network Parameters 146 NTP Server 146 DTMF Relay for H.323 Networks 146 Where to Go Next 146 Feature Information for Network Parameters 146 CHAPTER 6 System-Level Parameters 149 Prerequisites for System-Level Parameters 149 Information About Configuring System-Level Parameters 149 Bulk Registration Support for SIP Phones 149 Register Transaction 151 Phone Status Update Transaction 153 DSCP 155 Maximum Ephones in Cisco Unified CME 4.3 and Later Versions 155 Network Time Protocol for SIP Phones 156 Cisco Unified Communications Manager Express System Administrator Guide v Contents Per-Phone Configuration Files 156 HFS Download Support for IP Phone Firmware and Configuration Files 157 Enable HFS Service 158 File Binding and Fetching 159 Locale Installer 159 Security Recommendations 159 Redundant Cisco Unified CME Router for SCCP Phones 160 Redundant Cisco Unified CME Router for SIP Phones 161 Timeouts 162 IPv6 Support for Cisco Unified CME SCCP Endpoints 162 Support for IPv4-IPv6 (Dual-Stack) 163 Media Flow Through and Flow Around 163 Media Flow Around Support for SIP-SIP Trunk Calls 163 Overlap Dialing Support for SIP and SCCP IP Phones 164 Unsolicited Notify for Shared Line and Presence Events for Cisco Unified SIP IP Phones 165 Interface Support for Unified CME and Unified SRST 166 Configure System-Level Parameters 167 Configure IP Phones in IPv4, IPv6, or Dual Stack Mode 167 Example 168 Configure IPv6 Source Address for SCCP IP Phones 169 Verify IPv6 and Dual-Stack Configuration 170 Configure Bulk Registration 172 Configure Bulk Registration for SIP IP Phones 174 Verify Phone Registration Type and Status 175 Set Up Cisco Unified CME for SCCP Phones 175 Set Date and Time Parameters for SCCP Phones 178 Block Automatic Registration for SCCP Phones 180 Define Per-Phone Configuration Files and Alternate Location for SCCP Phones 181 Modify Defaults for Timeouts for SCCP Phones 182 Configure Redundant Router for SCCP Phones 184 Configure Redundant Router for SIP Phones 186 Configure Version Stamp Synchronization on the Primary Router 188 Configure the XML Interface for the Secondary Backup Router 189 Configure Overlap Dialing on SCCP IP Phones 190 Cisco Unified Communications Manager Express System Administrator Guide vi Contents Set Up Cisco Unified CME for SIP Phones 192 Set Up Cisco Unified CME for SIP Phones 195 Set Date and Time Parameters for SIP Phones 197 Set Network Time Protocol for SIP Phones 199 Enable HFS Download Service for SIP Phones 200 Troubleshooting HFS Download Service 202 Configure HFS Home Path for SIP Phone Firmware Files 202 Change Session-Level Application for SIP Phones 204 Enable Media Flow Mode on SIP Trunks 205 Configure Overlap Dialing on SIP Phones 207 Configuration Examples for System-Level Parameters 209 Example for Bulk Registration Support for SIP Phones 209 Example for IPv6 Support on Cisco Unified CME 209 Example for System-Level Parameters 212 Example for Blocking Automatic Registration 213 Example for Enabling the HFS Download Service for Cisco Unified SIP IP Phone 214 Example for Configuring an HFS Home Path for Cisco Unified SIP IP Phone Firmware Files 214 Example for Verifying the HFS File Bindings of Cisco Unified SIP IP Phone Configuration and Firmware Files 214 Example for Redundant Router for SCCP Phones 215 Example for Redundant Router for SIP Phones 215 Example for Media Flow Around Mode for SIP Trunks 216 Example for Configuring Overlap Dialing for SCCP IP Phones 217 Example for Configuring Overlap Dialing for SIP IP Phones 218 Where to Go Next 219 Feature Information for System-Level Parameters 219 CHAPTER 7 Configuring Phones to Make Basic Calls 223 Prerequisites for Configuring Phones to Make Basic Calls 223 Restrictions for Configuring Phones to Make Basic Calls 224 Information About Configuring Phones to Make Basic Calls 224 Phones in Cisco Unified CME 224 Directory Numbers 224 Single-Line 225 Cisco Unified Communications Manager Express System Administrator Guide vii Contents Dual-Line 225 Octo-Line 226 Feature Comparison by Directory Number Line-Mode on SCCP Phones 227 SIP Shared-Line (Nonexclusive) 228 Two Directory Numbers with One Telephone Number 228 Dual-Number 230 Shared Line (Exclusive) 231 Mixed Shared Lines 231 Incoming and Outgoing Calls 232 Hold and Resume 232 Privacy on Hold 232 Call Transfer and Forwarding 232 Call Pickup 233 Call Park 233 Message Waiting Indication 233 Software Conferencing 233 Dial Plan 234 Busy Lamp Field Speed-Dial Monitoring 234 Restrictions For Mixed Shared Lines 234 Overlaid Directory Numbers 234 Auto Registration of SIP Phones on Cisco Unified CME 235 Syslog Messages 237 Monitor Mode for Shared Lines 237 Watch Mode for Phones 238 PSTN FXO Trunk Lines 239 Codecs for Cisco Unified CME Phones 239 Analog Phones 241 Cisco ATAs in SCCP Mode 241 FXS Ports in SCCP Mode 241 FXS Ports in H.323 Mode 241 Fax Support 241 Cisco ATA-187 242 Cisco VG202, VG204, and VG224 Auto Configuration 242 Internet Protocol - Secure Telephone Equipment Support 242 Secure Communications Between STU, STE, and IP-STE 243 Cisco Unified Communications Manager Express System Administrator Guide viii Contents SCCP Media Control for Secure Mode 243 Secure Communication Between STE, STU, and IP-STE Across SIP Trunk 244 Remote Teleworker Phones 244 Media Termination Point for Remote Phones 245 G.729r8 Codec on Remote Phones 245 Busy Trigger and Channel Huntstop for SIP Phones 246 Multiple Calls Per Line 246 Cisco Unified 8941 and 8945 SCCP IP Phones 246 Cisco Unified 6921, 6941, 6945, 6961, 8941, and 8945 SIP IP Phones 247 Digit Collection on SIP Phones 247 Key Press Markup Language Digit Collection 247 SIP Dial Plans 247 Session Transport Protocol for SIP Phones 248 Real-Time Transport Protocol Call Information Display Enhancement 248 Ephone-Type Configuration 249 7926G Wireless SCCP IP Phone Support 249 KEM Support for Cisco Unified SIP IP Phones 250 Key Mapping 250 Call Control 250 XML Updates 251 Restrictions for KEM Support 251 Fast-Track Configuration Approach for Cisco Unified SIP IP Phones 251 Configure Phones for a PBX System 253 Create Directory Numbers for SCCP Phones 253 Configure Ephone-Type Templates for SCCP Phones 256 Ephone-Type Parameters for Supported Phone Types 258 Assign Directory Numbers to SCCP Phones 260 Create Directory Numbers for SIP Phones 263 Assign Directory Numbers to SIP Phones 266 Configure Dial Plans for SIP Phones 269 Troubleshooting Tips for Configuring Dial Plans for SIP 272 Verify SIP Dial Plan Configuration 272 Enable KPML on a SIP Phone 273 Select Session-Transport Protocol for a SIP Phone 275 Disable SIP Proxy Registration for a Directory Number 276 Cisco Unified Communications Manager Express System Administrator Guide ix Contents Modify the Global Codec 278 Configure Codecs of Individual Phones for Calls Between Local Phones 280 Configure Phones for a Key System 282 Creating Directory Numbers for a Simple Key System on SCCP Phone 282 Configure Trunk Lines for a Key System on SCCP Phone 284 Configure a Simple Key System Phone Trunk Line Configuration on SCCP Phone 285 Configure an Advanced Key System Phone Trunk Line Configuration on SCCP Phone 289 Configure Individual IP Phones for Key System on SCCP Phone 293 Configure Cisco ATA, Analog Phone Support, Remote Phones, Cisco IP Communicator, and Secure IP Phone (IP-STE) 295 Configure Cisco ATA Support 295 Verify Cisco ATA Support 297 Troubleshooting Cisco ATA Support 297 Call Pickup and Group Call Pickup with Cisco ATA 297 Configure Voice and T.38 Fax Relay on Cisco ATA-187 298 Auto-Configuration for Cisco VG202, VG204, and VG224 302 Configure Phones on SCCP Controlled Analog (FXS) Ports 305 Verify Analog Phone Support 307 Enable Remote Phone 307 Verify Remote Phones 310 Configure Cisco IP Communicator Support on SCCP Phone 310 Verify Cisco IP Communicator Support on SCCP Phone 311 Troubleshooting Cisco IP Communicator Support on SCCP Phone 311 Configure Secure IP Phone (IP-STE) on SCCP Phone 311 Configure Phone Services XML File for Cisco Unified Wireless Phone 7926G 313 Configure Phones to Make Basic Call 315 Configure Auto Registration for SIP Phones 315 Configure a Mixed Shared Line 317 Troubleshooting Tips for Mixed Shared Line 319 Configure the Maximum Number of Calls on SCCP Phone 319 Configure the Busy Trigger Limit on SIP Phone 322 Configure KEMs on SIP Phones 324 Provision SIP Phones to Use the Fast-Track Configuration Approach 325 SIP Phone Models Validated for CME using Fast-track Configuration 328 Cisco Unified Communications Manager Express System Administrator Guide x Contents Configuration Examples for Making Basic Calls 328 Example for Configuring SCCP Phones for Making Basic Calls 328 Example for Configuring SIP Phones for Making Basic Calls 332 Example for Disabling a Bulk Registration for a SIP Phone 334 Example for Configuring a Mixed Shared Line on a Second Common Directory Number 334 Example for Cisco ATA 335 Example for SCCP Analog Phone 335 Example for Remote Teleworker Phones 336 Example for Secure IP Phone (IP-STE) 336 Example for Configuring Phone Services XML File for Cisco Unified Wireless Phone 7926G 336 Example for Monitoring the Status of Key Expansion Modules 337 Cisco IOS Commands for Monitoring and Maintaining Cisco Unified CME 339 Example for Fast-Track Configuration Approach 340 Where To Go Next 341 Feature Information for Configuring Phones to Make Basic Calls 341 CHAPTER 8 Create Phone Configurations Using Extension Assigner 347 Prerequisites for Extension Assigner 347 Restrictions for Extension Assigner 348 Information About Extension Assigner 348 Extension Assigner Overview 348 Procedure for System Administrators 348 Extension Assigner in Mixed Deployment 352 Procedures for Installation Technicians 353 Files Included in this Release 353 Extension Assigner Synchronization 354 Configure Extension Assigner 354 Determine Extension Numbers to Assign to the New Phones and Plan Your Configuration 355 Download the Tcl Script and Audio Prompt Files 355 Configure the Tcl Script 356 Specify the Extension for Accessing Extension Assigner Application 358 Configure Provision-Tags for the Extension Assigner Feature 360 Configure Temporary Extension Numbers for SCCP Phones That Use Extension Assigner 361 Configure Temporary Extension Numbers for SIP Phones That Use Extension Assigner 363 Cisco Unified Communications Manager Express System Administrator Guide xi Contents Configure Extension Numbers That Installation Technicians Can Assign to SCCP Phones 364 Configure Extension Numbers That Installation Technicians Can Assign to SIP Phones 366 Configure Ephones with Temporary MAC Addresses 368 Configure Voice Register Pools with Temporary MAC Addresses 370 Configure the Router to Automatically Save Your Configuration 372 Provide the Installation Technician with the Required Information 374 Configure Extension Assigner Synchronization 375 Configure the XML Interface for the Secondary Backup Router 375 Configure Extension Assigner Synchronization on the Primary Router 376 Assign Extension Numbers Onsite by Using Extension Assigner 378 Assign New Extension Numbers 378 Unassign an Extension Number 378 Reassign the Current Extension Number 379 Verify Extension Assigner Configuration for SCCP Phones 380 Verify Extension Assigner Configuration for SIP Phones 380 Configuration Examples for Extension Assigner 380 Example for Extension Assigner on SCCP Phone 380 Example for Extension Assigner on SIP Phone 383 Example for Extension Assigner Synchronization 384 Feature Information for Extension Assigner 384 CHAPTER 9 Configuration Files for Phones 387 Information About Configuration Files 387 Configuration Files for Phones 387 Per-Phone Configuration Files 388 Generate Configuration Files for Phones 388 Generate Configuration Files for SCCP Phones 388 Verify Configuration Files for SCCP Phones 390 Generate Configuration Profiles for SIP Phones 391 Verify Configuration Profiles for SIP Phones 392 Where To Go Next 395 CHAPTER 10 Reset and Restart Cisco Unified IP Phones 397 Information About Resetting and Restarting Phones 397 Cisco Unified Communications Manager Express System Administrator Guide xii Contents Differences between Resetting and Restarting IP Phones 397 Cisco Unified CME TAPI Enhancement 398 Reset and Restart Phones 399 Use the reset Command on SCCP Phones 399 Use the restart Command on SCCP Phones 400 Reset a Session Between a TAPI Application and an SCCP Phone 401 Use the reset Command on SIP Phones 402 Use the restart Command on SIP Phones 403 Verify Basic Call 405 Feature Information for Reset and Restart Phones 405 CHAPTER 11 Localization Support 407 Information About Localization 407 Localization Enhancements in Cisco Unified CME 407 System-Defined Locales 408 Localization Support for Cisco Unified SIP IP Phones 409 User-Defined Locales 409 Localization Support for Phone Displays 409 Multiple Locales 410 Locale Installer for Cisco Unified SCCP IP Phones 410 Locale Installer for Cisco Unified SIP IP Phones 411 Configure Localization Support on SCCP Phones 411 Install System-Defined Locales for Cisco Unified IP Phone 6921, 6945, 7906, 7911, 7921, 7931, 7941, 7961, 7970, 7971, and Cisco IP Communicator 411 Install User-Defined Locales 415 Use the Locale Installer in Cisco Unified CME 7.0(1) and Later Versions 419 Verify User-Defined Locales 422 Configure Multiple Locales on SCCP Phones 422 Verify Multiple Locales on SCCP Phones 426 Configure Localization Support on SIP Phones 427 Install System-Defined Locales for Cisco Unified IP Phone 8961, 9951, and 9971 427 Use the Locale Installer in Cisco Unified CME 9.0 and Later Versions 431 Configure Multiple Locales on SIP Phones 434 Verify Multiple Locales on SIP Phones 437 Configuration Examples for Localization 437 Cisco Unified Communications Manager Express System Administrator Guide xiii Contents Example for Configuring Multiple User and Network Locales 437 Example for Configuring User-Defined Locales 438 Example for Configuring Chinese as the User-Defined Locale 439 Example for Configuring Swedish as the System-Defined Locale 439 Configuration Examples for Locale Installer on SCCP Phones 440 System-Defined Locale is the Default Applied to All Phones 440 User-Defined Locale is Default Language to be Applied to All Phones 440 Locale on a Non-default Locale Index 441 Examples for Configuring Multiple User and Network Locales on SIP Phones 442 Example for Configuring Locale Installer on SIP Phones 443 Where to Go Next 443 Feature Information for Localization Support 443 CHAPTER 12 Dial Plans 445 Information About Dial Plans 445 Phone Number Plan 445 Dial Plan Patterns 446 Direct Inward Dialing Trunk Lines 447 Voice Translation Rules and Profiles 448 Secondary Dial Tone 448 E .164 Enhancements 448 Phone Registration with Leading + E164 Number 449 Example 1 449 Example 2 450 Example 3 450 Callback and Calling Number Display 451 Configure Dial Plans 451 Configure SCCP Dial Plan Patterns 451 Configure SIP Dial Plan Patterns 452 Verify Dial Plan Patterns 454 Define Voice Translation Rules in Cisco CME 3.2 and Later Versions 454 Apply Voice Translation Rules on SCCP Phones in Cisco Unified CME 3.2 and Later Versions 457 Apply Translation Rules on SCCP Phones Before Cisco Unified CME 3.2 458 Apply Voice Translation Rules on SIP Phones in Cisco Unified CME 4.1 and Later 459 Cisco Unified Communications Manager Express System Administrator Guide xiv Contents Apply Voice Translation Rules on SIP Phones Before Cisco Unified CME 4.1 460 Verify Voice Translation Rules and Profiles 462 Activate Secondary Dial Tone For SCCP Phones 463 Activate Secondary Dial Tone for SIP Phones 464 Define Translation Rules for Callback-Number on SIP Phones 466 Configuration Examples for Dial Plan Features 469 Example for Configuring Secondary Dial Tone on SCCP Phones 469 Example for Configuring Secondary Dial Tone on SIP Phones 469 Example for Configuring Voice Translation Rules 469 Feature Information for Dial Plan Features 471 CHAPTER 13 Transcoding Resources 473 Prerequisites for Configuring Transcoding Resources 473 Restrictions for Configuring Transcoding Resources 474 Information About Transcoding Resources 474 Transcoding Support 474 Local Transcoding Interface (LTI) Based Transcoding 477 Transcoding When a Remote Phone Uses G.729r8 478 Secure DSP Farm Transcoding 479 Configure Transcoding Resources 479 Determine DSP Resource Requirements for Transcoding 479 Provision Network Modules or PVDMs for Transcoding 479 Configure DSP Farms for NM-HDs and NM-HDV2s 481 Configure DSP Farms for NM-HDVs 485 Configure the Cisco Unified CME Router to Act as the DSP Farm Host 487 Determine the Maximum Number of Transcoder Sessions 487 Set the Cisco Unified CME Router to Receive IP Phone Messages 487 Configure the Cisco Unified CME Router to Host a Secure DSP Farm 489 Modify DSP Farms for NM-HDVs After Upgrading Cisco IOS Software 490 Modify the Number of Transcoding Sessions for NM-HDVs 491 Tune DSP-Farm Performance on an NM-HDV 492 Verify DSP Farm Operation 493 Register the DSP Farm with Cisco Unified CME 4.2 or a Later Version in Secure Mode 496 Obtain Digital Certificate from a CA Server 496 Configure a CA Server 496 Cisco Unified Communications Manager Express System Administrator Guide xv Contents Create a Trustpoint 499 Authenticate and Enroll a Certificate with the CA Server 501 Copy the CA Root Certificate of the DSP Farm Router to the Cisco Unified CME Router 502 Copy CA Root Certificate of the Cisco Unified CME Router to the DSP Farm Router 503 Configure Cisco Unified CME to Allow the DSP Farm to Register 503 Verify DSP Farm Registration with Cisco Unified CME 504 Configure LTI-based Transcoding 506 Configuration Examples for Transcoding Resources 508 Example for Setting up DSP Farms for NM-HDVs 508 Example for Setting Up DSP Farms for NM-HDs and NM-HDV2s 508 Example for Configuring Cisco Unified CME Router as the DSP Farm Host 509 Example for Configuring LTI-based Transcoding 509 Example for Configuring Voice Class Codec 509 Where to go Next 510 Feature Information for Transcoding Resources 510 CHAPTER 14 Toll Fraud Prevention 511 Prerequisites for Configuring Toll Fraud Prevention 511 Information About Toll Fraud Prevention 511 IP Address Trusted Authentication 511 Direct Inward Dial for Incoming ISDN Calls 512 Disconnect ISDN Calls With No Matching Dial-peer 513 Block Two-stage Dialing Service on Analog and Digital FXO Ports 513 Configure Toll Fraud Prevention 513 Configure IP Address Trusted Authentication for Incoming VoIP Calls 513 Add Valid IP Addresses For Incoming VoIP Calls 515 Configure Direct Inward Dial for Incoming ISDN Calls 517 Block Secondary Dial tone on Analog and Digital FXO Ports 518 Troubleshooting Tips for Toll Fraud Prevention 520 Feature Information for Toll Fraud Prevention 521 CHAPTER 15 Graphical User Interface 523 Prerequisites for Enabling the GUI 523 Cisco Unified Communications Manager Express System Administrator Guide xvi Contents Restrictions for Enabling the GUI 523 Information About Enabling the GUI 524 Cisco Unified CME GUI Support 524 AAA Authentication 525 Enable the GUI 525 Enable the HTTP Server 525 Enable GUI Access for the System Administrator 526 Access the Cisco Unified CME GUI 528 Create a Customized XML File for Customer Administrator GUI 529 GUI Access for Customer Administrators 530 Prerequisites for Enabling GUI Access to Customer Administrators 530 Define a Customer Administrator Account Using GUI 531 Define a Customer Administrator Account Using Cisco IOS Software Commands 531 GUI Access for Phone Users 532 Prerequisites for Enabling GUI Access for Phone Users 532 Define a Phone User Account Using GUI 532 Define a Phone User Account Using Cisco IOS Software Commands 533 Troubleshooting the GUI 534 Configuration Examples for Enabling the GUI 534 Example for Configuring HTTP Server and System Administrator Account 534 Example for Configuring XML Configuration File Template 534 Example for Configuring XML Configuration File 535 Feature Information for Enabling the GUI 536 CHAPTER 16 Voice Mail Integration 539 Prerequisites for Voice Mail Integration 539 Information About Voice-Mail Integration 540 Cisco Unity Connection Integration 540 Cisco Unity Express Integration 541 Cisco Unity Integration 541 DTMF Integration for Legacy Voice-Mail Applications 541 Mailbox Selection Policy 541 RFC 2833 DTMF MTP Pass through 542 MWI Line Selection 542 AMWI 543 Cisco Unified Communications Manager Express System Administrator Guide xvii Contents SIP MWI Prefix Specification 543 SIP MWI - QSIG Translation 543 VMWI 544 Transfer to Voice Mail 545 Live Record 545 Cisco Unity Express AXL Enhancement 546 Configure Voice-Mail Integration 546 Configure a Voice Mailbox Pilot Number on a SCCP Phone 546 Configure a Mailbox Selection Policy on SCCP Phone 547 Set a Mailbox Selection Policy for Cisco Unity Express or a PBX Voice-Mail Number 548 Set a Mailbox Selection Policy for Cisco Unity 549 Transfer to Voice Mail 551 Configure Live Record on SCCP Phones 554 Configure a Voice Mailbox Pilot Number on a SIP Phone 557 Enable DTMF Integration 560 Enable DTMF Integration for Analog Voice-Mail Applications 560 Enable DTMF Integration Using RFC 2833 562 Enable DTMF Integration Using SIP NOTIFY 565 Configure a SCCP Phone for MWI Outcall 567 Enable MWI at the System-Level on SIP Phones 568 Configure a Directory Number for MWI on SIP Phones 570 Define Pilot Call Back Number for MWI Outcall 570 Configure a Directory Number for MWI NOTIFY 571 Enable SIP MWI Prefix Specification 573 Configure VMWI on SIP Phones 574 Verify Voice-Mail Integration 576 Configuration Examples for Voice-Mail Integration 576 Example for Setting up a Mailbox Selection Policy for SCCP Phones 576 Example for Configuring Voice Mailbox for SIP Phones 576 Example for Configuring DTMF Integration Using RFC 2833 577 Example for Configuring DTMF Integration Using SIP Notify 577 Example for Configuring DTMF Integration for Legacy Voice-Mail Applications 577 Example for Enabling SCCP Phone Line for MWI 577 Example for Configuring SIP MWI Prefix Specification 578 Cisco Unified Communications Manager Express System Administrator Guide xviii Contents Example for Configuring SIP Directory Number for MWI Outcall 578 Example for Configuring SIP Directory Number for MWI Unsolicited Notify 579 Example for Configuring SIP Directory Number for MWI Subscribe/NOTIFY 579 Feature Information for Voice-Mail Integration 579 CHAPTER 17 Security 581 Prerequisites for Security 581 Restrictions for Security 582 Information About Security 582 Phone Authentication Overview 582 Phone Authentication 583 File Authentication 583 Signaling Authentication 583 Public Key Infrastructure 584 Phone Authentication Components 584 Phone Authentication Process 588 Startup Messages 589 Configuration File Maintenance 590 CTL File Maintenance 590 CTL Client and Provider 590 Manually Importing MIC Root Certificate 591 Feature Design of Media Encryption 591 Secure Cisco Unified CME 591 Secure Supplementary Services 593 Secure SIP Trunk Support on Cisco Unified CME 593 Secure Cisco Unified CME in an H.450 Environment 594 Secure Cisco Unified CME in a Non H.450 Environment 594 Secure Transcoding for Remote Phones with DSP Farm Transcoding Configured 595 Secure Cisco Unified CME with Cisco Unity Express 596 Secure Cisco Unified CME with Cisco Unity 596 HTTPS Provisioning For Cisco Unified IP Phones 596 HTTPS support for an External Server 597 HTTPS Support in Cisco Unified CME 597 Configure Security 597 Configure the Cisco IOS Certification Authority 597 Cisco Unified Communications Manager Express System Administrator Guide xix Contents Obtain Certificates for Server Functions 601 Configure Telephony-Service Security Parameters 604 Verify Telephony-Service Security Parameters 606 Configure the CTL Client 607 Configure the CTL Client on a Cisco Unified CME Router 607 Configure the CTL Client on a Router That is Not a Cisco Unified CME Router 610 Configure the CAPF Server 612 Verify the CAPF Server 615 Configure Ephone Security Parameters 615 Verify Ephone Security Parameters 618 Configure the CTL Provider 619 Verify the CTL Provider 620 Configure the Registration Authority 621 Enter the Authentication String on the Phone 625 Manually Import the MIC Root Certificate 626 Configure Media Encryption (SRTP) in Cisco Unified CME 629 Configure Cisco Unified CME SRTP Fallback for H.323 Dial Peers 631 Configure Cisco Unity for Secure Cisco Unified CME Operation 633 Prerequisites for Configuring Cisco Unity for Secure Cisco Unified CME Operation 633 Configure Integration Between Cisco Unified CME and Cisco Unity 634 Import the Cisco Unity Root Certificate to Cisco Unified CME 634 Configure Cisco Unity Ports for Secure Registration 636 Verify that Cisco Unity are Registering Securely 636 HTTPS Provisioning for Cisco Unified IP Phones 637 Configuration Examples for Security 643 Example for Configuring Cisco IOS CA 643 Example for Manually Importing MIC Root Certificate on the Cisco Unified CME Router 643 Example for Configuring Telephony-Service Security Parameters 646 Example for Configuring CTL Client Running on Cisco Unified CME Router 646 Example for Secure Unified CME 648 Example for Configuring HTTPS Support for Cisco Unified CME 655 Where to Go Next 656 Feature Information for Security 656 Cisco Unified Communications Manager Express System Administrator Guide xx Contents CHAPTER 18 Directory Services 659 Information About Directory Services 659 Local Directory 659 External Directory 660 Called-Name Display 660 Directory Search 661 Configure Directory Services 661 Configure Local Directory Service 661 Define a Name for a Directory Number on SCCP Phone 662 Add an Entry to a Local Directory on SCCP Phone 663 Configure External Directory Service on SCCP Phone 665 Called-Name Display 666 Verify Called-Name Display 668 Define a Name for a Directory Number on SIP Phone 669 Configure External Directory Service on SIP Service 670 Verify Directory Services 671 Configuration Examples for Directory Services 672 Example for Configuring Local Directory 672 Example for Configuring Called-Name Display 672 Example for Called-Name Display for Voice Hunt Group 672 Example for Configuring First Ephone-dn in the Overlay Set 673 Example for Configuring Directory Name for an Overlaid Ephone-dn Set 673 Example for Configuring Directory Name for a Hunt Group with Overlaid Ephone-dns 674 Example for Configuring Directory Name for Non-Overlaid Ephone-dns 675 Example for Configuring Ephone-dn Name for Overlaid Ephone-dns 675 Feature Information for Directory Services 676 CHAPTER 19 Do Not Disturb 679 Information About Do Not Disturb 679 Do Not Disturb on SCCP Phone 679 Do Not Disturb on SIP Phone 680 Configure Do Not Disturb 681 Blocking Do Not Disturb on SCCP Phone 681 Verify Do Not Disturb on SCCP Phones 682 Cisco Unified Communications Manager Express System Administrator Guide xxi Contents Configure Do Not Disturb on SIP Phones 683 Where to Go Next 685 Feature Information for Do Not Disturb 686 CHAPTER 20 Enhanced 911 Services 687 Prerequisites for Enhanced 911 Services 687 Restrictions for Enhanced 911 Services 688 Information About Enhanced 911 Services 688 Overview of Enhanced 911 Services 688 Call Processing for E911 Services 691 Precautions for Mobile Phones 693 Plan Your Implementation of Enhanced 911 Services 693 Interactions with Existing Cisco Unified CME Features 695 Multiple Usages of an ELIN 696 Number Translation 696 Call Transfer 697 Call Forward 697 Call Blocking Features 697 Call Waiting 697 Three-Way Conference 697 Dial-Peer Rotary 697 Dial Plan Patterns 698 Caller ID Blocking 698 Shared Line 698 Configure Enhanced 911 Services 698 Configure the Emergency Response Location 698 Configure Locations under Emergency Response Zones 700 Configure Outgoing Dial Peers for Enhanced 911 Services 701 Configure Dial Peers for Emergency Calls 701 Configure Dial Peers for Emergency Response Zones 703 Configure a Dial Peer for Callbacks from the PSAP 704 Assign ERLs to Phones 706 Prerequisites for Assigning ERLs to Phones 706 Assign an ERL to a Phone’s IP Subnet 706 Assign an ERL to a SIP Phone 707 Cisco Unified Communications Manager Express System Administrator Guide xxii Contents Assign an ERL to a SCCP Phone 708 Assign an ERL to a Dial Peer 709 Customize E911 Settings 710 Using the Address Command for Two ELINS 712 Enable Call Detail Records 713 Output from a RADIUS Accounting Server 713 Output from a Syslog Server 714 Output from the show call history voice Command 714 Verify E911 Configuration 714 Troubleshooting Enhanced 911 Services 715 Error Messages 716 Configuration Examples for Enhanced 911 Services 716 Example for Configuring Enhanced E911 Services with Cisco Unified CME 4.2 716 Example for Configuring Enhanced E911 Services with Cisco Unified CME 4.1 in SRST Fallback Mode 718 Feature Information for Enhanced 911 Services 723 CHAPTER 21 Extension Mobility 725 Prerequisites for Configuring Extension Mobility 725 Restrictions for Configuring Extension Mobility 725 Information About Configuring Extension Mobility 726 Extension Mobility 726 Personal Speed Dials on an Extension Mobility Phone 726 Cisco Unified CME Extension Mobility Enhancements 727 Privacy on an Extension Mobility Phone 728 Extension Mobility for SIP Phones Enhancement 728 MIB Support for Extension Mobility in Cisco Unified SCCP IP Phones 729 Enable Extension Mobility 730 Configure Cisco Unified CME for Extension Mobility 730 Configure a Logout Profile for an IP Phone 733 Enable an IP Phone for Extension Mobility 736 Configure Extension Mobility for SIP Phones 738 Enable SIP Phones for Extension Mobility 740 Configure a User Profile 741 Configuration Examples for Extension Mobility 744 Cisco Unified Communications Manager Express System Administrator Guide xxiii Contents Example for Configuring Extension Mobility for Use with SIP Phones 744 Example for Configuring SIP Phones for Use with Extension Mobility 745 Example for Configuring Logout Profile 745 Example for Enabling an IP Phone for Extension Mobility 745 Example for Configuring User Profile 746 Where to Go Next 746 Feature Information for Extension Mobility 746 CHAPTER 22 Fax Relay 749 Prerequisites for Fax Relay 749 Restrictions for Fax Relay 750 Information About Fax Relay 750 Fax Relay and Equipment 750 Feature Design of Cisco Fax Relay 750 Supported Gateways, Modules, and Voice Interface Cards for Fax Relay 751 Configure Fax Relay 753 Configure Fax Relay on SCCP Phones 753 Verify and Troubleshoot Fax Relay Configuration 754 Configuration Examples for Fax Relay 754 Example for Configuring Fax Relay 754 Feature Information for Fax Relay 755 CHAPTER 23 Feature Access Codes 757 Information About Feature Access Codes 757 Feature Access Codes 757 Configure Feature Access Codes 759 Verify Feature Access Codes 760 Configuration Examples for Feature Access Codes 761 Example for Enabling Standard FACs for All Phones 761 Feature Information for Feature Access Codes 761 CHAPTER 24 Forced Authorization Code 763 Information About Forced Authorization Code 763 Forced Authorization Code Overview 763 FAC Call Flow 764 Cisco Unified Communications Manager Express System Administrator Guide xxiv Contents Forced Authorization Code Specification 765 FAC Requirement for Different Types of Calls 765 Configure Forced Authorization Code 770 Enable Forced Authorization Code (FAC) on LPCOR Groups 770 Define Parameters for Authorization Package 772 Configuration Example for Forced Authorization Code 774 Example for Configuring Forced Authorization Code 774 Feature Information for Forced Authorization Code 775 CHAPTER 25 Headset Auto Answer 777 Information About Headset Auto Answer 777 Auto Answering Calls Using a Headset 777 Difference Between a Line and a Button 777 Configure Headset Auto Answer 779 Enable Headset Auto Answer 779 Verify Headset Auto Answer 780 Configuration Example for Headset Auto Answer 780 Example for Enabling Headset Auto Answer 780 Feature Information for Headset Auto Answer 781 CHAPTER 26 Intercom Lines 783 Information About Intercom Lines 783 Intercom Auto-Answer Lines 783 Whisper Intercom 784 SIP Intercom 785 Extension Number 786 Configure Intercom Lines 786 Configure an Intercom Auto-Answer Line on SCCP Phones 786 Configure Whisper Intercom on SCCP Phones 788 Configure an Intercom Auto-Answer Line on SIP Phones 790 Configure Intercom Call Option on SIP Phones 792 Configuration Examples for Intercom Lines 795 Example for Configuring Intercom Lines 795 Example for Configuring SIP Intercom Support 795 Where to Go Next 795 Cisco Unified Communications Manager Express System Administrator Guide xxv Contents Feature Information for Intercom Lines 796 CHAPTER 27 Loopback Call Routing 797 Information About Loopback Call Routing 797 Loopback Call Routing 797 Configure Loopback Call Routing 798 Enable Loopback Call Routing 798 Verify Loopback Call Routing 801 Configuration Example for Loopback Call Routing 801 Example for Enabling Loopback Call Routing 801 Feature Information for Loopback Call Routing 802 CHAPTER 28 Multilevel Precedence and Preemption 803 Prerequisites for MLPP 803 Information About MLPP 803 Precedence 804 Basic Precedence Call Setup 805 Preemption 805 Basic Preemption Call 806 DSN Dialing Format 807 Service Digit 807 Route Code 808 Example for Dialing 808 MLPP Service Domains 809 MLPP Indication 810 MLPP Announcements 810 Automatic Call Diversion (Attendant Console) 812 Configure MLPP 813 Enable MLPP Service Globally in Cisco Unified CME 813 Enable MLPP Service on SCCP Phones 815 Enable MLPP Service on Analog FXS Phone Ports 819 Configure an MLPP Service Domain for Outbound Dial Peers 821 Configure MLPP Options 823 Troubleshooting MLPP Service 826 Feature Information for MLPP 827 Cisco Unified Communications Manager Express System Administrator Guide xxvi Contents CHAPTER 29 Music on Hold 829 Prerequisites for Music on Hold 829 Restrictions for Music on Hold 829 Information About Music on Hold 830 Music on Hold Summary 830 Music on Hold 831 Music on Hold from a Live Feed 831 Multicast MOH 832 Music on Hold for SIP Phones 832 Music On Hold Enhancement 832 Caching MOH Files for Enhanced System Performance 833 Configure G.711 and G.729 Files for Music on Hold 833 Configure Music on Hold 834 Configure Music on Hold from an Audio File to Supply Audio Stream 834 Configure Music on Hold from a Live Feed 837 Configure Music on Hold Groups to Support Different Media Sources 842 Assign a MOH Group to a Directory Number 845 Assign a MOH Group to all Internal Calls Only to SCCP Phones 847 Configure Buffer Size for MOH Files 849 Verify MOH File Caching 850 Verify Music on Hold Group Configuration 851 Feature Information for Music on Hold 854 CHAPTER 30 Paging 857 Restrictions for Paging 857 Information About Paging 857 Audio Paging 857 Paging Group Support for Cisco Unified SIP IP Phones 859 Configure Paging 860 Configure a Simple Paging Group on SCCP Phones 860 Configure a Combined Paging Group for SCCP Phones 861 Configure Paging Group Support for SIP IP Phones 864 Troubleshooting Tips 868 Verify Paging 868 Cisco Unified Communications Manager Express System Administrator Guide xxvii Contents Configuration Examples for Paging 869 Example for Configuring Simple Paging Group 869 Example for Configuring Combined Paging Groups 869 Example for Configuring a Combined Paging Group of Cisco Unified SIP IP Phones and Cisco Unified SCCP IP Phones 871 Where to Go Next 873 Feature Information for Paging 873 CHAPTER 31 Presence Service 875 Prerequisites for Presence Service 875 Restrictions for Presence Service 875 Information About Presence Service 875 Presence Service 875 BLF Monitoring of Ephone-DNs with DnD, Call Park, Paging, and Conferencing 877 Device-Based BLF Monitoring 878 Phone User Interface for BLF-Speed-Dial 879 Configure Presence Service 879 Enable Presence for Internal Lines 879 Enable a Directory Number to be Watched 881 Enable BLF Monitor for Speed-Dials and Call Lists Using SCCP Phones 883 Enable BLF Monitoring for Speed-Dials and Call Lists on SIP Phones 886 Enable BLF-Speed-Dial Menu 888 Configure Presence to Watch External Lines 889 Verify Presence Configuration 891 Troubleshooting Presence Service 893 Configuration Examples for Presence Service 893 Example for Configuring Presence in Cisco Unified CME 893 Feature Information for Presence Service 896 CHAPTER 32 Ringtones 899 Information About Ringtones 899 Distinctive Ringing 899 Customized Ringtones 900 On-Hold Indicator 900 Configure Ringtones 900 Cisco Unified Communications Manager Express System Administrator Guide xxviii Contents Configure Distinctive Ringing 900 Configure Customized Ringtones 901 Configure On-Hold Indicator 903 Enable Distinctive Ringing on SIP Phones 904 Configuration Examples for Ringtones 905 Example for Configuring Distinctive Ringing for Internal Calls 905 Example for Configuring On-Hold Indicator 905 Feature Information for Ringtones 906 CHAPTER 33 Single Number Reach 907 Information About Single Number Reach 907 Overview of Single Number Reach 907 SNR Enhancements 908 Hardware Conference 908 Call Park, Call Pickup, and Call Retrieval 908 Answer Too Soon Timer 908 SNR Phone Stops Ringing After Mobile Phone Answers 908 Single Number Reach for Cisco Unified SIP IP Phones 909 Virtual SNR DN for Cisco Unified SCCP IP Phones 910 Configure Single Number Reach 911 Configure Single Number Reach on SCCP Phones 911 Configure Single Number Reach Enhancements on SCCP Phones 915 Configure Single Number Reach on SIP Phones 917 Configure a Virtual SNR DN on SCCP Phones 921 Feature Information for Single Number Reach 923 CHAPTER 34 Customize Softkeys 925 Information About Softkeys 925 Softkeys on IP Phones 925 Account Code Entry 927 Hookflash Softkey 928 Feature Blocking 928 Feature Policy Softkey Control 928 Immediate Divert for SIP IP Phones 929 Programmable Line Keys ( PLK) 929 Cisco Unified Communications Manager Express System Administrator Guide xxix Contents Configure Softkeys 938 Modify Softkey Display on SCCP Phone 938 Modify Softkey Display on SIP Phone 942 Verify Softkey Configuration 944 Enable Flash Softkey 945 Verify Flash Softkey Configuration 946 Configure Feature Blocking 947 Verify Block Softkey Configuration 949 Configure Immediate Divert (iDivert) Softkey on SIP Phone 949 Configure Service URL Line Key Button on SCCP Phone 951 Configure Service URL Line Key Button on SIP Phone 953 Configure Feature Buttons on SCCP Phone Line Key 955 Configure Feature Buttons on SIP Phone Line Key 957 Configuration Example for Softkeys 958 Example for Modifying Softkey Display 958 Example for Modifying HLog Softkey for SCCP Phones 959 Example for Modifying HLog Softkey for SIP Phones 959 Example for Enabling Flash Softkey for PSTN Calls 959 Example for Park and Transfer Blocking 960 Example for Conference Blocking 960 Example for Immediate Divert (iDivert) Configuration 960 Example for Configuring URL Buttons on a SCCP Phone Line Key 960 Example for Configuring URL Buttons on a SIP Phone Line Key 961 Example for Configuring Feature Button on a SCCP Phone Line Key 961 Example for Configuring Feature Button on a SIP Phone Line Key 961 Feature Information for Softkeys 962 CHAPTER 35 Speed Dial 965 Information About Speed Dial 965 Speed Dial Summary 965 Speed Dial Buttons and Abbreviated Dialing 967 Bulk-Loading Speed Dial Numbers 967 Monitor-Line Button for Speed Dial 968 DSS (Direct Station Select) Service 969 Phone User-Interface for Speed Dial and Fast Dial 969 Cisco Unified Communications Manager Express System Administrator Guide xxx Contents Configure Speed Dial 970 Enable a Local Speed Dial Menu 970 Enable DSS Service 971 Enable a Personal Speed Dial Menu on SCCP Phones 972 Define Speed-Dial Buttons and Abbreviated Dialing on SCCP Phones 974 Enable Bulk-Loading Speed-Dial 976 Verify Bulk Speed-Dial Parameters on SCCP Phones 977 Enable Phone User Interface for Configuring Speed-Dial and Fast-Dial 978 Define Speed-Dial Buttons on SIP Phones 979 Enable a Personal Speed Dial Menu on SIP Phones 980 Configuration Examples for Speed Dial 982 Example for Enabling a Local Speed Dial Menu 982 Example for Configuring Personal Speed Dial Menu on SIP Phone 982 Example for Configuring Speed-Dial Buttons and Abbreviated Dialing 982 Example for Configuring Bulk-Loading Speed Dial 983 Example for Configuring Speed-Dial and Fast-Dial User Interface 983 Where to Go Next 983 Feature Information for Speed Dial 984 CHAPTER 36 Video Support 987 Prerequisites for Video Support 987 Restrictions for Video Support 988 Information About Video Support 989 Video Support Overview 989 SIP Trunk Video Support 989 Matching Endpoint Capabilities 990 Retrieving Video Codec Information 990 Call Fallback to Audio-Only 991 Call Setup for Video Endpoints 991 Call Setup Between Two Local SCCP Endpoints 991 Call Setup Between SCCP and H.323 Endpoints 991 Call Setup Between Two SCCP Endpoints Across an H.323 Network 992 SIP Endpoint Video and Camera Support for Cisco Unified IP Phones 8961, 9951, and 9971 992 Video and Camera Configuration for Cisco Unified IP Phones 992 Cisco Unified Communications Manager Express System Administrator Guide xxxi Contents Bandwidth Control for SIP Video Calls 993 Flow of the RTP Video Stream 993 Configure Video Support 994 Enable Video and Camera Support on Cisco Unified SIP Phones 994 Apply Video and Camera Configuration to Cisco Unified SIP Phones 997 Configure Video Bandwidth Control for SIP to SIP Video Calls 999 Enable Support for Video Streams Across H.323 Networks 1000 Enable System-Level Video Capabilities 1002 Enable Video Capabilities on a Phone 1003 Verify Video Support 1005 Troubleshooting Video Support 1005 Where to Go Next 1006 Feature Information for Video Support 1006 CHAPTER 37 SSL VPN Client for SCCP IP Phones 1009 Information About SSL VPN Client 1009 SSL VPN Support on Cisco Unified CME with DTLS 1009 Phone or Client Authentication 1010 SSL VPN Client Support on SCCP IP Phones 1011 Configure SSL VPN Client 1012 Configure SSL VPN Client with ASA as VPN Headend 1012 Prerequisites 1012 Basic Configuration on Cisco Unified CME 1013 Configure Cisco Unified CME as CA Server 1018 Verify Phone Registration and Phone Load 1020 Configure ASA (Gateway) as VPN Headend 1021 Configure VPN Group and Profile on Cisco Unified CME 1024 Associate VPN Group and Profile to SCCP IP Phone 1026 Configure Alternate TFTP Address on Phone 1030 Register Phone from a Remote Location 1031 Configure SSL VPN Client with DTLS on Cisco Unified CME as VPN Headend 1031 Set Up the Clock, Hostname, and Domain Name 1032 Configure Trustpoint and Enroll with the Certificates 1033 Configure VPN Gateway 1033 Configure User Database 1033 Cisco Unified Communications Manager Express System Administrator Guide xxxii Contents Configure Virtual Context 1034 Configure Group Policy 1034 Verify the IOS SSL VPN Connection 1035 Configure Cisco Unified SCCP IP Phones for SSL VPN 1035 Configuration on Cisco Unified SCCP IP Phone 1036 Configure SSL VPN on Cisco Unified CME 1036 VPN Phone Redundancy Support for Cisco Unified CME with DTLS 1037 Configuration Examples for SSL VPN Client 1037 Example for Configuring SSL VPN with ASA as VPN Headend 1037 Example for Configuring SSL VPN with DTLS on CME as VPN Headend 1038 Feature Information for SSL VPN Client 1040 CHAPTER 38 Automatic Line Selection 1041 Information About Automatic Line Selection 1041 Automatic Line Selection for Incoming and Outgoing Calls 1041 Configure Automatic Line Selection 1042 Enable Automatic Line Selection 1042 Verify Automatic Line Selection 1043 Configuration Examples for Automatic Line Selection 1044 Example for Automatic Line Selection 1044 Feature Information for Automatic Line Selection 1045 CHAPTER 39 Barge and Privacy 1047 Information About Barge and Privacy 1047 Barge and cBarge 1047 Barge (SIP) 1048 cBarge (SCCP and SIP) 1048 Privacy and Privacy on Hold 1049 Configure Barge and Privacy 1050 Configure the cBarge Soft Key on SCCP Phones 1050 Enable Barge and cBarge Soft Keys on SIP Phones 1052 Enable Privacy and Privacy on Hold on SCCP Phones 1054 Enable Privacy and Privacy on Hold on SIP Phones 1057 Feature Information for Barge and Privacy 1060 Cisco Unified Communications Manager Express System Administrator Guide xxxiii Contents CHAPTER 40 Call Blocking 1061 Information About Call Blocking 1061 Call Blocking Based on Date and Time (After-Hours Toll Bar) 1061 After-Hours Pattern-Blocking Support for Regular Expressions 1062 Call Blocking Override 1063 Class of Restriction 1063 Configure Call Blocking 1064 Configure Call Blocking 1064 Configure Call Blocking Exemption for a Dial Peer 1066 Configure Call Blocking Override for All SCCP Phones 1067 Configure Call Blocking Exemption for an Individual SCCP Phone 1069 Configure Call Blocking Exemption for an Individual SIP Phone or Directory Number 1070 Verify Call Blocking Configuration 1071 Apply Class of Restriction to a Directory Number on SCCP Phone 1072 Apply Class of Restriction to Directory Number on SIP Phones 1073 Verify Class of Restriction 1075 Configuration Examples for Call Blocking 1076 Example for Configuring Call Blocking 1076 Example for Configuring Class of Restriction 1077 Example for Configuring After-Hours Block Patterns of Regular Expressions 1078 Where to Go Next 1078 Feature Information for Call Blocking 1078 CHAPTER 41 Call Park 1081 Information About Call Park 1081 Call Park Enhancements in Cisco Unified CME 7.1 1081 Basic Call Park 1082 View Active Parked Calls 1083 Configure User Interface to View Active List of Parked Calls 1084 Directed Call Park 1085 Park Reservation Groups 1085 Dedicated Call-Park Slots 1086 Call-Park Blocking 1087 Call-Park Redirect 1088 Cisco Unified Communications Manager Express System Administrator Guide xxxiv Contents Call Park Recall Enhancement 1088 Park Monitor 1088 Configure Call Park 1089 Enable Call Park or Directed Call Park 1089 Verify Call Park 1094 Configure Timeout Duration for Recalled Calls 1095 Troubleshooting Call Park 1096 Configuration Examples for Call Park 1097 Example for Configuring Basic Call Park 1097 Example for Blocking Phone From Using Call Park 1097 Example for Configuring Call-Park Redirect 1098 Example for Configuring Call Park Recall 1098 Where to Go Next 1098 Feature Information for Call Park 1099 CHAPTER 42 Call Restriction Regulations 1101 Prerequisites for LPCOR 1101 Information About LPCOR 1101 LPCOR Overview 1101 LPCOR Policy and Resource Groups 1103 Default LPCOR Policy 1103 How LPCOR Policies are Associated with Resource Groups 1104 Analog Phones 1104 IP Phones 1104 PSTN Trunks 1104 VoIP Trunks 1105 LPCOR Support for Supplementary Services 1105 Phone Display and Warning Tone for LPCOR 1110 LPCOR VSAs 1110 Configure LPCOR 1111 Define a LPCOR Policy 1111 Associate a LPCOR Policy with Analog Phone or PSTN Trunk Calls 1114 Associate a LPCOR Policy with VoIP Trunk Calls 1117 Associate a LPCOR Policy with IP Phone or SCCP FXS Phone Calls 1120 Associate LPCOR with Mobile Phone Calls 1124 Cisco Unified Communications Manager Express System Administrator Guide xxxv Contents Verify LPCOR Configuration 1128 Configuration Examples for LPCOR 1128 Example for Configuring LPCOR for Cisco Unified CME 1128 Example for Configuring LPCOR on Cisco 3800 Series Integrated Services Router 1132 Feature Information for LPCOR 1145 CHAPTER 43 Call Transfer and Forward 1147 Information About Call Transfer and Forward 1147 Call Forward 1147 Selective Call Forward 1148 Call Forward Unregistered 1148 B2BUA Call Forward for SIP Devices 1149 Call Forward All Synchronization for SIP Phones 1150 Call Transfer 1150 Call Transfer Blocking 1151 Trunk-to-Trunk Transfer Blocking for Toll Fraud Prevention on Cisco Unified SIP IP Phones 1151 Transfer Pattern 1152 Backward Compatibility 1153 Dial Plans 1153 Transfer Max-Length 1153 Conference Max-Length 1153 Conference-Pattern Blocked 1154 Configure the Maximum Number of Digits for a Conference Call 1155 Configure Conference Blocking Options for Phones 1156 Transfer-Pattern Blocked 1158 Conference Transfer-Pattern 1159 Call Transfer Recall on SCCP Phones 1159 Call Transfer Recall on SIP Phones 1159 Consultative-Transfer Enhancements in Cisco Unified CME 4.3 and Later Versions 1160 Consultative Transfer With Direct Station Select 1161 H.450.2 and H.450.3 Support 1161 Tips for Using H.450 Standards 1164 Transfer Method Recommendations by Cisco Unified CME Version 1164 Cisco Unified Communications Manager Express System Administrator Guide xxxvi Contents H.450.12 Support 1166 Hairpin Call Routing 1167 Tips for Using Hairpin Call Routing 1170 Calling Number Local 1170 H.450 Tandem Gateways 1170 Tips for Using H.450 Tandem Gateways 1172 Dial Peers 1173 Q Signaling Supplementary Services 1173 Disable SIP Supplementary Services for Call Forward and Call Transfer 1174 Typical Network Scenarios for Call Transfer and Call Forwarding 1174 Cisco CME 3.1 or Later and Cisco IOS Gateways 1175 Cisco CME 3.0 or an Earlier Version and Cisco IOS Gateways 1175 Cisco CME 3.1 or Later, Non-H.450 Gateways, and Cisco IOS Gateways 1175 Cisco Unified CME, Non-H.450 Gateways, and Cisco IOS Gateways 1176 Cisco CME 3.1 or Later, Cisco Unified Communications Manager, and Cisco IOS Gateways 1177 Cisco CME 3.0 or an Earlier Version, Cisco Unified Communications Manager, and Cisco IOS Gateways 1177 Configure Call Transfer and Forwarding 1178 Enable Call Transfer and Forwarding on SCCP Phones at System-Level 1178 Enable Call-Transfer Recall on SIP Phones at System-Level 1183 Enable Call Forwarding for a Directory Number 1185 Call Transfer for a Directory Number 1188 Configure Call Transfer Options for SCCP Phones 1189 Verify Call Transfer for SCCP Phones 1191 Specify Transfer Patterns for Trunk-to-Trunk Calls and Conferences for SIP 1192 Conference Max-Length 1195 Block Trunk-to-Trunk Call Transfers for SIP 1195 Enable H.450.12 Capabilities 1196 Enable H.323-to-H.323 Connection Capabilities 1198 Forward Calls Using Local Hairpin Routing 1200 Enable H.450.7 and QSIG Supplementary Services at System-Level 1202 Enable H.450.7 and QSIG Supplementary Services on a Dial Peer 1204 Disable SIP Supplementary Services for Call Forward and Call Transfer 1206 Enable Interworking with Cisco Unified Communications Manager 1207 Cisco Unified Communications Manager Express System Administrator Guide xxxvii Contents Configure Cisco CME 3.1 or Later to Interwork with Cisco Unified Communications Manager 1208 Enable Cisco Unified Communications Manager to Interwork with Cisco Unified CME 1212 Troubleshooting Call Transfer and Forward Configuration 1212 Configure SIP-to-SIP Phone Call Forwarding 1213 Configure Call Forward Unregistered for SIP IP Phones 1216 Troubleshooting Tips for Call Forward Unregistered 1217 Configure Keepalive Timer Expiration in SIP Phones 1217 Configure Call-Forwarding-All Softkey URI on SIP Phones 1218 Specify Number of 3XX Responses To be Handled on SIP Phones 1220 Configure Call Transfer on SIP Phones 1221 Configuration Examples for Call Transfer and Forwarding 1223 Example for Configuring H.450.2 and H.450.3 Support 1223 Example for Configuring Basic Call Forwarding 1223 Example for Configuring Call Forwarding Blocked for Local Calls 1223 Example for Configuring Transfer Patterns 1224 Example for Configuring Maximum Length of Transfer Number 1224 Example for Configuring Conference Transfer Patterns 1224 Example for Blocking All Call Transfers 1224 Example for Configuring Selective Call Forwarding 1225 Example for Configuring Call Transfer 1225 Example for Configuring Call Transfer Recall for SCCP Phones 1226 Example for Configuring Call-Transfer Recall for SIP Phones 1226 Example for Enabling H.450.12 Capabilities 1227 Example for Enabling H.450.7 and QSIG Supplementary Services 1227 Example for Configuring Cisco Unified CME and Cisco Unified Communications Manager in Same Network 1228 Example for Configuring H.450 Tandem Gateway Working with Cisco Unified CME and Cisco Unified Communications Manager 1230 Example for Configuring Call Forward to Cisco Unity Express 1231 Example for Configuring Call Forward Unregistered for SIP IP Phones 1232 Example for Configuring Keepalive Timer Expiration in SIP Phones 1232 Where to Go Next 1232 Feature Information for Call Transfer and Forwarding 1233 Cisco Unified Communications Manager Express System Administrator Guide xxxviii Contents CHAPTER 44 Call Coverage Features 1239 Information About Call Coverage Features 1239 Call Coverage Summary 1239 Out-of- Dialog REFER 1242 Call Hunt 1243 Call Pickup 1243 Call Waiting 1246 Call-Waiting Beep for SCCP Phones 1246 Call-Waiting Ring for SCCP Phones 1247 Cancel Call Waiting 1247 Callback Busy Subscriber 1248 Hunt Groups 1248 Ephone-Hunt Groups and Voice Hunt-Groups Comparison 1249 Sequential Hunt Groups 1250 Peer Hunt Groups 1251 Longest-Idle Hunt Groups 1251 Parallel Hunt Groups (Call Blast) 1252 View and Join for Voice Hunt Groups 1253 Enable User Interface to View, Join, and Unjoin Voice Hunt Groups on SCCP Phone 1254 Configure Service URL Button On SCCP Phone Line Key 1255 Configure Service URL Button On SIP Phone Line Key 1257 Display Support for the Name of a Called Voice Hunt-Group 1259 Support for Voice Hunt Group Descriptions 1260 Prevent Local Call Forwarding to the Final Agent in a Voice Hunt-Groups 1260 Enhancement of Support for Voice Hunt Group Agent Statistics 1261 Enhancement of Support for Ephone-Hunt Group Agent Statistics 1261 Hunt Group Agent Availability Options 1262 Dynamic Ephone Hunt Group Membership 1264 Dynamically Join or Unjoin Multiple Voice Hunt Groups 1265 Agent Status Control for Ephone Hunt Group 1266 Agent Status Control for Voice Hunt Group 1267 Members Logout for Ephone Hunt Group 1268 Members Logout for Voice Hunt Group 1269 Automatic Agent Status Not-Ready for Ephone Hunt Group 1269 Cisco Unified Communications Manager Express System Administrator Guide xxxix Contents Automatic Agent Status Not-Ready for Voice Hunt Group 1269 Presentation of Calls for Ephone Hunt Group 1270 Presentation of Calls for Voice Hunt Group 1270 Night Service 1271 Overlaid Ephone-dns 1274 Shared- Line Overlays 1275 Call Waiting for Overlaid Ephone-dns 1276 Extend Calls for Overlaid Ephone-dns to Other Buttons on the Same Phone 1278 Configure Call Coverage Features 1278 Configure Call Hunt on SCCP Phones 1278 Verify Call Hunt Configuration on SCCP Phones 1280 Configure Call Hunt on SIP Phones 1281 Enable Call Pickup 1282 Configure Call-Waiting Indicator Tone on SCCP Phone 1285 Verify Call-Waiting Indicator Tone on SCCP Phone 1287 Configure Cancel Call Waiting on SCCP Phone 1288 Enable Call Waiting on SIP Phones 1290 Configure Ephone-Hunt Groups on SCCP Phones 1291 Verify Ephone Hunt Groups Configuration 1298 Configure Voice-Hunt Groups 1301 Verify Voice Hunt Groups Configuration 1306 Enable Audible Tone for Successful Login and Logout of a Hunt Group on SCCP Phone 1309 Enable the Collection of Call Statistics for Voice Hunt-Groups 1310 Associate a Name with a Called Voice Hunt-Group 1312 Prevent Local Call Forwarding to Final Agent in Voice Hunt-Groups 1314 Configure Night Service on SCCP Phones 1315 Configure Night Service on SIP Phones 1318 Verify Night Service Configuration on SCCP Phones 1322 Verify Night Service Configuration on SIP Phones 1325 Configure Overlaid Ephone-dns on SCCP Phones 1326 Verify Overlaid Ephone-dns Configuration on SCCP Phone 1330 Enable Out-Of-Dialog REFER 1330 Verify OOD-R Configuration 1332 Troubleshooting OOD-R 1333 Cisco Unified Communications Manager Express System Administrator Guide xl Contents Configuration Examples for Call Coverage Features 1333 Call Hunt: Examples 1333 Example for Setting Ephone-dn Dial-Peer Preference 1333 Example for Disabling Huntstop 1334 Example for Channel Huntstop 1334 Example for SIP Call Hunt 1335 Example for Call Pickup 1335 Example for Call-Waiting Beep 1335 Example for Call-Waiting Ring 1335 Examples for Hunt Group 1336 Example for Sequential Ephone-Hunt Group 1336 Example for Peer Ephone-Hunt Group 1336 Example for Longest-idle Ephone-Hunt Group 1336 Example for Longest-idle Ephone-Hunt Group Using From-Ring Option 1336 Example for Sequential Hunt Group 1337 Example for Preventing Local Call Forwarding in Parallel Voice Hunt-Groups 1338 Example for Associating a Name with a Called Voice Hunt-Group 1338 Example for Specifying a Description for a Voice Hunt-Group 1339 Example for Logout Display 1339 Example for Displaying Total Logged-In Time and Total Logged-Out Time for Each Hunt-Group Agent 1339 Example for Dynamic Membership To Ephone-Hunt 1341 Example for Dynamic Membership To Voice Hunt-Group 1341 Example for Agent Status Control using SCCP Phones 1341 Example for Agent Status Control using SIP Phones 1342 Example for Automatic Agent Not-Ready for Ephone Hunt Group 1342 Example for Automatic Agent Not-Ready for Voice Hunt Group 1343 Example for Call Statistics From a Voice Hunt Group 1343 Example for Night Service on SCCP Phones 1345 Example for Night Service on SIP Phones 1345 Examples for Overlaid Ephone-dns 1346 Example for Overlaid Ephone-dn 1346 Example for Overlaid Dual-Line Ephone-dn 1347 Example for Shared-line Overlaid Ephone-dns 1347 Example for Overlaid Ephone-dn with Call Waiting 1348 Cisco Unified Communications Manager Express System Administrator Guide xli Contents Example for Overlaid Ephone-dns with Rollover Buttons 1349 Example for Called-Name Display for Voice Hunt Group 1350 Example for Called Directory Name Display for Overlaid Ephone-dns 1350 Example for Called Ephone-dn Name Display for Overlaid Ephone-dns 1352 Example for OOD-R 1352 Where to Go Next 1352 Feature Information for Call Coverage Features 1354 CHAPTER 45 Caller ID Blocking 1363 Restrictions for Caller ID Blocking 1363 Information About Caller ID Blocking 1363 Caller ID Blocking on Outbound Calls 1363 Configure Caller ID Blocking 1364 Block Caller ID For All Outbound Calls on SCCP Phones 1364 Block Caller ID From a Directory Number on SCCP Phones 1365 Verify Caller ID Blocking 1366 Configuration Examples for Caller ID Blocking 1368 Example for Configuring Caller ID Blocking Code 1368 Example for Configuring Caller ID Blocking for Outbound Calls from a Directory Number on SCCP Phones 1368 Feature Information for Caller ID Blocking 1368 CHAPTER 46 Conferencing 1369 Restrictions for Conferencing 1369 Information About Conferencing 1369 Conferencing Overview 1369 Conferencing with Octo-Lines 1370 Secure Conferencing Limitation 1370 Ad-hoc Conferencing 1370 Multi-Party Ad Hoc Conferencing for More Than Three Parties 1371 Connected Conference 1372 Meet-Me Conferencing in Cisco Unified CME 4.1 and Later versions 1373 Meet-Me Conferencing in Cisco Unified CME 11.7 and Later Versions 1374 Soft Keys for Conference Functions 1374 Meet-Me Conferencing in Cisco CME 3.2 to Cisco Unified CME 4.0 1375 Cisco Unified Communications Manager Express System Administrator Guide xlii Contents Dial Plan 1376 Configure Conferencing 1377 Modify the Default Configuration for Three-Party Ad Hoc Conferencing 1377 Configure Conferencing Options on SCCP Phones 1379 Configure Conferencing Options on SIP Phones 1380 Verify Three-Party Ad Hoc Conferencing 1382 Troubleshooting Three-Party Ad Hoc Conferencing 1383 Configure Multi-Party Ad Hoc and Meet-Me Conferencing in Cisco Unified CME 4.1 and Later Versions on SCCP Phones 1383 Enable DSP Farm Services for a Voice Card 1384 Configure Join and Leave Tones on SCCP Phones 1384 Configure SCCP for Cisco Unified CME 1386 Configure the DSP Farm Profile on SCCP Phones 1387 Associate Cisco Unified CME with a DSP Farm Profile on SCCP Phones 1389 Enable Multi-Party Ad Hoc and Meet-Me Conferencing 1390 Configure Multi-Party Ad Hoc Conferencing and Meet-Me Numbers on SCCP Phones 1392 Configure Conferencing Options for SCCP Phones 1394 Verify Multi-Party Ad Hoc and Meet-Me Conferencing on SCCP Phones 1398 Configure Meet-Me Conferencing in Cisco CME 3.2 to Cisco Unified CME 4.0 on SCCP Phones 1398 Examples 1400 What to Do Next 1405 Configuration Examples for Conferencing 1406 Example for Configuring Basic Conferencing 1406 Example for Configuring End of Conference Options 1406 Example for Keep-Conference on SIP Phones 1407 Example of DSP Farm and Cisco Unified CME on the Same Router 1408 Example of DSP Farm and Cisco Unified CME on Different Routers 1417 Example of Cisco Unified CME Router Configuration 1417 Example of DSP Farm Router Configuration 1423 Where to Go Next 1425 Feature Information for Conferencing 1425 CHAPTER 47 Templates 1427 Information About Templates 1427 Cisco Unified Communications Manager Express System Administrator Guide xliii Contents Phone Templates 1427 Ephone-dn Templates 1428 Configure Templates 1428 Create an Ephone Template 1428 Create an Ephone-dn Template 1430 Verify Templates on SCCP Phones 1431 Create and Apply Templates for SIP Phones 1432 Configuration Examples for Creating Templates 1434 Example to Block The Use of Park and Transfer Soft Keys Using Ephone Template 1434 Example to Set Call Forwarding Using Ephone-dn Template 1435 Where to Go Next 1435 Feature Information for Creating Templates 1435 CHAPTER 48 Modify Cisco Unified IP Phone Options 1437 Information About Cisco Unified IP Phone Options 1437 Clear Directory Entries 1437 Enable Customized Background Images for Cisco Unified IP Phone 7970 1437 Customized Button Layout 1438 Customized Phone User Interface Services 1439 Fixed Line-Feature Buttons for Cisco Unified IP Phone 7931G 1440 Header Bar Display 1440 Phone Labels 1440 Programmable Vendor Parameters for Phones 1441 Push-to-Talk 1441 Support for Cisco Jabber 1442 Cisco Jabber Client Support on CME 1443 System Message Display 1444 URL Provisioning for Feature Buttons 1444 My Phone Apps for Cisco Unified SIP IP Phones 1445 Configure Cisco Unified IP Phone Options 1446 Enable Edit User Settings 1446 Configure Cisco Jabber 1447 Clear Call-History Details from a SCCP Phone 1449 Troubleshooting Tips for Clearing Call-History Details from a SCCP Phone 1450 Configure Dial Rules for Cisco Softphone SIP Client 1451 Cisco Unified Communications Manager Express System Administrator Guide xliv Contents Select Button Layout for a Cisco Unified SCCP IP Phone 7931G 1453 Configure Button Layout on SCCP Phones 1454 Configure Button Layout on SIP Phones 1456 Configure Service URL Button on a SIP IP Phone Line Key 1459 Configure Service URL Button on a SCCP Phone Line Key 1460 Configure Feature Button on a Cisco Unified SIP Phone Line Key 1462 Configure Feature Button on a Cisco Unified SCCP Line Key 1464 Block Local Services on Phone User Interface 1466 Modify Header Bar Display on SCCP Phones 1468 Modify Header Bar Display Supported SIP Phones 1469 Verify Header Bar Display 1470 Troubleshooting Header Bar Display 1470 Create Labels for Directory Numbers on SCCP Phones 1471 Create Labels for Directory Numbers on a SIP Phone 1472 Verify Labels 1473 Modify System Message Display on SCCP Phone Screen 1474 Verify System Message Display 1475 Troubleshooting System Message Display 1476 Provision URLs for Feature Buttons for SCCP Phones 1476 Provision URLs for Feature Buttons on SIP Phones 1478 Troubleshooting URL Provisioning for Feature Buttons 1479 Modify Vendor Parameters for All SCCP Phones 1479 Modify Vendor Parameters for a Specific SCCP Phone 1481 Troubleshooting Vendor Parameter Configuration 1483 Configure One-Way Push-to-Talk on Cisco Unified SCCP Wireless IP Phones 1483 Configure Cisco Jabber for CSF Client in Cisco Unified CME 1485 Configuration Examples for Cisco Unified IP Phone Options 1487 Example for Configuring Cisco Jabber 1487 Example for Configuring Cisco Jabber CSF Client 1488 Example for Configuring Dial Rules for Cisco Softphone SIP Client 1489 Example for Excluding Local Services from Cisco Unified SIP IP Phones 1489 Example to Create Text Labels for Ephone-dns 1490 Example for Phone Header Bar Display 1490 Example for System Text Message Display 1490 Example for System File Display 1490 Cisco Unified Communications Manager Express System Administrator Guide xlv Contents Example for URL Provisioning for Directories, Services, and Messages Buttons 1490 Example for Programmable VendorConfig Parameters 1491 Example for Push-to-Talk (PTT) on Cisco Unified Wireless IP Phones in Cisco Unified CME 1491 Feature Information for Cisco Unified IP Phone Options 1492 CHAPTER 49 Interoperability with Cisco Unified CCX 1495 Information About Interoperability with Cisco Unified CCX 1495 Configure Interoperability with Cisco Unified CCX 1498 Enable Interoperability with Cisco Unified CCX 1498 Identify Agent Directory Numbers in Cisco Unified CME for Session Manager on SCCP Phones 1501 Verify Registrations and Subscriptions in Cisco Unified CME 1503 Re-create a Session Manager in Cisco Unified CME 1503 Reconfigure a Cisco CRS Route Point as a SIP Endpoint 1505 Configuration Examples for Interoperability with Cisco Unified CCX 1508 Where to Go Next 1516 Feature Information for Interoperability with Cisco Unified CCX 1516 CHAPTER 50 CTI CSTA Protocol Suite 1519 Information About CTI CSTA Protocol Suite 1519 CTI CSTA in Cisco Unified CME 1519 CTI Session 1520 Supported Services and Events 1520 Configure CTI CSTA Protocol Suite 1521 Enable CTI CSTA in Cisco Unified CME 1522 Create a Session Manager 1525 Configure a Number or Device for CTI CSTA Operations 1527 Clear a Session Between a CSTA Client Application and Cisco Unified CME 1531 Configuration Examples for CTI CSTA Protocol Suite 1532 Example for Configuring MOC Client 1532 Example for Configuring CSTA Client Application Requiring a Session Manager 1534 Feature Information for CTI CSTA Protocol Suite 1537 CHAPTER 51 SRST Fallback Mode 1539 Cisco Unified Communications Manager Express System Administrator Guide xlvi Contents Prerequisites for SRST Fallback Mode 1539 Restrictions for SRST Fallback Mode 1539 Information About SRST Fallback Mode 1540 SRST Fallback Mode Using Cisco Unified CME 1540 Prebuilding Cisco Unified CME Phone Configurations 1543 Auto provision Directory Numbers in SRST Fallback Mode 1544 Configure SRST Fallback Mode 1544 Enable SRST Fallback Mode 1544 Verify SRST Fallback Mode 1546 Prebuilding Cisco Unified CME Phone Configurations 1547 Modify Call Pickup for Fallback Support 1548 Configuration Examples for SRST Fallback Mode 1549 Example for Enabling SRST Mode 1549 Example for Provisioning Directory Numbers for Fallback Support 1550 Example for Configuring Templates for Fallback Support: Example 1551 Example for Enabling Hunt Groups for Fallback Support 1551 Example for Modifying Call Pickup for Fallback Support 1552 Example for Prebuilding DNs 1552 Feature Information for SRST Fallback Mode 1552 CHAPTER 52 VRF Support 1553 Prerequisites for Configuring VRF Support 1553 Restrictions for Configuring VRF Support 1555 Information About VRF Support 1556 VRF-Aware Cisco Unified CME 1556 VRF-Aware Cisco Unified CME for SCCP Phones 1556 Multi-VRF Support on Cisco Unified CME for SIP Phones 1556 Configure VRF Support 1556 Create VRF Groups for SCCP Phones 1556 Create VRF Groups for SIP Phones 1558 Add Cisco Unified CME SCCP Phones to a VRF Group 1560 Add Cisco Unified CME SIP Phones to a VRF Group 1563 Configuration Examples for Configuring VRF Support 1565 Example for Mapping IP Address Ranges to VRF Using DHCP 1565 Example for Configuring VRF-Aware Hardware Conferencing 1565 Cisco Unified Communications Manager Express System Administrator Guide xlvii Contents Example for Configuring Cisco Unity Express on Global Voice VRF 1566 Example for Configuring Multi- VRF Support for Cisco Unified CME SIP Phones 1568 Feature Information for VRF Support 1571 CHAPTER 53 Configure the XML API 1573 Information About XML API 1573 XML API Definition 1573 XML API Provision Using IXI 1573 XML API for Cisco Unified CME 1574 Target Audience 1574 Prerequisites 1574 Information on XML API for Cisco Unified CME 1574 Examples for XML API Methods 1577 ISexecCLI 1578 ISSaveConfig 1579 ISgetGlobal 1579 ISgetDevice 1591 ISgetDeviceTemplate 1594 ISgetExtension 1597 ISgetExtensionTemplate 1601 ISgetUser 1602 ISgetUserProfile 1603 ISgetUtilityDirectory 1604 ISgetVoiceRegGlobal 1605 ISgetSipDevice 1605 ISgetSipExtension 1606 ISgetSessionServer 1607 ISgetVoiceHuntGroup 1607 ISgetPresenceGlobal 1608 Configure XML API 1609 Define XML Transport Parameters 1609 Define XML Application Parameters 1610 Define Authentication for XML Access 1612 Define XML Event Table Parameters 1613 Troubleshooting the XML Interface 1614 Cisco Unified Communications Manager Express System Administrator Guide xlviii Contents Configuration Examples for XML API 1614 Example for XML Transport Parameters 1614 Example for XML Application Parameters 1614 Example for XML Authentication 1615 Example for XML Event Table 1615 Where to Go Next 1615 Feature Information for XML API 1615 Cisco Unified Communications Manager Express System Administrator Guide xlix Contents Cisco Unified Communications Manager Express System Administrator Guide l Contents CHAPTER 1 Cisco Unified CME Features Roadmap This roadmap lists the features documented in the Cisco Unified Communications Manager Express System Administrator Guide and maps them to the modules in which they appear. Feature and Release Support Table 1: Supported Cisco Unified CME Features, on page 1 lists the Cisco Unified Communications Manager Express (Cisco Unified CME) version that introduced support for a given feature. Unless noted otherwise, subsequent versions of Cisco Unified CME software also support that feature. Only features that were introduced or modified in Cisco Unified CME 4.0 or a later version appear in the table. Not all features may be supported in your Cisco Unified CME software version. To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix. Use Cisco Feature Navigator to find information about platform support and Cisco IOS software image support. An account on Cisco.com is not required. Table 1: Supported Cisco Unified CME Features Version Feature Name Feature Description Where Documented Unified CME 12.1 No New features added in the Unified CME 12.1 Release. Unified CME 12.0 Phone Feature Support Guide for Unified CME, Unified SRST, Unified E-SRST, and Unified Secure SRST As part of Unified CME Release 12.0, new phone support for Cisco IP Phones 8821, 8845, 8865 was introduced for Cisco Integrated Services Router Generation 2. The support is introduced for T-Train Release Version, 15.7(3)M and later. New Phone Support Cisco Unified Communications Manager Express System Administrator Guide 1 Version Feature Name Feature Description Where Documented Information About Cisco Unified IP Phone Options, on page 1437 Support for Idle URL feature was introduced forSIPPhones, as part of Unified CME Release 12.0 Idle URL for SIP Phones Calling Number Local, on page 1170 Support to configure Calling Number Local under voice register global configuration mode was introduced as part of Unified CME Release 12.0. Calling Number Local Called-Name Display, on page 660 Support to configure Dialed Number IdentificationService for phones configured under voice hunt group was introduced as part of Unified CME Release 12.0. Called-Name Display (Dialed Number Identification Service) Barge and Privacy, on page 1047 Support for cBarge functionality in a mixed deploymentscenario was introduced as part of Unified CME Release 12.0. cBarge on Mixed Shared Lines Unified CME 11.7 Phone Feature Support Guide for Unified CME, Unified SRST, Unified E-SRST, and Unified Secure SRST As part of Unified CME Release 11.7, new phone support for Cisco IP Phones 8821, 8845, 8865 wasintroduced. With this addition, Unified CME supports all phone modelsin Cisco IPPhone 7800 Series and Cisco IP Phone 8800 Series. 11.7 New Phone Support Music on Hold, on page 829 Transcoding for MOH is supported on Cisco 4000 SeriesIntegratedServices Router from Cisco Unified CME Release 11.7 onwards. Transcoding support for Music on Hold Cisco Unified Communications Manager Express System Administrator Guide 2 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Conferencing, on page 1369 Provides support for conferencing on Cisco 4000 Series Integrated Services Router from Cisco Unified CME Release 11.7 onwards. Support for Conferencing on Unified CME Cisco Unified CME Overview, on page 67 Provides support for Smart Licensing apart from the existing CSL licensing model from Cisco Unified CME Release 11.7 onwards. Support for Cisco Smart License Unified CME 11.6 Create Phone Configurations Using Extension Assigner, on page 347 Provides support for automatically synchronizing configuration changes to backup systems for SIP Phones. Extension Assigner for SIP Phones 11.6 Call Transfer Recall on SIPPhones, on page 1159 Support for call transfer recall functionality on SIP phones. Call Transfer Recall for SIP Phones Redundant Cisco Unified CME Router for SIP Phones, on page 161 Failover to Redundant Router—Sites can be set up with a primary and secondary Cisco Unified CME router to provide redundant Cisco Unified CME capability. SIP Phones automatically register at the secondary router if the primary router fails and later rehome to the primary router when it is operational again. Secondary Unified CME for SIP Phones Cisco Unified Communications Manager Express System Administrator Guide 3 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Call Coverage Features, on page 1239 Customize Softkeys, on page 925 Support for voice hunt group features such as Hlog support on SIP phone, DND Softkey as Hlog, Members Logout, Auto Logout, Presentation of calls, and Dynamic Agent Join or Unjoin Status message display on SIP phones. VHG Enhancements Call Coverage Features, on page 1239 Support for night service functionality in a mixed deployment scenario. Night Service (Mixed Mode) Configure DialPlans, on page 451 Support for Secondary Dial Tone onSIPPhones. Secondary Dial Tone for SIP Phones http://www.cisco.com/c/ en/us/td/docs/ voice_ip_comm/cucme/ bacd/configuration/guide/ cme40tcl/40bacd.html Support to invoke B-ACD services when calling from a local SIP, SCCP or FXS phone. BACD with Loopback call flows TranscodingSupport, on page 474 Support for LTI-based Transcoding on Cisco 4000 Series Integrated Services Router. Transcoding Support on Unified CME Cisco Unified CME 11.5 Auto Registration of SIP Phones on Cisco Unified CME, on page 235 Support for auto registration ofSIPphones on Unified CME. Introduced the CLI command auto-register in voice register global mode to enable automatic registration ofSIPphones on Unified CME. 11.5 Auto Registration Night Service, on page 1271 Support for night service functionality on SIP phones. Night Service Cisco Unified CME B-ACD and Tcl Call-Handling Applications Support for B-ACD functionality on SIP phones. B-ACD Cisco Unified Communications Manager Express System Administrator Guide 4 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Cisco Unified CME 11.0 Phone Feature Support Guide for Unified CME, Unified SRST, Unified E-SRST, and Unified Secure SRST Lists the new phones that have been provided with support on Unified CME: • Support for Cisco IP Phone 7811 • Support for Cisco IP Phones 8811, 8831, 8841, 8851, 8851NR, 8861 • Support for Cisco ATA-190 Phones 11.0 New Phone Support Cisco Unified CME 10.5 Phone Feature Support Guide for Unified CME, Unified SRST, Unified E-SRST, and Unified Secure SRST Lists the new phones that have been provided with support on Unified CME: • Support for Cisco Unified 78xxSeries SIP IP Phones • Support for Cisco DX650 10.5 New Phone Support Example for Monitoring the Status of Key Expansion Modules, on page 337 Monitoring the Status of Key Expansion Modules: Example section has been updated to include support the show summary commands. Example for Monitoring the Status of Key Expansion Modules Cisco IOS Commandsfor Monitoring and Maintaining Cisco Unified CME, on page 339 Monitoring and Maintaining Cisco Unified CME table has been updated to include the new show commands introduced in thisrelease. Monitoring and Maintaining Cisco Unified CME Localization Enhancements in Cisco Unified CME, on page 407 Localization Enhancement feature recommends User-Defines locales. Localization Enhancements in Cisco Unified CME Cisco Unified Communications Manager Express System Administrator Guide 5 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Enable a Personal Speed Dial Menu on SCCP Phones, on page 972 Fast Dial range has been increased to 100. Fast Dial View Active Parked Calls, on page 1083 Viewing Active Parked Calls feature enables the user to view the list of active parked calls onSIP and SCCP phones. Viewing Active Parked Calls Call Park Recall Enhancement, on page 1088 Distinctive Ring feature enables the user to distinctly identify the type of call. Distinctive Ring View and Join for Voice Hunt Groups, on page 1253 Viewing and Joining Voice Hunt Groups feature enables the user to view voice hunt group related information on SIP and SCCP phones. Viewing and Joining Voice Hunt Groups Dynamically Join or Unjoin Multiple Voice Hunt Groups, on page 1265 Dynamically Joining or Unjoining Multiple Voice Hunt Groups feature provides support for phones to dynamically join the voice hunt groups is added. Dynamically Joining or Unjoining Multiple Voice Hunt Groups Enable Audible Tone for Successful Login and Logout of a Hunt Group onSCCPPhone, on page 1309 The Audible Tone feature has been introduced on SCCP phones to enable the user to receive a confirmation on successful log in or log out from an ephone hunt group and voice hunt group. Audible Tone Cisco Jabber Client Support on CME, on page 1443 A new phone type, 'Jabber-CSF-Client' has been added to configure the Cisco Jabber client under voice register pool. Cisco Jabber Client Support on CME Cisco Unified Communications Manager Express System Administrator Guide 6 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Example for Configuring Multi- VRF Support for Cisco Unified CME SIP Phones, on page 1568 Multi VRF Support feature has been enhanced to provide support for SIP phones. Multi VRF Support Cisco Unified CME 10.0 Fast-Track Configuration Approach for Cisco Unified SIP IP Phones, on page 251 Fast-Track Configuration feature provides a new configuration utility using which you can input the phone characteristics of a new SIP phone model. Fast-Track Configuration Approach for Cisco Unified SIP IP Phones 10.0 Cisco Jabber Client Support on CME, on page 1443 Cisco Jabber for Windows client is supported from Cisco Unified CME Release 10 onwards. Cisco Jabber for Microsoft Windows Cisco Unified Licenses, on page 69 CME-SRST permanent license has been introduced along with new license package called Collaboration Professional Suite. Cisco Unified CME-SRST License Secure SIP Trunk Support on Cisco Unified CME, on page 593 Supports supplementary services in secure SRTP andSRTPfallback modes onSIPtrunk of theSCCP Cisco Unified CME. Secure SIP Trunk Support on Cisco Unified CME Cisco Unified CME 9.5 After-Hours Pattern-BlockingSupport for Regular Expressions, on page 1062 Support for afterhours pattern blocking is extended to regular expression patterns for dial plans on Cisco Unified SIP and Cisco UnifiedSCCPIPphones. Afterhours Pattern Blocking Support for Regular Expressions 9.5 Cisco Unified Communications Manager Express System Administrator Guide 7 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Call Park Recall Enhancement, on page 1088 The recall force keyword is added to the call-park system command in telephony-service configuration mode to allow a user to force the recall or transfer of a parked call to the phone that put the call in park. Call Park Recall Enhancement Display Support for the Name of a Called Voice Hunt-Group, on page 1259 The display of the name of the called voice-hunt-group pilot is supported by configuring the following command in voice hunt-group or ephone-hunt configuration mode: [no] name primary pilot name [secondary secondary pilot name] Display Support for Name of Called Voice Hunt Groups Enhancement of Support for Ephone-Hunt Group AgentStatistics, on page 1261 Support for hunt group agent statistics of Cisco Unified SCCP IP phones is enhanced to include the following information: • Total logged in time—On an hourly basis, displays the duration (in sec) since a specific agent logged into a hunt group. • Total logged out time—On an hourly basis, displays the duration (in sec) since a specific agent logged out of a hunt group. Enhancement of Support for Hunt Group Agent Statistics Cisco Unified Communications Manager Express System Administrator Guide 8 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented HTTPSProvisioningFor Cisco Unified IPPhones, on page 596 With Hypertext Transfer ProtocolSecure (HTTPS) support in Cisco Unified CME 9.5 and later versions, these services can be invoked using an HTTPS connection from the phones to Cisco Unified CME. HTTPS Support in Cisco Unified CME Localization Enhancements in Cisco Unified CME, on page 407 Canadian French is supported as a user-defined locale on Cisco Unified SIP IP phones and Cisco Unified SCCP IP phones when the correct locale package is installed. Localization Enhancements in Cisco Unified CME Prevent Local Call Forwarding to the Final Agent in a Voice Hunt-Groups, on page 1260 Local calls are prevented from being forwarded to the final destination using the no forward local-calls to-final command in parallel or sequential voice hunt-group configuration mode. Preventing Local-Call Forwarding to Final Agent in Voice Hunt Groups Support for Voice Hunt Group Descriptions, on page 1260 A description can be specified for a voice hunt group using the description command in voice hunt-group configuration mode. Support for Voice Hunt Group Descriptions Trunk-to-Trunk Transfer Blocking for Toll Fraud Prevention on Cisco Unified SIP IP Phones, on page 1151 Trunk to trunk transfer blocking for toll bypass fraud prevention is supported on Cisco UnifiedSession Initiation Protocol (SIP) IP phones also. Trunk to Trunk Transfer Blocking for Toll Fraud Prevention on Cisco Unified SIP IP Phones Cisco Unified CME 9.0 Cisco Unified CME 9.0 Cisco Unified Communications Manager Express System Administrator Guide 9 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Increases line key and feature key appearances, speed dials, or programmable buttons on Cisco Unified SIP IP phones. KEM Support for Cisco Unified 8961, 9951, and 9971 SIP IP Phones 9.1 Configure Cisco ATA Support, on page 295 Supports T.38 fax relay and fax pass-through on Cisco ATA-187. 9.0 Cisco ATA-187 Phone Feature Support Guide for Unified CME, Unified SRST, Unified E-SRST, and Unified Secure SRST Adds SIP support for the following phone types: • Cisco Unified 6901 and 6911 IPPhones • Cisco Unified 6921, 6941, 6945, and 6961 IP Phones • Cisco Unified 8941 and 8945 IPPhones Cisco Unified SIP IP Phones Cisco Unified Communications Manager Express System Administrator Guide 10 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Localization Support for Cisco Unified SIP IP Phones, on page 409 Provides the following enhanced localization support for Cisco Unified SIP IP phones: • Localization support for Cisco Unified 6941 and 6945 SIP IP Phones. • Locale installer that supports a single procedure for all Cisco Unified SIP IP phones. Localization Enhancements for Cisco Unified SIP IP Phones MIB Support for Extension Mobility in Cisco Unified SCCP IP Phones, on page 729 Adds new MIB objectsto monitor Cisco Unified SCCP IP Extension Mobility (EM) phones. MIB Support for Extension Mobility in Cisco Unified SCCP IP Phones Mixed Shared Lines, on page 231 Allows Cisco UnifiedSIP and SCCP IP phones to share a common directory number. Mixed Shared Lines Multiple Calls Per Line, on page 246 Overcomesthe limitation on the maximum number of calls per line. Multiple Calls Per Line MyPhone Appsfor Cisco Unified SIP IP Phones, on page 1445 Adds support for My Phone Apps feature on Cisco Unified SIP IP phones. MyPhone Appsfor Cisco Unified SIP IP Phones Olson Timezones, on page 122 Olson Timezone Cisco Unified Communications Manager Express System Administrator Guide 11 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Eliminates the need to update time zone commands or phone loads to accommodate a new country with a new time zone or an existing country whose city or state wants to change their time zone, using the olsontimezone command in either telephony-service or voice register global configuration mode. Paging GroupSupport for Cisco Unified SIP IP Phones, on page 859 Allows you to specify a paging-dn tag and dial the paging extension number to page the Cisco Unified SIP IP phone associated with the paging-dn tag or paging group using the paging-dn command in voice register pool or voice register template configuration mode. Paging GroupSupport for Cisco Unified SIP IP Phones Programmable Line Keys ( PLK), on page 929 Addssupport forsoftkeys as programmable line keys on Cisco Unified 6911, 6921, 6941, 6945, 6961, 8941, and 8945SIP IP Phones. Programmable Line Keys for Cisco Unified SIP IP Phones Single Number Reach for Cisco Unified SIP IP Phones, on page 909 Single Number Reach for Cisco Unified SIP IP Phones Cisco Unified Communications Manager Express System Administrator Guide 12 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Supports the following SNR features for Cisco Unified SIP IP phones: • Enable and disable the EM feature. • Manual pull back of a call on a mobile phone. • Send a call to a mobile PSTN phone. • Send a call to a mobile phone regardless of whether the SNR phone is the originating or the terminating side. Unsolicited Notify for Shared Line andPresence Events for Cisco Unified SIP IP Phones, on page 165 Allows the Unsolicited Notify mechanism to reduce network traffic during Cisco UnifiedSIP IP phone registration using the bulk registration method. Unsolicited Notify for Shared Line andPresence Events for Cisco Unified SIP IP Phones Virtual SNR DN for Cisco Unified SCCP IP Phones, on page 910 Allows a call to be made to a virtual SNR DN and allowstheSNR feature to be launched even when the SNR DN is not associated with any phone. Virtual SNR DN for Cisco Unified SCCP IP Phones Hunt Groups, on page 1248 Allows all ephone and voice hunt group call statistics to be written to a file using the hunt-group statistics write-all command. Voice Hunt Group Enhancements Cisco Unified CME 8.8 Cisco Unified Communications Manager Express System Administrator Guide 13 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented CTI CSTA in Cisco Unified CME, on page 1519 Enables the dial-via-office functionality from computer-based CSTA client applications and adds support to CSTA services and events. CTI CSTA ProtocolSuite Enhancement HFS Download Support for IP Phone Firmware and Configuration Files, on page 157 Provides download support for SIP and SCCPIPphone firmware, scripts, midlets, and configuration files using the HTTP File-Fetch Server (HFS) infrastructure. HFS Download Support for IP Phone Firmware and Configuration Files HTTPS support for an ExternalServer, on page 597 Allows you to import an IP phone's trusted certificate to an IP phone's CTL file using the import certificate command. HTTPS Provisioning for Cisco Unified IP Phones System-Defined Locales, on page 408 Addslocalization support for Cisco Unified 3905 SIP and Cisco Unified 6945, 8941, and 8945 SCCP IP Phones. Localization Enhancement Programmable Line Keys ( PLK), on page 929 Addssupport forsoftkeys as programmable line keys on Cisco Unified 6945, 8941, and 8945 SCCP IP Phones. Programmable Line Keys Enhancement Real-Time Transport Protocol Call Information Display Enhancement, on page 248 Allows you to display information on active RTPcalls using the show ephone rtp connections command. The output from this command provides an overview of all the connections in the system, narrowing the criteria for debugging pulse code modulation and Cisco Unified CME packets without a sniffer. Real-Time Transport Protocol Call Information Display Enhancement Cisco Unified Communications Manager Express System Administrator Guide 14 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented SIP Intercom, on page 785 Addsintercom support to Cisco UnifiedSIPphones connected to a Cisco Unified CME system. SIP Intercom Phone Feature Support Guide for Unified CME, Unified SRST, Unified E-SRST, and Unified Secure SRST Adds support for SIP phones connected to a Cisco Unified CME system. Support for Cisco Unified 3905 SIP IP Phones Phone Feature Support Guide for Unified CME, Unified SRST, Unified E-SRST, and Unified Secure SRST Adds support for SCCP phones connected to a Cisco Unified CME system. Support for Cisco Unified 6945, 8941, and 8945 SCCP IP Phones Cisco Unified CME 8.6 Bulk Registration Support for SIP Phones, on page 149 Adds support for SIP phone bulk registration. Bulk Registration Support for SIP Phones 8.6 Cisco Unified Communications Manager Express System Administrator Guide 15 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Clear Directory Entries, on page 1437 Support for Cisco Jabber, on page 1442 Adds ability to clear phone call logs. Adds support for SIP client software for iPhone and iPod Touch. Clear Directory Entries in Missed/Placed/Received Calls List Support for iPhone and iPod Touch Softphone Client Call Forward Unregistered, on page 1148 Addssupport for the CFU feature on SIP IP phones using the call-forward b2bua unregistered command under voice register dn tag. Enhancement for Call-Forward Unregistered Extension Mobility for SIP Phones Enhancement, on page 728 Adds SIP phone support to extension mobility. Extension Mobility Support for SIP phone Define Translation Rules for Callback-Number on SIPPhones, on page 466 Increases the number of translation rules from 15 to 100 rules per translation rule table. Increase in the Number of Translation Rules Localization Support for Cisco Unified SIP IP Phones, on page 409 Multiple Locales, on page 410 Configure Localization Support on SCCP Phones, on page 411 Configure Multiple Locales on SIP Phones, on page 434 Addslocalization support for SIP IP phones. Localization Support for SIP IP Phones SSL VPN Support on Cisco Unified CME with DTLS, on page 1009 Configure SSL VPN Client with DTLS on Cisco Unified CME as VPN Headend, on page 1031 Adds enhancedSSL VPN support. Cisco Unified SCCP IP phones such as 7945, 7965, and 7975 located outside of the corporate network are able to register to Cisco Unified CME through an SSL VPN connection. SSL VPN SUPPORT on CUCME with DTLS Cisco Unified Communications Manager Express System Administrator Guide 16 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Support for 7926G Wireless SCCP IP Phone Phone Feature Support Guide for Unified CME, Unified SRST, Unified E-SRST, and Unified Secure SRST Adds support for 7926G WirelessSCCPIPPhone. Transcoding Resources, on page 473 Allows you to use on-board Digital Signal Processor resources (PVDM3) to facilitate adhoc or meetme video conference calls. Video Conferencing and Transcoding SIP Endpoint Video and Camera Support for Cisco Unified IP Phones 8961, 9951, and 9971, on page 992 Adds video support for IP phones 8961, 9951, and 9971. Video and Camera Support for Cisco Unified IP Phones 8961, 9951, and 9971 Cisco Unified CME 8.5 Cisco Unified Communications Manager Express System Administrator Guide 17 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Configure Button Layout on SCCP Phones, on page 1454 Configure Button Layout on SIP Phones, on page 1456 Allows you to customize the display order of various button types on a phone using the button layout feature. The button layout feature allows you to customize the display of the following button types: • Line buttons • Speed Dial buttons • BLF Speed Dial buttons • Feature Buttons • ServiceURL buttons Customized Button Layout 8.5 Customized Phone User Interface Services, on page 1439 Allows to customize the availability of individual service items such as Extension Mobility, My Phone Apps, and Single Number Reach (SNR) on a phone’s user interface by assigning an individualservice item to a button using the Programmable Line Key (PLK) url-button command. Customized Phone User Interface Services E .164 Enhancements, on page 448 Allowsto present a phone number in + E.164 telephone numbering format. E.164 is an International Telecommunication Union (ITU-T) recommendation that defines the international public telecommunication numbering plan used in the PSTN and other data networks. E.164 Enhancements Cisco Unified Communications Manager Express System Administrator Guide 18 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Enhancement to Voice Hunt Group Restriction Configure Call Coverage Features, on page 1278 Allows you to ignore the timeout value for voice hunt group member and the call forward no answer timer when call forwardnoancommand is configured in a voice hunt group. Feature Policy Softkey Control, on page 928 Allows you to control softkeys on the Cisco Unified SIP IP Phones 8961, 9951, and 9971 using the feature policy template. The feature policy template allows you to enable and disable a list of feature softkeys on Cisco Unified SIP IP Phones 8961, 9951, and 9971. Feature Policy Softkey Control Forced Authorization Code, on page 763 Allows you to manage call access and call accounting through the Forced Authorization Code (FAC) feature. The FAC feature regulatesthe type of call a certain caller may place and forces the caller to enter a valid authorization code on the phone before the call is placed. FAC allows you to track callers dialing non-toll-free numbers, long distance numbers, and also for accounting and billing purposes. Forced Authorization Code Configure Immediate Divert (iDivert) Softkey on SIP Phone, on page 949 Immediate Divert forSIP Phones Cisco Unified Communications Manager Express System Administrator Guide 19 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Allows you to immediately divert a call to a voice messaging system. You can divert a call to a voice messaging system by pressing the iDivert softkey on Cisco Unified SIP IP phones, such as 7940, 7040G, 7960 G, 7945, 7965, 7975, 8961, 9951, and 9971, with voice messaging systems (Cisco Unity Express or Cisco Unity). Enable Media Flow Mode on SIP Trunks, on page 205 Eliminates the need to terminate RTP and re-originate on Cisco Unified CME through the media flow around feature, reducing media switching latency and increasing the call handling capacity for Cisco Unified CME SIP trunks. Media Flow Around Support for SIP-SIP Trunk Calls Example for Configuring Overlap Dialing for SCCP IP Phones, on page 217 Enables overlap dialing on SCCP and SIP IP phones such as, 7942, 7945, 7962, 7965, 7970, 7971, and 7975. Overlap Dialing Support for SIP and SCCP IP Phones Park Monitor, on page 1088 Allows you to park a call and monitor the status of the parked call until the parked call is retrieved or abandoned. When aCisco Unified SIP IP Phone 8961, 9951, or 9971 parks a call using the park softkey, the park monitoring feature monitors the status of the parked call. Park Monitor Enable BLF-Speed-Dial Menu, on page 888 Phone User Interface for BLF-Speed-Dial Cisco Unified Communications Manager Express System Administrator Guide 20 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Allows extension mobility (EM) users to configure dn-based Busy Lamp Field (BLF)-speed-dialsettings directly on the phone through the Services feature button. BLF-speed-dial settings are added or modified (changed or deleted) on the phone using a menu available with the Services button. Programmable Line Keys ( PLK), on page 929 Allows you to program feature buttons or URL services button on phone’s line keys. You can configure line keys as line buttons, speed dials, BLF speed dials, feature buttons, and URL buttons. Programmable Line Keys (PLK) ConfigureSingle Number Reach Enhancements on SCCP Phones, on page 915 Adds enhanced Single Number Reach feature for Cisco Unified CME: • Hardware Conference • Call Park, Call Pickup, and Call Retrieval • Answer Too Soon Timer • SNR Phone Stops Ringing After Mobile Phone Answers SNR Enhancements SSL VPN Client for SCCP IP Phones, on page 1009 Enables Secure Sockets Layer (SSL) Virtual Private Network (VPN) on SCCP IP phones such as 7945, 7965, and 7975. SSL VPN ClientSupport on SCCP IP Phones Cisco Unified Communications Manager Express System Administrator Guide 21 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented XML API for Cisco Unified CME, on page 1574 Adds support for eXtensible Markup Language (XML) Application Programming Interface (API). XML API for Cisco Unified CME Cisco Unified CME 8.1 Toll Fraud Prevention, on page 511 Enables Toll Fraud Prevention on Cisco Unified CME to secure the Cisco Unified CME system against potential toll fraud exploitation by unauthorized users. 8.1 Toll Fraud Prevention Cisco Unified CME Commands: show presence global through subnet. Allows you to verify SIP phone registration process, remove global registration parameters, and display details on phones that attempted to register with Cisco Unified CME and failed. Enhancements to SIP Phone Configuration Ephone-TypeParameters for Supported Phone Types, on page 258 Adds support for new SCCP IP phones 6901 and 6911. Support for Cisco Unified 6901 and 6911 SCCP IP Phones Cisco Unified CME 8.0(1) Cisco Unified Communications Manager Express System Administrator Guide 22 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Call Coverage Features, on page 1239 Enables an SCCP phone user to disable Call Waiting for a call they originate. 8.0 Cancel Call Waiting CTI CSTA Protocol Suite, on page 1519 Allows computer-based CSTA client applications, such as a Microsoft Office Communicator (MOC) client, to monitor and control the Cisco Unified CME system to enable programmatic control of SCCP telephony devices registered in Cisco Unified CME. CTI CSTA ProtocolSuite Configure IP Phones in IPv4, IPv6, or DualStack Mode, on page 167 Adds IPv6 support for SCCP phones. SCCP Phones can interact with and support any SCCP devicesthatsupport IPv4 only or both IPv4 and IPv6 (dual-stack). IPv6 Support for SCCP Endpoints Call Restriction Regulations, on page 1101 Enables a single directory number on an IP or analog phone that is registered to Cisco Unified CME to connect to both PSTN and VoIP calls according to restrictions specified by Telecom Regulatory Authority of India (TRAI) regulations. LogicalPartitioning Class of Restriction (LPCOR) Configure MLPP, on page 813 MLPP enhancements Cisco Unified Communications Manager Express System Administrator Guide 23 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Adds enhanced Multilevel Priority and Preemption (MLPP) featuresfor Cisco Unified CME including: • Additional MLPP announcements for isolated code (ICA), unauthorized precedence level (UPA), loss of C2 features (LOC2), and vacant code (VCA) • Multiple service domains for the Defense Switched Network (DSN) and Defense Red Switched Network (DRSN) • Route codes and service digits in dialing formats • Support for supplementary services, such as Three-Way Conferencing, Call Pickup, and Cancel Call Waiting on Analog FXS ports Configure Music on Hold Groups to Support Different MediaSources, on page 842 Adds support for Music on Hold from different media sources. Music On Hold Enhancement InternetProtocol -Secure Telephone Equipment Support, on page 242 Adds support for secure IP Phone, IP-STE. Secure IP Phone (IP-STE) Support Cisco Unified CME 7.1 Cisco Unified Communications Manager Express System Administrator Guide 24 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Allows you to automatically configure the Cisco VG202, VG204, and VG224 Analog Phone Gateway from Cisco UnifiedCME. Autoconfiguration of Cisco VG202, VG204, and VG224 7.1 Barge and Privacy, on page 1047 Enables phone users to join a call on a SIP shared-line directory number. Barge and cBarge forSIP Phones Presence Service, on page 875 Provides Busy Lamp Field (BLF) indicatorsfor directory numbers that become DND-enabled or are configured as call-park slots, paging numbers, or conference numbers. BLF Monitoring of Ephone-DNs with DND, Call Park, Paging, and Conferencing Presence Service, on page 875 Supports device-based BLF monitoring, allowing a watcher to monitor the status of a phone, not only a line on the phone. BLF Monitoring of Devices Provides a busy trigger and channel huntstop for directory numbers onSIP phones to prevent incoming calls from overloading the phone. Busy Trigger and Channel Huntstop forSIP Phones Adds Call Park features for SIP phones and enhances the Directed Call Park feature. Call Park Enhancements Call Coverage Features, on page 1239 Adds Call Pickup features for SIP phones and enables users to perform Directed Call Pickup using the GPickUp softkey. Call Pickup Enhancements Cisco Unified Communications Manager Express System Administrator Guide 25 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Do Not Disturb, on page 679 Modifies DND behavior so that the SIP phone flashes an alert to visually indicate an incoming call instead of ringing and the call can be answered if desired. DND Enhancement for SIP phones Supports Differentiated Services Code Point (DSCP) packet marking for Cisco Unified IP phones. DSCP Barge and Privacy, on page 1047 Enables phone users to block other users from seeing call information or barging into a call on a SIP shared-line directory number. Privacy for SIP phones Adds shared-line directory numbersforSIP phones. Shared-Line Directory Numbers ConfigureSingle Number Reach, on page 911 Enables users to answer incoming calls on their desktop IP phone or at a remote destination, such as a mobile phone. Single Number Reach (SNR) Video Support, on page 987 Supports video calls betweenSCCPendpoints across different Cisco Unified CME routers connected through a SIP trunk. Supports H.264 codec for video calls. SIP Trunk VideoSupport for SCCP Endpoints Intercom Lines, on page 783 Provides a one-way voice path from the caller to the called party, regardless of whether the called party is busy or idle. The called phone automatically answers in speakerphone mode. Whisper Intercom Cisco Unified Communications Manager Express System Administrator Guide 26 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Cisco Unified CME 7.0(1) Cisco Unified Communications Manager Express System Administrator Guide 27 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Configure System-Level Parameters, on page 167 Upgrade or Downgrade SCCP Phone Firmware, on page 107 Cisco Unified CME 7.0 includes the same features as Cisco Unified CME 4.3, which is renumbered to align with Cisco Unified Communications versions. 7.0(1) Note Automatically creates TFTP bindings using the enhanced loadcommand if cnf location is router flash memory or router slot 0 memory. Cisco Unified CME Usability Enhancement • Introduces locale installer that supports a single procedure for all SCCP IP phones. • Automatically creates the required TFTP aliases for localization. • Provides backward compatibility with the configuration method in Cisco Unified CME 7.0 and earlier versions. Reset and Restart Cisco Unified IP Phones, on page 397 Introduces a Cisco IOS command that disassociates and reestablishes a TAPI session that is in frozen state or out of synchronization. Cisco Unified CME TAPI Enhancement Voice Mail Integration, on page 539 Automatically synchronizes Cisco Unified CME and Cisco Unity Express passwords. Cisco Unity Express AXL Enhancement Cisco Unified IP Phones Cisco Unified Communications Manager Express System Administrator Guide 28 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Cisco Unified Communications Manager Express 7.0/4.3 Supported Firmware, Platforms, Memory, and Voice Products Adds SCCP support for the following phone type: Cisco Unified Communications Manager Express 7.0/4.3 Supported Firmware, Platforms, Memory, and Voice Products • CiscoUnifiedWireless IP Phone 7925 Configure VRFSupport, on page 1556 Adds support for conferencing, transcoding, a RSVP components in Cisco Unified CME through a VRF; also allows soft phones and TAPI clients in data VRF resourcesto communicate with phones in a VRF voice gateway. VRF Support on Cisco Unified CME Cisco Unified CME 7.0/4.3 Cisco Unified Communications Manager Express System Administrator Guide 29 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented SRST Fallback Mode, on page 1539 Allows you to specify whether Cisco Unified CME in SRST Fallback mode creates octo-line or dual-line directory numbers for ephone-dns that are “learned” automatically from the ephone configuration. Autoprovisioning Directory Numbers in SRST Fallback Mode 7.0/4.3 Configure Barge and Privacy, on page 1050 Enables phone users to join a call on a shared octo-line directory number by pressing the Cbarge softkey and converting the call to an ad hoc conference. Barge Enables a transferred call to return to the phone that initiated the transfer if the destination does not answer. Call Transfer Recall Cisco Unified Communications Manager Express System Administrator Guide 30 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Support for Cisco Unified CME on the Cisco 3200 Series Mobile Access Router was added. Cisco 3200Series Mobile Access Router Cisco Unified Communications Manager Express 7.0/4.3 Supported Firmware, Platforms, Memory, and Voice Products Adds SCCP support for the following phone types: • Cisco Unified IP Phone 7915 Expansion Module • Cisco Unified IP Phone 7916 Expansion Module • Cisco Unified IP Conference Station 7937 • Nokia E61 Adds SIP support for the following phone types: • Cisco Unified IP Phone 7942G and 7945G • Cisco Unified IP Phone 7962G and 7965G • Cisco Unified IP Phone 7975G Cisco Unified IP Phones Consultative Transfer Enhancements Cisco Unified Communications Manager Express System Administrator Guide 31 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Modifies the digit-collection process for consultative call transfers. After a phone user presses the Transfer softkey for a consultative transfer, a new consultative call leg is created and the Transfer softkey is not displayed again until the dialed digits of the transfer-to number are matched to a transfer pattern and consultative call leg is in alerting state. Directory Services, on page 659 Increases the number of entries supported in a search resultslist from 32 to 240 when using the directory search feature. Directory Search Enhancement Extension Mobility, on page 725 Adds support for the following: • Automatic Logout, including: ◦Configurable time-of-day timers for automatically logging out all EM users. ◦Configurable idle-duration timer for logging out a single user from an idle EM phone. ◦Automatic Clear Call History when a user logs out from EM. Extension Mobility Enhancement Cisco Unified Communications Manager Express System Administrator Guide 32 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Allows you to dynamically add a new phone type to your configuration without upgrading your Cisco IOS software. Phone-Type Configuration Voice Mail Integration, on page 539 EnablesIPphone usersto record a phone conversation when Cisco Unity Express is the voice mail system. Live Record Sets the maximum number of SCCP phones that can register to Cisco Unified CME using the max-ephones command, without limiting the number that can be configured. This enhancement also expands the maximum number of phones that can be configured to 1000. Maximum Ephones Adds octo-line directory numbers that support up to eight active calls, both incoming and outgoing, on a single phone button. Unlike a dual-line directory number, an octo-line directory number can split its channels among other phones that share the directory number. Octo-Line Directory Numbers Cisco Unified Communications Manager Express System Administrator Guide 33 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Configure Barge and Privacy, on page 1050 Enables phone users to block other users from seeing call information or barging into a call on a shared octo-line directory number. Privacy Configure One-Way Push-to-Talk on Cisco Unified SCCP Wireless IPPhones, on page 1483 Adds support for one-way Push-to-Talk (PTT) in Cisco Unified CME without requiring an externalserver to support the functionality. PTT is supported in firmware version 1.0.4 and later versions on Cisco Unified wireless IP phones with a thumb button. Push-to-Talk Allows IP phone users to Speed Dial, on page 965 configure their own speed-dial and fast-dial settings directly from the phone. Extension Mobility users can add or modify speed-dial settings in their user profile after logging in. Speed Dial/Fast Dial Phone User Interface Voice Mail Integration, on page 539 Allows a phone user to transfer a call directly to a voice-mail extension by pressing the TrnsfVM softkey. Transfer to Voice Mail Call Coverage Features, on page 1239 Voice Hunt-Group Enhancements Cisco Unified Communications Manager Express System Administrator Guide 34 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Supports the following Voice Hunt Group features: • Call Forwarding to a Parallel Voice Hunt-Group (Blast Hunt Group). • Call Transfer to a Voice Hunt-Group. • Member of Voice Hunt-Group can be a SCCP phone, FXS analog phone, DS0-group, PRI-group, SIP phone, orSIPtrunk. Cisco Unified CME 4.2(1) Call Blocking, on page 1061 Adds support for selective call blocking on IP phones and PSTN trunk lines. Call Blocking Enhancements 4.2(1) Create Phone Configurations Using Extension Assigner, on page 347 Provides support for automatically synchronizing configuration changes to backup systems. Extension Assigner Synchronization Access the Cisco Unified CME GUI, on page 528 Allows a phone user to use a name and password from an EM profile to log into the Cisco Unified CME GUI for configuring personal speed dials on an EM phone. EM options in the GUI cannot be accessed from the System Administrator or Customer Administrator login screens. Extension Mobility Phone User support in Cisco Unified CME GUI Cisco Unified CME 4.2 Cisco Unified Communications Manager Express System Administrator Guide 35 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Enhanced 911 Services, on page 687 • Enables routing to thePSAPclosest to the caller by assigning ERLs to zones. • Allows you to customize E911 services by defining a default ELIN, designated number for callback, expiry time for Last Caller table, and syslog messages for emergency calls. • Expands the E911 location information to include name and address. • Uses templates to assign ERLs to a group of phones. • Adds permanent call detail records. 4.2 Enhanced 911 Services Extension Mobility, on page 725 Provides the benefit of phone mobility for end users by enabling the user to log into any local Cisco Unified IP phone that is enabled for extension mobility. Extension Mobility Cisco Unified Communications Manager Express System Administrator Guide 36 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Interoperability with Cisco Unified CCX, on page 1495 Enables interoperability between Cisco Unified CME and Cisco Customer Response Solutions (CRS) 5.0 and later versions with Cisco Unified Contact Center Express (Unified CCX), including Cisco Unified IP IVR, enhanced call processing, device and call monitoring, and unattended call transfers to multiple call center agents and basic extension mobility. Interoperability with Cisco Unified Contact Center Express (Cisco UCCX) Provides the following Security, on page 581 secure voice call capabilities: • Secure call control signaling and media streams in Cisco Unified CME networks using Secure Real-Time Transport Protocol (SRTP) and H.323 protocols. • Secure supplementary services for Cisco Unified CME networks using H.323 trunks. • Secure Cisco VG224 Analog Phone Gateway endpoints. Media Encryption (SRTP) on Cisco Unified Communications Manager Express Cisco Unified CME 4.1 Cisco Unified Communications Manager Express System Administrator Guide 37 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented When a user enables Call Forward All on a SIP phone using the CfwdAll softkey, the uniform resource identifier (URI) for the service is sent to Cisco Unified CME. When Call Forward All is configured in Cisco Unified CME, the configuration is sent to the SIP phone which updates the CfwdAll softkey to indicate that Call forward All is enabled. Call Forward All Synchronization 4.1 Cisco Unified Communications Manager Express System Administrator Guide 38 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Cisco Unified CME 4.1 Supported Firmware, Platforms, Memory, and Voice Products Adds SCCP support for the following phones: • Cisco Unified IP Phone 7921G • Cisco Unified IP Phone 7942G and 7945G • Cisco Unified IP Phone 7962G and 7965G • Cisco Unified IP Phone 7975G Adds SIP support for the following phones: • Cisco Unified IP Phone 3911 • Cisco Unified IP Phone 3951 • Cisco Unified IP Phone 7911G • Cisco Unified IP Phone 7941G and 7941G-GE • Cisco Unified IP Phone 7961G and 7961G-GE • Cisco Unified IP Phone 7970G and 7971G-GE No additional configuration is required for these phones. They are supported in the appropriate Cisco IOS commands. Cisco Unified IP Phones Directory Services, on page 659 Supports local directory and local speed dial features for SIP phones. Directory Services Cisco Unified Communications Manager Express System Administrator Guide 39 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Disabling SIP Supplementary Services for CallForward and Call Transfer Allows you to prevent REFER messagesfor call transfers and redirect responses for call forwarding from being sent by Cisco Unified CME if a destination gateway does not support supplementary services. Supports disabling of supplementary servicesif all endpoints use SCCP or all endpoints use SIP. Enhanced 911 Services, on page 687 Routes callers dialing 911 to the correct location. Enhanced 911 Services for Cisco Unified CME in SRST Fallback Mode Allows Key Press Markup Language (KPML) to report SIP phone users’ input digit by digit to Cisco Unified CME, which performs pattern recognition by matching a destination pattern to a dial peer as it collects the dialed digits. KPML Conferencing, on page 1369 Provides the following enhancements: • Enhanced ad-hoc conferences are hardware-based and allow more than three parties. • Meet-me conferences consist of at least three parties dialing a meet-me conference number. Multi-PartyConferencing Enhancements Network Parameters, on page 121 Network Time Protocol Cisco Unified Communications Manager Express System Administrator Guide 40 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Allows SIP phones registered to a Cisco Unified CME router to synchronize to a Network TimeProtocol (NTP) server, known as the clock master. Network Parameters, on page 121 Allows remote applications to establish calls by sending an out-of-dialog REFER (OOD-R) message to Cisco Unified CME without an initial INVITE. After the REFER message is sent, the remainder of the call setup is independent of the application and the media stream does not flow through the application. Out-of-Dialog REFER Presence Service, on page 875 Allows presence to support BLF notification features for speed dial buttons and directory call lists for missed calls, placed calls, and received calls. SIP and SCCP phones that support BLF speed-dial and BLF call-list features can subscribe to status notification for internal and external directory numbers. Presence with BLFStatus Reset and Restart Cisco Unified IP Phones, on page 397 Allows SIP phones to quickly reset using the restart command. Phones contact the TFTP server for updated configuration information and re-register without contacting the DHCP server. Restarting Phones Cisco Unified Communications Manager Express System Administrator Guide 41 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Session Transport Allows TCPto be used as the transport protocol for supported SIP phones connected to Cisco Unified CME. Previously, only UDP was supported. Enables SIP phones to perform local digit collection and recognize dial patterns as user input is collected using dial plans. After a pattern is recognized, the SIP phone sends an INVITE message to Cisco Unified CME to initiate the call. SIP Dial Plans Customize Softkeys, on page 925 Allows you to customize the display and order of softkeys that appear on individual SIP phones during the connected, hold, idle, and seized call states. Softkeys Allows SIP phones in a Dial Plans, on page 445 Cisco Unified CME system to support translation rules with functionality similar to phones running SCCP. Translation rules can be applied to incoming calls for directory numbers on a SIP phone. Translation Rules Cisco Unified CME 4.0(3) Cisco Unified Communications Manager Express System Administrator Guide 42 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Voice Mail Integration, on page 539 Allows Cisco Unified IP Phone 7911 and Cisco Unified IP Phone 7931G to be configured to receive AMWI (Audible Message Line Indicator) and visual MWI notification from an external voice-messaging system. 4.0(3) AMWI Cisco Unified CME 4.0(3) Supported Firmware, Platforms, Memory, and Voice Products Adds support for the following phones: • Cisco Unified IP Phone 7906G • Cisco Unified IP Phone 7931G Cisco Unified IP Phones Introduces the DSS Speed Dial, on page 965 (Direct Station Select) feature that allows the phone user to press a single speed-dial line button to transfer an incoming call when the call is in the connected state. This feature is supported on all phones on which monitor line buttons for speed dial or speed-dial line buttons are configured. DSS Create Phone Configurations Using Extension Assigner, on page 347 Allows installation technicians to assign extension numbers to phones without administrative access to Cisco Unified CME, typically during the installation of new phones or the replacement of broken phones. Extension Assigner ConfigureFax Relay, on page 753 Fax Relay Cisco Unified Communications Manager Express System Administrator Guide 43 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Introduces a SCCP-enhanced feature that adds support for Cisco Fax Relay and Super Group 3 (SG3) to G3 fax relay. The feature allows the fax stream between two SG3 fax machines to negotiate down to G3 speeds (less than 14.4 kbps) allowing SG3 fax machines to interoperate over fax relay with G3 fax machines. Cisco Unified CME 4.0(1) Cisco Unified Communications Manager Express System Administrator Guide 44 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Automatic call forwardingduringnight service—Ephone-dns (extensions) can be designated to automatically forward their calls to a specified number during the time that night service is in effect. Blocking call forwarding of local calls—Forwarding of local (internal) calls from other Cisco Unified CME ephones can be blocked. External calls will continue to be forwarded as specified by the configuration for the ephone-dns. Selective call forwarding—Call forwarding for busy and no-answer ephone-dns can be applied selectively based on the number that a caller dials for a particular ephone-dn: the primary number, the secondary number, or either of those numbers expanded through the use of a dial-plan pattern. 4.0(1) Call Forwarding Cisco Unified Communications Manager Express System Administrator Guide 45 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Call park blocked per ephone—Individual ephones can be blocked from parking calls at call-park slots. Callparkredirect—You can specify that calls use the H.450 or SIP Refer method of call forwarding or transfer to park calls and to pick up calls from park. Dedicated call-park slots—A private call-park slot can be configured for each ephone. Directpickupofparked call on monitored park slot —A call that is parked on a monitored call-park slot can be picked up by pressing the assigned monitor button. Call Park Call Coverage Features, on page 1239 Directed call pickup disable—Theno service directed-pickup command globally disables directed call pickup and changes the action of the PickUp softkey to invoke local group pickup rather than directed call pickup. Call Pickup Call Transfer Cisco Unified Communications Manager Express System Administrator Guide 46 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Call transfer blocking—When call transfers to phones outside the Cisco Unified CME system have been globally enabled, you can block them for individual ephones. Call transferdestination digits limited—When call transfers to phones outside the Cisco Unified CME system have been globally enabled, you can limit the number of digits that can be dialed when transferring a call. transfer-system command—The command default has been changed from the blind keyword to the full-consult keyword, making H.450.2 consultative transfer the default method. QSIG supplementary servicessupport—H.450 supplementary services features allow Cisco Unified CME phones to use QSIG to interwork with PBX phones. IP phones can use a PBX message center with proper MWI notifications. Cisco Unified CME 4.0 Supported Firmware, Platforms, Memory, And Voice Products Cisco Unified IP Phones Cisco Unified Communications Manager Express System Administrator Guide 47 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Adds support for the following phones: • Cisco Unified IP Phone 7911G • Cisco Unified IP Phone 7941G and 7941G-GE • Cisco Unified IP Phone 7961G and 7961G-GE No additional configuration is required for these phones. They are supported in the appropriate Cisco IOS commands. Conferencing, on page 1369 Drop last party or keep parties connected—New options specify whether the last party that joined a conference can be dropped from the conference and whether the remaining two parties should be allowed to continue their connection after the conference initiator has left the conference. Improved conference display—A Cisco Unified IP phone that is connected to a three-way conference displays “Conference.” No special configuration is required. Conferencing Cisco Unified Communications Manager Express System Administrator Guide 48 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Feature Access Codes, on page 757 Feature Access Code (FAC) support—The same FACs that are used by analog phones can be enabled for IP phones. In addition, standard FACs can be customized and aliases can be created to simplify the dialing of a FAC and any additional digits that are required to activate the feature. Feature Access Codes Headset Auto Answer, on page 777 Headset auto-answer—When the headset key on a phone is activated, lines on the phone that are specified for headset auto-answer will automatically connect to incoming calls after playing an alerting tone to notify the phone user of the incoming call. This feature is available on Cisco Unified IP Phones 7940G, 7960G, 7970G, and 7971G-GE. Headset Auto-Answer Cisco Unified Communications Manager Express System Administrator Guide 49 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Call Coverage Features, on page 1239 Hunt Groups Cisco Unified Communications Manager Express System Administrator Guide 50 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Agent status control—Hunt group agents can put their phones in a not-ready state to temporarily suspend the receiving of hunt group calls by using the HLog softkey. A new FAC can toggle ready and not-ready state. Automatic agent not-ready status—The criterion for placing a hunt group agent into not-ready status (previously called automatic logout) was changed. If an agent does not answer the number of consecutive hunt-group calls that you specify in the auto logout command, the agent’s ephone-dn is put into not-ready status (logged out) and will not receive further hunt group calls. Call hold statistics—New fields describing the length of time that calls spend in the hold state are in the statistical reports for Cisco Unified CME B-ACD applications.See the show ephone-hunt statistics command and the hunt-group report url command in Cisco Unified CME B-ACD and Tcl Call-Handling Applications. Dynamic hunt group membership—Agents can join or leave a hunt group using standard or custom FACs when Cisco Unified Communications Manager Express System Administrator Guide 51 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented wildcard slots are configured for hunt groups and the agents’ ephone-dns are authorized to join hunt groups. Change in hops commanddefault—The maximum number of hops allowed by a hunt group is automatically adjusted to reflect the dynamically changing number of members. Enhanced display of ephone hunt-group information—A text string can be added to provide information in configuration output and to display on IP phones when a hunt-group call is ringing or answered or when all hunt-group members are logged out. Local call forwarding restrictioninsequential ephonehunt groups—In sequential ephone-hunt groups, local (internal) calls to the hunt group can be prevented from being forwarded beyond the first ephone-dn in the hunt group. Cisco Unified Communications Manager Express System Administrator Guide 52 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Call Coverage Features, on page 1239 Hunt Groups Cisco Unified Communications Manager Express System Administrator Guide 53 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Longest-idlehunt group improvement—The from-ring command specifies that on-hook time stamps should be updated when a call rings an agent and when a call is answered by an agent. Maximum number of agents—The maximum number of agents per hunt group has increased from 10 to 20. No special configuration isrequired. Maximum number of hunt groups—The maximum number of hunt groups per Cisco Unified CME system has increased from 10 to 100. No special configuration is required. No-answer timeout enhancements—No-answer timeouts in ephone hunt groups can be set individually for each ephone-dn in the list. A maximum cumulative no-answer timeout can be also be set. Restrictingpresentation of calls to idle or on-hook phones—The presentation of hunt group calls can be restricted to hunt-group members on phones that are idle or on-hook. This enhancement considers all lines on the phone, both members of the hunt group and nonmembers, when restricting presentation of hunt group calls. Cisco Unified Communications Manager Express System Administrator Guide 54 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Return to a secondary destinationinanephone hunt group after call park—Calls parked by hunt group agents can be returned to a different entry point in the hunt group. Return to transferring party on no answer in an ephone hunt group—A call that was transferred into a hunt group and was not answered can be returned to the party that transferred it to the hunt group instead of being sent to voice mail or another final destination. Multiple user locales and network locales—Up to five user and network locales are supported. User-defined user locales and network locales— User-defined locales can be added for supported phones. Localization Cisco Unified Communications Manager Express System Administrator Guide 55 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Music on Hold, on page 829 Music on hold (MOH) for internal calls—Internal callers (those making calls between extensionsin the same Cisco Unified CME system) hear music when they are on hold or are being transferred. The mulitcast mohcommand must be used to enable the flow of packets to the subnet on which the phones are located. Internal extensions that are connected through an analog voice gateway or through a WAN (remote extensions) do not hear MOH on internal calls. The ability to disable multicast MOH per phone was introduced, using the no multicast-mohcommand in ephone or ephone-template configuration mode. Music on Hold Cisco Unified Communications Manager Express System Administrator Guide 56 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Call Coverage Features, on page 1239 Overlaid ephone-dns—The maximum number of overlaid ephone-dns per ephone button has increased from 10 to 25. No special configuration is required. Overlaid ephone-dn call-waiting display—The number of waiting calls that can be displayed for overlaid ephone-dnsthat have call waiting configured has been increased to six for the Cisco IP Phone 7940G, 7941G, 7941G-GE, 7960G, 7961G, 7961G-GE, 7970G, and 7971G-GE. The overlaid ephone-dns must be configured on the phone using the button command and the c keyword. Overlaidephone-dncall overflow to other buttons—One or more buttons can be dedicated to serve as expansion or overflow buttons for another button on the same Cisco Unified IP phone that has overlaid ephone-dns. A call to an overlay button that is busy with an active call will roll over to the next available expansion button. Overlaid Ephone-dns Phone Support Cisco Unified Communications Manager Express System Administrator Guide 57 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Cisco IP Communicator is a software-based application that appears on a user’s computer monitor as a graphical, display-based IP phone with a color screen, a key pad, feature buttons, and softkeys. Cisco Unified CME supports Cisco IP Communicator 2.0 and later versions. Remote teleworker phone—Teleworkers can connect remote phones over a WAN and be directly supported by Cisco Unified CME. Distinctive ringing—An Ringtones, on page 899 extension’s ring patterns can be set to distinguish among internal, external, and feature calls. Ring Tones Cisco Unified CME Security, on page 581 phone authentication is a security infrastructure for providing secure Skinny Client Control Protocol (SCCP) signaling between Cisco Unified CME and IP phones. Security Customize Softkeys, on page 925 Softkeys Cisco Unified Communications Manager Express System Administrator Guide 58 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Feature blocking—The features associated with the following softkeys can be individually blocked per ephone: CFwdAll, Confrn, GpickUp, Park, PickUp, and Trnsfer. The softkey is not removed, but it does not function. Softkey control forhold state—The softkeys that are available while a call is on hold can be modified. The NewCall and Resume softkeys are normally available when a phone has a call on hold, but a template can be applied to the phone to remove these softkeys. Bulk-loading of Speed Dial, on page 965 speed-dial numbers—Text files with lists of speed-dial numbers can be loaded into system flash or a URL. The files can hold up to 10,000 numbers and can be applied to all ephones or to specific ephones. Speed Dial Cisco Unified Communications Manager Express System Administrator Guide 59 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented System-LevelParameters Cisco Unified Communications Manager Express System Administrator Guide 60 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Disabling automatic phone registration—Normally, Cisco Unified CME allocates an ephone slot to any ephone that connects to the system. To prevent unauthorized registrations, the no auto-reg-ephone command prevents any ephone from registering with Cisco Unified CME if its MAC address is not explicitly listed in the configuration. External storage of configuration files and per-phone configuration files—Phone configuration files can be stored on an external TFTP server to offload the TFTPserver function of the Cisco Unified CME router. This additional storage space permits the use of per-phone configuration files, which can be used to specify different user locales and network locales for phones. Failover to Redundant Router—Sites can be set up with a primary and secondary Cisco Unified CME router to provide redundant Cisco Unified CME capability. Phones automatically register at the secondary router if the primary router fails and later rehome to the primary router when it is Cisco Unified Communications Manager Express System Administrator Guide 61 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented operational again. Maximum number of Templates, on page 1427 ephone templates—The maximum number of ephone templatesthat can be defined has increased from 5 to 20. No special configuration isrequired. New commands available for ephone templates—Ephone templates were previously introduced to allow system administrators to control the display of softkeys in various call states on individual ephones. Their role has been expanded to allow you to define a set of ephone parameter values that can be assigned to one or more phones in a single step. Ephone-dn templates—Ephone-dn templates are introduced to allow administratorsto easily apply sets of configured parameters to individual ephone-dns. Up to 15 ephone-dn templates can be defined. Templates Video Support, on page 987 Video Support Cisco Unified Communications Manager Express System Administrator Guide 62 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Video support for SCCP-based endpoints—This feature adds video support to allow you to pass a video stream with a voice call between video-capable SCCP endpoints and betweenSCCPand H.323 endpoints. Through the Cisco Unified CME router, the video-capable endpoints can communicate with each other locally to a remote H.323 endpoint through a gateway or through an H.323 network. Voice Mail Integration, on page 539 Voice Mail Cisco Unified Communications Manager Express System Administrator Guide 63 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented Line-selectable MWI—Previously, the message-waiting indication (MWI) lamp on a phone could only indicate when messages were waiting for the primary number on a phone. Now, any phone line can be designated during configuration. Mailbox selectionpolicy for voice-mail servers—A policy can be set for selecting the mailbox to use for calls that are diverted one or more times within a Cisco Unified CME system before being sent to a Cisco Unity Express, Cisco Unity, or PBX voice-mail pilot number. Prefix option for SIP unsolicited MWI Notify messages—Central voice-message servers that provide mailboxes for multiple Cisco Unified CME sites may use site codes or prefixes to distinguish among similarly numbered ranges of extensions at different sites. You can specify the prefix for yoursite so that central mailbox numbers are correctly converted to your extension numbers. Configure XML API, on page 1609 XML Interface Cisco Unified Communications Manager Express System Administrator Guide 64 Cisco Unified CME Features Roadmap Version Feature Name Feature Description Where Documented XML interface enhancements—An eXtensible Markup Language (XML) application program interface (API) is provided to supply data from Cisco Unified CME to managementsoftware. In Cisco Unified CME 4.0 and later versions, all Cisco Unified CME features have XML support. • Obtaining Documentation, Obtaining Support, and Security Guidelines, page 65 Obtaining Documentation, Obtaining Support, and Security Guidelines For information on obtaining documentation, obtaining support, providing documentation feedback, security guidelines, and also recommended aliases and general Cisco documents, see the monthly What’s New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at: http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html DISCLAIMER: The use of monitoring, recording, or listening devices to eavesdrop, monitor, retrieve, or record phone conversations or othersound activities, whether or not contemporaneous with transmission, may be illegal in certain circumstances under federal, state and/or local laws. Legal advice should be sought prior to implementing any practice that monitors or records any phone conversation. Some laws require some form of notification to all parties to a phone conversation, such as by using a beep tone or other notification method or requiring the consent of all parties to the phone conversation, prior to monitoring or recording the phone conversation. Some of these laws incorporate strict penalties. In cases where local laws require a periodic beep while a conversation is being recorded, the Cisco Unity Express voice-mail system provides a user with the option of activating “the beep.” Prior to activating the Cisco Unity Express live record function, check the laws of all applicable jurisdictions. This is not legal advice and should not take the place of obtaining legal advice from a lawyer. IN ADDITION TO THE GENERAL DISCLAIMER THAT ACCOMPANIES THIS CISCO UNITY EXPRESSPRODUCT,CISCO ADDITIONALLY DISCLAIMS ANY AND ALL LIABILITY, BOTH CIVIL AND CRIMINAL, AND ASSUMES NO RESPONSIBILITY FOR THE UNAUTHORIZED AND/OR ILLEGAL USE OF THIS CISCO UNITY EXPRESS PRODUCT. THIS DISCLAIMER OF LIABILITY INCLUDES, BUT IS NOT NECESSARILY LIMITED TO, THE UNAUTHORIZED AND/OR ILLEGAL RECORDING AND MONITORING OF TELEPHONE CONVERSATIONS IN VIOLATION OF APPLICABLE FEDERAL, STATE AND/OR LOCAL LAWS.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third-party Cisco Unified Communications Manager Express System Administrator Guide 65 Cisco Unified CME Features Roadmap Obtaining Documentation, Obtaining Support, and Security Guidelines trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company (1110R). Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figuresincluded in the document are shown for illustrative purposes only. Any use of actual IPaddresses or phone numbers in illustrative content is unintentional and coincidental. Cisco Unified Communications Manager Express System Administrator Guide (All Versions) © 2016 Cisco Systems, Inc. All rights reserved. Cisco Unified Communications Manager Express System Administrator Guide 66 Cisco Unified CME Features Roadmap Obtaining Documentation, Obtaining Support, and Security Guidelines CHAPTER 2 Cisco Unified CME Overview • Important Information about Cisco IOS XE 16 Denali, page 67 • Introduction, page 67 • Licenses, page 69 • PBX or Keyswitch, page 73 • Call Detail Records, page 75 • Additional References, page 76 Important Information about Cisco IOS XE 16 Denali Effective Cisco IOS XE Release 3.7.0E (for CatalystSwitching) and Cisco IOS XE Release 3.17S(for Access and Edge Routing) the two releases evolve (merge) into a single version of converged release—the Cisco IOS XE 16 Denali—providing one release covering the extensive range of access and edge productsin theSwitching and Routing portfolio. For migration information related to the Cisco IOS XE 16, see Cisco IOS XE Denali 16.2 Migration Guide for Access and Edge Routers. Introduction The Cisco Unified Communications Manager ExpressSystem Administrator Guide refers to a phone with SIP firmware as SIP Phone, SIP IP Phone, or Cisco Unified SIP IP phone. A phone with SCCP firmware is referred as SCCP Phone, SCCP IP Phone, or Cisco Unified SCCP IP phone. Note Cisco Unified Communications Manager Express (formerly known as Cisco Unified CallManager Express) is a call-processing application in Cisco IOS software that enables Cisco routers to deliver key-system or hybrid PBX functionality for enterprise branch offices or small businesses. Cisco Unified CME is a feature-rich entry-level IPtelephony solution that is integrated directly into Cisco IOS software. Cisco Unified CME allowssmall business customers and autonomoussmall enterprise branch offices Cisco Unified Communications Manager Express System Administrator Guide 67 to deploy voice, data, and IP telephony on a single platform for small offices, thereby streamlining operations and lowering network costs. Cisco Unified CME is ideal for customers who have data connectivity requirements and also have a need for a telephony solution in the same office. Whether offered through a service provider’s managed services offering or purchased directly by a corporation, Cisco Unified CME offers most of the core telephony featuresrequired in the small office, and also many advanced features not available with traditional telephony solutions. The ability to deliver IP telephony and data routing by using a single converged solution allows customers to optimize their operations and maintenance costs, resulting in a very cost-effective solution that meets office needs. A Cisco Unified CME system is extremely flexible because it is modular. A Cisco Unified CME system consists of a router thatserves as a gateway and one or more VLANsthat connect IPphones and phone devices to the router. Figure 1: Cisco Unified CME for theSmall- and Medium-Size Office, on page 68 shows a typical deployment of Cisco Unified CME with several phones and devices connected to it. The Cisco Unified CME router is connected to the public switched telephone network (PSTN). The router can also connect to a gatekeeper and a RADIUS billing server in the same network. Figure 1: Cisco Unified CME for the Small- and Medium-Size Office Figure 2: Cisco Unified CME for Service Providers, on page 69 shows a branch office with several Cisco Unified IP phones connected to a Cisco IAD2430 series router with Cisco Unified CME. The Cisco Unified Communications Manager Express System Administrator Guide 68 Cisco Unified CME Overview Introduction Cisco IAD2430 router is connected to a multiservice router at a service provider office, which provides connection to the WAN and PSTN. Figure 2: Cisco Unified CME for Service Providers A Cisco Unified CME system uses the following basic building blocks: • Ephone or voice register pool—A software concept that usually represents a physical telephone, although it is also used to represent a port that connectsto a voice-mailsystem, and providesthe ability to configure a physical phone using Cisco IOS software. Each phone can have multiple extensions associated with it and a single extension can be assigned to multiple phones. Maximum number of ephones and voice register pools supported in a Cisco Unified CME system is equal to the maximum number of physical phones that can be connected to the system. • Directory number—A software concept that represents the line that connects a voice channel to a phone. A directory number represents a virtual voice port in the Cisco Unified CME system, so the maximum number of directory numbers supported in Cisco Unified CME is the maximum number of simultaneous call connections that can occur. This concept is different from the maximum number of physical lines in a traditional telephony system. Licenses You must purchase a base Cisco Unified CME feature license and phone user licenses that entitle you to use Cisco Unified CME. In Cisco Unified CME Release 11, you should purchase: Cisco Unified CME Permanent License When you purchase a Cisco Unified CME permanent license, the permanent license is installed on the device when the product is shipped to you. A permanent license never expires and you will gain access to that Cisco Unified Communications Manager Express System Administrator Guide 69 Cisco Unified CME Overview Licenses particular feature set for the lifetime of the device across all IOS release. If you purchase a permanent license for Cisco Unified CME , you do not have to go through the Evaluation Right to Use and Right To Use (RTU) licensing processes for using the features. If you want to purchase a CME-SRST license for your existing device, you have to go through the RTU licensing process for using the features. There is no change in the existing process for purchasing the license. The Cisco Unified CME permanent license is available in the form of an XML cme-locked3 file. You should get the XML file and load it in the flash memory of the device. To install the permanent license from the command prompt, use the license install flash0:cme-locked3 command. The cme-locked3 is the xml file of the license. Collaboration Professional Suite License Collaboration Professional is a new suite of licenses. The Collaboration Professional Suite can be purchased either as a permanent license or an RTU license. Collaboration Professional Suite Permanent License —When you purchase the Collaboration Professional Suite license, by default, the Cisco Unified CME licenses are delivered as part of the CollaborationProfessional Suite. You do not have to separately install and activate the Cisco Unified CME license. The Collaboration Professional Suite permanent license is available in the form of an XML file. You should get the XML file and load it in the flash memory of the device. To install the permanent license from the command prompt, use the license install flash:lic_name command. Collaboration Professional Suite RTU License—When you purchase the Collaboration Professional Suite RTU license, you do not have to go through the Evaluation Right to Use process. However, you have to go through the RTU licensing process for using the Cisco Unified CME features. To install the Collaboration ProfessionalSuite RTU license from the command prompt, use the license install flash0:colla_pro command. To activate the license, use the licenseboot module c2951 technology-package collabProSuitek9 command. Cisco Smart License From Release 11.7 onwards, Cisco Unified CME supports Smart Licensing, apart from the existing CSL licensing model.Smart Licensing issupported only on Cisco 4000SeriesIntegratedServices Router. Depending on the technology package available on the router, licenses such as UCK9 and Security are supported using Smart Licensing. Cisco Smart Software Manager satellite which is a component of Cisco Smart Licensing is not supported for Unified CME. Note TheSmart Licensing feature is a software based licensing model that gives you visibility into license ownership and consumption. The Smart Licensing model consists of a web interface named Cisco Smart Software Manager (CSSM). CSSM is a central license repository that manages licenses across all Cisco products that you own, including Unified CME. Your access to the CSSM account is authenticated using valid Cisco credentials. You can use the CSSM Smart Account to generate valid tokens IDs. The token IDs are used to register the Unified CME device with your CSSM Smart Account. Once the token is generated, it can be used to register many other product instances in your network. On the Unified CME router, you need to ensure that the call home feature is not disabled. Also,Smart Licensing feature should be enabled at the router using the CLI command license smart enable. Use the no form of the Cisco Unified Communications Manager Express System Administrator Guide 70 Cisco Unified CME Overview Collaboration Professional Suite License command to disable smart licensing. For more information on configuring Smart Licensing in your router, see Software Activation Configuration Guide, Cisco IOS Release 15M&T. Once the smart license is enabled and the router is not yet registered with CSSM, the device enters an evaluation period of 90 days. You can register the router to CSSM with the token ID. To register the device (Unified CME router) with CSSM, use the CLI command license smart register idtoken. For information on registering the device with CSSM, see Software Activation Configuration Guide. Upon successful registration, Unified CME isin Registered status. Then, Unified CME sends an authorization request for all the phones configured. Based on the licenses in the Smart Account, CSSM responds with one of the defined statuses such as Authorized (using less than it has licenses for) or Out-of-Compliance (using more than it has licenses for). The CSSM assigns licenses that are available in your CSSM account to the phones configured across the routers. Unified CME supports only one license entitlement to validate phones configured on Unified CME. • CME_EP—This license type supports all phones configured on Unified CME. The CME_EPlicense count reflectsthe total phone count of both the ephones and poolsthat are configured in the Unified CME irrespective of whether the phones are registered or not. Note Unified CME sends an authorization request when a license consumption changes or every 30 days to let CSSM know it's still available and communicating. The ID certificate issued to identify Unified CME at time of registration is valid for one year, and is automatically renewed every six months. Note If the router does not communicate with CSSM for a period of 90 days, the license authorization expires. The license count is evaluated for the number of phones configured across the routers. The CSSM Licenses page reflectsthe total license count usage. The total number of licenses available for a type of license (Quantity), number of licenses currently use (In Use), and the number of unused or over-used licenses(Surplus/Shortage). For example, consider a smart account in CSSM with 50 CME_EP licenses. If the user has a single registered Unified CME with 20 analog phones configured, the CSSM licenses page will reflect Quantity as 50, In Use as 20, andSurplus as 30.For more information onSmartSoftware manager,see CiscoSmartSoftware Manager User Guide. Once a new phone is configured on a Unified CME registered with CSSM, a timer is initiated to report the phone configuration to CSSM. A new phone configuration is reported only at the end of the time set in the timer (3 minutes). Hence, the Smart Agent reports all the new configurations created within the time period defined using the preset timer. The CSSM increments the license usage count based on the report sent by Smart Agent. If the number of phones configured exceeds the license limit, then CSSM generates an alert in the user account. When a phone configuration is removed, the license usage count is decremented. The license entitlement for Unified CME smart license is displayed on the router as follows: Router# show license summary Smart Licensing is ENABLED Registration: Status: REGISTERED Smart Account: Call-Manager-Express Virtual Account: CME Application Export-Controlled Functionality: Not Allowed Last Renewal Attempt: None Next Renewal Attempt: Oct 07 12:08:10 2016 UTC Cisco Unified Communications Manager Express System Administrator Guide 71 Cisco Unified CME Overview Cisco Smart License License Authorization: Status: AUTHORIZED Last Communication Attempt: SUCCESS Next Communication Attempt: May 13 07:11:48 2016 UTC License Usage: License Entitlement tag Count Status ----------------------------------------------------------------------------- regid.2014-12.com.ci... (ISR_4351_UnifiedCommun..) 1 AUTHORIZED regid.2016-10.com.ci... (CME_EP) 4 AUTHORIZED Licensing Modes From Unified CME 11.7 onwards, both CSL and Smart Licensing modes are supported. That is, customers can continue with CSL by not enabling Smart Licensing. Alternatively, they can enable Smart Licensing and decide later to go back to CSL by disabling Smart Licensing with the no license smart enable command. When you switch to CSL from the Smart Licensing mode, you need to ensure that the End User License Agreement (EULA) issigned. CSL is notsupported unlessthe EULA issigned. Use the CLI command license accept end user agreement in global configuration mode to configure EULA. To verify the status of the license issued to phones registered on Unified CME, you can use the show license command. Router#show license ? all Show license all information status Show license status information suites Show license suite information summary Show license summary tech Show license tech support information udi Show license udi information usage Show license usage information Restrictions • For the Cisco Unified CME license, the UCK9 technology package must be available if the Collaboration Professional Suite package is not installed. • UCK9 is a prerequisite for Cisco Unified CME Release 11. As compared to Unified CME Release 10.5 and prior, all the future releases of Unified CME displays the CME-SRST license state as Active, Not in Use. This is applicable when Unified CME is removed from the router (configure no telephony-service and no voice register global to remove Unified CME from the router). Note To activate the Cisco Unified CME feature license, see Activating CME-SRST Feature License. Cisco Unified Communications Manager Express System Administrator Guide 72 Cisco Unified CME Overview Restrictions To support H.323 call transfers and forwards to network devices that do not support the H.450 standard, such as Cisco Unified Communications Manager, a tandem gateway isrequired in the network. The tandem gateway must be running Cisco IOS Release 12.3(7)T or a later release and requires the Integrated Voice and Video Services feature license (FL-GK-NEW-xxx), which includes the H.323 gatekeeper, IP-to-IP gateway, and H.450 tandem functionality. Note PBX or Keyswitch When setting up a Cisco Unified CME system, you need to decide if call handling should be similar to that of aPBX,similar to that of a keyswitch, or a hybrid of both. Cisco Unified CME providessignificant flexibility in this area, but you must have a clear understanding of the model that you choose. PBX Model The simplest model is the PBX model, in which most of the IP phones in your system have a single unique extension number. IncomingPSTN calls are routed to a receptionist at an attendant console or to an automated attendant. Phone users may be in separate offices or be geographically separated and therefore often use the telephone to contact each other. For this model, we recommend that you configure directory numbers as dual-lines so that each button that appears on an IP phone can handle two concurrent calls. The phone user toggles between calls using the blue navigation button on the phone. Dual-line directory numbers enable your configuration to support call waiting, call transfer with consultation, and three-party conferencing (G.711 only). Figure 3: Incoming Call Using PBX Model, on page 73 shows a PSTN call that is received at the Cisco Unified CME router, which sends it to the designated receptionist or automated attendant (1), which then routes it to the requested extension (2). Figure 3: Incoming Call Using PBX Model For configuration information, see Configure Phones for a PBX System, on page 253. Cisco Unified Communications Manager Express System Administrator Guide 73 Cisco Unified CME Overview PBX or Keyswitch Keyswitch Model In a keyswitch system, you can set up most of your phones to have a nearly identical configuration, in which each phone is able to answer any incoming PSTN call on any line. Phone users are generally close to each other and seldom need to use the telephone to contact each other. For example, a 3x3 keyswitch system has three PSTN lines shared across three telephones, such that all three PSTN lines appear on each of the three telephones. This permits an incoming call on any PSTN line to be directly answered by any telephone—without the aid of a receptionist, an auto-attendant service, or the use of (expensive) DID lines. Also, the lines act as shared lines—a call can be put on hold on one phone and resumed on another phone without invoking call transfer. In the keyswitch model, the same directory numbers are assigned to all IP phones. When an incoming call arrives, it rings all available IP phones. When multiple calls are present within the system at the same time, each individual call (ringing or waiting on hold) is visible and can be directly selected by pressing the corresponding line button on an IPphone. In this model, calls can be moved between phonessimply by putting the call on hold at one phone and selecting the call using the line button on another phone. In a keyswitch model, the dual-line option is rarely appropriate because the PSTN lines to which the directory numbers correspond do not themselves support dual-line configuration. Using the dual-line option also makes configuration of call-coverage (hunting) behaviors more complex. You configure the keyswitch model by creating a set of directory numbers that correspond one-to-one with your PSTN lines. Then you configure your PSTN ports to route incoming calls to those ephone-dns. The maximum number of PSTN lines that you can assign in this model can be limited by the number of available buttons on your IP phones. If so, the overlay option may be useful for extending the number of lines that can be accessed by a phone. Figure 4: Incoming PSTN Call Using Keyswitch Model, on page 74 shows an incoming call from the PSTN (1), which is routed to extension 1001 on all three phones (2). Figure 4: Incoming PSTN Call Using Keyswitch Model For configuration information, see Configure Phones for a Key System, on page 282. Cisco Unified Communications Manager Express System Administrator Guide 74 Cisco Unified CME Overview Keyswitch Model Hybrid Model PBX and keyswitch configurations can be mixed on the same IPphone and can include both unique per-phone extensions forPBX-style calling and shared lines for keyswitch-style call operations.Single-line and dual-line directory numbers can be combined on the same phone. In the simplest keyswitch deployments, individual telephones do not have private extension numbers. Where key system telephones do have individual lines, the lines are sometimes referred to as intercoms rather than as extensions. The term “Intercom” is derived from “internal communication;” there is no assumption of the common “intercom press-to-talk” behavior of auto dial or auto answer in this context, although those options may exist. For key systems that have individual intercom (extension) lines, PSTN calls can usually be transferred from one key system phone to another using the intercom (extension) line. When Call Transfer is invoked in the context of a connected PSTN line, the outbound consultation call is usually placed from the transferrer phone to the transfer-to phone using one of the phone’s intercom (extension) line buttons. When the transferred call is connected to the transfer-to phone and the transfer is committed (the transferrer hangs up), the intercom lines on both phones are normally released and the transfer-to call continues in the context of the original PSTN line button (all PSTN lines are directly available on all phones). The transferred call can be put on hold (on the PSTN line button) and then subsequently resumed from another phone that shares that PSTN line. For example, you can design a 3x3 keyswitch system as shown in Figure 4: Incoming PSTN Call Using Keyswitch Model, on page 74 and then add another, unique extension on each phone (Figure 5: Incoming PSTN Call Using Hybrid PBX-Keyswitch Model, on page 75). This setup will allow each phone to have a “private” line to use to call the other phones or to make outgoing calls. Figure 5: Incoming PSTN Call Using Hybrid PBX-Keyswitch Model Call Detail Records The accounting process collects accounting data for each call leg created on the Cisco voice gateway. You can use thisinformation for post-processing activitiessuch as generating billing records and network analysis. Voice gateways capture accounting data in the form of call detail records(CDRs) containing attributes defined by Cisco. The gateway can send CDRsto a RADIUSserver,syslog server, or to a file in .csv format forstoring to flash or an FTP server. For information about generating CDRs, see CDR Accounting for Cisco IOS Voice Gateways. Cisco Unified Communications Manager Express System Administrator Guide 75 Cisco Unified CME Overview Hybrid Model Additional References The following section provides references related to Cisco Unified CME. Table 2: Related Documents for Unified CME Related Topic Document Title Cisco Unified CME Command Reference Cisco Unified CME Documentation Roadmap Cisco Unified CME configuration Cisco IOS Voice Command Reference Cisco IOS Software Releases 12.4T Command References Cisco IOS commands Cisco IOS Voice Configuration Library Cisco IOS Software Releases 12.4T Configuration Guides Cisco IOS configuration Cisco IOS Voice Troubleshooting and Monitoring Guide Cisco IOS voice troubleshooting Dial Peer Configuration on Voice Gateway Routers Understanding One Stage and Two Stage Dialing (technical note) Understanding How Inbound and Outbound Dial Peers Are Matched on Cisco IOSPlatforms(technical note) Using IOS Translation Rules- CreatingScalable Dial Plans for VoIP Networks (sample configuration) Dial peers, DID, and other dialing issues “DHCP” section of the Cisco IOS IP Addressing Services Configuration Guide Dynamic Host Configuration Protocol (DHCP) Fax and modem configurations Cisco Fax Services over IP Application Guide FXS PortsinSCCP Mode on Cisco VG 224 Analog Phone Gateway “Configuring Analog VoicePorts”section of the Cisco IOS Voice Port Configuration Guide FXS PortsinSCCP Mode on Cisco VG 224 Analog Phone Gateway SCCP Controlled Analog (FXS) Ports with Supplementary Features in Cisco IOS Gateways Cisco VG 224 Analog Phone Gateway data sheet FXS ports Cisco Unified Communications Manager Express System Administrator Guide 76 Cisco Unified CME Overview Additional References Related Topic Document Title H.323 Cisco IOS H.323 Configuration Guide “Performing Basic System Management” chapter of Cisco IOS Network ManagementConfiguration Guide Network Time Protocol (NTP) Phone documentation for Cisco Unified CME User Documentation for Cisco Unified IP Phones “Part 5: Implementing and Managing a PKI” in the Cisco IOS Security Configuration Guide Public key infrastructure (PKI) SIP Cisco IOS SIP Configuration Guide TAPI and TSP documentation Cisco Unified CME programming Guides Cisco IOS Tcl IVR and VoiceXML Application Guide - 12.3(14)T and later Cisco Voice XML Programmer’s Guide Tcl IVR and VoiceXML Enterprise QoS Solution Reference Network Design Guide VLAN class-of-service (COS) marking Cisco Unified CallManager Express 3.0 Integration Guide for Cisco Unity 4.0 Integrating Cisco CallManager Express with Cisco Unity Express Voice-mail integration Call detail records (CDRs) CDR Accounting for Cisco IOS Voice Gateways XML Provisioning Guide for Cisco CME/SRST Cisco IP Phone Services Application Development Notes XML Management Information Base MIBs MIBs Link To locate and download MIBsforselected platforms, Cisco IOS releases, and feature sets, use Cisco MIB Locator found at the following URL: http://www.cisco.com/go/mibs CISCO-CCME-MIB MIB CISCO-VOICE-DIAL-CONTROL-MIB Cisco Unified Communications Manager Express System Administrator Guide 77 Cisco Unified CME Overview Management Information Base Cisco Unified Communications Manager Express System Administrator Guide 78 Cisco Unified CME Overview Management Information Base CHAPTER 3 Before You Begin • Prerequisites for Configuring Cisco Unified CME, page 79 • Restrictions for Configuring Cisco Unified CME, page 80 • Information About Planning Your Configuration, page 81 • Cisco Unified CME Workflow, page 83 • Install Cisco Voice Services Hardware, page 87 • Install Cisco IOS Software, page 89 • Configure VLANs on a Cisco Switch, page 90 • Using Cisco IOS Commands, page 95 • Voice Bundles, page 97 • Cisco Unified CME GUI, page 98 Prerequisites for Configuring Cisco Unified CME • Base Cisco Unified CME feature license and phone user licensesthat entitle you to use Cisco Unified CME are purchased. To support H.323 call transfers and forwards to network devices that do not support the H.450 standard, such as Cisco Unified Communications Manager, a tandem gateway isrequired in the network. The tandem gateway must be running Cisco IOS release 12.3(7)T or a later release and requires the Integrated Voice and VideoServicesfeature license (FL-GK-NEW-xxx), which includes H.323 gatekeeper, IP-to-IPgateway, and H.450 tandem functionality. Note • Your IP network is operational and you can access Cisco web. • You have a valid Cisco.com account. • You have access to a TFTP server for downloading files. Cisco Unified Communications Manager Express System Administrator Guide 79 • Cisco router with all recommended services hardware for Cisco Unified CME isinstalled.For installation information, see Install Cisco Voice Services Hardware, on page 87. • Recommended Cisco IOS IP Voice or higher image is downloaded to flash memory in the router. ◦To determine which Cisco IOS software release supports the recommended Cisco Unified CME version, see Cisco Unified CME and Cisco IOS Software Compatibility Matrix. ◦For a list of features for each Cisco IOS Software release, see Feature Navigator. ◦For installation information, see Install Cisco IOS Software, on page 89. • VoIPnetworking must be operational.For quality and security purposes, we recommend separate virtual LANs (VLANs) for data and voice. The IP network assigned to each VLAN should be large enough to support addresses for all nodes on that VLAN. Cisco Unified CME phones receive their IP addresses from the voice network, whereas all other nodes such as PCs, servers, and printers receive their IP addresses from the data network. For configuration information, see Configure VLANs on a Cisco Switch, on page 90. Restrictions for Configuring Cisco Unified CME • Cisco Unified CME cannot register as a member of a Cisco Unified Communications Manager cluster. • For conferencing and music on hold (MOH) support with G.729, hardware digital signal processors (DSPs) are required for transcoding G.729 between G.711. • After a three-way conference is established, a participant cannot use call transfer to join the remaining conference participants to a different number. • Cisco Unified CME does not support the following: ◦CiscoWorks IP Telephony Environment Monitor (ITEM) ◦Element Management System (EMS) integration ◦Media Gateway Control Protocol (MGCP) on-net calls ◦Java Telephony Application Programming Interface (JTAPI) applications, such as the Cisco IP Softphone, Cisco Unified Communications Manager Auto Attendant, or Cisco Personal Assistant ◦Telephony Application Programming Interface (TAPI) Cisco Unified CME implements only a small subset of TAPI functionality. It supports operation of multiple independent clients (for example, one client per phone line), but not full support for multiple-user or multiple-call handling, which is required for complex features such as automatic call distribution (ACD) and Cisco Unified Contact Center (formerly Cisco IPCC). Also, this TAPI version does not have direct media- and voice-handling capabilities. Cisco Unified Communications Manager Express System Administrator Guide 80 Before You Begin Restrictions for Configuring Cisco Unified CME Information About Planning Your Configuration System Design Traditional telephony systems are based on physical connections and are therefore limited in the types of phone servicesthat they can offer. Because phone configurations and directory numbersin a Cisco Unified CME system are software entities and because the audio stream is packet-based, an almost limitless number of combinations of phone numbers, lines, and phones can be planned and implemented. Cisco Unified CME systems can be designed in many ways. The key is to determine the total number of simultaneous calls you want to handle at your site and at each phone at your site, and how many different directory numbers and phones you want to have. Even a Cisco Unified CME system has its limits, however. Consider the following factors in your system design: • Maximum number of phones—This number corresponds to the maximum number of devices that can be attached. The maximum is platform- and version-dependent. To find the maximum for your platform and version, see Cisco CME Supported Firmware, Platforms, Memory, and Voice Products. • Maximum number of directory numbers—This number corresponds to the maximum number of simultaneous call connections that can occur. The maximum is platform- and version-dependent. To find the maximum for your platform and version, see Cisco CME Supported Firmware, Platforms, Memory, and Voice Products. • Telephone number scheme—Your numbering plan may restrict the range of telephone numbers or extension numbers that you can use. For example, if you have DID, the PSTN may assign you a certain series of numbers. • Maximum number of buttons per phone—You may be limited by the number of buttons and phones that your site can use. For example, you may have two people with six-button phones to answer 20 different telephone numbers. The flexibility of a Cisco Unified CME system is due largely to the different types of directory numbers(DNs) that you can assign to phones in your system. By understanding types of DNs and considering how they can be combined, you can create the complete call coverage that your business requires. For more information about DNs, see Configuring Phones to Make Basic Calls, on page 223. After setting up the DNs and phones that you need, you can add optional Cisco Unified CME features to create a telephony environment that enhances your business objectives. Cisco Unified CME systems are able to integrate with the PSTN and with your business requirements to allow you to continue using your existing number plans, dialing schemes, and call coverage patterns. When creating number plans, dialing schemes, and call coverage patterns in Cisco Unified CME, there are several factors that you must consider: • Is there an existing PBX or Key System that you are replacing and want to emulate? • Number of phones and phone users to be supported? • Do you want to use single-line or dual-line DNs? • What protocols does your voice network support? • Which call transfer and forwarding methods must be supported? Cisco Unified Communications Manager Express System Administrator Guide 81 Before You Begin Information About Planning Your Configuration • What existing or preferred billing method do you want to use for transferred and forwarded calls? • Do you need to optimize network bandwidth or minimize voice delay? Because these factors can limit your choices for some of the configuration decisions that you will make when you create of a dialing plan, see the Cisco Unified Communications Manager Express Solution Reference Network Design Guide to help you understand the effect these factors have on your Cisco Unified CME implementation. Toll Fraud Prevention When a Cisco router platform is installed with a voice-capable Cisco IOSsoftware image, appropriate features must be enabled on the platform to prevent potential toll fraud exploitation by unauthorized users. Deploy these features on all Cisco router Unified Communications applications that process voice calls, such as Cisco Unified Communications Manager Express (Cisco Unified CME), Cisco Survivable Remote Site Telephony (Cisco Unified SRST), Cisco Unified Border Element, Cisco IOS-based router and standalone analog and digital PBX and public-switched telephone network (PSTN) gateways, and Cisco contact-center VoiceXML gateways. These features include, but are not limited to, the following: • Disable secondary dial tone on voice ports—By default, secondary dial tone is presented on voice ports on Cisco router gateways. Use private line automatic ringdown (PLAR) for foreign exchange office (FXO) ports and direct-inward-dial (DID) for T1/E1 ports to prevent secondary dial tone from being presented to inbound callers. • Cisco router access control lists (ACLs)—Define ACLs to allow only explicitly valid sources of calls to the router or gateway, and therefore to prevent unauthorizedSession InitiationProtocol (SIP) or H.323 calls from unknown parties to be processed and connected by the router or gateway. • Close unused SIP and H.323 ports—If either the SIP or H.323 protocol is not used in your deployment, close the associated protocol ports. If a Cisco voice gateway has dial peers configured to route calls outbound to the PSTN using either time division multiplex (TDM) trunks or IP, close the unused H.323 or SIP ports so that calls from unauthorized endpoints cannot connect calls. If the protocols are used and the ports must remain open, use ACLs to limit access to legitimate sources. • Change SIP port 5060—If SIP is actively used, consider changing the port to something other than well-known port 5060. • SIP registration—If SIP registration is available on SIP trunks, turn on this feature because it provides an extra level of authentication and validation that only legitimate sources can connect calls. If it is not available, ensure that the appropriate ACLs are in place. • SIP Digest Authentication—If the SIP Digest Authentication feature is available for either registrations or invites, turn this feature on because it provides an extra level of authentication and validation that only legitimate sources can connect calls. • Explicit incoming and outgoing dial peers—Use explicit dial peers to control the types and parameters of calls allowed by the router, especially in IP-to-IP connections used on Cisco Unified CME, Cisco Unified SRST, and Cisco Unified Border Element. Incoming dial peers offer additional control on the sources of calls, and outgoing dial peers on the destinations. Incoming dial peers are always used for calls. If a dial peer is not explicitly defined, the implicit dial peer 0 is used to allow all calls. • Explicit destination patterns—Use dial peers with more granularity than .T for destination patterns to block disallowed off-net call destinations. Use class of restriction (COR) on dial peers with specific destination patterns to allow even more granular control of calls to different destinations on the PSTN. Cisco Unified Communications Manager Express System Administrator Guide 82 Before You Begin Toll Fraud Prevention • Translation rules—Use translation rules to manipulate dialed digits before calls connect to the PSTN to provide better control over who may dial PSTN destinations. Legitimate users dial an access code and an augmented number for PSTN for certain PSTN (for example, international) locations. • Tcl and VoiceXML scripts—Attach a Tcl/VoiceXML script to dial peers to do database lookups or additional off-router authorization checks to allow or deny call flows based on origination or destination numbers. Tcl/VoiceXML scripts can also be used to add a prefix to inbound DID calls. If the prefix plus DID matches internal extensions, then the call is completed. Otherwise, a prompt can be played to the caller that an invalid number has been dialed. • Host name validation—Use the “permit hostname” feature to validate initial SIP Invites that contain a fully qualified domain name (FQDN) host name in the Request Uniform Resource identifier (Request URI) against a configured list of legitimate source hostnames. • Dynamic Domain Name Service (DNS)—If you are using DNS as the “session target” on dial peers, the actual IP address destination of call connections can vary from one call to the next. Use voice source groups and ACLs to restrict the valid address ranges expected in DNS responses (which are used subsequently for call setup destinations). For more configuration guidance,see Cisco IOS Unified Communications TollFraudPrevention and Configure Toll Fraud Prevention, on page 513. Cisco Unified CME Workflow Table 3: Workflow for Creating or Modifying Basic Telephony Configuration, on page 83 lists the tasks for installing and configuring Cisco Unified CME and for modifying the configuration, in the order in which the tasks are to be performed and including links to modules in this guide that support each task. Not all tasks are required for all Cisco Unified CME systems, depending on software version and on whether it is a new Cisco Unified CME, an existing Cisco router that is being upgraded to support Cisco Unified CME, or an existing Cisco Unified CME that is being upgraded or modified for new features or to add or remove phones. Note Table 3: Workflow for Creating or Modifying Basic Telephony Configuration Task Cisco Unified CME Configuration New Modify Documentation Install Cisco Voice Services Hardware, on page 87 Install Cisco router and all Required Optional recommended services hardware for Cisco Unified CME. Install Cisco IOS Software, on page 89 Download recommended Optional Optional Cisco IOS IP Voice or higher image to flash memory in the router. Cisco Unified Communications Manager Express System Administrator Guide 83 Before You Begin Cisco Unified CME Workflow Task Cisco Unified CME Configuration New Modify Documentation Install and Upgrade Cisco Unified CME Software, on page 101 Download recommended Optional Optional Cisco Unified CME software including phone firmware and GUI files. Network Assistant, on page 90 or Cisco IOS Commands, on page 91 or Internal Cisco Ethernet Switching Module, on page 94 Configure separate virtual Required — LANs (VLANS) for data and voice on the port switch. Network Parameters, on page 121 Required Optional • Enable calls in your VoIP network. • Define DHCP. • Set Network Time Protocol (NTP). • Configure DTMF Relay for H.323 networks in multisite installations. • Configure SIP trunk support. • Change the TFTP address on a DHCP server • Enable OOD-R. Cisco Unified Communications Manager Express System Administrator Guide 84 Before You Begin Cisco Unified CME Workflow Task Cisco Unified CME Configuration New Modify Documentation System-Level Parameters, on page 149 Required Optional • Configure Bulk Registration. • Set up Cisco Unified CME. • Set date and time parameters. • Block Automatic Registration. • Define alternate location and type of configuration files. • Change defaults for Time Outs. • Configure a redundant router. ConfigurePhonesto Make Basic Call, on page 315 Required Optional • Create directory numbers and assigning directory numbers to phones. • Create phone configurations using Extension Assigner. • Generate configuration files for phones. • Reset or restart phones. Connect to PSTN. Required — Dial Plans, on page 445 Localization Support, on page 407 Install system- and Optional Optional user-defined files for localization of phones. Table 4: Workflow for Adding Features in Cisco Unified CME, on page 86 contains a list of tasks for adding commonly configured features in Cisco Unified CME and the module in which they appear in this guide. For a detailed list of features, with links to corresponding information in this guide, see Cisco Unified CME Features Roadmap, on page 1. Cisco Unified Communications Manager Express System Administrator Guide 85 Before You Begin Cisco Unified CME Workflow Table 4: Workflow for Adding Features in Cisco Unified CME Task Documentation Configure transcoding to support conferencing, call Transcoding Resources, on page 473 transferring and forwarding, MOH, and Cisco Unity Express. Enable the graphical user interface in Cisco Unified Graphical User Interface, on page 523 CME. Configure support for voice mail. Voice Mail Integration, on page 539 Interoperability with Cisco Unified CCX, on page 1495 Configure interoperability with Cisco Unified CCX. Configure authentication support. Security, on page 581 • Automatic Line Selection, on page 1041 • Call Blocking, on page 1061 • Call Coverage Features, on page 1239 • Call Park, on page 1081 • Call Transfer and Forward, on page 1147 • Caller ID Blocking, on page 1363 • Conferencing, on page 1369 • Directory Services, on page 659 • Do Not Disturb, on page 679 • Extension Mobility, on page 725 • Feature Access Codes, on page 757 • Headset Auto Answer, on page 777 • Intercom Lines, on page 783 • Loopback Call Routing, on page 797 • Music on Hold, on page 829 • Paging, on page 857 • Presence Service, on page 875 • Ringtones, on page 899 • Customize Softkeys, on page 925 • Speed Dial, on page 965 Add features. • Call Blocking • Call-Coverage Features, including: ◦Call Hunt ◦Call Pickup ◦Call Waiting ◦Callback Busy Subscriber ◦Hunt Groups ◦Night Service ◦Overlaid Ephone-dns • Call Park • Call Transfer and Forwarding • Caller ID Blocking • Conferencing • Intercom Lines • Music on Hold (MOH) • Paging Cisco Unified Communications Manager Express System Administrator Guide 86 Before You Begin Cisco Unified CME Workflow Task Documentation Modify Cisco Unified IP Phone Options, on page 1437 Configure phone options, including: • Customized Background Images for Cisco Unified IP Phone 7970 • Fixed Line/Feature Buttons for Cisco Unified IP Phone 7931G • Header Bar Display • PC Port Disable • Phone Labels • Programmable vendorConfig Parameters • System Message Display • URL Provisioning for Feature Buttons Configure video support. Video Support, on page 987 Configure Cisco Unified CME as SRST Fallback. SRST Fallback Mode, on page 1539 Install Cisco Voice Services Hardware Cisco routers are normally shipped with Cisco voice services hardware and other optional equipment that you ordered already installed. In the event that the hardware is not installed or you are upgrading your existing Cisco router to support Cisco Unified CME or Cisco Unity Express, you will be required to install hardware components. Voice bundles do not include all the necessary components for Cisco Unity Express. Contact the Cisco IP Communications Express partner in your area for more information about including Cisco Unity Express in your configuration. Note Before You Begin • Cisco router and all recommended hardware for Cisco Unified CME, and if required, Cisco Unity Express, is ordered and delivered, or is already onsite. Step 1 Install the Cisco router on your network. To find installation instructions for the Cisco router, access documents located at www.cisco.com>Technical Support & Documentation>Product Support>Routers>router you are using>Install and Upgrade Guides. Step 2 Install Cisco voice services hardware. Cisco Unified Communications Manager Express System Administrator Guide 87 Before You Begin Install Cisco Voice Services Hardware a) To find installation instructionsfor any Cisco interface card, access documentslocated at www.cisco.com>Technical Support & Documentation>Product Support>Cisco Interfaces and Modules>interface you are using>Install and Upgrade Guides or Documentation Roadmap. b) To install and configure your Catalyst switch, see Cisco Network Assistant. c) To find installation instructions for any Cisco EtherSwitch module, access documents located at www.cisco.com>Technical Support & Documentation>Product Support>Cisco Switches>switch you are using>Install and Upgrade Guides. Step 3 Connect to the Cisco router using a terminal or PC with terminal emulation. Attach a terminal or PC running terminal emulation to the console port of the router. Use the following terminal settings: • 9600 baud rate • No parity • 8 data bits • 1 stop bit • No flow control Memory recommendations and maximum numbers of Cisco IPphonesidentified in the nextstep are for common Cisco Unified CME configurations only. Systems with large numbers of phones and complex configurations may not work on all platforms and can require additional memory or a higher performance platform. Note Step 4 Log in to the router and use the show version EXEC command or the show flash privileged EXEC command to check the amount of memory installed in the router. Look for the following lines after issuing the show version command. Example: Router> show version... Cisco 2691 (R7000) processor (revision 0.1) with 177152K/19456K bytes of memory ... 31360K bytes of ATA System Compactflash (Read/Write) The first line indicates how much Dynamic RAM (DRAM) andPacket memory isinstalled in your router.Some platforms use a fraction of their DRAM as Packet memory. The memory requirements take this into account, so you have to add both numbers to find the amount of DRAM available on your router (from a memory requirement point of view). The second line identifies the amount of flash memory installed in your router. or Look for the following line after issuing the show flash command. Add the number available to the number used to determine the total flash memory installed in the Cisco router. Router# show flash ... 2252800 bytes available, (29679616 bytes used] Cisco Unified Communications Manager Express System Administrator Guide 88 Before You Begin Install Cisco Voice Services Hardware Step 5 Identify DRAM and flash memory requirements for the Cisco Unified CME version and Cisco router model you are using. To find Cisco Unified CME specifications,see the appropriate Cisco Unified CME SupportedFirmware,Platforms, Memory, and Voice Products. Step 6 Compare the amount of memory required to the amount of memory installed in the router. To install or upgrade the system memory in the router, access documents located at www.cisco.com>Technical Support & Documentation>Product Support>Routers>router you are using>Install and Upgrade Guides. Step 7 Use the memory-size iomem i/o memory-percentage privileged EXEC command to disable Smartinit and allocate ten percent of the total memory to Input/Output (I/O) memory. Example: Router# memory-size iomem 10 Install Cisco IOS Software The Cisco router in a voice bundle is preloaded with the recommended Cisco IOS software release and feature set plus the necessary Cisco Unified CME phone firmware and GUI files to support Cisco Unified CME and Cisco Unity Express. If the recommended software is not installed or if you are upgrading an existing Cisco router to support Cisco Unified CME and Cisco Unity Express, you will be required to download and extract the required image and files. Note To verify that the recommended software is installed on the Cisco router and if required, download and install a Cisco IOS Voice or higher image, perform the following steps. Before You Begin • The Cisco router is installed including sufficient memory, all Cisco voice services hardware, and other optional hardware. Step 1 Identify which Cisco IOS software release is installed on router. Log in to the router and use the show version EXEC command. Router> show version Cisco Internetwork Operating System Software IOS (tm) 12.3 T Software (C2600-I-MZ), Version 12.3(11)T, RELEASE SOFTWARE Step 2 Compare the Cisco IOS release installed on the Cisco router to the information in the Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix to determine whether the Cisco IOS release supports the recommended Cisco Unified CME. Step 3 If required, download and extract the recommended Cisco IOS IP Voice or higher image to flash memory in the router. To find software installation information, access information located at www.cisco.com>Technical Support & Documentation>Product Support> Cisco IOS Software>Cisco IOS Software Mainline release you are using> Configuration Guides> Cisco IOS Configuration Fundamentals and Network Management Configuration Guide>Part 2: File Management>Locating and Maintaining System Images. Cisco Unified Communications Manager Express System Administrator Guide 89 Before You Begin Install Cisco IOS Software Step 4 To reload the Cisco Unified CME router with the new software after replacing or upgrading the Cisco IOS release, use the reload privileged EXEC command. Example: Router# reload System configuration has been modified. Save [yes/no]: Y Building configuration... OK Proceed with reload? Confirm. 11w2d: %Sys-5-RELOAD: Reload requested by console. Reload reason: reload command . System bootstrap, System Version 12.2(8r)T, RELEASE SOFTWARE (fc1) ... Press RETURN to get started. ... Router> What to Do Next • If you installed a new Cisco IOSsoftware release on the Cisco router, download and extract the compatible Cisco Unified CME version. See Install and Upgrade Cisco Unified CME Software, on page 101. • If you are installing a new stand-alone Cisco Unified CME system, see Configure VLANs on a Cisco Switch, on page 90. Configure VLANs on a Cisco Switch To configure two Virtual Local Area Networks (VLANs), one for voice and one for data, on a Cisco Catalyst switch or an internal Cisco NM, HWIC, orFast Ethernet switching module, perform only one of the following tasks. • Network Assistant, on page 90 • Cisco IOS Commands, on page 91 • Internal Cisco Ethernet Switching Module, on page 94 Network Assistant To configure two Virtual Local Area Networks (VLANs), one for voice and one for data, on an external Cisco Catalyst switch and to implement Cisco Quality-of-Service (QoS) policies on your network, perform the following steps. Before You Begin • The Cisco router is installed including sufficient memory, all Cisco voice services hardware and other optional hardware. • The recommended Cisco IOS release and feature set plus the necessary Cisco Unified CME phone firmware and GUI files are installed. Cisco Unified Communications Manager Express System Administrator Guide 90 Before You Begin Configure VLANs on a Cisco Switch • Determine if you can use the Cisco Network Assistant to configure VLANs on the switch for your Cisco Unified CME router, see Devices Supported in the appropriate Release Notes for Cisco Network Assistant. A PC connected to the Cisco Unified CME router over the LAN is required to download, install, and run Cisco Network Assistant. Note • If you want to use Cisco Network Assistant to configure VLANs on the Cisco Catalyst switch, verify that the PC on which you want to install and run Cisco Network Assistant meets the minimum hardware and operating system requirements. See Installing, Launching, and Connecting Network Assistant in Getting Started with Cisco Network Assistant. • An RJ-45-to-RJ-45 rollover cable and the appropriate adapter (both supplied with the switch) connecting the RJ-45 console port of the switch to a management station or modem is required to manage a Cisco Catalyst switch through the management console. Step 1 Install, launch, and connect Cisco Network Assistant.For instructions,see Installing,Launching, and Connecting Network Assistant in Getting Started with Cisco Network Assistant. Step 2 Use Cisco Network Assistant to perform the following tasks. See online Help for additional information and procedures. • Enable two VLANs on the switch port. • Configure a trunk between the Cisco Unified CME router and the switch. • Configure Cisco IOS Quality-of-Service (QoS). Cisco IOS Commands To configure two Virtual Local Area Networks (VLANs), one for voice and one for data, a trunk between the Cisco Unified CME router and the switch, and Cisco IOS Quality-of-Service (QoS) on an external Cisco Catalyst switch, perform the following steps. Before You Begin • The Cisco router is installed including sufficient memory, all Cisco voice services hardware and other optional hardware. • The recommended Cisco IOS release and feature set plus the necessary Cisco Unified CME phone firmware and GUI file are installed. • An RJ-45-to-RJ-45 rollover cable and the appropriate adapter (both supplied with the switch) connecting the RJ-45 console port of the switch to a management station or modem is required to manage a Cisco Catalyst switch through the management console. Cisco Unified Communications Manager Express System Administrator Guide 91 Before You Begin Cisco IOS Commands SUMMARY STEPS 1. enable 2. vlan database 3. vlan vlan-number name vlan-name 4. vlan vlan-number name vlan-name 5. exit 6. wr 7. configure terminal 8. macro global apply cisco-global 9. interface slot-number / port-number 10. macro apply cisco-phone $AVID number $VVID number 11. interface slot-number / port-number 12. macro apply cisco-router $NVID number 13. end 14. wr DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Switch> enable • Enter your password if prompted. vlan database Enters VLAN configuration mode. Example: Switch# vlan database Step 2 Step 3 vlan vlan-number name vlan-name Specifies the number and name of the VLAN being configured. Example: Switch(vlan)# vlan 10 name data VLAN 10 modified Name: DATA • vlan-number—Unique value that you assign to the dial-peer being configured. Range: 2 to 1004. • name—Name of the VLAN to associate to the vlan-number being configured. vlan vlan-number name vlan-name Specifies the number and name of the VLAN being configured. Example: Switch(vlan)# vlan 100 name voice VLAN 100 modified Name: VOICE Step 4 exit Exits this configuration mode. Example: Switch(vlan)# exit Step 5 Cisco Unified Communications Manager Express System Administrator Guide 92 Before You Begin Cisco IOS Commands Command or Action Purpose wr Writes the modifications to the configuration file. Example: Switch# wr Step 6 configure terminal Enters global configuration mode. Example: Switch# configure terminal Step 7 macro global apply cisco-global Applies the Smartports global configuration macro for QoS. Example: Switch (config)# macro global apply cisco-global Step 8 Specifies interface to be configured while in the interface configuration mode. interface slot-number / port-number Example: Switch (config)# interface fastEthernet 0/1 Step 9 • slot-number/port-number—Slot and port of interface to which Cisco IP phones or PCs are connected. The slash must be entered between the slot and port numbers. Note Applies VLAN and QoS settings in Smartports macro to the port being configured. macro apply cisco-phone $AVID number $VVID number Step 10 Example: Switch (config-if)# macro apply cisco-phone $AVID 10 $VVID 100 • $AVID number—Data VLAN configured in earlier step. • $VVID number—Voice VLAN configured in earlier step. Specifies interface to be configured while in the interface configuration mode. interface slot-number / port-number Example: Switch (config-if)# interface fastEthernet 0/24 Step 11 • slot-number/port-number—Slot and port of interface to which the Cisco router is connected. The slash must be entered between the slot and port numbers. Note Applies the VLAN and QoS settings in Smartports macro to the port being configured. macro apply cisco-router $NVID number Example: Switch (config-if)# macro apply cisco-router $NVID 10 Step 12 • $NVID number—Data VLAN configured in earlier step. end Exits to privileged EXEC configuration mode. Example: Switch(config-if)# end Step 13 Cisco Unified Communications Manager Express System Administrator Guide 93 Before You Begin Cisco IOS Commands Command or Action Purpose wr Writes the modifications to the configuration file. Example: Switch# wr Step 14 What to Do Next See Using Cisco IOS Commands, on page 95. Internal Cisco Ethernet Switching Module To configure two Virtual Local Area Networks (VLANs), one for voice and one for data, on an internal Cisco Ethernet switching module, perform the following steps. Before You Begin • The Cisco router is installed including sufficient memory, all Cisco voice services hardware and other optional hardware. • The recommended Cisco IOS release and feature set plus the necessary Cisco Unified CME phone firmware and GUI files are installed. • The switch is in privileged EXEC mode. SUMMARY STEPS 1. enable 2. vlan database 3. vlan vlan-number name vlan-name 4. vlan vlan-number name vlan-name 5. exit 6. wr DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Switch> enable • Enter your password if prompted. Cisco Unified Communications Manager Express System Administrator Guide 94 Before You Begin Internal Cisco Ethernet Switching Module Command or Action Purpose vlan database Enters VLAN configuration mode. Example: Switch# vlan database Step 2 Step 3 vlan vlan-number name vlan-name Specifiesthe number and name of the VLAN being configured. Example: Switch(vlan)# vlan 10 name data VLAN 10 modified Name: DATA • vlan-number—Unique value that you assign to dial-peer being configured. Range: 2 to 1004. • name—Name of the VLAN to associate to the vlan-number being configured. vlan vlan-number name vlan-name Specifiesthe number and name of the VLAN being configured. Example: Switch(vlan)# vlan 100 name voice VLAN 100 modified Name: VOICE Step 4 exit Exits this configuration mode. Example: Switch(vlan)# exit Step 5 wr Writes the modifications to the configuration file. Example: Switch# wr Step 6 What to Do Next See Using Cisco IOS Commands, on page 95. Using Cisco IOS Commands Prerequisites • Hardware and software to establish a physical or virtual console connection to the Cisco router using a terminal or PC running terminal emulation is available and operational. • Connect to the Cisco router using a terminal or PC with terminal emulation. Attach a terminal or PC running terminal emulation to the console port of the router. For connecting to the router to be configured, use the following terminal settings: ◦9600 baud rate ◦No parity ◦8 data bits Cisco Unified Communications Manager Express System Administrator Guide 95 Before You Begin Using Cisco IOS Commands ◦1 stop bit ◦No flow control Your choice of configuration method depends on whether you want to create an initial configuration for your IP telephony system or you want to perform ongoing maintenance, such as routinely making additions and changes associated with employee turnover. Table 5: Comparison of Configuration Methodsfor Cisco Unified CME, on page 96 compares the different methods for configuring Cisco Unified CME. Table 5: Comparison of Configuration Methods for Cisco Unified CME Configuration Method Benefits Restrictions Requires knowledge of Cisco IOS commands and Cisco Unified CME. • Generates commands for running configuration which can be saved on Cisco router to be configured. • Use for setting up or modifying all parameters and features during initial configuration and ongoing maintenance. Cisco IOS command line interface • Cannot provision voice features such as digit translation, call routing, and class of restriction. • Cannot provision data features such as DHCP, IP addressing, and VLANs. • Can only provision IPphones that are registered to Cisco Unified CME. Cannot use bulk administration to import multiple phones at the same time. Cannot manage IP phone firmware. • Requires manual upgrade of files in flash if Cisco Unified CME version is upgraded. • Graphical user interface • Use for ongoing system maintenance • Modifies, adds, and deletes phones and extensions; configures voice-mail; IP phone URLs; secondary dial tone pattern; timeouts; transfer patterns; and the music-on-hold file. • Three configurable levels of access. Cisco Unified CME GUI, on page 98 Cisco Unified Communications Manager Express System Administrator Guide 96 Before You Begin Using Cisco IOS Commands Voice Bundles Voice bundlesinclude a Cisco IntegratedServices Router forsecure data routing, Cisco Unified CME software and licenses to support IP telephony, Cisco IOS SP Services or Advanced IP Services software for voice gateway features, and the flexibility to add Cisco Unity Express for voice mail and auto attendant capabilities. Voice bundles are designed to meet the diverse needs of businesses worldwide. To complete the solution, add digital or analog trunk interfacesto interface to thePSTN or the hostPBX, Cisco IPphones, and Cisco Catalyst data switches supporting Power-over Ethernet (PoE). Table 6: Cisco Tools for Deploying Cisco IPC Express, on page 97 contains a list of the Cisco tools for deploying Cisco IPC Express. Table 6: Cisco Tools for Deploying Cisco IPC Express Tool Name Description Cisco CP Express is a basic router configuration tool that residesin routerFlash memory. It isshipped with every device ordered with Cisco CP. Cisco CP Express allows the user to give the device a basic configuration, and allows the user to install Cisco CP for advanced configuration and monitoring capabilities. Cisco CP is the next generation advanced configuration and monitoring tool. It enables you to configure such things as router LAN and WAN interfaces, a firewall, IPSec VPN, dynamic routing, and wireless communication. Cisco CP is installed on a PC. It is available on a CD, and can also be downloaded from www.cisco.com. Cisco Configuration Professional Express (Cisco CP Express) and Cisco ConfigurationProfessional (Cisco CP) Cisco Unified CME GUI enablesthe user to configure a subset of optional system and phone features. Cisco Unified CME GUI, on page 98 Cisco Network Assistant is a PC-based network management application optimized for networks of small and medium-sized businesses. Through a user-friendly GUI, the user can apply common servicessuch as configuration management, inventory reports, password synchronization and Drag and Drop IOS Upgrade across Cisco SMB-Class switches, routers and access points. Cisco Network Assistant Initialization Wizard in the Cisco Unity Express GUI promptsthe user for required information to configure users, voice mailboxes, and other features of voice mail and auto attendant. The wizard starts automatically the first time you log in to the Cisco Unity Express GUI. Initialization Wizard for Cisco Unity Express See Configuring the System for the First Time, in the appropriate Cisco Unity Express GUI Administrator Guide. Cisco Unified Communications Manager Express System Administrator Guide 97 Before You Begin Voice Bundles Tool Name Description Cisco Router and Security Device Manager (Cisco SDM) is an intuitive, Web-based device-management tool for Cisco routers. Cisco SDM simplifies router and security configuration through smart wizards, which help customers and Cisco partners quickly and easily deploy, and configure a Cisco router without requiring knowledge of the command-line interface (CLI). Supported on Cisco 830Seriesto Cisco 7301 routers, Cisco SDM is shipping on Cisco 1800 Series, Cisco 2800 Series, and Cisco 3800 Series routers pre-installed by the factory. Router and Security Device Manager (SDM) Cisco Unified CME GUI The Cisco Unified CME GUI provides a web-based interface to manage most system-level and phone-level features. In particular, the GUI facilitatesthe routine additions and changes associated with employee turnover, allowing these changes to be performed by nontechnical staff. The GUI provides three levels of access to support the following user classes: • System administrator—Able to configure all systemwide and phone-based features. This person is familiar with Cisco IOS software and VoIP network configuration. • Customer administrator—Able to perform routine phone additions and changes without having access to systemwide features. This person does not have to be familiar with Cisco IOS software. • Phone user—Able to program a small set of features on his or her own phone and search the Cisco Unified CME directory. The Cisco Unified CME GUI uses HTTP to transfer information between the Cisco Unified CME router and the PC of an administrator or phone user. The router must be configured as an HTTP server, and an initial system administrator username and password must be defined. Additional customer administrators and phone users can be added by using Cisco IOS command line interface or by using GUI screens. Cisco Unified CME provides support for eXtensible Markup Language (XML) cascading style sheets (files with a .css suffix) that can be used to customize the browser GUI display. The GUIsupports authentication, authorization, and accounting (AAA) authentication forsystem administrators through a remote server capability. If authentication through the server fails, the local router is searched. Cisco Unified CME GUI must be installed and set up before it can be used. Instructions for using the Cisco Unified GUI are in online help for the GUI. To use the Cisco Unified CME GUI to modify the configuration, see online help. Prerequisites • Cisco CME 3.2 or a later version. Cisco Unified Communications Manager Express System Administrator Guide 98 Before You Begin Cisco Unified CME GUI • Files required for the operation of the GUI must be copied into flash memory on the router. For information about files, see Install and Upgrade Cisco Unified CME Software, on page 101. • Cisco Unified CME GUI must be enabled. For information, see Enable the GUI, on page 525. Restrictions • The web browser that you use to access the GUI must be Microsoft Internet Explorer 5.5 or a later version. No other type of browser can be used to access the GUI. • Cannot provision voice features such as digit translation, call routing, and class of restriction. • Cannot provision data features such as DHCP, IP addressing, and VLANs. • Can only provision IP phones that are registered to Cisco Unified CME. Cannot use bulk administration to import multiple phones at the same time. Cannot manage IP phone firmware. • Requires manual upgrade of files in flash memory of router if Cisco Unified CME is upgraded to later version. • Other minor limitations, such as: ◦If you use an XML configuration file to create a customer administrator login, the size of that XML file must be 4000 bytes or smaller. ◦The password of the system administrator cannot be changed through the GUI. Only the password of a customer administrator or a phone user can be changed through the GUI. ◦If more than 100 phones are configured, choosing to display all phones will result in a long delay before results are shown. Cisco Unified Communications Manager Express System Administrator Guide 99 Before You Begin Cisco Unified CME GUI Cisco Unified Communications Manager Express System Administrator Guide 100 Before You Begin Cisco Unified CME GUI CHAPTER 4 Install and Upgrade Cisco Unified CME Software • Prerequisites for Installing Cisco Unified CME Software, page 101 • Cisco Unified CME Software, page 101 • Install and Upgrade Cisco Unified CME Software, page 105 Prerequisites for Installing Cisco Unified CME Software Hardware • Your IP network is operational and you can access Cisco web. • You have a valid Cisco.com account. • You have access to a TFTP server for downloading files. • Cisco router and all recommended services hardware for Cisco Unified CME isinstalled.For installation information, see Install Cisco Voice Services Hardware, on page 87. Cisco IOS Software • Recommended Cisco IOS IP Voice or higher image is downloaded to flash memory in the router. To determine which Cisco IOS software release supports the recommended Cisco Unified CME version, see Cisco Unified CME and Cisco IOSSoftware Compatibility Matrix.For installation information, see Install Cisco IOS Software, on page 89. Cisco Unified CME Software This section contains a list of the types of files that must be downloaded and installed in the router flash memory to use with Cisco Unified CME. The files listed in this section are included in zipped or tar archives that are downloaded from the Cisco Unified CME software download website at http://www.cisco.com/cgi-bin/ tablebuild.pl/ip-iostsp. Cisco Unified Communications Manager Express System Administrator Guide 101 Basic Files A tar archive containsthe basic files you need for Cisco Unified CME. Be sure to download the correct version for the Cisco IOS software release that is running on your router. The basic tar archive generally also contains the phone firmware files that you require, although you may occasionally need to download individual phone firmware files.For information about installing Cisco Unified CME,see Install Cisco Unified CME Software, on page 105. GUI Files A tar archive contains the files that you need to use the Cisco Unified CME graphical user interface (GUI), which provides a mouse-driven interface for provisioning phones after basic installation is complete. For installation information, see Install Cisco Unified CME Software, on page 105. Cisco Unified CME GUI files are version-specific; GUI files for one version of Cisco Unified CME are not compatible with any other version of Cisco Unified CME. When downgrading or upgrading Cisco Unified CME, the GUI files for the old version must be overwritten with GUI files that match the Cisco Unified CME version that is being installed. Note Phone Firmware Files Phone firmware files provide code to enable phone displays and operations. These files are specialized for each phone type and protocol, SIP or SCCP, and are periodically revised. You must be sure to have the appropriate phone firmware filesfor the types of phones, protocol being used, and Cisco Unified CME version at your site. New IPphones are shipped from Cisco with a default manufacturingSCCPimage. When a IPphone downloads its configuration profile, the phone compares the phone firmware mentioned in the configuration profile with the firmware already installed on the phone. If the firmware version differs from the one that is currently loaded on the phone, the phone contactsthe TFTPserver to upgrade to the new phone firmware and downloads the new firmware before registering with Cisco Unified CME. Generally, phone firmware files are included in the Cisco Unified CME software archive that you download. They can also be posted on the software download website as individual files or archives. Early versions of Cisco phone firmware for SCCP and SIP IP phones had filenames as follows: • SCCP firmware—P003xxyy.bin • SIP firmware—P0S3xxyy.bin In both bases, x representsthe major version, and y represented the minor version. The third character represents the protocol, “0” for SCCP or “S” for SIP. In later versions, the following conventions are used: • SCCP firmware—P003xxyyzzww, where x represents the major version, y represents the major subversion, z represents the maintenance version, and w represents the maintenance subversion. Cisco Unified Communications Manager Express System Administrator Guide 102 Install and Upgrade Cisco Unified CME Software Basic Files • SIPfirmware—P0S3-xx-y-zz, where x represents the major version, y represents the minor version, and z represents the subversions. • The third character in a filename—Represents the protocol, “0” for SCCP or “S” for SIP. There are exceptions to the general guidelines.For Cisco ATA, the filename begins with AT.For Cisco Unified IP Phone 7002, 7905, and 7912, the filename can begin with CP. Signed and unsigned versions of phone firmware are available for certain phone types. Signed binary files support image authentication, which increasessystem security. We recommend signed versionsif your version of Cisco Unified CME supports them. Signed binary files have .sbn file extensions, and unsigned files have .bin file extensions. For Java-based IP phones, such as the Cisco Unified IP Phone 7911, 7941, 7941GE, 7961, 7961GE, 7970, and 7971, the firmware consists of multiple files including JAR and tone files. All of the firmware files for each phone type must be downloaded the TFTP server before they can be downloaded to the phone. The following example shows a list of phone firmware files that are installed in flash memory for the Cisco Unified IP Phone 7911: tftp-server flash:SCCP11.7-2-1-0S.loads tftp-server flash:term06.default.loads tftp-server flash:term11.default.loads tftp-server flash:cvm11.7-2-0-66.sbn tftp-server flash:jar11.7-2-0-66.sbn tftp-server flash:dsp11.1-0-0-73.sbn tftp-server flash:apps11.1-0-0-72.sbn tftp-server flash:cnu11.3-0-0-81.sbn However, you only specify the filename for the image file when configuring Cisco Unified CME.ForJava-based IP phones, the following naming conventions are used for image files: • SCCP firmware—TERMnn.xx-y-z-ww or SCCPnn.xx-y-zz-ww, where n represents the phone type, x represents the major version, y represents the major subversion, z represents the maintenance version, and w represents the maintenance subversion. The following example shows how to configure Cisco Unified CME so that the Cisco Unified IP Phone 7911 can download the appropriate SCCP firmware from flash memory: Router(config)# telephony-service Router(config-telephony)#load 7911 SCCP11.7-2-1-0S Table 7: Firmware-Naming Conventions, on page 103 contains firmware-naming convention examples, in alphabetical order: Table 7: Firmware-Naming Conventions SCCP Phones SIP Phones Image Version Image Version P00303030300 3.3(3) P0S3-04-4-00 4.4 P00305000200 5.0(2) P0S3-05-2-00 5.2 P00306000100 6.0(1) P0S3-06-0-00 6.0 Cisco Unified Communications Manager Express System Administrator Guide 103 Install and Upgrade Cisco Unified CME Software Phone Firmware Files SCCP Phones SIP Phones SCCP41.8-0-4ES4-0-1S 8.0(4) SIP70.8-0-3S 8.0(3) TERM41.7-0-3-0S 7.0(3) — — The phone firmware filenamesfor each phone type and Cisco Unified CME version are listed in the appropriate document available at Cisco CME Supported Firmware, Platforms, Memory, and Voice Products. For information about installing firmware files, see Install Cisco Unified CME Software, on page 105. For information about configuring Cisco Unified CME for upgrading between versions or converting between SCCP and SIP, see Install and Upgrade Cisco Unified CME Software, on page 101. XML Template The file called xml.template can be copied and modified to allow or restrictspecific GUI functionsto customer administrators, a class of administrative users with limited capabilities in a Cisco Unified CME system. This file is included in both tar archives (cme-basic-... and cme-gui-...). To install the file, see Install Cisco Unified CME Software, on page 105. Music-on-Hold (MOH) File An audio file named music-on-hold.au provides music for external callers on hold when a live feed is not used. This file is included in the tar archive with basic files (cme-basic-...). To install the file, see Install Cisco Unified CME Software, on page 105. Script Files Archives containing Tcl script files are listed individually on the Cisco Unified CME software download website.For example, the file named app-h450-transfer.2.0.0.9.zip.tar contains a script that adds H.450 transfer and forwarding support for analog FXS ports. The Cisco Unified CME Basic Automatic Call Distribution and Auto Attendant Service (B-ACD) requires a number of script files and audio files, which are contained in a tar archive with the name cme-b-acd-.... For a list of files in the archive and for more information about the files, see Cisco CME B-ACD and TCL Call-Handling Applications. For information about installing Tcl script file or an archive, see Install Cisco Unified CME Software, on page 105. Bundled TSP Archive An archive is available at the Cisco Unified CME software download website that contains several Telephony Application Programming Interface (TAPI) Telephony Service Provider (TSP) files. These files are needed to set up individual PCs for Cisco Unified IP phone users who wish to make use of Cisco Unified CME-TAPI integration with TAPI-capablePC software. To install the filesfrom the archive,see the installation instructions in TAPI Developer Guide for Cisco CME/SRST. Cisco Unified Communications Manager Express System Administrator Guide 104 Install and Upgrade Cisco Unified CME Software XML Template File Naming Conventions Most of the files available at the Cisco Unified CME software download website are archives that must be uncompressed before individual files can be copied to the router. In general, the following naming conventions apply to files on the Cisco Unified CME software download website: Table 8: File Naming Conventions Basic Cisco Unified CME files, including phone firmware files for a particular Cisco Unified CME version or versions. cme-basic-... Files required for the Cisco Unified CME GUI. cme-gui-... Phone firmware files. Not all firmware files to be downloaded to a phone are specified in the load command. For a list of file namesto be installed in flash memory, and which file names are to be specified by using the load command, see Cisco Unified CME Supported Firmware, Platforms, Memory, and Voice Products. Note cmterm..., P00..., 7970.. Filesrequired for Cisco Unified CME B-ACD service. cme-b-acd... Install and Upgrade Cisco Unified CME Software Customers who purchase a router bundle enabled with Cisco Unified CME will have the necessary Cisco Unified CME files installed at time of manufacture. Note Install Cisco Unified CME Software Step 1 Go to http://www.cisco.com/cgi-bin/tablebuild.pl/ip-key. Step 2 Select the file to download. Step 3 Download zip file to tftp server. Step 4 Use the zip program to extract the file to be installed, then: a) If the file is an individual file, use the copy command to copy the files to router flash: Router# copy tftp://x.x.x.x/P00307020300.sbn flash: b) If the file is a tar file, use the archive tarcommand to extract the files to flash memory. Router# archive tar /xtract source-urlflash:/file-url Cisco Unified Communications Manager Express System Administrator Guide 105 Install and Upgrade Cisco Unified CME Software File Naming Conventions Step 5 Verify the installation. Use the show flash: command to list the files installed in in flash memory. Router# show flash: 31 128996 Sep 19 2005 12:19:02 -07:00 P00307020300.bin 32 461 Sep 19 2005 12:19:02 -07:00 P00307020300.loads 33 681290 Sep 19 2005 12:19:04 -07:00 P00307020300.sb2 34 129400 Sep 19 2005 12:19:04 -07:00 P00307020300.sbn Step 6 Use the archive tar /create command to create a backup tar file of all the files stored in flash. You can create a tar file that includes all files in a directory or a list of up to four files from a directory. For example, the following command creates a tar file of the three files listed: archive tar /create flash:abctestlist.tar flash:orig1 sample1.txt sample2.txt sample3.txt The following command creates a tar file of all the files in the directory: archive tar /create flash:abctest1.tar flash:orig1 The following command creates a tar file to backup the flash files to a USB card, on supported platforms: archive tar /create usbflash1:abctest1.tar flash:orig1 What to Do Next • If you installed Cisco Unified CME software and Cisco Unified CME is not configured on your router, see Network Parameters, on page 121. • If Cisco Unified IP phones presently connected to Cisco Unified CME are using the SCCP protocol to receive and place calls and the firmware version must be upgraded to a recommended version, or if the phones to be connected to Cisco Unified CME are brand new, out-of-the-box, the phone firmware preloaded at the factory must be upgraded to the recommended version before your phones can complete registration, see Upgrade or Downgrade SCCP Phone Firmware, on page 107. • If Cisco Unified IP phones presently connected to Cisco Unified CME are using the SIP protocol to receive and place calls and the firmware version must be upgraded to a recommended version, see Upgrade or Downgrade SIP Phone Firmware, on page 108. • If Cisco Unified IP phones presently connected to Cisco Unified CME are using the SCCP protocol to receive and place calls and you now want some or all of these phones to use the SIP protocol, the phone firmware for each phone type must be upgraded from SCCP to the recommended SIP version before the phones can register. See Phone Firmware Conversion from SCCP to SIP, on page 112. • If Cisco Unified IP phones to be connected to Cisco Unified CME are using the SIP protocol and are brand new, out-of-the-box, the phone firmware preloaded at the factory must be upgraded to the recommended SIP version before your SIP phones can complete registration. See Phone Firmware Conversion from SCCP to SIP, on page 112. • If Cisco Unified IP phones presently connected to Cisco Unified CME are using the SIP protocol to receive and place calls and you now want some or all of these phones to use the SCCP protocol, the phone firmware for each phone type must be upgraded from SIP to the recommended SCCP version before the phones can register. See Phone Firmware Conversion from SIP to SCCP, on page 115. Cisco Unified Communications Manager Express System Administrator Guide 106 Install and Upgrade Cisco Unified CME Software Install Cisco Unified CME Software Upgrade or Downgrade SCCP Phone Firmware For certain IPphones,such asthe Cisco Unified IPPhone 7911, 7941, 7961, 7970, and 7971, the firmware consists of multiple files including JAR and tone files. All of the firmware files must be downloaded to the TFTP server before they can be downloaded to the phone. For a list of files in each firmware version, see the appropriate Cisco Unified CME Supported Firmware, Platforms, Memory, and Voice Products. Note Before You Begin • Phone firmware for Cisco Unified IP phones to be connected to Cisco Unified CME, including all versions required during an upgrade or downgrade sequence, must be loaded in the flash memory of the TFTP server from which the phones download their configuration profiles. For information about installing firmware files in flash memory, see Install Cisco Unified CME Software, on page 105. SUMMARY STEPS 1. enable 2. configure terminal 3. tftp-server device:firmware-file 4. telephony-service 5. load phone-type firmware-file 6. create cnf-files 7. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 (Optional) Creates TFTP bindings to permit IP phones served by the Cisco Unified CME router to access the specified file. tftp-server device:firmware-file Example: Router(config)# tftp-server flash:P00307020300.loads Step 3 • A separate tftp-server command is required for each phone type. • Required for Cisco Unified CME 7.0/4.3 and earlier versions. Router(config)# tftp-server flash:P00307020300.sb2 • Cisco Unified CME 7.0(1) and later versions: Required only if the location for cnf files is not flash or slot 0. Use the complete Router(config)# tftp-server flash:P00307020300.sbn Router(config)# tftp-server flash:P00307020300.bin Cisco Unified Communications Manager Express System Administrator Guide 107 Install and Upgrade Cisco Unified CME Software Upgrade or Downgrade SCCP Phone Firmware Command or Action Purpose filename, including the file suffix, for phone firmware versions later than version 8-2-2 for all phone types. telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony service Step 4 Step 5 load phone-type firmware-file Associates a phone type with a phone firmware file. Example: Router(config-telephony)# load 7960-7940 P00307020300 • A separate load command is required for each IP phone type. • firmware-file—Filenames are case-sensitive. • In Cisco Unified CME 7.0/4.3 and earlier versions, do not use the file suffix (.bin, .sbin, .loads) for any phone type except the Cisco ATA and Cisco Unified IP Phone 7905 and 7912. • In Cisco Unified CME 7.0(1) and later versions, you must use the complete filename, including the file suffix, for phone firmware versions later than version 8-2-2 for all phone types. create cnf-files Builds XML configuration files required for SCCP phones. Example: Router(config-telephony)# create cnf-files Step 6 end Exits to privileged EXEC mode. Example: Router(config-telephony)# end Step 7 What to Do Next • If the Cisco Unified IP phone to be upgraded is not configured in Cisco Unified CME, see Configure Phones for a PBX System, on page 253. • If the Cisco Unified IP phone is already configured in Cisco Unified CME and can make and receive calls, you are ready to reboot the Cisco Unified IPphones to download the phone firmware to the phone. See Reset and Restart Cisco Unified IP Phones, on page 397. Upgrade or Downgrade SIP Phone Firmware The upgrade and downgrade sequences for SIP phones differ per phone type as follows: • Upgrading/downgrading the phone firmware for Cisco Unified IPPhone 7905G, Cisco Unified IPPhone 7912G, and Cisco ATA Analog Telephone Adapter is straightforward; modify the load command to upgrade directly to the target load. Cisco Unified Communications Manager Express System Administrator Guide 108 Install and Upgrade Cisco Unified CME Software Upgrade or Downgrade SIP Phone Firmware • The phone firmware version upgrade sequence for Cisco Unified IP Phone 7940Gs and 7960Gs is from version [234].x to 4.4, to 5.3, to 6.x, to 7.x. You cannot go directly from version [234].x to version 7.x. • To downgrade phone firmware for Cisco Unified IPPhone 7940Gs and 7960Gs, first upgrade to version 7.x, then modify the load command to downgrade directly to the target phone firmware. Restriction • Cisco Unified IP Phone 7905G, Cisco Unified IP Phone 7912G, and Cisco ATA—Signed load starts from SIPv1.1. After you upgrade the firmware to a signed load, you cannot downgrade the firmware to an unsigned load. • Cisco Unified IP Phone 7940G and Cisco Unified IP Phone 7960G—Signed load starts from SIP v5.x. Once you upgrade the firmware to a signed load, you cannot downgrade the firmware to an unsigned load. • The proceduresfor upgrading phone firmware filesforSIPphonesisthe same for all Cisco Unified IP phones.For other limits on firmware upgrade between versions, see Cisco 7940 and 7960 IPPhones Firmware Upgrade Matrix. Before You Begin Phone firmware for Cisco Unified IP phones to be connected to Cisco Unified CME, including all versions required during an upgrade or downgrade sequence, must be loaded in the flash memory of the TFTP server from which the phones will download their configuration profiles. For information about installing firmware files in flash memory, see Install Cisco Unified CME Software, on page 105. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register global 4. mode cme 5. load phone-type firmware-file 6. upgrade 7. Repeat Step 5 and Step 6. 8. file text 9. create profile 10. exit 11. voice register pool pool-tag 12. reset 13. exit 14. voice register global 15. no upgrade 16. end Cisco Unified Communications Manager Express System Administrator Guide 109 Install and Upgrade Cisco Unified CME Software Upgrade or Downgrade SIP Phone Firmware DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register global configuration mode to set parametersfor all supported SIP phones in Cisco Unified CME. voice register global Example: Router(config)# voice register global Step 3 mode cme Enables mode for provisioning SIP phones in Cisco Unified CME. Example: Router(config-register-global)# mode cme Step 4 Step 5 load phone-type firmware-file Associates a phone type with a phone firmware file. Example: Router(config-register-global)# load 7960-7940 P0S3-06-0-00 • A separate load command is required for each IP phone type. • firmware-file—Filename to be associated with the specified Cisco Unified IP phone type. • Do not use the .sbin or .loads file extension except for Cisco ATA and Cisco Unified IP Phone 7905 and 7912 Generates a file with the universal application loader image for upgrading phone firmware and performs the TFTP server alias binding. upgrade Example: Router(config-register-global)# upgrade Step 6 (Optional) Repeat for each version required in multistep upgrade sequences only. Repeat Step 5 and Step 6. Example: Router(config-register-global)# load 7960-7940 P0S3-07-4-00 Router(config-register-global)# upgrade Step 7 (Optional) Generates ASCII text files for Cisco Unified IP Phone 7905s and 7905Gs, Cisco Unified IPPhone 7912s and 7912Gs, Cisco ATA-186, or Cisco ATA-188. file text Example: Router(config-register-global)# file text Step 8 • Default—System generates binary files to save disk space. Cisco Unified Communications Manager Express System Administrator Guide 110 Install and Upgrade Cisco Unified CME Software Upgrade or Downgrade SIP Phone Firmware Command or Action Purpose Generates provisioning files required for SIP phones and writes the file to the location specified with the tftp-path command. create profile Example: Router(config-register-global;)# create profile Step 9 Exits from the current command mode to the next highest mode in the configuration mode hierarchy. exit Example: Router(config-register-global)# exit Step 10 Enters voice register pool configuration mode to set phone-specific parameters for SIP phones. voice register pool pool-tag Example: Router(config)# voice register pool 1 Step 11 • pool-tag—Unique sequence number of the SIP phone to be configured. Range is 1 to 100 or the upper limit as defined by max-pool command. Performs a complete reboot of the single SIP phone specified with the voice registerpool command and contacts the DHCPserver and the TFTP server for updated information. reset Example: Router(config-register-pool)# reset Step 12 Exits from the current command mode to the next highest mode in the configuration mode hierarchy. exit Example: Router(config-register-pool)# exit Step 13 Enters voice register global configuration mode to set parametersfor all supported SIP phones in Cisco Unified CME. voice register global Example: Router(config)# voice register global Step 14 no upgrade Return to the default for the upgrade command. Example: Router(config-register-global)# no upgrade Step 15 end Exits configuration mode and enters privileged EXEC mode. Example: Router(config-register-global)# end Step 16 Cisco Unified Communications Manager Express System Administrator Guide 111 Install and Upgrade Cisco Unified CME Software Upgrade or Downgrade SIP Phone Firmware The following example shows the configuration steps for upgrading firmware for a Cisco Unified IP Phone 7960G or Cisco Unified IP Phone 7940G from SIP 5.3 to SIP 6.0, then from SIP 6.0 to SIP 7.4: Router(config)# voice register global Router(config-register-global)# mode cme Router(config-register-global)# load 7960 P0S3-06-0-00 Router(config-register-global)# upgrade Router(config-register-global)# load 7960 P0S3-07-4-00 Router(config-register-global)# create profile The following example showsthe configuration stepsfor downgrading firmware for a Cisco Unified IPPhone 7960/40 from SIP 7.4 to SIP 6.0: Router(config)# voice register global Router(config-register-global)# mode cme Router(config-register-global)# load 7960 P0S3-06-0-00 Router(config-register-global)# upgrade Router(config-register-global)# create profile What to Do Next • If the Cisco Unified IP phone to be upgraded is not configured in Cisco Unified CME, see Configure Phones for a PBX System, on page 253. • If the Cisco Unified IP phone is already configured in Cisco Unified CME and can make and receive calls, you are ready to reboot the Cisco Unified IPphones to download the phone firmware to the phone. See Reset and Restart Cisco Unified IP Phones, on page 397. Phone Firmware Conversion from SCCP to SIP If Cisco Unified IPphones presently connected to Cisco Unified CME are using theSCCPprotocol to receive and place calls and you now want some or all of these phones to use the SIP protocol, the phone firmware for each phone type must be upgraded from SCCPto the recommendedSIPversion before the phones can register. If Cisco Unified IP phones to be connected to Cisco Unified CME are brand new, out-of-the-box, the SCCP phone firmware preloaded at the factory must be upgraded to the recommended SIP version before your SIP phones can complete registration. If codec values for the dial peers of a connection do not match, the call fails. The default codec for the POTS dial peer for an SCCP phone is G.711 and the default codec for a VoIP dial peer for a SIP phone is G.729. If neither the SCCP phone nor the SIP phone in Cisco Unified CME has been specifically configured to change the codec, calls between the two IP phones on the same router will produce a busy signal caused by the mismatched default codecs. To avoid codec mismatch,specify the codec for IPphones in Cisco Unified CME.For configuration information,see Configure Individual IPPhonesfor KeySystem on SCCP Phone, on page 293. Note Before You Begin • Phone firmware for Cisco Unified IP phones to be connected to Cisco Unified CME, including all versions required during an upgrade or downgrade sequence, must be loaded in the flash memory of the TFTP server from which the phones download their configuration profiles. For information about installing firmware files in flash memory, see Install Cisco Unified CME Software, on page 105. Cisco Unified Communications Manager Express System Administrator Guide 112 Install and Upgrade Cisco Unified CME Software Phone Firmware Conversion from SCCP to SIP • Cisco Unified IP Phone 7940Gs and Cisco Unified IP Phone 7960Gs—If these IP phones are already configured in Cisco Unified CME to use the SCCP protocol, the SCCP phone firmware on the phone must be version 5.x. If required, upgrade the SCCP phone firmware to 5.x before upgrading to SIP. SUMMARY STEPS 1. enable 2. configure terminal 3. no ephone ephone-tag 4. exit 5. no ephone-dn dn-tag 6. exit 7. voice register global 8. mode cme 9. load phone-type firmware-file 10. upgrade 11. Repeat Step 9 and Step 10. 12. create profile 13. file text 14. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 no ephone ephone-tag (Optional) Disables the ephone and removes the ephone configuration. Example: Router (config)# no ephone 23 • Required only if the Cisco Unified IP phone to be configured is already connected to Cisco Unified CME and is using SCCP protocol. • ephone-tag—Particular IP phone to which this configuration change will apply. (Optional) Exits from the current command mode to the next highest mode in the configuration mode hierarchy. exit Example: Router(config-ephone)# exit Step 4 • Required only if you performed the previous step. Cisco Unified Communications Manager Express System Administrator Guide 113 Install and Upgrade Cisco Unified CME Software Phone Firmware Conversion from SCCP to SIP Command or Action Purpose (Optional) Disables the ephone-dn and removes the ephone-dn configuration. Step 5 no ephone-dn dn-tag • Required only if this directory number is not now nor will be associated to any SCCP phone line, intercom line, paging line, voice-mail port, or message-waiting indicator (MWI) connected to Cisco Unified CME. • dn-tag—Particular configuration to which this change will apply. (Optional) Exits from the current command mode to the next highest mode in the configuration mode hierarchy. exit Example: Router(config-ephone-dn)# exit Step 6 • Required only if you performed the previous step. Enters voice register global configuration mode to set parameters for all supported SIP phones in Cisco Unified CME. voice register global Example: Router(config)# voice register global Step 7 mode cme Enables mode for provisioning SIP phones in Cisco Unified CME. Example: Router(config-register-global)# mode cme Step 8 Step 9 load phone-type firmware-file Associates a phone type with a phone firmware file. Example: Router(config-register-global)# load 7960-7940 P0S3-06-3-00 • A separate load command is required for each IP phone type. Generates a file with the universal application loader image for upgrading phone firmware and performs the TFTP server alias binding. upgrade Example: Router(config-register-global)# upgrade Step 10 (Optional) Repeat for each version required in multistep upgrade sequences only. Repeat Step 9 and Step 10. Example: Router(config-register-global)# load 7960-7940 P0S3-07-4-00 Router(config-register-global)# upgrade Step 11 Generates provisioning files required for SIP phones and writes the file to the location specified with the tftp-path command. create profile Example: Router(config-register-global)# create profile Step 12 Cisco Unified Communications Manager Express System Administrator Guide 114 Install and Upgrade Cisco Unified CME Software Phone Firmware Conversion from SCCP to SIP Command or Action Purpose (Optional) Generates ASCII text filesfor Cisco Unified IPPhones 7905 and 7905G, Cisco Unified IP Phone 7912 and Cisco Unified IP Phone 7912G, Cisco ATA-186, or Cisco ATA-188. file text Example: Router(config-register-global)# file text Step 13 • Default—System generates binary files to save disk space. end Exits configuration mode and enters privileged EXEC mode. Example: Router(config-register-global)# end Step 14 The following example shows the configuration steps for converting firmware on an Cisco Unified IP phone already connected in Cisco Unified CME and using the SCCP protocol, from SCCP 5.x to SIP 7.4: Router(config)# telephony-service Router(config-telephony)# no create cnf CNF files deleted Router(config-telephony)# voice register global Router(config-register-global)# mode cme Router(config-register-global)# load 7960 P0S3-07-4-00 Router(config-register-global)# upgrade Router(config-register-global)# create profile What to Do Next After you configure the upgrade command, refer to the following statements to determine which task to perform next. • If the Cisco Unified IP phone to be upgraded is already connected in Cisco Unified CME and you removed the SCCP configuration file for the phone but have not configured this phone for SIP in Cisco Unified CME, see Configure Phones for a PBX System, on page 253. • If the Cisco Unified IP phones to be upgraded are already configured in Cisco Unified CME, see Reset and Restart Cisco Unified IP Phones, on page 397. Phone Firmware Conversion from SIP to SCCP If Cisco Unified IP phones presently connected to Cisco Unified CME are using the SIP protocol to receive and place calls and you now want some or all of these phones to use the SCCP protocol, the phone firmware for each phone type must be upgraded from SIP to SCCP before the phones can register. Cisco Unified Communications Manager Express System Administrator Guide 115 Install and Upgrade Cisco Unified CME Software Phone Firmware Conversion from SIP to SCCP If codec values for the dial peers of a connection do not match, the call fails. The default codec for the POTS dial peer for an SCCP phone is G.711 and the default codec for a VoIP dial peer for a SIP phone is G.729. If neither the SCCP phone nor the SIP phone in Cisco Unified CME has been specifically configured to change the codec, calls between the two IP phones on the same router will produce a busy signal caused by the mismatched default codecs. To avoid codec mismatch, specify the codec for SIP and SCCP phones in Cisco Unified CME. For more information, see Configure Phones for a PBX System, on page 253. Note Before You Begin • Phone firmware for Cisco Unified IP phones to be connected to Cisco Unified CME, including all versions required during an upgrade or downgrade sequence, must be loaded in the flash memory of the TFTP server from which the phones will download their configuration profiles. For information about installing firmware files in flash memory, see Install Cisco Unified CME Software, on page 105. • Cisco Unified IP Phone 7940Gs and Cisco Unified IP Phone 7960Gs—If these IP phones are already configured in Cisco Unified CME to use the SIP protocol, the SIP phone firmware must be version 7.x. See Upgrade or Downgrade SIP Phone Firmware, on page 108. Remove SIP Configuration Profile To remove the SIP configuration profile before downloading the SCCP phone firmware to convert a phone from SIP to SCCP, perform the steps in this task. SUMMARY STEPS 1. enable 2. configure terminal 3. no voice register pool pool-tag 4. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Cisco Unified Communications Manager Express System Administrator Guide 116 Install and Upgrade Cisco Unified CME Software Phone Firmware Conversion from SIP to SCCP Command or Action Purpose Disables voice register pool and removes the voice pool configuration. no voice register pool pool-tag Example: Router(config)# no voice register pool 1 Step 3 • pool-tag—Unique sequence number for a particular SIP phone to which this configuration applies. Exits from the current command mode to the next highest mode in the configuration mode hierarchy. end Example: Router(config-register-pool)# end Step 4 Generate SCCP XML Configuration File to Upgrade from SIP to SCCP To create an ephone entry and generate a new SCCP XML configuration file for upgrading a particular Cisco Unified IP phone in Cisco Unified CME from SIP to SCCP, perform the steps in this task. SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-dn dn-tag 4. exit 5. tftp-server device:firmware-file 6. telephony-service 7. load phone-type firmware-file 8. create cnf-files 9. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Cisco Unified Communications Manager Express System Administrator Guide 117 Install and Upgrade Cisco Unified CME Software Phone Firmware Conversion from SIP to SCCP Command or Action Purpose Enters ephone-dn configuration mode, creates an ephone-dn, and optionally assigns it dual-line status. ephone-dn dn-tag Example: Router(config)# ephone dn 1 Step 3 • dn-tag—Unique sequence number that identifies this ephone-dn during configuration tasks. The maximum number of ephone-dns in Cisco Unified CME is version and platform specific. Type ? to display range. Exits from the current command mode to the next highest mode in the configuration mode hierarchy. exit Example: Router(config-ephone-dn)# exit Step 4 (Optional) Creates TFTP bindings to permit IP phones served by the Cisco Unified CME router to access the specified file. tftp-server device:firmware-file Example: Router(config)# tftp-server flash:P00307020300.loads Step 5 • A separate tftp-server command is required for each phone type. • Required for Cisco Unified CME 7.0/4.3 and earlier versions. Router(config)# tftp-server flash:P00307020300.sb2 • Cisco Unified CME 7.0(1) and later versions: Required only if the location for cnf files is not flash or slot 0. Use the complete Router(config)# tftp-server flash:P00307020300.sbn Router(config)# tftp-server flash:P00307020300.bin filename, including the file suffix, for phone firmware versions later than version 8-2-2 for all phone types. telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony service Step 6 Step 7 load phone-type firmware-file Associates a phone type with a phone firmware file. Example: Router(config-telephony)# load 7960-7940 P00307020300 • A separate load command is required for each IP phone type. • firmware-file—Filename is case-sensitive. • Cisco Unified CME 7.0/4.3 and earlier versions: Do not use the .sbin or .loads file extension except for the Cisco ATA and Cisco Unified IP Phone 7905 and 7912. • Cisco Unified CME 7.0(1) and later versions: Use the complete filename, including the file suffix, for phone firmware versions later than version 8-2-2 for all phone types. create cnf-files Builds XML configuration files required for SCCP phones. Example: Router(config-telephony)# create cnf-files Step 8 Cisco Unified Communications Manager Express System Administrator Guide 118 Install and Upgrade Cisco Unified CME Software Phone Firmware Conversion from SIP to SCCP Command or Action Purpose end Exits to privileged EXEC mode. Example: Router(config-telephony)# end Step 9 Example The following example shows the configuration steps for upgrading firmware for a Cisco Unified IP Phone 7960G from SIP to SCCP. First the SIP firmware is upgraded to SIP 6.3 and from SIP 6.3 to SIP 7.4; then, the phone firmware is upgraded from SIP 7.4 to SCCP 7.2(3). The SIP configuration profile is deleted and a new ephone configuration profile is created for the Cisco Unified IP phone. Router(config)# v oice register global Router(config-register-global)# mode cme Router(config-register-global)# load 7960 P0S3-06-0-00 Router(config-register-global)# upgrade Router(config-register-global)# load 7960 P0S3-07-4-00 Router(config-register-global)# exit Router(config)# no voice register pool 1 Router(config-register-pool)# exit Router(config)# v oice register global Router(config-register-global)# no upgrade Router(config-register-global)# exit Router(config)# ephone-dn 1 Router(config-ephone-dn)# exit Router(config)# tftp-server flash:P00307020300.loads Router(config)# tftp-server flash:P00307020300.sb2 Router(config)# tftp-server flash:P00307020300.sbn Router(config)# tftp-server flash:P00307020300.bin Router(config)# telephony service Router(config-telephony)# load 7960-7940 P00307000100 Router(config-telephony)# create cnf-files What to Do Next After you configure the upgrade command: • If the Cisco Unified IP phone to be upgraded is already connected in Cisco Unified CME and you removed the SIP configuration file for the phone and have not configured the SCCP phone in Cisco Unified CME, see Configure Phones for a PBX System, on page 253. • If the Cisco Unified IP phones to be upgraded are already configured in Cisco Unified CME, see Reset and Restart Cisco Unified IP Phones, on page 397. Verify SCCP Phone Firmware Version Step 1 show flash: Cisco Unified Communications Manager Express System Administrator Guide 119 Install and Upgrade Cisco Unified CME Software Verify SCCP Phone Firmware Version Use this command to learn the filenames associated with that phone firmware Router# show flash: 31 128996 Sep 19 2005 12:19:02 -07:00 P00307020300.bin 32 461 Sep 19 2005 12:19:02 -07:00 P00307020300.loads 33 681290 Sep 19 2005 12:19:04 -07:00 P00307020300.sb2 34 129400 Sep 19 2005 12:19:04 -07:00 P00307020300.sbn Step 2 show ephone phone-load Use this command to verify which phone firmware is installed on a particular ephone. The DeviceName includes the MAC address for the IP phone. Router# show ephone phone-load DeviceName CurrentPhoneload PreviousPhoneload LastReset ===================================================================== SEP000A8A2C8C6E 7.3(3.02) Initialized Troubleshooting Tips for Cisco Phone Firmware Use the debug tftp event command to troubleshoot an attempt to upgrade or convert Cisco phone firmware files for SIP phones. Cisco Unified Communications Manager Express System Administrator Guide 120 Install and Upgrade Cisco Unified CME Software Troubleshooting Tips for Cisco Phone Firmware CHAPTER 5 Network Parameters • Prerequisites for Defining Network Parameters, page 121 • Restrictions for Defining Network Parameters, page 122 • Information About Defining Network Parameters, page 122 • Define Network Parameters, page 125 • Configuration Examples for Network Parameters, page 146 • Where to Go Next, page 146 • Feature Information for Network Parameters, page 146 Prerequisites for Defining Network Parameters • IP routing must be enabled. • VoIP networking must be operational. For quality and security purposes, we recommend you have separate virtual LANs (VLANs) for data and voice. The IP network assigned to each VLAN should be large enough to support addresses for all nodes on that VLAN. Cisco Unified CME phones receive their IP addresses from the voice network, whereas all other nodes such as PCs, servers, and printers receive their IP addresses from the data network. For configuration information, see Configure VLANs on a Cisco Switch, on page 90. • If applicable, PSTN lines are configured and operational. • If applicable, the WAN links are configured and operational. • Trivial File Transfer Protocol (TFTP) must be enabled on the router to allow IP phones to download phone firmware files. • To support IP phones that are running SIP to be directly connected to the Cisco Unified CME router, Cisco Unified CME 3.4 or later must be installed on the router. • To provide voice-mail support for phones connected to the Cisco Unified CME router, install and configure voice mail on your network. Cisco Unified Communications Manager Express System Administrator Guide 121 Restrictions for Defining Network Parameters In Cisco Unified CME 4.0 and later versions, Layer-3-to-Layer-2 VLAN Class of Service (CoS) priority marking is not automatically processed. Cisco Unified CME 4.0 and later versions will continue to mark Layer 3, but Layer 2 marking is now only handled in the Cisco IOS software. Any Quality of Service (QoS) design that requires Layer 2 marking will have to be explicitly configured, either on a Catalyst switch that supports this capability or on the Cisco Unified CME router under the Ethernet interface configuration.For configuration information, see Enterprise QoS Solution Reference Network Design Guide. Information About Defining Network Parameters DHCP Service When a Cisco Unified IP phone is connected to the Cisco Unified CME system, it automatically queries for a Dynamic Host ConfigurationProtocol (DHCP)server. The DHCPserver responds by assigning an IPaddress to the Cisco Unified IP phone and providing the IP address of the TFTP server through DHCP option 150. Then the phone registers with the Cisco Unified CME server and attempts to get configuration and phone firmware files from the TFTP server. For configuration information, perform only one of the following procedures to set up DHCPservice for your IP phones: • If your Cisco Unified CME router is the DHCP server and you can use a single shared address pool for all your DHCP clients, see Configure Single DHCP IP Address Pool, on page 127. • If your Cisco Unified CME router is the DHCP server and you need separate pools for non-IP-phone DHCP clients, see Configure Separate DHCP IP Address Pool for Each DHCP Client, on page 129. • If the Cisco Unified CME router is not the DHCP server and you want to relay DHCP requests from IP phones to a DHCP server on a different router, see Configure DHCP Relay, on page 131. Network Time Protocol for the Cisco Unified CME Router Network Time Protocol (NTP) allows you to synchronize your Cisco Unified CME router to a single clock on the network, known as the clock master. NTP is disabled on all interfaces by default, but it is essential for Cisco Unified CME so you must ensure that it is enabled. For information about configuring NTP for the Cisco Unified CME router, see Enable Network Time Protocol, on page 133. Olson Timezones Before Cisco Unified CME 9.0, some Cisco Unified SCCP IP phones and Cisco Unified SIP IP phones displayed exactly the same time as that of the Cisco Unified CME. For these phones, the correct time was displayed whenever the Cisco Unified CME time wasset correctly. The clocktimezone, clocksummer-time, and clock set commands were the only commands used to set the Cisco Unified CME time correctly. Other phones used only the time-zone command in telephony-service configuration mode and the timezone command in voice register global configuration mode to specify which time zone they were in so that the Cisco Unified Communications Manager Express System Administrator Guide 122 Network Parameters Restrictions for Defining Network Parameters correct local time was displayed on Cisco Unified SCCP IP phones and Cisco Unified SIP IP phones, respectively. The phones calculated and displayed the time based on the Greenwich Mean Time (GMT) provided by the Cisco Unified CME or the Network Time Protocol server. The problem with this method is that every time a new country or new time zone was available or an old time zone was changed, the Cisco Unified CME time-zone and timezone commands and the phone loads had to be updated. In Cisco Unified CME 9.0 and later versions, the Olson Timezone feature eliminates the need to update time zone commands or phone loads to accommodate a new country with a new time zone or an existing country whose city or state wants to change their time zone. Oracle’s Olson Timezone updater tool, tzupdater.jar, only needsto be current for you to set the correct time using the olsontimezone command in either telephony-service or voice register global configuration mode. For Cisco Unified 3911 and 3951 SIP IP phones and Cisco Unified 6921, 6941, 6945, and 6961 SCCP and SIP IP phones, the correct Olson Timezone updater file is TzDataCSV.csv. The TzDataCSV.csv file is created based on the tzupdater.jar file. To set the correct time zone, you must determine the Olson Timezone area/location where the Cisco Unified CME is located and download the latest tzupdater.jar or TzDataCSV.csv to a TFTP server that is accessible to the Cisco Unified CME, such as flash or slot 0. After a complete reboot, the phone checks if the version of its configuration file is earlier or later than 2010o. If it is earlier, the phone loads the latest tzupdater.jar and uses that updater file to calculate the Olson Timezone. To make the Olson Timezone feature backward compatible, both the time-zone and timezone commands are retained as legacy time zones. Because the olsontimezone command covers approximately 500 time zones (Version 2010o of the tzupdater.jar file supports approximately 453 Olson Timezone IDs.), this command takes precedence when either the time-zone or the timezone command (that covers a total of 90 to 100 time zones only) is present at the same time as the olsontimezone command. For more information on setting the time zone so that the correct local time is displayed on an IP phone, see Set Olson Timezone for SCCP Phones, on page 134 or Set Olson Timezone for SIP Phones, on page 137. DTMF Relay IP phones connected to Cisco Unified CME systems require the use of out-of-band DTMF relay to transport DTMF(keypad) digits across VoIPconnections. The reason for thisisthat the codecs used for in-band transport may distort DTMF tones and make them unrecognizable. DTMF relay solves the problem of DTMF tone distortion by transporting DTMF tones out-of-band, or separate, from the encoded voice stream. For IP phones on H.323 networks, DTMF is relayed using the H.245 alphanumeric method, which is defined by the ITU H.245 standard. This method separates DTMF digits from the voice stream and sends them as ASCII characters in H.245 user input indication messages through the H.245 signaling channel instead of the RTP channel. For information about configuring a DTMF relay in a multisite installation, see Configure DTMF Relay for H.323 Networks in Multisite Installations, on page 141. To use remote voice-mail or IVR applications on SIP networks from Cisco Unified CME phones, the DTMF digits used by the Cisco Unified CME phones must be converted to the RFC 2833 in-band DTMF relay mechanism used by SIP phones. The SIP DTMF relay method is needed in the following situations: • When SIP is used to connect a Cisco Unified CME system to a remote SIP-based IVR or voice-mail application. • When SIP is used to connect a Cisco Unified CME system to a remote SIP-PSTN voice gateway that goes through the PSTN to a voice-mail or IVR application. Cisco Unified Communications Manager Express System Administrator Guide 123 Network Parameters DTMF Relay The requirement for out-of-band DTMF relay conversion is limited to SCCP phones. SIP phones natively support in-band DTMF relay as specified in RFC 2833. To use voice mail on a SIP network that connects to a Cisco Unity Express system, which uses a nonstandard SIP Notify format, the DTMF digits used by the Cisco Unified CME phones must be converted to the Notify format. Additional configuration may be required for backward compatibility with Cisco CME 3.0 and 3.1. For configuration information about enabling DTMFrelay forSIPnetworks,see ConfigureSIP TrunkSupport, on page 142. SIP Register Support SIPregistersupport enables aSIPgateway to register E.164 numbers with aSIPproxy orSIPregistrar,similar to the way that H.323 gateways can register E.164 numbers with a gatekeeper.SIPgateways allow registration of E.164 numbers to a SIP proxy or registrar on behalf of analog telephone voice ports (FXS) and IP phone virtual voice ports (EFXS) for local SCCP phones. When registering E.164 numbers in dial peers with an external registrar, you can also register them with a secondarySIPproxy or registrar to provide redundancy. The secondary registration can be used if the primary registrar fails. Note No commands allow registration between the H.323 and SIP protocols. By default,SIPgateways do not generateSIP Register messages,so the gateway must be configured to register the gateway’s E.164 telephone numbers with an external SIP registrar. For information about configuring the SIP gateway to register phone numbers with Cisco Unified CME, see Configure SIP Trunk Support, on page 142. When you configure SIP on a router, the ports on all its interfaces are open by default. This makes the router vulnerable to malicious attackers who can execute toll fraud across the gateway if the router has a public IP address and a public switched telephone network (PSTN) connection. To eliminate the threat, you should bind an interface to private IP address that is not accessible by untrusted hosts. In addition, you should protect any public or untrusted interface by configuring a firewall or an access control list (ACL) to prevent unwanted traffic from traversing the router. Note Cisco Unified Communications Manager Express System Administrator Guide 124 Network Parameters SIP Register Support Define Network Parameters Enable Calls in Your VoIP Network Restriction • SIP endpoints are not supported on H.323 trunks. SIP endpoints are supported on SIP trunks only. • Cisco Unified CME 3.4 and later versions support Media Flow-through mode only; enabling SIP-to-SIP calls is required before you can successfully make SIP-to-SIP calls. • Media Flow-around configured with the media flow-around command is not supported by Cisco Unified CME with SIP phones. SUMMARY STEPS 1. enable 2. configure terminal 3. voice service voip 4. allow-connections from-type to to-type 5. sip 6. registrar server [expires [max sec] [min sec]] 7. exit 8. sip-ua 9. notify telephone-event max-duration time 10. registrar {dns:host-name | ipv4:ip-address} expires seconds [tcp] [secondary] 11. retry register number 12. timers register time 13. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Cisco Unified Communications Manager Express System Administrator Guide 125 Network Parameters Define Network Parameters Command or Action Purpose Enters voice service configuration mode and specifies Voice over IP (VoIP) encapsulation. voice service voip Example: Router(config)# voice service voip Step 3 Step 4 allow-connections from-type to to-type Enables calls between specific types of endpoints in a VoIP network. Example: Router(config-voi-srv)# allow-connections h323 to h323 Router(config-voi-srv)# allow-connections h323 to SIP Router(config-voi-srv)# allow-connections SIP to SIP • A separate allow-connections command is required for each type of endpoint to be supported. Step 5 sip (Optional) Enters SIP configuration mode. Example: Router(config-voi-srv)# sip • Required if you are connecting IP phones running SIP directly in Cisco CME 3.4 and later. Step 6 registrar server [expires[max sec] [min sec]] (Optional) EnablesSIPregistrar functionality in Cisco Unified CME. Example: Router(config-voi-sip)# registrar server expires max 600 min 60 • Required if you are connecting IP phones running SIP directly in Cisco CME 3.4 and later. Cisco Unified CME does not maintain a persistent database of registration entries acrossreloads. BecauseSIPphones do not use a keepalive functionality, theSIPphones must register again. To decrease the amount of time after which the SIP phones register again, we recommend that you change the expiry. Note • max sec—(Optional) Range: 600 to 86400. Default: 3600. Recommended value: 600. Ensure that the registration expiration timeout isset to a value smaller than the TCP connection aging timeout to avoid disconnection from the TCP. Note • min sec—(Optional) Range: 60 to 3600. Default: 60. exit Exits dial-peer configuration mode. Example: Router(config-voi-sip)# exit Step 7 sip-ua Enters SIP user-agent configuration mode. Example: Router(config)# sip-ua Step 8 Cisco Unified Communications Manager Express System Administrator Guide 126 Network Parameters Enable Calls in Your VoIP Network Command or Action Purpose Configures the maximum time interval allowed between two consecutive NOTIFY messages for a single DTMF event. notify telephone-event max-duration time Example: Router(config-sip-ua)# notify telephone-event max-duration 2000 Step 9 • max-duration time—Range: 500 to 3000. Default: 2000. Registers E.164 numbers on behalf of analog telephone voice ports (FXS) and IP phone virtual voice ports (EFXS) with an external SIP proxy or SIP registrar server. registrar {dns:host-name | ipv4:ip-address} expires seconds [tcp] [secondary] Example: Router(config-sip-ua)# registrar ipv4:10.8.17.40 expires 3600 secondary Step 10 Setsthe total number ofSIP Register messagesthat the gateway should send. retry register number Example: Router(config-sip-ua)# retry register 10 Step 11 • number—Number of Register message retries. Range: 1 to 10. Default: 10. Sets how long the SIP user agent (UA) waits before sending Register requests. timers register time Example: Router(config-sip-ua)# timers register 500 Step 12 • time—Waiting time, in milliseconds. Range: 100 to 1000. Default: 500. end Exits configuration mode and enters privileged EXEC mode. Example: Router(config-sip-ua)# end Step 13 Configure DHCP To set up DHCP service for your DHCP clients, perform only one of the following procedures: • If your Cisco Unified CME router is the DHCP server and you can use a single shared address pool for all your DHCP clients, see Configure Single DHCP IP Address Pool, on page 127. • If your Cisco Unified CME router is the DHCP server and you need separate pools for each IP phone and each non-IP-phone DHCP client, see Configure Separate DHCP IP Address Pool for Each DHCP Client, on page 129. • If the Cisco Unified CME router is not the DHCP server and you want to relay DHCP requests from IP phones to a DHCP server on a different router, see Configure DHCP Relay, on page 131. Configure Single DHCP IP Address Pool To create a shared pool of IP addresses for all DHCP clients, perform the following step. Cisco Unified Communications Manager Express System Administrator Guide 127 Network Parameters Configure DHCP Do not perform this task if you already have a DHCP server on the LAN that can be used to provide addresses to the Cisco Unified CME phones. See Enable Network Time Protocol, on page 133. Note A single DHCP IP address pool cannot be used if non-IP-phone clients, such as PCs, must use a different TFTP server address. Restriction Before You Begin Your Cisco Unified CME router is a DHCP server. SUMMARY STEPS 1. enable 2. configure terminal 3. ip dhcp pool pool-name 4. network ip-address [mask | / prefix-length] 5. option 150 ip ip-address 6. default-router ip-address 7. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Creates a name for the DHCPserver address pool and enters DHCPpool configuration mode. ip dhcp pool pool-name Example: Router(config)# ip dhcp pool mypool Step 3 network ip-address [mask | / prefix-length] Specifies the IP address of the DHCP address pool to be configured. Example: Router(config-dhcp)# network 10.0.0.0 255.255.0.0 Step 4 Cisco Unified Communications Manager Express System Administrator Guide 128 Network Parameters Configure DHCP Command or Action Purpose Specifiesthe TFTPserver addressfrom which the Cisco Unified IPphone downloads the image configuration file. option 150 ip ip-address Example: Router(config-dhcp)# option 150 ip 10.0.0.1 Step 5 • This is your Cisco Unified CME router’s address. (Optional) Specifies the router that the IP phones will use to send or receive IP traffic that is external to their local subnet. default-router ip-address Example: Router(config-dhcp)# default-router 10.0.0.1 Step 6 • If the Cisco Unified CME router is the only router on the network, this address should be the Cisco Unified CME IP source address. This command can be omitted if IPphones need to send or receive IP traffic only to or from devices on their local subnet. • The IP address that you specify for default router will be used by the IP phones for fallback purposes. If the Cisco Unified CME IP source address becomes unreachable, IP phones will attempt to register to the address specified in this command. end Returns to privileged EXEC mode. Example: Router(config-dhcp)# end Step 7 What to Do Next • If you are configuring Cisco Unified CME for the first time on this router, you are ready to configure NTP for the Cisco Unified CME router. For more information, see Enable Network Time Protocol, on page 133. • If you are finished modifying network parameters for an already configured Cisco Unified CME router, see Configuration Files for Phones, on page 387. Configure Separate DHCP IP Address Pool for Each DHCP Client To create a DHCPIPaddress pool for each DHCPclient, including non-IP-phone clientssuch asPCs, perform the following steps. Do not perform this task if you already have a DHCP server on the LAN that can be used to provide addresses to the Cisco Unified CME phones. See Enable Network Time Protocol, on page 133. Note Restriction To use a separate DHCP IP address pool for each DHCP client, make an entry for each IP phone. Cisco Unified Communications Manager Express System Administrator Guide 129 Network Parameters Configure DHCP Before You Begin Your Cisco Unified CME router is a DHCP server. SUMMARY STEPS 1. enable 2. configure terminal 3. ip dhcp pool pool-name 4. host ip-address subnet-mask 5. client-identifier mac-address 6. option 150 ip ip-address 7. default-router ip-address 8. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Creates a name for the DHCPserver address pool and enters DHCPpool configuration mode. ip dhcp pool pool-name Example: Router(config)# ip dhcp pool pool2 Step 3 host ip-address subnet-mask Specifies the IP address that you want the phone to get. Example: Router(config-dhcp)# host 10.0.0.0 255.255.0.0 Step 4 Specifies the MAC address of the phone, which is printed on a label on each Cisco Unified IP phone. client-identifier mac-address Example: Router(config-dhcp)# client-identifier 01238.380.3056 Step 5 • A separate client-identifier command is required for each DHCP client. • Add “01” prefix number before the MAC address. Cisco Unified Communications Manager Express System Administrator Guide 130 Network Parameters Configure DHCP Command or Action Purpose Specifiesthe TFTPserver addressfrom which the Cisco Unified IPphone downloads the image configuration file. option 150 ip ip-address Example: Router(config-dhcp)# option 150 ip 10.0.0.1 Step 6 • This is your Cisco Unified CME router’s address. (Optional) Specifies the router that the IP phones will use to send or receive IP traffic that is external to their local subnet. default-router ip-address Example: Router(config-dhcp)# default-router 10.0.0.1 Step 7 • If the Cisco Unified CME router is the only router on the network, this address should be the Cisco Unified CME IP source address. This command can be omitted if IP phones need to send or receive IP traffic only to or from devices on their local subnet. • The IP address that you specify for default router will be used by the IP phones for fallback purposes. If the Cisco Unified CME IP source address becomes unreachable, IP phones will attempt to register to the address specified in this command. end Returns to privileged EXEC mode. Example: Router(config-dhcp)# end Step 8 What to Do Next • If you are configuring Cisco Unified CME for the first time on this router, you are ready to configure NTP for the Cisco Unified CME router. See Enable Network Time Protocol, on page 133. • If you are finished modifying network parameters for an already configured Cisco Unified CME router, see Configuration Files for Phones, on page 387. Configure DHCP Relay To set up DHCP relay on the LAN interface where the Cisco Unified IP phones are connected and enable the DHCP relay to relay requests from the phones to the DHCP server, perform the following steps. Restriction The Cisco Unified CME router cannot be the DHCP server. Before You Begin There is a DHCP server that is not on this Cisco Unified CME router on the LAN that can provide addresses to the Cisco Unified CME phones. Cisco Unified Communications Manager Express System Administrator Guide 131 Network Parameters Configure DHCP SUMMARY STEPS 1. enable 2. configure terminal 3. service dhcp 4. interface type number 5. ip helper-address ip -address 6. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 service dhcp Enables the Cisco IOS DHCP server feature on the router. Example: Router(config)# service dhcp Step 3 interface type number Enters interface configuration mode for the specified interface. Example: Router(config)# interface vlan 10 Step 4 Specifies the helper address for any unrecognized broadcast for TFTP server and DNS server requests. ip helper-address ip -address Example: Router(config-if)# ip helper-address 10.0.0.1 Step 5 • A separate ip helper-address command is required for each server if the servers are on different hosts. • You can also configure multiple TFTPserver targets by using the ip helper-address commands for multiple servers. end Returns to privileged EXEC mode. Example: Router(config-if)# end Step 6 Cisco Unified Communications Manager Express System Administrator Guide 132 Network Parameters Configure DHCP What to Do Next • If you are configuring Cisco Unified CME for the first time on this router, you are ready to configure NTP for the Cisco Unified CME router. See Enable Network Time Protocol, on page 133. • If you are finished modifying network parameters for an already configured Cisco Unified CME router, see Configuration Files for Phones, on page 387. Enable Network Time Protocol SUMMARY STEPS 1. enable 2. configure terminal 3. clock timezone zone hours-offset [minutes-offset] 4. clock summer-time zone recurring [week day month hh:mm week day month hh:mm [offset]] 5. ntp server ip-address 6. exit DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 clock timezone zone hours-offset [minutes-offset] Sets the local time zone. Example: Router(config)# clock timezone pst -8 Step 3 clock summer-time zone recurring [week day month (Optional) Specifies daylight savings time. hh:mm week day month hh:mm [offset]] Step 4 • Default: summer time is disabled. If the clock summer-time zone recurring command is specified Example: Router(config)# clock summer-time pdt recurring without parameters, the summer time rules default to United States rules. Default of the offset argument is 60. Cisco Unified Communications Manager Express System Administrator Guide 133 Network Parameters Enable Network Time Protocol Command or Action Purpose Synchronizes software clock of router with the specified NTP server. ntp server ip-address Example: Router(config)# ntp server 10.1.2.3 Step 5 exit Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 6 What to Do Next • If you are configuring Cisco Unified CME for the first time on this router and if you have a multisite installation, you are ready to configure a DTMF relay. See Configure DTMF Relay for H.323 Networks in Multisite Installations, on page 141. • If Cisco Unified CME will interact with a SIP Gateway, you must set up support for the gateway. See Configure SIP Trunk Support, on page 142. • If you are configuring Cisco Unified CME for the first time on this router and you are ready to configure system parameters. See System-Level Parameters, on page 149. • If you are finished modifying network parameters for an already configured Cisco Unified CME router, see Configuration Files for Phones, on page 387. Set Olson Timezone for SCCP Phones To set the Olson Timezone so that the correct local time is displayed on a Cisco Unified SCCP IP phone, perform the following steps. Before You Begin • TzDataCSV.csv file is added to the configuration files of Cisco Unified 6921, 6941, 6945, and 6961 SCCP IP phones. • tzupdater.jar file is added to the configuration files of Cisco Unified 7961 SCCP IP phones. Cisco Unified Communications Manager Express System Administrator Guide 134 Network Parameters Set Olson Timezone for SCCP Phones SUMMARY STEPS 1. enable 2. configure terminal 3. tftp-server device: tzupdater.jar 4. tftp-server device: TZDataCSV.csv 5. telephony-service 6. olsontimezone timezone version number 7. create cnf-files 8. time-zone number 9. exit 10. clock timezone zone hours-offset 11. clock summer-time zone date date month year hh:mm date month year hh:mm 12. exit 13. clock set hh:mm:ss day month year 14. configure terminal 15. telephony-service 16. reset 17. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 tftp-server device: tzupdater.jar Enables access to the tzupdater.jar file on the TFTP server. Example: Router(config)# tftp-server flash:tzupdater.jar • device—TFTPserver that is accessible to the Cisco Unified CME, such as flash or slot 0. Step 4 tftp-server device: TZDataCSV.csv Enables access to the TZDataCSV.csv file on the TFTP server. Example: Router(config)# tftp-server flash:TZDataCSV.csv • device—TFTPserver that is accessible to the Cisco Unified CME, such as flash or slot 0. Cisco Unified Communications Manager Express System Administrator Guide 135 Network Parameters Set Olson Timezone for SCCP Phones Command or Action Purpose telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 5 Sets the Olson Timezone so that the correct local time is displayed on Cisco Unified SCCP IP phones or Cisco Unified SIP IP phones. olsontimezone timezone version number Example: Router(config-telephony)# olsontimezone America/Argentina/Buenos Aires version 2010o Step 6 • timezone—Olson Timezone names, which include the area (name of continent or ocean) and location (name of a specific location within that region, usually cities or small islands). • versionnumber—Version of the tzupdater.jar or TzDataCSV.csv file. The version indicates whether the file needs to be updated or not. In Cisco Unified CME 9.0, the latest version is 2010o. Note Builds the eXtensible Markup Language (XML) configuration files that are required for Cisco Unified SCCP IP phones in Cisco Unified CME. create cnf-files Example: Router(config-telephony)# create cnf-files Step 7 Sets the time zone so that the correct local time is displayed on Cisco Unified SCCP IP phones. time-zone number Example: Router(config-telephony)# time-zone 21 Step 8 • number—Numeric code for a named time zone. exit Exits telephony-service configuration mode. Example: Router(config-telephony)# exit Step 9 Step 10 clock timezone zone hours-offset Sets the time zone for display purposes. Example: Router(config)# clock timezone CST -6 • zone—Name of the time zone to be displayed when standard time is in effect. The length of the zone argument is limited to 7 characters. • hours-offset—Hours difference from UTC. (Optional) Configuresthe Cisco Unified CME system to automatically switch to summer time (daylight saving time). clock summer-time zone date date month year hh:mm date month year hh:mm Step 11 Example: Router(config)# clock summer-time CST date 12 October 2010 2:00 26 April 2011 2:00 • zone—Name of the time zone (for example, “PDT” for Pacific Daylight Time) to be displayed when summer time is in effect. The length of the zone argument is limited to 7 characters. • date—Indicatesthatsummer time should start on the firstspecific date listed in the command and end on the second specific date in the command. Cisco Unified Communications Manager Express System Administrator Guide 136 Network Parameters Set Olson Timezone for SCCP Phones Command or Action Purpose • date—Date of the month (1 to 31). • month—Month (January, February, and so on). • year—Year (1993 to 2035). • hh:mm—Time (24-hour format) in hours and minutes. exit Exits global configuration mode. Example: Router(config)# exit Step 12 Step 13 clock set hh:mm:ss day month year Manually sets the system software clock. Example: Router# clock set 19:29:00 13 May 2011 • hh:mm:ss—Current time in hours(24-hour format), minutes, and seconds. • day—Current day (by date) in the month. • month—Current month (by name). • year—Current year (no abbreviation). configure terminal Enters global configuration mode. Example: Router# configure terminal Step 14 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 15 Performs a complete reboot of Cisco Unfiied SCCP IP phones associated with a Cisco Unified CME router. reset Example: Router(config-telephony)# reset Step 16 end Exits to privileged EXEC mode. Example: Router(config-telephony)# end Step 17 Set Olson Timezone for SIP Phones To set the Olson Timezone so that the correct local time is displayed on a Cisco UnifiedSIPIPphone, perform the following steps. Cisco Unified Communications Manager Express System Administrator Guide 137 Network Parameters Set Olson Timezone for SIP Phones Before You Begin • TzDataCSV.csv file is added to the configuration files of Cisco Unified 3911, 3951, 6921, 6941, 6945, and 6961 SIP IP phones. • tzupdater.jar file is added to the configuration files of Cisco Unified 7961 SIP IP phones. SUMMARY STEPS 1. enable 2. configure terminal 3. tftp-server device: tzupdater.jar 4. tftp-server device: TZDataCSV.csv 5. voice register global 6. olsontimezone timezone version number 7. create profile 8. timezone number 9. exit 10. clock timezone zone hours-offset 11. clock summer-time zone date date month year hh:mm date month year hh:mm 12. exit 13. clock set hh:mm:ss day month year 14. configure terminal 15. voice register global 16. reset 17. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 tftp-server device: tzupdater.jar Enables access to the tzupdater.jar file on the TFTP server. Example: Router(config)# tftp-server slot0:tzupdater.jar • device—TFTP server that is accessible to the Cisco Unified CME, such as flash or slot 0. Step 4 tftp-server device: TZDataCSV.csv Enables access to the TZDataCSV.csv file on the TFTP server. Cisco Unified Communications Manager Express System Administrator Guide 138 Network Parameters Set Olson Timezone for SIP Phones Command or Action Purpose Example: Router(config)# tftp-server slot0:TZDataCSV.csv • device—TFTP server that is accessible to the Cisco Unified CME, such as flash or slot 0. voice register global Enters voice register global configuration mode. Example: Router(config)# voice register global Step 5 Sets the Olson Timezone so that the correct local time is displayed on Cisco Unified SCCP IP phones or Cisco Unified SIP IP phones. olsontimezone timezone version number Example: Router(config-register-global)# olsontimezone America/Argentina/Buenos Aires version 2010o Step 6 • timezone—Olson Timezone names, which include the area (name of continent or ocean) and location (name of a specific location within that region, usually cities or small islands). • version number—Version of the tzupdater.jar or tzdatacsv.csv file. The version indicates whether the file needs to be updated or not. In Cisco Unified CME 9.0, the latest version is 2010o. Note Generates the configuration profile files required for Cisco Unified SIP IP phones. create profile Example: Router(config-register-global)# create profile Step 7 Step 8 timezone number Sets the time zone used for Cisco Unified SIP IP phones. Example: Router(config-register-global)# timezone 21 • number—Range is 1 to 53. Default is 5, Pacific Standard/Daylight Time. exit Exits voice register global configuration mode. Example: Router(config-register-global)# exit Step 9 Step 10 clock timezone zone hours-offset Sets the time zone for display purposes. Example: Router(config)# clock timezone CST -6 • zone—Name of the time zone to be displayed when standard time is in effect. The length of the zone argument is limited to 7 characters. • hours-offset—Hours difference from UTC. (Optional) Configuresthe Cisco Unified CME system to automatically switch to summer time (daylight saving time). clock summer-time zone date date month year hh:mm date month year hh:mm Step 11 Cisco Unified Communications Manager Express System Administrator Guide 139 Network Parameters Set Olson Timezone for SIP Phones Command or Action Purpose Example: Router(config)# clock summer-time CST date 12 October 2010 2:00 26 April 2011 2:00 • zone—Name of the time zone (for example, “PDT” for Pacific Daylight Time) to be displayed when summer time is in effect. The length of the zone argument is limited to 7 characters. • date—Indicates that summer time should start on the first specific date listed in the command and end on the second specific date in the command. • date—Date of the month (1 to 31). • month—Month (January, February, and so on). • year—Year (1993 to 2035). • hh:mm—Time (24-hour format) in hours and minutes. exit Exits global configuration mode. Example: Router(config)# exit Step 12 Step 13 clock set hh:mm:ss day month year Manually sets the system software clock. Example: Router# clock set 15:25:00 17 November 2011 • hh:mm:ss—Current time in hours (24-hour format), minutes, and seconds. • day—Current day (by date) in the month. • month—Current month (by name). • year—Current year (no abbreviation). configure terminal Enters global configuration mode. Example: Router# configure terminal Step 14 voice register global Enters voice register global configuration mode. Example: Router(config)# voice register global Step 15 Performs a complete reboot of Cisco Unified SIP phones associated with a Cisco Unified CME router. reset Example: Router(config-register-global)# reset Step 16 end Exits to privileged EXEC mode. Example: Router(config-register-global)# end Step 17 Cisco Unified Communications Manager Express System Administrator Guide 140 Network Parameters Set Olson Timezone for SIP Phones Configure DTMF Relay for H.323 Networks in Multisite Installations To configure DTMF relay for H.323 networks in a multisite installation only, perform the following steps. Note To configure DTMF relay on SIP networks, see Configure SIP Trunk Support, on page 142. SUMMARY STEPS 1. enable 2. configure terminal 3. dial-peer voice tag voip 4. dtmf-relay h245-alphanumeric 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 dial-peer voice tag voip Enters dial-peer configuration mode. Example: Router(config)# dial-peer voice 2 voip Step 3 Specifiesthe H.245 alphanumeric method for relaying dual tone multifrequency (DTMF) tones between telephony interfaces and an H.323 network. dtmf-relay h245-alphanumeric Example: Router(config-dial-peer)# dtmf-relay h245-alphanumeric Step 4 end Returns to privileged EXEC mode. Example: Router(config-dial-peer)# end Step 5 What to Do Next • To set up support for a SIP trunk, see Configure SIP Trunk Support, on page 142. Cisco Unified Communications Manager Express System Administrator Guide 141 Network Parameters Configure DTMF Relay for H.323 Networks in Multisite Installations • If you are configuring Cisco Unified CME for the first time on this router and you are ready to configure system parameters. For more information, see System-Level Parameters, on page 149. • If you are finished modifying network parameters for an already configured Cisco Unified CME router, see Configuration Files for Phones, on page 387. Configure SIP Trunk Support To enable DTMF relay on a dial-peer for a SIP gateway and set up the gateway to register phone numbers with Cisco Unified CME, perform the following steps. SUMMARY STEPS 1. enable 2. configure terminal 3. dial-peer voice tag voip 4. dtmf-relay rtp-nte 5. dtmf-relay sip-notify 6. exit 7. sip-ua 8. notify telephone-event max-duration msec 9. registrar {dns: host-name | ipv4: ip-address} expires seconds [tcp] [secondary] 10. retry register number 11. timers register msec 12. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 dial-peer voice tag voip Enters dial-peer configuration mode. Example: Router(config)# dial-peer voice 2 voip Step 3 Cisco Unified Communications Manager Express System Administrator Guide 142 Network Parameters Configure SIP Trunk Support Command or Action Purpose Forwards DTMFtones by using Real-Time TransportProtocol (RTP) with the Named Telephone Event (NTE) payload type and enables DTMFrelay using the RFC 2833 standard method. dtmf-relay rtp-nte Example: Router(config-dial-peer)# dtmf-relay rtp-nte Step 4 dtmf-relay sip-notify Forwards DTMF tones using SIP NOTIFY messages. Example: Router(config-dial-peer)# dtmf-relay sip-notify Step 5 exit Exits dial-peer configuration mode. Example: Router(config-dial-peer)# exit Step 6 sip-ua Enters SIP user-agent configuration mode. Example: Router(config)# sip-ua Step 7 Sets the maximum milliseconds allowed between two consecutive NOTIFY messages for a single DTMF event. notify telephone-event max-duration msec Example: Router(config-sip-ua)# notify telephone-event max-duration 2000 Step 8 • max-durationtime—Range: 500 to 3000. Default: 2000. Registers E.164 numbers on behalf of analog telephone voice ports (FXS) and IP phone virtual voice ports (EFXS) with an external SIP proxy or SIP registrar server. registrar {dns: host-name | ipv4: ip-address} expires seconds [tcp] [secondary] Example: Router(config-sip-ua)# registrar ipv4:10.8.17.40 expires 3600 secondary Step 9 Setsthe total number ofSIP Register messagesthat the gateway should send. retry register number Example: Router(config-sip-ua)# retry register 10 Step 10 • number—Number of Register message retries. Range: 1 to 10. Default: 10. Sets how long the SIP user agent (UA) waits before sending Register requests. timers register msec Example: Router(config-sip-ua)# timers register 500 Step 11 • time—Waiting time, in milliseconds. Range: 100 to 1000. Default: 500. end Returns to privileged EXEC mode. Example: Router(config-sip-ua)# end Step 12 Cisco Unified Communications Manager Express System Administrator Guide 143 Network Parameters Configure SIP Trunk Support Verify SIP Trunk Support Configuration To verify SIP trunk configuration, perform the following steps in any order. Step 1 show sip-ua status Use this command to display the time interval between consecutive NOTIFY messages for a telephone event. In the following example, the time interval is 2000 ms: Example: Router# show sip-ua status SIP User Agent Status SIP User Agent for UDP :ENABLED SIP User Agent for TCP :ENABLED SIP User Agent bind status(signaling):DISABLED SIP User Agent bind status(media):DISABLED SIP early-media for 180 responses with SDP:ENABLED SIP max-forwards :6 SIP DNS SRV version:2 (rfc 2782) NAT Settings for the SIP-UA Role in SDP:NONE Check media source packets:DISABLED Maximum duration for a telephone-event in NOTIFYs:2000 ms SIP support for ISDN SUSPEND/RESUME:ENABLED Redirection (3xx) message handling:ENABLED SDP application configuration: Version line (v=) required Owner line (o=) required Timespec line (t=) required Media supported:audio image Network types supported:IN Address types supported:IP4 Transport types supported:RTP/AVP udptl Step 2 show sip-ua timers This command displays the waiting time before Register requests are sent; that is, the value that has been set with the timers register command. Step 3 show sip-ua register status This command displays the status of local E.164 registrations. Step 4 show sip-ua statistics This command displays the Register messages that have been sent. Change the TFTP Address on a DHCP Server To change the TFTP IP address after it has already been configured, perform the following steps. Cisco Unified Communications Manager Express System Administrator Guide 144 Network Parameters Verify SIP Trunk Support Configuration If the DHCPserver is on a different router than Cisco Unified CME, reconfigure the external DHCPserver with the new IP address of the TFTP server. Restriction Before You Begin Your Cisco Unified CME router is a DHCP server. SUMMARY STEPS 1. enable 2. configure terminal 3. ip dhcp pool pool-name 4. option 150 ip ip-address 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters DHCP pool configuration mode to create or modify a DHCP pool. ip dhcp pool pool-name Example: Router(config)# ip dhcp pool pool2 Step 3 • pool-name—Previously configured unique identifier for the pool to be configured. Specifies the TFTP server IP address from which the Cisco Unified IP phone downloads the image configuration file, XmlDefault.cnf.xml. option 150 ip ip-address Example: Router(config-dhcp)# option 150 ip 10.0.0.1 Step 4 end Returns to privileged EXEC mode. Example: Router(config-dhcp)# end Step 5 Cisco Unified Communications Manager Express System Administrator Guide 145 Network Parameters Change the TFTP Address on a DHCP Server Configuration Examples for Network Parameters NTP Server The following example definesthe pst timezone as 8 hours offset from UTC, using a recurring daylightsavings time called pdt, and synchronizes the clock with the NTP server at 10.1.2.3: clock timezone pst -8 clock summer-time pdt recurring ntp server 10.1.2.3 DTMF Relay for H.323 Networks The following excerpt from the show running-config command output shows a dial peer configured to use H.245 alphanumeric DTMF relay: dial-peer voice 4000 voip destination-pattern 4000 session target ipv4:10.0.0.25 codec g711ulaw dtmf-relay h245-alphanumeric Where to Go Next • If you are configuring Cisco Unified CME for the first time on this router, you are ready to configure system-level parameters. See System-Level Parameters, on page 149. • If you modified network parameters for an already configured Cisco Unified CME router, you are ready to generate the configuration file to save the modifications.See ConfigurationFiles forPhones, on page 387. Feature Information for Network Parameters The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Cisco Unified Communications Manager Express System Administrator Guide 146 Network Parameters Configuration Examples for Network Parameters Table 9: Feature Information for Network Parameters Feature Name Cisco Unified CME Version Modification Eliminates the need to update time zone commands or phone loads to accommodate a new country with a new time zone or an existing country whose city or state wants to change their time zone, using the olsontimezone command in either telephony-service or voice register global configuration mode. Olson Timezone 9.0 Cisco Unified Communications Manager Express System Administrator Guide 147 Network Parameters Feature Information for Network Parameters Cisco Unified Communications Manager Express System Administrator Guide 148 Network Parameters Feature Information for Network Parameters CHAPTER 6 System-Level Parameters • Prerequisites for System-Level Parameters, page 149 • Information About Configuring System-Level Parameters, page 149 • Configure System-Level Parameters, page 167 • Configuration Examples for System-Level Parameters, page 209 • Where to Go Next, page 219 • Feature Information for System-Level Parameters, page 219 Prerequisites for System-Level Parameters • To directly connect Cisco Unified IP phones that are running Session Initiation Protocol (SIP) in Cisco Unified CME, Cisco CME 3.4 or a later version must be installed on the router. For installation information, see Install and Upgrade Cisco Unified CME Software, on page 101. • Cisco Unified CME must be configured to work with your IP network. For configuration information, see Network Parameters, on page 121. Information About Configuring System-Level Parameters Bulk Registration Support for SIP Phones Cisco Unified CME 8.6 enhances the bulk registration feature for Cisco Unified SIP IP phones by optimizing the two main transactions involved in bulk registration process and minimizing the number of required messagesto be sent to the phones. The bulk registration processinvolvesthe following two main transactions: • Register—Register transaction handles per line REGISTER messages coming to Cisco Unified CME and provisions phone DNs by creating dialpeers and various phone data structures. • Phone Status Update—Phone status update transaction sends back device information using REFER and NOTIFY messages. Cisco Unified Communications Manager Express System Administrator Guide 149 In Cisco Unified CME 8.6, the bulk registration process consists of only one REGISTER message per phone instead of one REGISTER message per phone per line, thus reducing any negative impact on your router’s performance. For information on configuring bulk registration, see Configure Bulk Registration for SIP IP Phones, on page 174. The show voice register pool command displays the registration method a phone uses: per line, bulk-in progress, or bulk-completed. The per line option indicates that the phone is using the per line registration process. The bulk-in progress option indicates that the phone is using the bulk registration process but the registration process is not complete yet. The bulk-completed option indicates that the phone is registered using the bulk registration process and the registration process is complete. For information on verifying the phone registration process, see Verify Phone Registration Type and Status, on page 175. The bulk registration feature in Cisco Unified CME 8.6 optimizes line registration on SIP phones and is a phone interop feature. The bulk registration feature is not related to the bulk command under voice register global configuration mode. Note In earlier versions of Cisco Unified CME, the registration process was very lengthy and severalSIP messages were exchanged between the end points and Cisco Unified CME to properly provision the phone. Table 10: Number of Messages Required for an Eight-Button IP Phone, on page 150 lists the number of messages required to register an eight-button Cisco Unified SIP IP phone, where all of the eight buttons can be configurd as a shared line with message waiting indicator (MWI) notification enabled, to Cisco Unified CME. Table 10: Number of Messages Required for an Eight-Button IP Phone Total number of messages (bulk) Total number of messages (per line) Number of Transactions Messages Per Transaction Transactions Method Register REGISTER 2 8 24 3 6 2 16 3 8 2 2 REFER remotecc NOTIFY (mwi, service-control) Phone Status Update SUBSCRIBE 4 8 32 32 (sharedline) Subscription Total 78 37 You can see from the preceding table that more than 70 messages are required to register one 8-button IP phone. If there is a simultaneous registration of more phones, the amount of messages can be overwhelming and can have a negative impact on the performance of the router. With the enhanced bulk registration process, the two main transactions (Register and Phone Status Update) are optimized to minimize the number of messages required to complete the phone registration process. Table 10: Number of Messages Required for an Eight-Button IP Phone, on page 150 shows that the total number of messages required for bulk registration is only 37. Cisco Unified Communications Manager Express System Administrator Guide 150 System-Level Parameters Bulk Registration Support for SIP Phones Register Transaction The following is an example of the REGISTER message: REGISTER sip:28.18.88.1 SIP/2.0 Via: SIP/2.0/TCP 28.18.88.33:44332;branch=z9hG4bK53f227fc From: ;tag=001b2a893698027db8ea0454-26b9fb0c To: Call-ID: 001b2a89-3698011e-280209a4-567e339c@28.18.88.33 Max-Forwards: 70 Date: Wed, 03 Mar 2010 01:18:34 GMT CSeq: 240 REGISTER User-Agent: Cisco-CP7970G/8.4.0 Contact: ;+sip.instance=" ";+u.sip!model.ccm.cisco.com="30006" Supported: replaces,join,norefersub,extended-refer,X-cisco-callinfo,X-cisco-serviceuri,X-cisco-escapecodes, X-cisco-service-control,X-cisco-srtp-fallback,X-cisco-monrec,X-cisco-config,X-cisco-sis-3.0.0,X-cisco-xsi-7.0.1 Reason: SIP;cause=200;text="cisco-alarm:23 Name=SEP001B2A893698 Load=SIP70.8-4-2-30S Last=reset-restart" Expires: 3600 Content-Type: multipart/mixed; boundary=uniqueBoundary Mime-Version: 1.0 Content-Length: 982 --uniqueBoundary Content-Type: application/x-cisco-remotecc-request+xml Content-Disposition: session;handling=optional > < x-cisco-remotecc-request > < contact all="true" > < register > < /register > < /contact > < /bulkregisterreq > < /x-cisco-remotecc-request > --uniqueBoundary Content-Type: application/x-cisco-remotecc-request+xml Content-Disposition: session;handling=optional Cisco Unified Communications Manager Express System Administrator Guide 151 System-Level Parameters Bulk Registration Support for SIP Phones > < x-cisco-remotecc-request > < optionsind > < combine max="6" > < remotecc > < status > < /status > < /remotecc > < service-control > < /service-control > < /combine > < dialog usage="hook status" > < unot > < /unot > < sub > < /sub > < /dialog > < dialog usage="shared line" > < unot > < /unot > < sub > < /sub > < /dialog > < presence usage="blf speed dial" > < unot > < /unot > < sub > < /sub > < /presence > < joinreq > < /joinreq > < /optionsind > < /x-cisco-remotecc-request > --uniqueBoundary-- The following is an example of a response to the preceding REGISTER message: SIP/2.0 200 OK Date: Wed, 03 Mar 2010 01:18:41 GMT From: < sip:6010@28.18.88.1 > ;tag=001b2a893698027db8ea0454-26b9fb0c Content-Length: 603 To: < sip:6010@28.18.88.1 > ;tag=E2556C-6C1 Contact: < sip:6010@28.18.88.33:44332;transport=tcp > ;expires=3600;x-cisco-newreg Expires: 3600 Content-Type: multipart/mixed;boundary=uniqueBoundary Call-ID: 001b2a89-3698011e-280209a4-567e339c@28.18.88.33 Via: SIP/2.0/TCP 28.18.88.33:44332;branch=z9hG4bK53f227fc Cisco Unified Communications Manager Express System Administrator Guide 152 System-Level Parameters Bulk Registration Support for SIP Phones Server: Cisco-SIPGateway/IOS-12.x CSeq: 240 REGISTER Mime-Version: 1.0 > < x-cisco-remotecc-response > < response > < code > 200 < /code > < optionsind > < combine max="6" > < remotecc > < status/ > < /remotecc > < service-control/ > < /combine > < dialog usage="shared line" > < sub/ > < /dialog > < presence usage="blf speed dial" > < sub/ > < /presence > < /optionsind > < /response > < /x-cisco-remotecc-response > Phone Status Update Transaction Cisco Unified IP phones use the option indication to negotiate supported options with Cisco Unified CME via remotecc request. Cisco Unified CME selects an option or options that it wishes to support and return it in the response. Cisco Unified CME ignores items (elements, attributes, and values) that it fails to understand. A new phone option, combine, is defined to optimize phone status update. This option combines remotecc status information (cfwdall, privacy, dnd, bulk mwi) and service-control. The following is an example of a combined status update: The following is another example of a combined status update: To minimize the data size, Cisco Unified CME and the phone agree ahead of time on a default value to apply updates. Therefore, during initial registration, Cisco Unified CME will not send the value if it matches the agreed upon default. Table 11: Status Information and Default, on page 153 captures the existing status information and applicable default value. Table 11: Status Information and Default Status Default Initialization Always send regardless of the value CallForwardAll Update No default Only send if the value is not equal to the default Privacyrequest Disabled Only send if value is not equal to the default DnDupdate Disabled Bulkupdate (MWI) No default Always send regardless of value Cisco Unified Communications Manager Express System Administrator Guide 153 System-Level Parameters Bulk Registration Support for SIP Phones During bulk registration, Cisco Unified CME uses a single REFER message to send combined phone status update message for phone status updates such as cfwdallupdate, privacyrequet, DnDupdate, and Bulkupdate (MWI) instead ofsending phone statusin individual NOTIFY or REFER message to the phone. The following is an example of the single REFER message sent by Cisco Unified CME to the phone: REFER sip:6010@28.18.88.33:44332 SIP/2.0 Content-Id: <1483336> From: ;tag=E256D4-2316 Timestamp: 1267579121 Content-Length: 934 User-Agent: Cisco-SIPGateway/IOS-12.x Require: norefersub Refer-To: cid:1483336 To: Contact: Referred-By: Content-Type: multipart/mixed;boundary=uniqueBoundary Call-ID: 89CBE590-259911DF-80589501-4E753388@28.18.88.1 Via: SIP/2.0/UDP 28.18.88.1:5060;branch=z9hG4bKA22639 CSeq: 101 REFER Max-Forwards: 70 Mime-Version: 1.0 --uniqueBoundary Content-Type: application/x-cisco-remotecc-request+xml off --uniqueBoundary Content-Type: application/x-cisco-remotecc-request+xml true --uniqueBoundary Content-Type: application/x-cisco-remotecc-request+xml no yes yes --uniqueBoundary Content-Type: text/plain action=check-version RegisterCallId={001b2a89-3698011e-280209a4-567e339c@28.18.88.33} ConfigVersionStamp={0106514225374329} DialplanVersionStamp={} SoftkeyVersionStamp={0106514225374329} --uniqueBoundary-- Cisco Unified Communications Manager Express System Administrator Guide 154 System-Level Parameters Bulk Registration Support for SIP Phones Cisco Unified IP phones use the TCP for registration refresh. TCP socket has a default keepalive time out session of 60 minutes. If registration refresh to Cisco Unified CME does not takes place within an hour (60 minutes), the TCP connection will be removed. This will make the phones restart instead of refresh. To stop the phones from restarting, adjust the registrar expire timer under voice service voip or set the timer connection aging under sip-ua to a value greater than what the phone uses for registration refreshes. For example, if the phone does a registration refresh every 60 minutes, then setting up a timer connection aging to 100 minutes will guarantee that the TCP keeps the connection open. Or you can set the registrar expire maximum value to less than 3600. Note DSCP Differentiated Services Code Point (DSCP) packet marking is used to specify the class of service for each packet. Cisco Unified IP Phones get their DSCP information from the configuration file that is downloaded to the device. In earlier versions of Cisco Unified CME, the DSCP value is predefined. In Cisco Unified CME 7.1 and later versions, you can configure the DSCP value for different types of network traffic. Cisco Unified CME downloads the configured DSCP value to SCCP and SIP phones in their configuration files and all control messages and flow-through RTP streams are marked with the configured DSCP value. This allows you to set different DSCP values, for example, for video streams and audio streams. For configuration information, see Set Up Cisco Unified CME for SCCP Phones , on page 175 or Set Up Cisco Unified CME for SIP Phones, on page 192. Maximum Ephones in Cisco Unified CME 4.3 and Later Versions In Cisco Unified CME 4.3 and later versions, the max-ephones command is enhanced to set the maximum number of SCCP phones that can register to Cisco Unified CME, without limiting the number that can be configured. In previous versions of Cisco Unified CME, the max-ephones command defined the maximum number of phones that could be both configured and registered. This enhancement expands the maximum number of phones that can be configured to 1000. The maximum number of phones that can register to Cisco Unified CME has not changed; it is dependent on the number of phones supported by the hardware platform and is limited by the max-ephones command. This enhancement supports features, such as Extension Assigner, that require you to configure more phones than can register. For example, if you set the max-ephones command to 50 and configure 100 ephones, only 50 phones can register to Cisco Unified CME, one at a time in random order. The remaining 50 phones cannot register and an error message displays for each rejected phone. This enhancement also allows you to assign ephone tags that match the extension number of the phone, for extensions up to 1000. If you reduce the value of the max-ephones command, currently registered phones are not forced to unregister until a reboot. If the number of registered phones, however, is already equal to or more than the max-ephones value, no additional phones can register to Cisco Unified CME. If you increase the value of the max-ephones command, the previously rejected ephones are able to register immediately until the new limit is reached. Cisco Unified Communications Manager Express System Administrator Guide 155 System-Level Parameters DSCP For Cisco IntegratedServices Router 4351, you can set the max-ephones value to 3925.For Cisco Integrated Services Router 4331, you can set the max-ephones value to 2921. For Cisco Integrated Services Router 4321, you can set the max-ephones value to 2901. For Cisco Integrated Services Router 4400 series, you can set the max-ephones value to 4451. Note Network Time Protocol for SIP Phones Although SIP phones can synchronize to a Cisco Unified CME router, the router can lose its clock after a reboot causing phones to display the wrong time. SIP phones registered to a Cisco Unified CME router can synchronize to a Network Time Protocol (NTP) server. Synchronizing to an NTP server ensures that SIP phones maintain the correct time. For configuration information, see Set Network Time Protocol for SIP Phones, on page 199. Per-Phone Configuration Files In Cisco Unified CME 4.0 and later versions, you can use an external TFTPserver to off load the TFTPserver function on the Cisco Unified CME router. Using flash memory or slot 0 memory on the Cisco Unified CME router allows you to use different configuration files for each phone type or for each phone, permitting you to specify different user locales and network locales for different phones. Before Cisco Unified CME 4.0, you could specify only a single default user and network locale for a Cisco Unified CME system. You can specify one of the following four locations to store configuration files: • System—This is the default. When system:/its is the storage location, there is only one default configuration file for all phonesin the system. All phones, therefore, use the same user locale and network locale. User-defined locales are not supported. • Flash or slot 0—When flash memory or slot 0 memory on the router is the storage location, you can create additional configuration files to apply per phone type or per individual phone. Up to five user and network locales can be used in these configuration files. When the storage location you selected is flash memory and the file system type on this device is Class B (LEFS), you must check the free space on the device periodically and use the squeeze command to free the space used up by deleted files. Unless you use the squeeze command, the space used by the moved or deleted configuration files cannot be used by other files. Rewriting flash memory space during the squeeze operation may take several minutes. We recommend that you use this command during scheduled maintenance periods or off-peak hours. Note • TFTP—When an external TFTP server is the storage location, you can create additional configuration files that can be applied per phone type or per individual phone. Up to five user and network locales can be used in these configuration files. You can then specify one of the following ways to create configuration files: Cisco Unified Communications Manager Express System Administrator Guide 156 System-Level Parameters Network Time Protocol for SIP Phones • Per system—This is the default. All phones use a single configuration file. The default user and network locale in a single configuration file are applied to all phones in the Cisco Unified CME system. Multiple locales and user-defined locales are not supported. • Per phone type—This setting creates separate configuration files for each phone type. For example, all Cisco Unified IPPhone 7960s use XMLDefault7960.cnf.xml, and all Cisco Unified IPPhone 7905s use XMLDefault7905.cnf.xml. All phones of the same type use the same configuration file, which is generated using the default user and network locale. This option is not supported if you store the configuration files in the system:/its location. • Per phone—This setting creates a separate configuration file for each phone by MAC address. For example, a Cisco Unified IP Phone 7960 with the MAC address 123.456.789 creates the per-phone configuration file SEP123456789.cnf.xml. The configuration file for a phone is generated with the default user and network locale unless a different user and network locale is applied to the phone using an ephone template. This option is not supported if you store the configuration files in the system:/its location. For configuration information, see Define Per-Phone Configuration Files and Alternate Location for SCCP Phones, on page 181. HFS Download Support for IP Phone Firmware and Configuration Files Legacy IP phones access the TFTP server to download firmware and configuration files but Cisco Unified CME 8.8 enhances download support for SIP phone firmware, scripts, midlets, and configuration files using the HTTP File-Fetch Server (HFS) infrastructure. In Cisco Unified CME 8.8 and later versions,SIPphones use an HTTPserver asthe primary download service when it is configured and access a TFTP server as a secondary or fallback option when the HTTP server fails. Note When the HFS download service is not configured, SIP phones automatically access the TFTP server. The following scenario shows a successful download sequence using an HTTP server: An IP phone initiates TCP connection to port 6970. A connection is established and an internal request for a file is sent to the HTTP server. The phone receives the HTTP response status code of 200, signifying that the download is successful. The following scenario shows a download sequence that begins with an IP phone using an HTTP server to download files and ends with a TFTP server as a fallback option when the initial download attempt fails: An IPphone initiates TCPconnection to port 6970 but is unable to establish a connection. The phone contacts the TFTP server and sends an internal request for a file. The file is successfully downloaded from the TFTP server. The following scenario shows how a download sequence that starts with an HTTP server does not always fall back to the TFTP server when the initial download attempt fails: An IP phone initiates TCP connection to port 6970. A connection is established and an internal request for a file is sent to the HTTP server. The phone receives the HTTP response status code of 404, signifying that the file requested could not be found. Because the file cannot be found, the request is not sent to the TFTP server. Cisco Unified Communications Manager Express System Administrator Guide 157 System-Level Parameters Per-Phone Configuration Files The configuration files are shared by the HTTPand TFTPservers. However, the firmware files are different for each server. Note For more information on Phone Firmware Files, see Install and Upgrade Cisco Unified CME Software, on page 101. For more information on Per-Phone Configuration Files, see Per-Phone Configuration Files, on page 156. For more information on Configuration Files for Phones in Cisco Unified CME, see Generate Configuration Files for Phones, on page 388. Enable HFS Service To enable the HFS download service, the underlying HTTP server must be enabled first because the HFS infrastructure is built on top of an existing IOS HTTP server. Router(config)# ip http server This HFS infrastructure enables multiple HTTP services to co-exist. The HFS download service runs on custom port 6970 but can also share default port 80 with other services. Other HTTP services run on other non-standard ports like 1234. Router(config)# ip http server Router(config)# ip http port1234 The HFS download service starts when the following is configured in telephony-service configuration mode. For the default port: Router(config-telephony)# hfs enable For the custom port: Router(config-telephony)# hfs enable port 6970 If the entered custom HFS port clashes with the underlying IP HTTP port, an error message is displayed and the command is disallowed. Note In the following example, port 6970 is configured as the IP HTTPport. When the HFSport is configured with the same value, an error message is displayed to show that the port is already in use. Router (config)# ip http port 6970 . . Router (config)# telephony-service Router (config-telephony)# hfs enable port 6970 Error Message Invalid port number or port in use by other application Explanation The HFS port number is already in use by the underlying IP HTTP server. Recommended Action Use an HFS port that is different from the underlying IP HTTP port. Because IP phones are hardcoded to use port 6970 to connect to Cisco Unified CME, you must search for other applicationsrunning on port 6970 and assign them with ports different from 6970 to prevent a failure in connecting to Cisco Unified CME. Note For configuration information, see Enable HFS Download Service for SIP Phones, on page 200. Cisco Unified Communications Manager Express System Administrator Guide 158 System-Level Parameters Per-Phone Configuration Files File Binding and Fetching File binding and fetching using the HTTP server can be classified into two: • Explicit binding – The create profile command triggers the system to generate the configuration and firmware files and store them in RAM or a flash memory. The system asks the new internal application programming interfaces (APIs) implemented by the HFS download service to bind the filename and alias that an IP phone wants to access to their corresponding URL. • Loose binding – The HFSdownload service enablesthe Cisco Unified CME system to configure a home path from where any requested firmware file that has no explicit binding can be searched and fetched. The files can be stored on any device (such as flash memory or NVRAM) under a root directory or a suitable subdirectory. No matter how the system is configured, if there is no explicit binding, the files will go to the home path. An advantage of the HFSservice over the TFTPservice isthat only the absolute path where the firmware files are located needs to be configured in telephony-service configuration mode. For example: Router(config-telephony)# hfs home-path flash:/cme/loads/ In contrast, the TFTP service requires that each file be explicitly bound to its URL using the following tftp-server command: tftp-server flash: SCCP70.8-3-3-14S.loads The method is inefficient because this step must be repeated for each file that needs to be fetched using the TFTP server. For information on verifying HFS file bindings, see Example for Verifying the HFS File Bindings of Cisco Unified SIP IP Phone Configuration and Firmware Files, on page 214. For information on how to configure the home path, see Configure HFS Home Path for SIP Phone Firmware Files, on page 202. Locale Installer Installing and configuring locale files in Cisco Unified CME when using an HTTP server is the same as when using a TFTP server. For configuration information, see Use the Locale Installer in Cisco Unified CME 7.0(1) and Later Versions, on page 419. Security Recommendations Like any access interface, the HFS download service can open router files that should only be accessed by authorized persons. Security issues are made more severe by the fact that the HFS download service is HTTP based, enabling anyone with a simple web browser to access sensitive files, such as configuration or image files, by entering a random string of words. However, the HFS security problem is restricted to the loose binding operation, where the administrator provides an HFS home path in which the phone firmware and other related files are stored. In the case where a unique directory path (where only the phone firmware files are stored) is used as the HFS home path (config-telephony)# hfs home-path flash:/cme/loads/ Cisco Unified Communications Manager Express System Administrator Guide 159 System-Level Parameters Per-Phone Configuration Files only those files that are in flash:/cme/loads/ can be accessed. But when it is the root directory path that is used as the HFS home path (config-telephony)# hfs home-path flash:/ there is a risk of making configuration files and system images, which are stored in the root directory shared with the phone firmware files, accessible to unauthorized persons. The following are two recommendations on how to make firmware files inaccessible to unauthorized persons: • Create a unique directory, which is not shared by any other application or used for any other purpose, fpr IP phone firmware files. Using a root directory as the HFS home path is not recommended. • Use the ip http access-class command to specify the access list that should be used to restrict access to the HTTP server. Before the HTTP server accepts a connection, it checks the access list. If the check fails, the HTTP server does not accept the request for a connection. Redundant Cisco Unified CME Router for SCCP Phones A second Cisco Unified CME router can be configured to provide call-control services if the primary Cisco Unified CME router fails. The secondary Cisco Unified CME router provides uninterrupted services until the primary router becomes operational again. When a phone registers to the primary router, it receives a configuration file from the primary router. Along with other information, the configuration file contains the IP addresses of the primary and secondary Cisco Unified CME routers. The phone uses these addresses to initiate a keepalive (KA) message to each router. The phone sends a KA message after every KA interval (30 seconds by default) to the router with which it is registered and after every two KA intervals (60 seconds by default) to the other router. The KA interval can be adjusted. If the primary router fails, a phone will not receive an acknowledgment (ACK) to its KA message to the primary router. If the phone does not get an ACK from the primary router for three consecutive KAs, it registers with the secondary Cisco Unified CME router. During the time that the phone isregistered to the secondary router, it keepssending a KA probe to the primary router to see if it has come back up, now every 60 seconds by default or two times the normal KA interval. After the primary Cisco Unified CME router returns to normal operation, the phone starts receiving ACKs for its probes. After the phone receives ACKs from the primary router for three consecutive probes, it switches back to the primary router and re-registers with it. The re-registration of phones with the primary router is also called rehoming. The physical setup for redundant Cisco Unified CME routers is as follows. The FXO line from the PSTN is split using a splitter. From the splitter, one line goes to the primary Cisco Unified CME router and the other line goes to the secondary Cisco Unified CME router. When a call comes in on the FXO line, it is presented to both the primary and secondary Cisco Unified CME routers. The primary router is configured by default to answer the call immediately. The secondary Cisco Unified CME router is configured to answer the call after three rings. If the primary router is operational, it answers the call immediately and changes the call state so that the secondary router does not try to answer it. If the primary router is unavailable and does not answer the call, the secondary router sees the new call coming in and answers after three rings. The secondary Cisco Unified CME router should be connected in some way on the LAN, either through the same switch or through another switch that may or may not be connected to the primary Cisco Unified CME router directly. As long as both routers and the phones are connected on the LAN with the appropriate configurations in place, the phones can register to whichever router is active. Cisco Unified Communications Manager Express System Administrator Guide 160 System-Level Parameters Redundant Cisco Unified CME Router for SCCP Phones Configure primary and secondary Cisco Unified CME routers identically, with the exception that the FXO voice port from the PSTN on the secondary router should be configured to answer after more rings than the primary router, as previously explained. The same command is used on both routersto specify the IPaddresses of the primary and secondary routers. For configuration information, see Configure Redundant Router for SCCP Phones, on page 184. Restriction • Due to lack of High Availability support, Stateful Swtichover or preservation of active calls is not supported in the redundancy feature offered by Unified CME. • The physical setup for redundant Cisco Unified CME routers only support Loop start signaling. The Ground start signaling is not supported. Redundant Cisco Unified CME Router for SIP Phones A secondary Cisco Unified CME router can be configured to provide call-controlservicesif the primary Cisco Unified CME router fails. The secondary Cisco Unified CME router provides uninterrupted services until the primary router becomes operational again. When a SIP phone registers to the primary router, it receives a configuration file from the primary router. Along with other information, the configuration file contains the IP addresses of the primary and secondary Cisco Unified CME routers. The phone uses these addresses to initiate a keepalive (KA) message to the secondary CME router. The phone sends a REGISTER message to the primary router for registration and a keepalive REGISTER message with Expires=0, to the secondary router during the keepalive interval (every 120 seconds by default). The keepalive interval can be configured (Range is 120 to 65535). If primary router fails, a SIP phone (on registration refresh) will not receive a successful response for its REGISTER message. On unsuccessful response from primary router, phone registers with the secondary router. When the phone is registered to the secondary router, phone sends keepalive REGISTER (Expires=0) messages to the primary router. After the primary Cisco Unified CME router returnsto normal operation, the phone sends a "token-registration" to the primary router seeking permission to move registration of the phone from the standby secondary router to the primary router. To obtain a token, theSIPphonessends a Out-of-Dialog REFER message to the primary router for registration. The primary router accepts the token by responding with a 202 Accepted response. When the SIP phones receive the token (202 Accepted response) from the primary router, the phones will immediately de-register from the secondary router by sending a REGISTER message with Expires=0 for each line and registers back to the primary router. The re-registration of phones with the primary router is called rehoming. No signaling or media preservation is done for any active calls on Unified CME. Hence during failover on primary CME, calls would remain in active state. But media would not be present for those calls. The SIP phones will not register to the secondary router until the active call is disconnected. The secondary Cisco Unified CME router is connected directly to the same SIP trunk as the primary Cisco Unified CME router. As long as both routers and the phones are connected on the LAN with the appropriate configurationsin place, the phones can register to whichever router is active. You should configure the primary and secondary Cisco Unified CME routers identically. The same command is used on both routers to specify the IP addresses of the primary and secondary routers. For configuration information, see Configure Redundant Router for SIP Phones, on page 186. Cisco Unified Communications Manager Express System Administrator Guide 161 System-Level Parameters Redundant Cisco Unified CME Router for SIP Phones Restriction • Due to lack of High Availability support, Stateful Swtichover or preservation of active calls is not supported in the redundancy feature offered by Unified CME. Timeouts The following system-level timeout parameters have default values that are generally adequate: • Busy Timeout—Length of time that can elapse after a transferred call reaches a busy signal before the call is disconnected. • Interdigit Timeout—Length of time that can elapse between the receipt of individual dialed digits before the dialing process times out and is terminated. If the timeout ends before the destination is identified, a tone sounds and the call ends. This value is important when using variable-length dial-peer destination patterns (dial plans). • Ringing Timeout—Length of time a phone can ring with no answer before returning a disconnect code to the caller. Thistimeout is used only for extensionsthat do not have no-answer call forwarding enabled. The ringing timeout prevents hung calls received over interfaces, such as FXO, that do not have forward-disconnect supervision. • Keepalive—Interval determines how often a message is sent between the router and Cisco Unified IP phones, over the session, to ensure that the keepalive timeout is not exceeded. If no other traffic is sent over the session during the interval, a keepalive message is sent. For configuration information, see Modify Defaults for Timeouts for SCCP Phones, on page 182. IPv6 Support for Cisco Unified CME SCCP Endpoints Internet Protocol version 6 (IPv6), which is the latest version of the Internet Protocol (IP) that uses packets to exchange data, voice, and video traffic over digital networks, increases the number of network address bits from 32 bitsin IPv4 to 128 bits. IPv6 support in Cisco Unified CME allowsthe network to behave transparently in a dual-stack (IPv4 and IPv6) environment and provides additional IP address space to SCCP phones and devices that are connected to the network. For information on configuring DHCP for IPv6, see Network Parameters, on page 121. Before Cisco Unified CME 8.0, SCCP supported IPv4 addresses (4 bytes) only. With Cisco Unified CME 8.0, the SCCP version is upgraded to store IPv6 address (16 bytes) also. The followingSCCPphones and devices are supported on IPv6: 7911, 7931, 7941G, 7941GE, 7961G, 7961GE, 7970G, 7971G, 7971G-GE, 7942, 7962, 7945, 7965, 7975, SCCP analogue gateway, Xcoder, and Hardware Conference devices. For more information on configuring SCCP IP phones for IPv6 source address, see Configure IPv6 Source Address for SCCP IP Phones, on page 169. You must disable Alternative Network Address Transport (ANAT) globally for SIP lines if you have a Cisco Unified CME with a dual-stack SIP trunk and enable ANAT at dial-peer level for the SIP trunk. Note Cisco Unified Communications Manager Express System Administrator Guide 162 System-Level Parameters Timeouts Support for IPv4-IPv6 (Dual-Stack) Cisco Unified CME 8.0 can interact with and support any SCCP devices that support IPv4 only or both IPv4 and IPv6 (dual-stack). In dual-stack mode, two IPaddresses are assigned to an interface, one is an IPv4 address and the other is an IPv6 address. Both IPv4 and IPv6 stacks are enabled on the voice gateways so that applications can interact with both versions of IP addresses. To support devices that use IPv4 only, IPv6 only, or both IPv4 and IPv6 (dual-stack) addresses, you must ensure that the Cisco Unified CME has both IPv4 address and IPv6 address enabled. For more information, see Configure IP Phones in IPv4, IPv6, or Dual Stack Mode, on page 167. Media Flow Through and Flow Around Media transport modes, such as flow around and flow through, are used to transport media packets across endpoints. Media flow around enables media packets to pass directly between the endpoints, without the intervention of the IP-IP Gateway (IPIPGW). Media flow through enables media packets to pass through the endpoints, without the intervention of the IPIPGW. Table 12: Call Flow Scenarios Between IPv4 only, IPv6 only, and Dual-Stack, on page 163 lists media flow-through and flow-around scenarios between endpoints that support IPv4, IPv6, and dual- stack. When both endpoints are IPv4 only or IPv6 only, the call flows around. When one endpoint is IPv4 and the other is IPv6, calls flow through. When one endpoint is dual-stack and the other IPv4 or IPv6 the calls flow around. When both endpoints are dual-stack calls flow around or follows the preference (preferred IPaddress version) selected by protocol mode in dual-stack. Table 12: Call Flow Scenarios Between IPv4 only, IPv6 only, and Dual-Stack IP Versions IPv4 Only IPv6 Only Dual-Stack Flow Around Flow Through Flow Around 1 IPv4 Only IPv6 Only Flow Through Flow Around Flow Around/IPv6 Dual-Stack Flow Around/IPv4 Flow Around/IPv6 Flow Around/Preference 1 When MTP is configured under ephones all the call flow-around scenarios change to flow-through. This is also applicable to cross-VRF endpoints. Media Flow Around Support for SIP-SIP Trunk Calls Cisco Unified CME 8.5 and later versions support the media flow around functionality for SIP to SIP trunk calls on Cisco Unified CME, allowing less consumption of resources on Cisco Unified CME. The media flow around feature eliminates the need to terminate RTP and re-originate on Cisco Unified CME. This reduces media switching latency and increases the call handling capacity for a Cisco Unified CME SIP trunk. Media flow around is supported in the following scenarios: • Single Number Reach (SNR) Push—If an SNR call on a SIP trunk is pushed over to a mobile user over another SIP trunk, the resulting connection is a SIP-SIP trunk call connection. If both SIP trunks are Cisco Unified Communications Manager Express System Administrator Guide 163 System-Level Parameters Support for IPv4-IPv6 (Dual-Stack) configured for media flow around, the media is allowed to flow around Cisco Unified CME for the resulting call. • Call Forward—If a SIP trunk call is forwarded over another SIP trunk and both the SIP trunks are configured for media flow around, media flows around Cisco Unified CME for the resulting SIP-SIP trunk call. Media flow around is supported for all types of call forwarding, such as call forward night-service, call forward all, call forward busy, and call forward no-answer. • Call Transfer—If aSIPtrunk call istransferred over anotherSIPtrunk and bothSIPtrunks are configured for media flow around, media flows around Cisco Unified CME for the resulting SIP-SIP trunk call. Media flow around is supported on both SIP-line-initiated call transfer and SCCP-line-initiated call transfers. It is supported for all types of call transfers, such as blind transfer, consult transfer, and full consult transfer. Media is forced to flow through on different types of call flows including the SIP to SIP trunk call with asymmetric flow mode configurations or symmetric flow through configuration. In asymmetric flow mode configurations, one SIP leg is configured in the media flow around mode and another SIP leg is configured in the media flow through mode. In such cases, media is forced to flow through Cisco Unified CME. Media is forced to flow through Cisco Unified CME for the following types of call flows: • Any calls involving a SIP endpoint, a SCCP endpoint, PSTN trunks (BRI/PRI/FXO), or FXO circuits. • SIP to SIP trunk call with either asymmetric flow mode configurations or symmetric flow through configurations. • SIP to SIP trunk call that requires transcoding services on Cisco Unified CME. • SIP to SIP trunk calls that require DTMF interworking with RFC2833 on one side, and SIP-Notify on the other side. • SNR pullback to SCCP— When an SNR call is pulled back from a mobile phone to the local SCCP SNR extension, the call is connected to the SCCP SNR extension. Media is required to flow through Cisco Unified CME because one of the calls is from a SCCP SNR extension, which is local to Cisco Unified CME. In Cisco Unified CME 8.5, the media flow around feature isturned on or turned off using the media command in voice service voip, dial-peer voip, and voice class media configuration modes. The configuration specified under voice class media configuration mode takes precedence over the configuration in dial-peer configuration mode. If the media configuration is not specified under voice class media or dial-peer configuration mode, then the global configuration specified under voice service voip takes precedence. For more information, see Enable Media Flow Mode on SIP Trunks, on page 205. Overlap Dialing Support for SIP and SCCP IP Phones Cisco Unified CME 8.5 and later versions support overlap dialing on SCCP and SIP IP phones such as 7942, 7945, 7962, 7965, 7970, 7971, and 7975. In earlier versions of Cisco Unified CME, overlap dialing was not supported over PRI/BRI trunks for calls originating from SCCP or SIP IP phones. Dialing was always converted into enbloc dialing based on the dial-peer configuration and the dial-peer mapping application. Once dialpeer matching took place, no further dialing was possible and no overlap digit were sent over ISDN trunk, even though overlap dialing wassupported over ISDN trunks. Cisco Unified Communications Manager Express System Administrator Guide 164 System-Level Parameters Overlap Dialing Support for SIP and SCCP IP Phones SCCP IP phones currently support overlap dialing, but digits are converted to enbloc digits when it reaches Cisco Unified CME. Overlap dialing is supported on SIP IP phones using the KeyPad Markup Language (KPML) method. With overlap dialing support, the dialed digits from the SIP or SCCP IP phones are passed across to the PRI/BRI trunks as overlap digits and not as enbloc digits, enabling overlap dialing on the PRI/BRI trunks as well. For information on how to configure SCCP and SIP IP phones for overlap dialing, see Configure Overlap Dialing on SCCP IP Phones, on page 190 and Configure Overlap Dialing on SIP Phones, on page 207. Unsolicited Notify for Shared Line and Presence Events for Cisco Unified SIP IP Phones Before Cisco Unified CME 9.0, a Cisco UnifiedSIPIPphone receives NOTIFY messages that convey shared line and presence events from the Cisco Unified CME only by subscribing to such events. To subscribe, the IP phone sends a SUBSCRIBE message to the Cisco Unified CME with the type of event for which it wants to be notified. The Cisco Unified CME sends a NOTIFY message to alert the subscribed IPphone orsubscriber of event updates. In Unsolicited Notify, the Cisco Unified CME acquires the required information from the router configuration to create the implicit subscription and adds subscribers without a subscription request from Cisco UnifiedSIP IP phones. The Cisco Unified CME sends out NOTIFY messages to the IP phones for shared line or presence updates. In Cisco Unified CME 9.0 and later versions, the Unsolicited Notify mechanism reduces network traffic particularly during Cisco Unified SIP IP phone registration using the bulk registration method. Through this registration method, the preferred notification method of the IPphone is embedded in the registration message. Configuring TCP as the transport layer protocol under voice register pool configuration mode enables bulk registration with negotiation for the Unsolicited Notify mechanism. Note The Unsolicited Notify mechanism supports backward compatibility with all existing Cisco Unified SIP IP phone features. This mechanism is also the defacto notify mechanism in newer IP phone and Cisco Unified CME features, such as SNR Mobility. From the end-user perspective, the following are the only two discernible differences between the SUBSCRIBE/NOTIFY and the Unsolicited Notify mechanisms: • show presence subscription and show shared-line commands display different subscription IDs for each mechanism. • With the SUBSCRIBE/NOTIFY mechanism, a Cisco Unified SIP IP phone needs to refresh the Cisco Unified CME subscription. In Unsolicited Notify mode, the subscription is permanent and does not need a refresh as long as the IP phone remains registered. Cisco Unified Communications Manager Express System Administrator Guide 165 System-Level Parameters Unsolicited Notify for Shared Line and Presence Events for Cisco Unified SIP IP Phones Restriction • Because Unsolicited Notify is negotiated during bulk registration, the mechanism is not available on Cisco Unified SIP IP phones that do not have bulk registration turned on or have firmware that do not support bulk registration. • Cisco Unified CME cannot disable the Unsolicited Notify mechanism. The system complies with and cannot override the requests of Cisco Unified SIP IP phones. • In the absence of Cisco UnifiedSIPIPphone subscription information to distinguish if a notification event is for line or device monitoring, local device monitoring is not supported in the Unsolicited Notify mode. Interface Support for Unified CME and Unified SRST Unified CME and Unified SRST routers have multiple interfaces that are used for signaling and data packet transfers. The two types of interfaces available on a Cisco router include the physical interface and the virtual interface. The types of physical interfaces available on a router depends on its interface processors or port adapters. Virtual interfaces are software-based interfaces that you create in the memory of the networking device using Cisco IOS commands. When you need to configure a virtual interface for connectivity, you can use the Loopback Interface for Unified CME and Unified SRST. The following interfaces are supported on Unified CME and Unified SRST: • Gigabit Ethernet Interface (IEEE 802.3z) (interface gigabitethernet) • Loopback Interface (interface loopback) • Fast Ethernet Interface (interface fastethernet) The remaining Cisco IOS interfaces are not validated on Unified CME and Unified SRST. Hence, Unified CME and Unified SRST do not claim support for these interfaces. For more information on the Cisco IOS Interface commands, see Cisco IOS Interface and Hardware Component Command Reference. For physical interfaces such as interface gigabitethernet and interface fastethernet, subinterfaces are supported. In a subinterface, virtual interfaces are created by dividing a physical interface into multiple logical interfaces. For Cisco routers, a subinterface uses the parent physical interface for sending and receiving data. Virtual interfaces (For example, interface loopback) do not support subinterfaces. A subinterface for interface gigabitethernet is configured as follows: Router(config)#interface gigabitEthernet 0/0.1 Router(config-subif)#exit Router(config)#exit Cisco Unified Communications Manager Express System Administrator Guide 166 System-Level Parameters Interface Support for Unified CME and Unified SRST Configure System-Level Parameters Configure IP Phones in IPv4, IPv6, or Dual Stack Mode Restriction • Legacy IP phones are not supported. • Multicast MOH and multicast paging features are not supported on IPv6 only phones. If you want to receive paging calls on IPv6 enabled phones, use the default multicast paging. • Primary and secondary CME need to be provisioned with the same network type. • MWI relay server must be in IPv4 network. • Presence server must be IPv4 only. • Video endpoints, such as CUVA and 7985, are not supported in IPv6 • TAPI client is not supported in IPv6. • All HTTP based IPv6 services are not supported. • IOS TFTP server is not supported in IPv6. • If protocol mode is IPv4, you can only configure IPv4 as the source IP-address, if protocol mode is IPv6 you can only configure IPv6 as the source IP address and if the protocol mode is dual-stack, you can configure both IPv4 and IPv6 source addresses. Before You Begin • Cisco Unified CME 8.0 or later version. • IPv6 CEF must be enabled for dual-stack configuration. SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. protocol mode {ipv4 | ipv6 | dual-stack [preference {ipv4 | ipv6}]} 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Cisco Unified Communications Manager Express System Administrator Guide 167 System-Level Parameters Configure System-Level Parameters Command or Action Purpose Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 3 AllowsSCCPphonesto interact with phones on IPv6 voice gateways. You can configure phones for IPv4 addresses, IPv6 address es, or for a dual-stack mode protocol mode {ipv4 | ipv6 | dual-stack [preference {ipv4 | ipv6}]} Example: Router(config-telephony)# protocol mode dual-stack preference ipv6 Step 4 • ipv4—Allows you to set the protocol mode as an IPv4 address. • ipv6—Allows you to set the protocol mode as an IPv6 address. • dual-stack—Allows you to set the protocol mode for both IPv4 and IPv6 addresses. • preference—Allows you to choose a preferred IP address family if protocol mode is dual-stack. end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 5 Example telephony-service protocol mode dual-stack preference ipv6 .... ip source-address 10.10.2.1 port 2000 ip source-address 2000:A0A:201:0:F:35FF:FF2C:697D Cisco Unified Communications Manager Express System Administrator Guide 168 System-Level Parameters Configure IP Phones in IPv4, IPv6, or Dual Stack Mode Configure IPv6 Source Address for SCCP IP Phones Restriction • IPv6 option only appears if protocol mode is in dual-stack or IPv6. • Do not change the default port number (2000) in the ip source-address configuration command. If you change the port number, IPv6 CEF packet switching engine may not be able to handle the IPv6 SCCP phones and various packet handling problems may occur. Before You Begin Cisco Unified CME 8.0 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. ip source-address {ipv4 address | ipv6 address} port port [secondary {ipv4 address | ipv6 address } [rehome seconds]] [strict-match] 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 telephony-service Enters the telephony-service configuration mode. Example: Router(config)# telephony-service Step 3 Allows to configure an IPv4 or IPv6 address as an IP source-address for phones to communicate with a Cisco Unified CME router. ipsource-address {ipv4 address | ipv6 address} port port [secondary {ipv4 Step 4 address | ipv6 address } [rehome seconds]] [strict-match] • ipv4 address—Allows phones to communicate with phones or voice gateways in an IPv4 network. ipv4 address can only be configured with an IPv4 address or a dual-stack mode. Example: Router(config-telephony)# ip source-address 10.10.10.33 port Cisco Unified Communications Manager Express System Administrator Guide 169 System-Level Parameters Configure IPv6 Source Address for SCCP IP Phones Command or Action Purpose • ipv6 address—Allows phones to communicate with phones or voice gateways in an IPv6 network. ipv6 address can only be configured with an IPv6 address or a dual-stack mode. 2000 ip source-address 2001:10:10:10:: • (Optional)port port—TCP/IPport number to use forSCCP. Range is from 2000 to 9999. Default is 2000. For dual-stack, port is only configured with an IPv4 address. • (Optional) secondary—Cisco Unified CME router with which phones can register if the primary Cisco Unified CME router fails. • (Optional) rehome seconds—Used only by Cisco Unified IP phones that have registered with a Cisco Unified Survivable Remote Site Telephony (SRST) router. This keyword defines a delay that is used by phonesto verify the stability of their primarySCCPcontroller (Cisco Unified Communication Manager or Cisco Unified CME) before the phones re-register with it. This parameter is ignored by phones unless they are registered to a secondary Cisco Unified SRST router. The range is from 0 to 65535 seconds. The default is 120 seconds. The use of this parameter is a phone behavior and is subject to change, based on the phone type and phone firmware version. • (Optional) strict-match— Requires strict IP address checking for registration. end Returns to privileged EXEC mode. Example: outer(config-telephony)# end Step 5 Verify IPv6 and Dual-Stack Configuration Step 1 The following example shows a list of success messages that are printed during Cisco IOS boot up. These messages confirm whether IPv6 has been enabled on interfaces (for example, EDSP0.1 to EDSP0.5) specific to exchanging RTP packets with SCCP endpoints. Example: Router# 00:00:33: %EDSP-6-IPV6_ENABLED: IPv6 on interface EDSP0 added. 00:00:34: %EDSP-6-IPV6_ENABLED: IPv6 on interface EDSP0.1 added. 00:00:34: %EDSP-6-IPV6_ENABLED: IPv6 on interface EDSP0.2 added. 00:00:34: %EDSP-6-IPV6_ENABLED: IPv6 on interface EDSP0.3 added. 00:00:34: %EDSP-6-IPV6_ENABLED: IPv6 on interface EDSP0.4 added. 00:00:34: %EDSP-6-IPV6_ENABLED: IPv6 on interface EDSP0.5 added. 00:00:34: %LINEPROTO-5-UPDOWN: Line protocol on Interface FastEthernet0/1, changed state to down 00:00:34: %LINK-3-UPDOWN: Interface ephone_dsp DN 1.1, changed state to up Cisco Unified Communications Manager Express System Administrator Guide 170 System-Level Parameters Verify IPv6 and Dual-Stack Configuration 00:00:34: %LINK-3-UPDOWN: Interface ephone_dsp DN 1.2, changed state to up . Step 2 Use the show ephone socket command to verify if IPv4 only, IPv6 only, or dual-stack (IPv4/IPv6) is configured in Cisco Unified CME. In the following example, SCCP TCP listening socket (skinny_tcp_listen_socket fd) values 0 and 1 verify dual-stack configuration. When IPv6 only is configured, the show ephone socket command displays SCCP TCPlistening socket values as(-1) and (0). The listening socket is closed if the value is(-1). When IPv4 only is configured, the show ephone socket command displays SCCP TCP listening socket values as (0) and (-1). Example: Router# show ephone socket skinny_tcp_listen_socket fd = 0 skinny_tcp_listen_socket (ipv6) fd = 1 skinny_secure_tcp_listen_socket fd = -1 skinny_secure_tcp_listen_socket (ipv6) fd = -1 Phone 7, skinny_sockets[15] fd = 16 [ipv6] read_buffer 0x483C0BC4, read_offset 0, read_header N, read_length 0 resend_queue 0x47EC69EC, resend_offset 0, resend_flag N, resend_Q_depth 0 MTP 1, skinny_sockets[16] fd = 17 read_buffer 0x483C1400, read_offset 0, read_header N, read_length 0 resend_queue 0x47EC6978, resend_offset 0, resend_flag N, resend_Q_depth 0 Phone 8, skinny_sockets[17] fd = 18 [ipv6] read_buffer 0x483C1C3C, read_offset 0, read_header N, read_length 0 resend_queue 0x47EC6904, resend_offset 0, resend_flag N, resend_Q_depth 0 Step 3 Use the show ephone summary command to verify the IPv6 or IPv4 addresses configured for ephones. The following example displays IPv6 and IPv4 addresses for different ephones: Example: Router# show ephone summary ephone-2[1] Mac:0016.46E0.796A TCP socket:[7] activeLine:0 whisperLine:0 REGISTERED mediaActive:0 whisper_mediaActive:0 startMedia:0 offhook:0 ringing:0 reset:0 reset_sent:0 debug:0 privacy:1 primary_dn: 1* IPv6:2000:A0A:201:0:216:46FF:FEE0:796A* IP:10.10.10.12 7970 keepalive 599 music 0 1:1 sp1:2004 ephone-7[6] Mac:0013.19D1.F8A2 TCP socket:[6] activeLine:0 whisperLine:0 REGISTERED mediaActive:0 whisper_mediaActive:0 startMedia:0 offhook:0 ringing:0 reset:0 reset_sent:0 debug:0 privacy:0 primary_dn: 13* Cisco Unified Communications Manager Express System Administrator Guide 171 System-Level Parameters Verify IPv6 and Dual-Stack Configuration IP:10.10.10.14 * Telecaster 7940 keepalive 2817 music 0 1:13 2:28 Configure Bulk Registration To configure bulk registration for registering a block of phone numbers with an external registrar so that calls can be routed to Cisco Unified CME from a SIP network, perform the following steps. Numbers that match the number pattern defined by using the bulk command can register with the external registrar. The block of numbers that is registered can include any phone that is attached to Cisco Unified CME or any analog phone that is directly attached to an FXS port on a Cisco Unified CME router. Use the no reg command to specify that an individual directory number should not register with the external registrar. For configuration information, see Disable SIP Proxy Registration for a Directory Number, on page 276. Note Before You Begin Cisco Unified CME 3.4 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register global 4. mode cme 5. bulk number 6. exit 7. sip-ua 8. registrar {dns: address | ipv4: destination-address} expires seconds [tcp] [secondary] no registrar [secondary] 9. end DETAILED STEPS Command or Action Purpose enable Enables privileged EXEC mode. Example: Router> enable Step 1 • Enter your password if prompted. Cisco Unified Communications Manager Express System Administrator Guide 172 System-Level Parameters Configure Bulk Registration Command or Action Purpose configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register global configuration mode to set parameters for all supported SIP phones in Cisco Unified CME. voice register global Example: Router(config)# voice register global Step 3 Enables mode for provisioning SIP phones in Cisco Unified CME. mode cme Example: Router(config-register-global)# mode cme Step 4 Sets bulk registration for E.164 numbers that will register with a SIP proxy server. bulk number Example: Router(config-register-global)# bulk 408526.... Step 5 • number—Unique sequence of up to 32 characters, including wild cards and patterns that represents E.164 numbers that will register with a SIP proxy server. Exits configuration mode to the next highest mode in the configuration mode hierarchy. exit Example: Router(config-register-pool)# exit Step 6 EntersSIPuser agent (UA) configuration mode for configuring the user agent. sip-ua Example: Router(config)# sip-ua Step 7 Enables SIP gateways to register E.164 numbers with a SIP proxy server. registrar {dns: address| ipv4: destination-address} expires seconds [tcp] [secondary] no registrar [secondary] Step 8 Example: Router(config-sip-ua)# registrar server ipv4:1.5.49.240 Exits SIP UA configuration mode and enters privileged EXEC mode. end Example: Router(config-sip-ua)# end Step 9 Examples The following example shows that all phone numbers that match the pattern “408555...” can register with a SIP proxy server (IP address 1.5.49.240): voice register global mode cme Cisco Unified Communications Manager Express System Administrator Guide 173 System-Level Parameters Configure Bulk Registration bulk 408555…. sip-ua registrar ipv4:1.5.49.240 Configure Bulk Registration for SIP IP Phones Before You Begin • Cisco Unified CME 8.6 or a later version. • Phone firmware 8.3 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register pool tag 4. session-transport {tcp | udp} 5. number tag dn tag 6. end DETAILED STEPS Command or Action Purpose enable Enables privileged EXEC mode. Example: Router> enable Step 1 • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register dn configuration mode to define a directory number for a SIP phone, intercom line, voice port, or an MWI. voice register pool tag Example: Router(config)#voice register pool 20 Step 3 Specifies the transport layer protocol that a SIP phone uses to connect to Cisco Unified CME. session-transport {tcp | udp} Example: Router(config-register-pool)#session-transport tcp Step 4 • tcp—TCP is used for bulk registration. • udp—UDP is used for line registration. Associates a directory number with the SIP phone being configured. number tag dn tag Example: Router(config-register-pool)#number 1 dn 2 Step 5 • dndn-tag—Identifiesthe directory number for thisSIP phone as defined by the voice register dn command. Cisco Unified Communications Manager Express System Administrator Guide 174 System-Level Parameters Configure Bulk Registration for SIP IP Phones Command or Action Purpose end Returns to privileged EXEC mode. Example: Router(config-register-pool)# end Step 6 Verify Phone Registration Type and Status You can verify phone registration type and status using the show voice registerpool command. The following example shows that the Cisco Unified IP phone 7970 used the bulk registration method and completed the registration process: Router#sh voice register pool 20 Pool Tag 20 Config: Mac address is 001B.2A89.3698 Type is 7970 Number list 1 : DN 20 Number list 2 : DN 2 Number list 3 : DN 24 Number list 4 : DN 4 Number list 5 : DN 6 Number list 6 : DN 7 Number list 7 : DN 17 Number list 8 : DN 23 Proxy Ip address is 0.0.0.0 Current Phone load version is Cisco-CP7970G/9.0.1 DTMF Relay is enabled, rtp-nte, sip-notify Call Waiting is enabled DnD is disabled Video is disabled Camera is disabled Busy trigger per button value is 0 speed-dial blf 1 6779 label 6779_device speed-dial blf 2 3555 label 3555_remote speed-dial blf 3 6130 label 6130 speed-dial blf 4 3222 label 3222_remote_dev fastdial 1 1234 keep-conference is enabled username johndoe password cisco template is 1 kpml signal is enabled Lpcor Type is none Transport type is tcp service-control mechanism is supported Registration method: bulk - completed registration Call ID is 001b2a89-3698017e-68646967-126b902e@28.18.88.33 Privacy is configured: init status: ON, current status: ON Privacy button is enabled active primary line is: 6010 Set Up Cisco Unified CME for SCCP Phones To identify filenames and the location of phone firmware for phone types to be connected, specify the port for phone registration, and specify the number of phones and directory numbers to be supported, perform the following steps. Cisco Unified Communications Manager Express System Administrator Guide 175 System-Level Parameters Set Up Cisco Unified CME for SCCP Phones DSCP requires Cisco Unified CME 7.1 or a later version. If DSCP is configured for the gateway interface using the service-policy command or for the dial peer using the ip qos dscp command, the value set with those commands takes precedence over the DSCP value configured in this procedure. Restriction SUMMARY STEPS 1. enable 2. configure terminal 3. tftp-server device:filename 4. telephony-service 5. load phone-type firmware-file 6. max-ephones max-phones 7. max-dn max-directory-numbers [preference preference-order] [no-reg primary | both] 8. ip source-address ip-address [port port] [any-match | strict-match] 9. ip qos dscp {{number | af | cs | default | ef} {media | service | signaling | video}} 10. end DETAILED STEPS Command or Action Purpose enable Enables privileged EXEC mode. Example: Router> enable Step 1 • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 (Optional) Creates TFTP bindings to permit IP phones served by the Cisco Unified CME router to access the specified file. tftp-server device:filename Example: Router(config)# tftp-server flash:P00307020300.bin Step 3 • A separate tftp-server command is required for each phone type. • Required for Cisco Unified CME 7.0/4.3 and earlier versions. • Cisco Unified CME 7.0(1) and later versions: Required only if the location for cnf files is not flash or slot 0, such as system memory or a TFTP server url. Use the complete filename, including the file suffix, for phone firmware versionslater than version 8.2(2) for all phone types. telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 4 Cisco Unified Communications Manager Express System Administrator Guide 176 System-Level Parameters Set Up Cisco Unified CME for SCCP Phones Command or Action Purpose Identifies a Cisco Unified IPphone firmware file to be used by phones of the specified type when they register. load phone-type firmware-file Example: Router(config-telephony)# load 7960-7940 P00307020300 Step 5 • A separate load command is required for each IP phone type. • firmware-file—Filename is case-sensitive. ◦Cisco Unified CME 7.0/4.3 and earlier versions: Do not use the .sbin or .loads file extension except for the Cisco ATA and Cisco Unified IP Phone 7905 and 7912. ◦Cisco Unified CME 7.0(1) and later versions: Use the complete filename, including the file suffix, for phone firmware versions later than version 8.2(2) for all phone types. If you are loading a firmware file larger than 384 KB, you must first load a file for that phone type that is smaller than 384 KB and then load the larger file. Note max-ephones max-phones Setsthe maximum number of phonesthat can register to Cisco Unified CME. Example: Router(config-telephony)# max-ephones 24 Step 6 • Maximum number is platform and version-specific. Type ? for range. • In Cisco Unified CME 7.0/4.3 and later versions, the maximum number of phones that can register is different from the maximum number of phones that can be configured. The maximum number of phones that can be configured is 1000. • In versions earlier than Cisco Unified CME 7.0/4.3, this command restricted the number of phones that could be configured on the router. max-dn max-directory-numbers Limits number of directory numbers to be supported by this router. [preference preference-order] [no-reg primary | both] Step 7 • Maximum number is platform and version-specific. Type ? for value. Example: Router(config-telephony)# max-dn 200 no-reg primary Identifies the IP address and port number that the Cisco Unified CME router uses for IP phone registration. ip source-address ip-address [port port] [any-match | strict-match] Example: Router(config-telephony)# ip source-address 10.16.32.144 Step 8 • port port—(Optional) TCP/IP port number to use for SCCP. Range is 2000 to 9999. Default is 2000. • any-match—(Optional) Disables strict IP address checking for registration. This is the default. • strict-match—(Optional) Instructs the router to reject IP phone registration attempts if the IP server address used by the phone does not exactly match the source address. Cisco Unified Communications Manager Express System Administrator Guide 177 System-Level Parameters Set Up Cisco Unified CME for SCCP Phones Command or Action Purpose ip qos dscp {{number | af | cs | default | Sets the DSCP priority levels for different types of traffic. ef} {media | service | signaling | video}} Step 9 Example: Router(config-telephony)# ip qos dscp af43 video end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 10 Examples The following example shows different DSCP settings for media, signaling, video, and services enabled with the ip qos dscp command: telephony-service load 7960-7940 P00308000500 max-ephones 100 max-dn 240 ip source-address 10.10.10.1 port 2000 ip qos dscp af11 media ip qos dscp cs2 signal ip qos dscp af43 video ip qos dscp 25 service cnf-file location flash: . . Set Date and Time Parameters for SCCP Phones To specify the format of the date and time that appears on all SCCP phones in Cisco Unified CME, perform the following steps. For certain phones, such as the Cisco Unified IP Phones 7906, 7911, 7931, 7941, 7942, 7945, 7961, 7962, 7965, 7970, 7971, and 7975, you must configure the time-zone command to ensure that the correct time stamp appears on the phone display. This command is not required for Cisco Unified IP Phone 7902G, 7905G, 7912G, 7920, 7921, 7935, 7936, 7940, 7960, or 7985G. Note Cisco Unified Communications Manager Express System Administrator Guide 178 System-Level Parameters Set Date and Time Parameters for SCCP Phones SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. date-format {dd-mm-yy | mm-dd-yy |yy-dd-mm | yy-mm-dd} 5. time-format {12 | 24} 6. time-zone number 7. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 3 date-format {dd-mm-yy | mm-dd-yy |yy-dd-mm | (Optional) Sets the date format for phone display. yy-mm-dd} Step 4 • Default: mm-dd-yy. Example: Router(config-telephony)# date-format yy-mm-dd (Optional) Selects a 12-hour or 24-hour clock for the time display format on phone display. time-format {12 | 24} Example: Router(config-telephony)# time-format 24 Step 5 • Default: 12. Step 6 time-zone number Sets time zone for SCCP phones. Example: Router(config-telephony)# time-zone 2 • Not required for Cisco Unified IPPhone 7902G, 7905G, 7912G, 7920, 7921, 7935, 7936, 7940, 7960, or 7985G. • Default: 5, Pacific Standard/Daylight Time (-480). end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 7 Cisco Unified Communications Manager Express System Administrator Guide 179 System-Level Parameters Set Date and Time Parameters for SCCP Phones Block Automatic Registration for SCCP Phones Before You Begin Cisco Unified CME 4.0 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. no auto-reg-ephone 5. end DETAILED STEPS Command or Action Purpose enable Enables privileged EXEC mode. Example: Router> enable Step 1 • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 3 Disables automatic registration of Cisco Unified IP phones that are running SCCP but are not explicitly configured in Cisco Unified CME. no auto-reg-ephone Example: Router(config-telephony)# no auto-reg-ephone Step 4 • Default: Enabled. end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 5 Cisco Unified Communications Manager Express System Administrator Guide 180 System-Level Parameters Block Automatic Registration for SCCP Phones Define Per-Phone Configuration Files and Alternate Location for SCCP Phones Restriction • TFTPdoes notsupport file deletion. When configuration files are updated, they overwrite any existing configuration files with the same name. If you change the configuration file location, files are not deleted from the TFTP server. • Generating configuration files on flash memory orslot 0 memory can take up to a minute, depending on the number of files being generated. • For smaller routers such as the Cisco 2600 series routers, you must manually enter the squeeze command to erase files after changing the configuration file location or entering any commands that trigger the deletion of configuration files. Unless you use the squeeze command, the space used by the moved or deleted configuration files is not usable by other files. • If VRFSupport on Cisco Unified CME is configured and the cnf-file locationcommand is configured for system:, the per phone or per phone type file for an ephone in a VRF group is created in system:/its/vrf/. The vrf directory is automatically created and appended to the TFTP path. No action is required on your part. Locale files are still created in system:/its/. • If VRFSupport on Cisco Unified CME is configured and the cnf-file locationcommand is configured as flash: or slot0:, the per phone or per phone type file for an ephone in a VRF group is named flash:/its/vrf_ or slot0:/its/vrf_filename>. The vrf directory is automatically created and appended to the TFTP path. No action is required on your part. The location of the locale files is not changed. To define a location other than system:/its for storing configuration files for per-phone and per-phone type configuration files, perform the following steps. Before You Begin • Cisco Unified CME 4.0 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. cnf-file location {flash: | slot0: | tftp tftp-url} 5. cnf-file {perphonetype | perphone} 6. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Cisco Unified Communications Manager Express System Administrator Guide 181 System-Level Parameters Define Per-Phone Configuration Files and Alternate Location for SCCP Phones Command or Action Purpose Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 3 Specifies a location other than system:/its for storing phone configuration files. cnf-file location {flash: | slot0: | tftp tftp-url} Example: Router(config-telephony)# cnf-file location flash: Step 4 • Required for per-phone or per-phone type configuration files. Specifies whether to use a separate file for each type of phone or for each individual phone. cnf-file {perphonetype | perphone} Example: Router(config-telephony)# cnf-file perphone Step 5 • Required if you configured the cnf-file location command. end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 6 The following example selects flash memory as the configuration file storage location and per-phone as the type of configuration files that the system generates: telephony-service cnf-file location flash: cnf-file perphone What to Do Next If you changed the configuration file storage location, use the option 150 ip command to update the address. See Change the TFTP Address on a DHCP Server, on page 144. Modify Defaults for Timeouts for SCCP Phones To configure values for system-level intervals for which default values are typically adequate, perform the following steps. Cisco Unified Communications Manager Express System Administrator Guide 182 System-Level Parameters Modify Defaults for Timeouts for SCCP Phones SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. timeouts busy seconds 5. timeouts interdigit seconds 6. timeouts ringing seconds 7. keepalive seconds 8. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 3 (Optional)Sets the length of time after which calls that are transferred to busy destinations are disconnected. timeouts busy seconds Example: Router(config-telephony)# timeouts busy 20 Step 4 • seconds—Number of seconds. Range is 0 to 30. Default is 10. (Optional) Configures the interdigit timeout value for all Cisco Unified IP phones attached to the router. timeouts interdigit seconds Example: Router(config-telephony)# timeouts interdigit 30 Step 5 • seconds—Number ofseconds before the interdigit timer expires. Range is 2 to 120. Default is 10. (Optional) Sets the duration, in seconds, for which the Cisco Unified CME system allows ringing to continue if a call is not answered. Range is 5 to 60000. Default is 180. timeouts ringing seconds Example: Router(config-telephony)# timeouts ringing 30 Step 6 (Optional) Sets the time interval, in seconds, between keepalive messages that are sent to the router by Cisco Unified IP phones. keepalive seconds Example: Router(config-telephony)# keepalive 45 Step 7 Cisco Unified Communications Manager Express System Administrator Guide 183 System-Level Parameters Modify Defaults for Timeouts for SCCP Phones Command or Action Purpose • The default is usually adequate. If the interval is set too large, it is possible for notification to be delayed when a system goes down. • Range: 10 to 65535. Default: 0. end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 8 Configure Redundant Router for SCCP Phones Before You Begin • Cisco Unified CME 4.0 or a later version. • The secondary router‘s running configuration must be identical to that of the primary router. • The physical configuration of the secondary router must be as described in Redundant Cisco Unified CME Router for SCCP Phones, on page 160. • Phones that use this feature must be configured with the type command, which guarantees that the appropriate phone configuration file will be present. SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. ip source-address ip-address [port port] [secondary ip-address [rehome seconds]] [any-match | strict-match] 5. exit 6. voice-port slot-number / port 7. signal ground-start 8. incoming alerting ring-only 9. ring number number 10. end Cisco Unified Communications Manager Express System Administrator Guide 184 System-Level Parameters Configure Redundant Router for SCCP Phones DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 3 Identifiesthe IPaddress and port number that the primary Unified CME router uses for IP phone registration. ip source-address ip-address [port port] [secondary ip-address [rehome seconds]] [any-match | strict-match] Step 4 • ip-address—Address of the primary Unified CME router. Example: Router(config-telephony)# ip source-address 10.0.0.1 port 2000 secondary 10.2.2.25 • port port—(Optional) TCP/IP port number to use for SCCP. Range is 2000 to 9999. Default is 2000. • secondary ip-address—Indicates a backup Unified CME router. • rehome seconds—Not used by Unified CME. Used only by phones registered to Cisco Unified SRST. • any-match—(Optional) Disables strict IP address checking for registration. This is the default. • strict-match—(Optional) Router rejects IP phone registration attempts if the IP server address used by the phone does not exactly match the source address. exit Exits telephony-service configuration mode. Example: Router(config-telephony)# exit Step 5 Enters voice-port configuration mode for the FXO voice port for DID calls from the PSTN. voice-port slot-number / port Example: Router(config)# voice-port 2/0 Step 6 signal ground-start Specifies ground-start signaling for a voice port. Example: Router(config-voiceport)# signal ground-start Step 7 Cisco Unified Communications Manager Express System Administrator Guide 185 System-Level Parameters Configure Redundant Router for SCCP Phones Command or Action Purpose Instructs the FXO ground-start voice port to detect incoming calls by detecting incoming ring signals. incoming alerting ring-only Example: Router(config-voiceport)# incoming alerting ring-only Step 8 (Required only for the secondary router) Sets the maximum number of rings to be detected before answering an incoming call over an FXO voice port. ring number number Example: Router(config-voiceport)# ring number 3 Step 9 • number—Number of rings detected before answering the call. Range is 1 to 10. Default is 1. For an incoming FXO voice port on a secondary Cisco Unified CME router, set this value higher than is set on the primary router. We recommend setting this value to 3 on the secondary router. Note end Returns to privileged EXEC mode. Example: Router(config-voiceport)# end Step 10 Configure Redundant Router for SIP Phones Before You Begin • Cisco Unified CME 11.6 or a later version. • Auto-register configuration is recommended only on the primary router. • XML interface for secondary backup router is configured. See Configure the XML Interface for the Secondary Backup Router, on page 189. It is recommended to configure the XML interface for a seamless failover from primary to secondary Cisco Unified CME. Else, there is delay in the phones getting registered to secondary Cisco Unified CME due to mismatch in the configuration version timestamp. Note • Ensure that you configure version stamp synchronization on the primary router. See Configure Version Stamp Synchronization on the Primary Router, on page 188. It is recommended to configure version stamp synchronization for a seamless failover from primary to secondary Cisco Unified CME. Else, there is delay in the phones getting registered to secondary Cisco Unified CME. Note Cisco Unified Communications Manager Express System Administrator Guide 186 System-Level Parameters Configure Redundant Router for SIP Phones Restriction • Active calls are notsupported when switchover happensfrom primary router to the secondary router. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register global 4. source-address ip-address [port port] [secondary ip-address] 5. keepalive seconds 6. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 voice register global Enters voice register global configuration mode. Example: Router(config)# voice register global Step 3 Identifies the IP address and port number that the Cisco Unified CME router uses for IP phone registration. source-addressip-address[port port] [secondary ip-address] Step 4 Example: Router(config-register-global)# source-address 10.6.21.4 port 6000 secondary 10.6.50.6 • ip-address—Address of the primary Cisco Unified CME router. • port port—(Optional) TCP/IP port number to use for SIP. Range is 2000 to 9999. Default is 5060 for SIP. • secondary ip-address—Indicates a backup Cisco Unified CME router. Sets the length of the time interval between successive keepalive messages from the SIP phones to Cisco Unified CME router. Default is 120 seconds. keepalive seconds Example: Router(config-register-global)# keepalive 200 Step 5 Cisco Unified Communications Manager Express System Administrator Guide 187 System-Level Parameters Configure Redundant Router for SIP Phones Command or Action Purpose end Returns to privileged EXEC mode. Example: Router(config-register-global)# end Step 6 Configure Version Stamp Synchronization on the Primary Router To configure the primary router to enable automatic synchronization of 'version stamp' with secondary backup router, perform the following steps. All phone-related configurations are tagged with a 'version stamp' that indicates when the last configuration change was made. Tip Before You Begin • XML interface for secondary backup router is configured. See Configure the XML Interface for the Secondary Backup Router, on page 189. SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. standby username username password password 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Cisco Unified Communications Manager Express System Administrator Guide 188 System-Level Parameters Configure Version Stamp Synchronization on the Primary Router Command or Action Purpose telephony-service Enters telephony service configuration mode. Example: Router(config)# telephony-service Step 3 Step 4 standby username username password password Defines an authorized user. Example: Router(config-telephony)# standby username user23 password 3Rs92uzQ • Same username and password that is defined in Configure the XML Interface for the Secondary Backup Router, on page 189. end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 5 Configure the XML Interface for the Secondary Backup Router To configure the secondary backup router to activate the XML interface required to receive "version stamp" configuration change information from the primary router, perform the following steps. Restriction • Automatic synchronization for new or replacement routers is not supported. Before You Begin • The XML interface, provided through the Cisco IOS XML Infrastructure (IXI), must be configured.See Configuring the XML API. SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. xml user user-name password password privilege-level 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Cisco Unified Communications Manager Express System Administrator Guide 189 System-Level Parameters Configure the XML Interface for the Secondary Backup Router Command or Action Purpose Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 telephony-service Enters telephony service configuration mode. Example: Router(config)# telephony-service Step 3 xml user user-name password password Defines an authorized user. privilege-level Step 4 • user-name—Username of the authorized user. Example: Router(config-telephony)# xml user user23 password 3Rs92uzQ 15 • password—Password to use for access. • privilege-level—Level of access to Cisco IOS commands to be granted to this user. Only the commands with the same or a lower level can be executed via XML. Range is 0 to 15. end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 5 Configure Overlap Dialing on SCCP IP Phones SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. overlap-signal 5. exit 6. ephone phone-tag 7. overlap-signal 8. exit 9. ephone-template template-tag 10. overlap-signal 11. end Cisco Unified Communications Manager Express System Administrator Guide 190 System-Level Parameters Configure Overlap Dialing on SCCP IP Phones DETAILED STEPS Command or Action Purpose enable Enables privileged EXEC mode. Example: Router> enable Step 1 • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 telephony-service Enters telephony-service configuration mode. Example: Router(config)telephony-service Step 3 Allows to configure overlap signaling support for SCCP IP phones. overlap-signal Example: Router(config-telephony)#overlap-signal Step 4 exit Exits telephony-service configuration mode. Example: Router(config-telephony)#exit Step 5 ephone phone-tag Enters ephone configuration mode. Example: Router(config)ephone 10 Step 6 overlap-signal Applies overlap signaling support for ephone. Example: Router(config-ephone)overlap-signal Step 7 exit Exits ephone configuration mode. Example: Router(config-ephone)exit Step 8 ephone-template template-tag Enters ephone-template configuration mode. Example: Router(config)ephone-template 10 Step 9 overlap-signal Applies overlap signaling support to ephone template. Example: Router(config-ephone-template)#overlap-signal Step 10 Cisco Unified Communications Manager Express System Administrator Guide 191 System-Level Parameters Configure Overlap Dialing on SCCP IP Phones Command or Action Purpose end Returns to privileged EXEC mode. Example: Router(config-ephone-template)# end Step 11 Set Up Cisco Unified CME for SIP Phones To identify filenames and location of phone firmware for phone types to be connected, to specify the port for phone registration, and to specify the number of phones and directory numbers to be supported, perform the following steps. If your Cisco Unified CME system supports SCCP and SIP phones, do not connect your SIP phones to your network until after you have verified the configuration profile for the SIP phone. Note Restriction • SIP endpoints are not supported on H.323 trunks. SIP endpoints are supported on SIP trunks only. • Certain Cisco Unified IP phones, such as the Cisco Unified IP Phones 7911G, 7941G, 7941GE, 7961G, 7961GE, 7970G, and 7971GE, are supported only in Cisco Unified CME 4.1 and later versions. • DSCP requires Cisco Unified CME 7.1 or a later version. If DSCP is configured for the gateway interface using the service-policy command or for the dial peer using the ip qos dscp command, the value set with those commandstakes precedence over the DSCPvalue configured in this procedure. Before You Begin Cisco CME 3.4 or a later version. Cisco Unified Communications Manager Express System Administrator Guide 192 System-Level Parameters Set Up Cisco Unified CME for SIP Phones SUMMARY STEPS 1. enable 2. configure terminal 3. voice register global 4. mode cme 5. source-address ip-address [port port] 6. load phone-type firmware-file 7. tftp-path {flash: | slot0: | tftp://url} 8. max-pool max-phones 9. max-dn max-directory-numbers 10. authenticate [all][realm string] 11. ip qos dscp {{number | af | cs | default | ef} {media | service | signaling | video}} 12. end DETAILED STEPS Command or Action Purpose enable Enables privileged EXEC mode. Example: Router> enable Step 1 • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register global configuration mode to set parameters for all supported SIP phones in Cisco Unified CME. voice register global Example: Router(config)# voice register global Step 3 mode cme Enables mode for provisioning SIP phones in Cisco Unified CME. Example: Router(config-register-global)# mode cme Step 4 Enables the Cisco Unified CME router to receive messages from SIP phones through the specified IP address and port. source-address ip-address [port port] Example: Router(config-register-global)# source-address 10.6.21.4 Step 5 • port port—(Optional) TCP/IP port number. Range: 2000 to 9999. Default: 2000. load phone-type firmware-file Associates a phone type with a phone firmware file. Example: Router(config-register-global)# load 7960-7940 P0S3-07-3-00 Step 6 • A separate load command is required for each phone type. Cisco Unified Communications Manager Express System Administrator Guide 193 System-Level Parameters Set Up Cisco Unified CME for SIP Phones Command or Action Purpose (Optional) Defines a location, other than system memory, from which the SIP phones will download configuration profile files. tftp-path {flash: | slot0: | tftp://url} Example: Router(config-register-global)# tftp-path http://mycompany.com/files Step 7 • Default: system memory (system:/cme/sipphone/). Sets maximum number of SIP phones to be supported by the Cisco Unified CME router. max-pool max-phones Example: Router(config-register-global)# max-pool 10 Step 8 • Version- and platform-dependent; type ? for range. • In Cisco CME 3.4 to Cisco Unified CME 7.0: Default is maximum number supported by platform. • In Cisco Unified CME 7.0(1) and later versions: Default is 0. (Optional) Sets maximum number of directory numbers for SIP phones to be supported by the Cisco Unified CME router. max-dn max-directory-numbers Example: Router(config-register-global)# max-dn 20 Step 9 • Required for Cisco Unified CME 7.0(1) and later versions. • In Cisco Unified CME 7.0(1) and later versions: Default is 0. Range is 1 to maximum number supported by platform. Type ? for range. • In Cisco CME 3.4 to Cisco Unified CME 7.0: Default is 150 or maximum allowed on platform. Type ? for value. (Optional) Enables authentication for registration requests in which the MAC address of the SIP phone cannot be identified by using other methods. authenticate [all][realm string] Example: Router(config-register-global)# authenticate all realm company.com Step 10 ip qos dscp {{number | af | cs | default | ef} Sets the DSCP priority levels for different types of traffic. {media | service | signaling | video}} Step 11 Example: Router(config-register-global)# ip qos dscp af43 video Exits voice register global configuration mode and enters privileged EXEC mode. end Example: Router(config-register-global)# end Step 12 Cisco Unified Communications Manager Express System Administrator Guide 194 System-Level Parameters Set Up Cisco Unified CME for SIP Phones Set Up Cisco Unified CME for SIP Phones To identify filenames and location of phone firmware for phone types to be connected, to specify the port for phone registration, and to specify the number of phones and directory numbers to be supported, perform the following steps. If your Cisco Unified CME system supports SCCP and SIP phones, do not connect your SIP phones to your network until after you have verified the configuration profile for the SIP phone. Note Restriction • SIP endpoints are not supported on H.323 trunks. SIP endpoints are supported on SIP trunks only. • Certain Cisco Unified IP phones, such as the Cisco Unified IP Phones 7911G, 7941G, 7941GE, 7961G, 7961GE, 7970G, and 7971GE, are supported only in Cisco Unified CME 4.1 and later versions. • DSCP requires Cisco Unified CME 7.1 or a later version. If DSCP is configured for the gateway interface using the service-policy command or for the dial peer using the ip qos dscp command, the value set with those commandstakes precedence over the DSCPvalue configured in this procedure. Before You Begin Cisco CME 3.4 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register global 4. mode cme 5. source-address ip-address [port port] 6. load phone-type firmware-file 7. tftp-path {flash: | slot0: | tftp://url} 8. max-pool max-phones 9. max-dn max-directory-numbers 10. authenticate [all][realm string] 11. ip qos dscp {{number | af | cs | default | ef} {media | service | signaling | video}} 12. end Cisco Unified Communications Manager Express System Administrator Guide 195 System-Level Parameters Set Up Cisco Unified CME for SIP Phones DETAILED STEPS Command or Action Purpose enable Enables privileged EXEC mode. Example: Router> enable Step 1 • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register global configuration mode to set parameters for all supported SIP phones in Cisco Unified CME. voice register global Example: Router(config)# voice register global Step 3 mode cme Enables mode for provisioning SIP phones in Cisco Unified CME. Example: Router(config-register-global)# mode cme Step 4 Enables the Cisco Unified CME router to receive messages from SIP phones through the specified IP address and port. source-address ip-address [port port] Example: Router(config-register-global)# source-address 10.6.21.4 Step 5 • port port—(Optional) TCP/IP port number. Range: 2000 to 9999. Default: 2000. load phone-type firmware-file Associates a phone type with a phone firmware file. Example: Router(config-register-global)# load 7960-7940 P0S3-07-3-00 Step 6 • A separate load command is required for each phone type. (Optional) Defines a location, other than system memory, from which the SIP phones will download configuration profile files. tftp-path {flash: | slot0: | tftp://url} Example: Router(config-register-global)# tftp-path http://mycompany.com/files Step 7 • Default: system memory (system:/cme/sipphone/). Sets maximum number of SIP phones to be supported by the Cisco Unified CME router. max-pool max-phones Example: Router(config-register-global)# max-pool 10 Step 8 • Version- and platform-dependent; type ? for range. • In Cisco CME 3.4 to Cisco Unified CME 7.0: Default is maximum number supported by platform. • In Cisco Unified CME 7.0(1) and later versions: Default is 0. Cisco Unified Communications Manager Express System Administrator Guide 196 System-Level Parameters Set Up Cisco Unified CME for SIP Phones Command or Action Purpose (Optional) Sets maximum number of directory numbers for SIP phones to be supported by the Cisco Unified CME router. max-dn max-directory-numbers Example: Router(config-register-global)# max-dn 20 Step 9 • Required for Cisco Unified CME 7.0(1) and later versions. • In Cisco Unified CME 7.0(1) and later versions: Default is 0. Range is 1 to maximum number supported by platform. Type ? for range. • In Cisco CME 3.4 to Cisco Unified CME 7.0: Default is 150 or maximum allowed on platform. Type ? for value. (Optional) Enables authentication for registration requests in which the MAC address of the SIP phone cannot be identified by using other methods. authenticate [all][realm string] Example: Router(config-register-global)# authenticate all realm company.com Step 10 ip qos dscp {{number | af | cs | default | ef} Sets the DSCP priority levels for different types of traffic. {media | service | signaling | video}} Step 11 Example: Router(config-register-global)# ip qos dscp af43 video Exits voice register global configuration mode and enters privileged EXEC mode. end Example: Router(config-register-global)# end Step 12 Set Date and Time Parameters for SIP Phones Before You Begin • Cisco CME 3.4 or a later version. • mode cme command is enabled. Cisco Unified Communications Manager Express System Administrator Guide 197 System-Level Parameters Set Date and Time Parameters for SIP Phones SUMMARY STEPS 1. enable 2. configure terminal 3. voice register global 4. timezone number 5. date-format [d/m/y | m/d/y | y-d-m |y/d/m | y/m/d | yy-m-d] 6. time-format {12 | 24} 7. dst auto-adjust 8. dst {start | stop} month [day day-of-month | week week-number | day day-of-week] time hour:minutes 9. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register global configuration mode to set parameters for all supported SIP phones in Cisco Unified CME. voice register global Example: Router(config)# voice register global Step 3 Step 4 timezone number Selectsthe time zone used forSIPphonesin Cisco Unified CME. Example: Router(config-register-global)# timezone 8 • Default: 5, Pacific Standard/Daylight Time. Type ? to display a list of time zones. (Optional) Selects the date display format on SIP phones in Cisco Unified CME. date-format [d/m/y | m/d/y | y-d-m |y/d/m | y/m/d | yy-m-d] Step 5 Example: Router(config-register-global)# date-format yy-m-d • Default: m/d/y. (Optional) Selects the time display format on SIP phones in Cisco Unified CME. time-format {12 | 24} Example: Router(config-register-global)# time-format 24 Step 6 • Default: 12. Cisco Unified Communications Manager Express System Administrator Guide 198 System-Level Parameters Set Date and Time Parameters for SIP Phones Command or Action Purpose (Optional) Enables automatic adjustment of Daylight Saving Time on SIP phones in Cisco Unified CME. dst auto-adjust Example: Router(config-register-global)# dst auto-adjust Step 7 • To modify start and stop times for daylight savings time, use the dst command. (Optional)Sets the time period for DaylightSaving Time onSIP phones in Cisco Unified CME. dst {start | stop} month [day day-of-month | week week-number |day day-of-week] time hour:minutes Step 8 Example: Router(config-register-global)# dst start jan day 1 time 00:00 Router(config-register-global)# dst stop mar day 31 time 23:59 • Required if automatic adjustment of DaylightSaving Time is enabled by using the dst auto-adjust command. • Default is Start: First week of April, Sunday, 2:00 a.m. Stop: Last week of October, Sunday 2:00 a.m. end Returns to privileged EXEC mode. Example: Router(config-register-global)# end Step 9 Set Network Time Protocol for SIP Phones To enable Network Time Protocol (NTP) for certain phones, such as the Cisco Unified IP Phones 7911G, 7941G, 7941GE, 7961G, 7961GE, 7970G, and 7971GE, connected to Cisco Unified CME running SIP, perform the following steps. Before You Begin • Cisco Unified CME 4.1 or a later version. • The firmware load 8.2(1) or a later version is installed for SIP phones to download. For upgrade information, see Upgrade or Downgrade SIP Phone Firmware, on page 108. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register global 4. ntp-server ip-address [mode {anycast | directedbroadcast | multicast | unicast}] 5. end Cisco Unified Communications Manager Express System Administrator Guide 199 System-Level Parameters Set Network Time Protocol for SIP Phones DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register global configuration mode to set global parameters for all supported SIP phones in a Cisco Unified CME environment. voice register global Example: Router(config)# voice register global Step 3 Synchronizes clock on this router with the specified NTP server. ntp-server ip-address [mode {anycast | directedbroadcast | multicast | unicast}] Example: Router(config-register-global)# ntp-server 10.1.2.3 Step 4 end Returns to privileged EXEC mode. Example: Router(config-register-global)# end Step 5 Enable HFS Download Service for SIP Phones Restriction • Only Cisco Unified 8951, 9951, and 9971 SIP IP Phones are supported. • No IPv6 support for the HFS download service. Before You Begin Cisco Unified CME 8.8 or a later version. Cisco Unified Communications Manager Express System Administrator Guide 200 System-Level Parameters Enable HFS Download Service for SIP Phones SUMMARY STEPS 1. enable 2. configure terminal 3. ip http server 4. ip http port number 5. voice register global 6. mode cme 7. load phone-type firmware-file 8. create profile 9. exit 10. telephony-service 11. hfs enable [port port-number] 12. end DETAILED STEPS Command or Action Purpose enable Enables privileged EXEC mode. Example: Router> enable Step 1 • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enables the underlying IOS HTTP server of the HFS infrastructure. ip http server Example: Router(config)# ip http server Step 3 ip http port number (Optional) Specifies the port where the HTTP service is run. Example: Router(config)# ip http port 60 Step 4 Enters voice register global configuration mode to set global parameters for all supported Cisco SIP IP phones in a Cisco Unified CME. voice register global Example: Router(config)# voice register global Step 5 Enables the mode for configuring SIP IP phones in a Cisco Unified CME system. mode cme Example: Router(config-register-global)# mode cme Step 6 Cisco Unified Communications Manager Express System Administrator Guide 201 System-Level Parameters Enable HFS Download Service for SIP Phones Command or Action Purpose load phone-type firmware-file Associates a type of SIP IP phone with a phone firmware file. Example: Router(config-register-global)# load 3951 SIP51.9.2.1S Step 7 Generates the configuration profile files required for SIP IP phones. create profile Example: Router(config-register-global)# create profile Step 8 exit Exits voice register global configuration mode. Example: Router(config-register-global)# exit Step 9 Enters telephony-service configuration mode for configuring Cisco Unified CME. telephony-service Example: Router (config)# telephony-service Step 10 hfs enable [port port-number] Enables the HFS download service on a specified port. Example: Router(config-telephony)# hfs enable port 5678 Step 11 • port port-number—(Optional) Specifies the port where the HFS download service is enabled. Range is from 1024 to 65535. Port 80 is the default port. Port 6970 is the custom port. If the entered custom HFS port clashes with the underlying IP HTTPport, an error message is displayed and the command is disallowed. Note end Exits to privileged EXEC mode. Example: Router(config-telephonyl)# end Step 12 Troubleshooting HFS Download Service Thedebug cme-hfs command can be used to troubleshoot an attempt to download Cisco UnifiedSIPIPphone configuration and firmware files using the HFS service. Configure HFS Home Path for SIP Phone Firmware Files To configure a home path where any requested Cisco Unified SIP IP Phone firmware file that has no explicit binding can be searched and fetched using the HFS download service, perform the following steps. Cisco Unified Communications Manager Express System Administrator Guide 202 System-Level Parameters Configure HFS Home Path for SIP Phone Firmware Files Restriction • Only Cisco 8951, 9951, and 9971 SIP IP Phones are supported. • No IPv6 support for the HFS download service. Before You Begin Cisco Unified CME 8.8 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. ip http server 4. ip http port number 5. telephony-service 6. hfs enable [port port-number] 7. hfs home-path path 8. end DETAILED STEPS Command or Action Purpose enable Enables privileged EXEC mode. Example: Router> enable Step 1 • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enables the underlying IOS HTTP server of the HFS infrastructure. ip http server Example: Router(config)# ip http server Step 3 ip http port number Specifies the port where the HTTP service is run. Example: Router(config)# ip http port 1234 Step 4 Enters telephony-service configuration mode for configuring Cisco Unified CME. telephony-service Example: Router (config)# telephony-service Step 5 Cisco Unified Communications Manager Express System Administrator Guide 203 System-Level Parameters Configure HFS Home Path for SIP Phone Firmware Files Command or Action Purpose hfs enable [port port-number] Enables the HFS download service on a specified port. Example: Router(config-telephony)# hfs enable port 6970 Step 6 Sets a home path directory for Cisco Unified SIP IP phone firmware filesthat can be searched and fetched using the HFS download service. The administrator muststore the phone firmware files at the location set as the home path directory. Note hfs home-path path Example: Router(config-telephony)# hfs home-path flash:/cme/loads/ Step 7 end Exits to privileged EXEC mode. Example: Router(config-telephony)# end Step 8 Change Session-Level Application for SIP Phones Before You Begin Cisco CME 3.4 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register global 4. application application-name 5. end DETAILED STEPS Command or Action Purpose enable Enables privileged EXEC mode. Example: Router> enable Step 1 • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Cisco Unified Communications Manager Express System Administrator Guide 204 System-Level Parameters Change Session-Level Application for SIP Phones Command or Action Purpose Enters voice register global configuration mode to set parameters for all supported SIP phones in Cisco Unified CME. voice register global Example: Router(config)# voice register global Step 3 (Optional) Changesthe default application for all dial peers associated with theSIPphonesin Cisco Unified CME to the specified application. application application-name Example: Router(config-register-global)# application sipapp2 Step 4 This command can also be configured in voice register pool configuration mode. The value set in voice register pool configuration mode has priority over the value set in voice register global mode. Note Exits voice register global configuration mode and enters privileged EXEC mode. end Example: Router(config-register-global)# end Step 5 Enable Media Flow Mode on SIP Trunks Restriction • If any media service (like transcoding and conferencing) is needed for SIP to SIP trunk call, at least one of the SIP trunks must be placed in flow through mode. • If media needs to flow through Cisco Unified CME for voicemail calls, the SIP trunk going towards the voicemail must be in flow through mode. SUMMARY STEPS 1. enable 2. configure terminal 3. voice service voip 4. media [flow around | flow through] 5. exit 6. dial-peer voice tag voip 7. media {[flow-around | flow-through] forking} 8. exit 9. voice class media tag 10. media {[flow-around | flow-through] forking} 11. end Cisco Unified Communications Manager Express System Administrator Guide 205 System-Level Parameters Enable Media Flow Mode on SIP Trunks DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 voice service voip Enters voice service voip configuration mode. Example: Router(config)#voice service voip Step 3 Step 4 media [flow around | flow through] Enables global media setting for VoIP calls. Example: Router(conf-voi-serv)#media flow-around • flow around—Allowsthe media to flow around the gateway. • flow through—Allows the media to flow through the gateway. exit Exits voice service voip configuration mode. Example: Router(config-voi-ser)#exit Step 5 Enters dial-peer configuration mode to define a VoIPdial peer for the voice-mail system. dial-peer voice tag voip Example: Router(config)#dial-peer voice 222 voip Step 6 • tag—Defines the dial peer being configured. Range is 1 to 1073741823. Step 7 media {[flow-around | flow-through] forking} Enables media settings for voice dial-peer. Example: Router(config-dial-peer)#media flow-around • flow-around—Allowsthe media to flow around the gateway. • flow-through—Allows the media to flow through the gateway. • forking—Enables media forking. exit Exits voip dial-peer configuration mode. Example: Router(config-ephone)exit Step 8 Step 9 voice class media tag Enters voice class media configuration mode. Example: Router(config)#voice class media 10 • tag— Defines the voice class media tag being configured. Range is from 1 to 10000. Cisco Unified Communications Manager Express System Administrator Guide 206 System-Level Parameters Enable Media Flow Mode on SIP Trunks Command or Action Purpose Step 10 media {[flow-around | flow-through] forking} Enables media settings for voice dial-peer. Example: Router(config-class)#media flow-around • flow-around—Allowsthe media to flow around the gateway. • flow-through—Allows the media to flow through the gateway. • forking—Enables media forking. end Returns to privileged EXEC mode. Example: Router(config-class)# end Step 11 Configure Overlap Dialing on SIP Phones SUMMARY STEPS 1. enable 2. configure terminal 3. voice register global 4. overlap-signal 5. exit 6. voice register pool pool-tag 7. overlap-signal 8. exit 9. voice register template template tag 10. overlap-signal 11. end DETAILED STEPS Command or Action Purpose enable Enables privileged EXEC mode. Example: Router> enable Step 1 • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Cisco Unified Communications Manager Express System Administrator Guide 207 System-Level Parameters Configure Overlap Dialing on SIP Phones Command or Action Purpose Enters voice register global configuration mode to set parameters for all supported SIP phones in Cisco Unified CME. voice register global Example: Router(config)voice register global Step 3 Allows to configure overlap signaling support for SIP IP phones. overlap-signal Example: Router(config-register-pool)overlap-signal Step 4 exit Exits voice register pool configuration mode. Example: Router(config-register-pool)exit Step 5 Enters voice register pool configuration mode to set phone-specific parameters for a SIP phone. voice register pool pool-tag Example: Router(config)voice register pool 10 Step 6 overlap-signal Enables overlap signaling support for voice register global. Example: Router(config-register-global)overlap-signal Step 7 exit Exits voice register-template configuration mode. Example: Router(config-register-global)exit Step 8 Enters voice register-template configuration mode to create an ephone template. voice register template template tag Example: Router(config)voice register template 5 Step 9 • template-tag—Unique identifier for the ephone template that is being created. Range: 1 to 10. overlap-signal Applies overlap signaling support for voice register-template. Example: Router(config-register-temp) overlap-signal Step 10 end Returns to privileged EXEC mode. Example: Router(config-register-temp)# end Step 11 Cisco Unified Communications Manager Express System Administrator Guide 208 System-Level Parameters Configure Overlap Dialing on SIP Phones Configuration Examples for System-Level Parameters Example for Bulk Registration Support for SIP Phones The following example shows TCP and UDP configured for various phones. Notice that in Bulk Registration (TCP), only the primary directory number is displayed, while in Line Registration (UDP), all directory numbers are displayed. Router# show sip-ua status registrar Line destination expires(sec) contact transport call-id peer ============================================================ 1001 21.1.1.138 112 21.1.1.138 TCP 239665429027943@21.1.1.138 40015 1009 21.1.1.138 118 21.1.1.138 UDP 239671730027945@21.1.1.138 40019 1010 21.1.1.138 118 21.1.1.138 UDP 239671745127945@21.1.1.138 40021 Example for IPv6 Support on Cisco Unified CME ! ip source-route ! !ip cef no ip dhcp use vrf connected ip dhcp excluded-address 10.10.10.1 10.10.10.9 ip dhcp excluded-address 192.168.2.1 ipv6 unicast-routing ipv6 cef ntp server 223.255.254.254 multilink bundle-name authenticated isdn switch-type primary-5ess ! voice service voip allow-connections h323 to h323 allow-connections h323 to sip allow-connections sip to h323 allow-connections sip to sip fax protocol cisco Cisco Unified Communications Manager Express System Administrator Guide 209 System-Level Parameters Configuration Examples for System-Level Parameters sip registrar server expires max 1200 min 300 ! ! ! voice register dn 1 number 2016 allow watch name SIP-7961GE label SIP2016 ! voice register dn 2 number 2017 ! ! voice logout-profile 1 ! voice logout-profile 2 number 2001 type normal speed-dial 1 2004 label "7960-1" ! interface GigabitEthernet0/0 ip address 10.10.10.2 255.255.255.0 duplex auto speed auto ipv6 address 2000:A0A:201:0:F:35FF:FF2C:697D/64 ipv6 enable interface GigabitEthernet0/1 ip address 40.10.30.1 255.255.255.0 shutdown duplex auto speed auto ipv6 address 2000::1/64 ipv6 address 2000::2/64 ipv6 address 2000::A/64 ipv6 address 3000::1/64 ipv6 address 4000::1/64 ipv6 address 9000::1/64 ipv6 address F000::1/64 ipv6 enable ! i! ! ! ip http server ! ipv6 route 2001:20:20:20::/64 2000:A0A:201:0:F:35FF:FF2C:5 ipv6 route 2001:50:50:50::/64 2000:A0A:201:0:F:35FF:FF2C:5 ! tftp-server flash:P00308000500.bin tftp-server flash:P00308000500.loads p-server flash:cvm70sccp.8-5-2FT1-18.sbn ! ! voice-port 0/0/0:23 ! ! mgcp fax t38 ecm ! sccp local GigabitEthernet0/0 sccp ccm 10.10.10.2 identifier 1 version 7.0 sccp ccm 2000:A0A:201:0:F:35FF:FF2C:697D identifier 2 version 7.0 sccp ! ! gateway Cisco Unified Communications Manager Express System Administrator Guide 210 System-Level Parameters Example for IPv6 Support on Cisco Unified CME timer receive-rtp 1200 ! sip-ua protocol mode dual-stack preference ipv6 ! ! telephony-service protocol mode dual-stack preference ipv6 sdspfarm conference mute-on 111 mute-off 222 sdspfarm units 2 sdspfarm transcode sessions 20 sdspfarm tag 1 xcoder sdspfarm tag 2 conference conference hardware no auto-reg-ephone em logout 0:0 0:0 0:0 max-ephones 52 max-dn 192 ip source-address 10.10.10.2 port 2000 ip source-address 2000:A0A:201:0:F:35FF:FF2C:697D service phone settingsAccess 1 service phone spanTOPCPort 0 timeouts transfer-recall 15 system message MOTO-CME1 url directories http://10.10.10.2:80/localdirectory cnf-file location flash: cnf-file perphone load 7914 S00103020003 load 7911 SCCP11.8-5-2FT1-18S load 7970 SCCP70.8-5-2FT1-18S time-zone 5 max-conferences 4 gain -6 call-forward pattern .T web admin system name cisco password cisco web admin customer name admin password admin transfer-system full-consult Cisco Unified Communications Manager Express System Administrator Guide 211 System-Level Parameters Example for IPv6 Support on Cisco Unified CME Example for System-Level Parameters The following example shows the system-level configuration for a Cisco Unified CME that can support up to 500 directory numbers on 100 phones. It sets up TFTP file sharing for phone firmware files for Cisco Unified IP Phones 7905, 7912, 7914, 7920, 7940, and 7960 and it loads those files. tftp-server flash:ATA030100SCCP040211A.zup ! ATA 186/188 firmware tftp-server flash:CP7902080001SCCP051117A.sbin ! 7902 firmware tftp-server flash:CP7905080001SCCP051117A.sbin ! 7905 firmware tftp-server flash:CP7912080001SCCP051117A.sbin ! 7912 firmware tftp-server flash:cmterm_7920.4.0-02-00.bin ! 7914 firmware tftp-server flash:P00503010100.bin ! 7920 firmware tftp-server flash:S00104000100.sbn ! 7935 firmware tftp-server flash:cmterm_7936.3-3-5-0.bin ! 7936 firmware tftp-server flash:P0030702T023.bin tftp-server flash:P0030702T023.loads tftp-server flash:P0030702T023.sb2 ! 7960/40 firmware ! telephony-service max-ephones 100 max-dn 500 load ata ATA030100SCCP040211A load 7902 CP7902080001SCCP051117A load 7905 CP7905080001SCCP051117A load 7912 CP7912080001SCCP051117A load 7914 S00104000100 load 7920 cmterm_7920.4.0-02-00 load 7935 P00503010100 load 7936 cmterm_7936.3-3-5-0 load 7960-7940 P0030702T023 ip source-address 10.16.32.144 port 2000 create cnf-files version-stamp Jan 01 2002 00:00:00 transfer-system full-consult Cisco Unified IP Phone 7911, 7941, 7941-GE, 7961, 7961-GE, 7970, and 7971 require multiple files to be shared using TFTP. The following configuration example adds support for these phones. tftp-server flash:SCCP11.7-2-1-0S.loads tftp-server flash:term11.default.loads tftp-server flash:apps11.1-0-0-72.sbn tftp-server flash:cnu11.3-0-0-81.sbn tftp-server flash:cvm11.7-2-0-66.sbn tftp-server flash:dsp11.1-0-0-73.sbn tftp-server flash:jar11.7-2-0-66.sbn ! 7911 firmware ! tftp-server flash:TERM41.7-0-3-0S.loads tftp-server flash:TERM41.DEFAULT.loads tftp-server flash:TERM61.DEFAULT.loads tftp-server flash:CVM41.2-0-2-26.sbn tftp-server flash:cnu41.2-7-6-26.sbn tftp-server flash:Jar41.2-9-2-26.sbn ! 7941/41-GE, 7961/61-GE firmware ! tftp-server flash:TERM70.7-0-1-0s.LOADS tftp-server flash:TERM70.DEFAULT.loads tftp-server flash:TERM71.DEFAULT.loads tftp-server flash:CVM70.2-0-2-26.sbn Cisco Unified Communications Manager Express System Administrator Guide 212 System-Level Parameters Example for System-Level Parameters tftp-server flash:cnu70.2-7-6-26.sbn tftp-server flash:Jar70.2-9-2-26.sbn ! 7970/71 firmware ! telephony-service load 7911 SCCP11.7-2-1-0S load 7941 TERM41.7-0-3-0S load 7961 TERM41.7-0-3-0S load 7941GE TERM41.7-0-3-0S load 7961GE TERM41.7-0-3-0S load 7970 TERM70.7-0-1-0s load 7971 TERM70.7-0-1-0s create cnf-files version-stamp Jan 01 2002 00:00:00 . . . Example for Blocking Automatic Registration The following example shows how to disable automatic ephone registration, display a log of attempted registrations, and then clear the log: Router(config)# telephony-service Router(config-telephony)# no auto-reg-ephone Router(config-telephony)# exit Router(config)# exit Router# show ephone attempted-registrations Attempting Mac address: Num Mac Address DateTime DeviceType ----------------------------------------------------------------------------- 1 C863.8475.5417 22:52:05 UTC Thu Apr 28 2005 SCCP Gateway (AN) 2 C863.8475.5408 22:52:05 UTC Thu Apr 28 2005 SCCP Gateway (AN) ..... 25 000D.28D7.7222 22:26:32 UTC Thu Apr 28 2005 Telecaster 7960 26 000D.BDB7.A9EA 22:25:59 UTC Thu Apr 28 2005 Telecaster 7960 ... 47 C863.94A8.D40F 22:52:17 UTC Thu Apr 28 2005 SCCP Gateway (AN) 48 C863.94A8.D411 22:52:18 UTC Thu Apr 28 2005 SCCP Gateway (AN) 49 C863.94A8.D400 22:52:15 UTC Thu Apr 28 2005 SCCP Gateway (AN) Router# clear telephony-service ephone-attempted-registrations Cisco Unified Communications Manager Express System Administrator Guide 213 System-Level Parameters Example for Blocking Automatic Registration Example for Enabling the HFS Download Service for Cisco Unified SIP IP Phone The following example shows how to enable the HFS download service: Router(config)# ip http server Router(config)# ip http port 1234 Router (config)# telephony-service Router(config-telephony)# hfs enable port 65500 Example for Configuring an HFS Home Path for Cisco Unified SIP IP Phone Firmware Files The following example shows how a new directory called phone-load can be created under the root directory of the flash memory and set as the hfs home-path: cassini-c2801#mkdir flash:phone-loads Create directory filename [phone-loads]? Created dir flash:phone-loads cassini-c2801#sh flash: -#- --length-- -----date/time------ path 1 13932728 Mar 22 2007 15:57:38 +00:00 c2801-ipbase-mz.124-1c.bin 2 33510140 Sep 18 2010 01:21:56 +00:00 rootfs9951.9-0-3.sebn 3 143604 Sep 18 2010 01:22:20 +00:00 sboot9951.111909R1-9-0-3.sebn 4 1249 Sep 18 2010 01:22:40 +00:00 sip9951.9-0-3.loads 5 66996 Sep 18 2010 01:23:00 +00:00 skern9951.022809R2-9-0-3.sebn 6 10724 Sep 18 2010 00:59:48 +00:00 dkern9951.100609R2-9-0-3.sebn 7 1507064 Sep 18 2010 01:00:24 +00:00 kern9951.9-0-3.sebn 8 0 Jan 5 2011 02:03:46 +00:00 phone-loads 14819328 bytes available (49192960 bytes used) cassini-c2801#conf t Enter configuration commands, one per line. End with CNTL/Z. cassini-c2801(config)#tele cassini-c2801(config)#telephony-service cassini-c2801(config-telephony)#hfs hom cassini-c2801(config-telephony)#hfs home-path flash:? WORD cassini-c2801(config-telephony)#hfs home-path flash:phone-loads cassini-c2801(config-telephony)# Example for Verifying the HFS File Bindings of Cisco Unified SIP IP Phone Configuration and Firmware Files The following is a sample output from the show voice register hfs command: Router(config)#show voice register hfs Fetch Service Enabled = Y App enabled port = 6970 Use default port = N Registered session-id = 19 Default home path = flash:/ Ongoing fetches from home = 0 HTTP File Server Bindings No. of bindings = 11 No. of url table entries = 9 No. of alias table entries = 9 Cisco Unified Communications Manager Express System Administrator Guide 214 System-Level Parameters Example for Enabling the HFS Download Service for Cisco Unified SIP IP Phone Example for Redundant Router for SCCP Phones The following example is configured on the primary Cisco Unified CME router. It establishes the router at 10.5.2.78 as a secondary router. The voice port 3/0/0 is the FXO port for incoming calls from the PSTN. It is set to use ground-start signaling and to detect incoming calls by counting incoming ring signals. telephony-service ip source-address 10.0.0.1 port 2000 secondary 10.5.2.78 voice-port 3/0/0 signal ground-start incoming alerting ring-only The secondary Cisco Unified CME router is configured with the same commands, except that the ring number command is set to 3 instead of using the default of 1. telephony-service ip source-address 10.0.0.1 port 2000 secondary 10.5.2.78 voice-port 3/0/0 signal ground-start incoming alerting ring-only ring number 3 Example for Redundant Router for SIP Phones The following example is configured on the primary Cisco Unified CME router. It establishes the router at 10.6.50.6 as a secondary router with keepalive value set to 200 seconds. For the synchronization to happen, additional configurations are needed. These configurations such as IXI, HTTP, and telephony-service are provided in the output. Note voice register global source-address 10.6.21.4 port 6000 secondary 10.6.50.6 keepalive 200 ip http server ixi transport http response size 8 no shutdown request outstanding 2 request timeout 30 ixi application cme no shutdown response timeout -1 telephony-service ip source-address 10.6.21.4 secondary 10.6.50.6 standby user cisco password cisco123 The secondary Cisco Unified CME router is configured with the same commands: voice register global source-address 10.6.21.4 port 6000 secondary 10.6.50.6 keepalive 200 ip http server ixi transport http response size 8 Cisco Unified Communications Manager Express System Administrator Guide 215 System-Level Parameters Example for Redundant Router for SCCP Phones no shutdown request outstanding 2 request timeout 30 ixi application cme no shutdown response timeout -1 telephony-service ip source-address 10.6.50.6 xml user cisco password cisco123 15 Example for Media Flow Around Mode for SIP Trunks The following example shows media flow-around enabled in voice service voip, voice class media, and dial peer configuration modes: Router# show running config ! ! voice service voip ip address trusted list ipv4 20.20.20.1 media flow-around allow-connections sip to sip vpn-group 1 vpn-gateway 1 https://9.10.60.254/SSLVPNphone vpn-trustpoint 1 trustpoint cme_cert root vpn-hash-algorithm sha-1 vpn-profile 1 keepalive 50 auto-network-detect enable host-id-check disable vpn-profile 2 mtu 1300 authen-method both password-persistent enable host-id-check enable vpn-profile 4 fail-connect-time 50 sip ! voice class media 10 media flow-around Cisco Unified Communications Manager Express System Administrator Guide 216 System-Level Parameters Example for Media Flow Around Mode for SIP Trunks ! ! ! dspfarm profile 1 conference codec g711ulaw maximum sessions 2 associate application SCCP ! dial-peer voice 222 voip media flow-around ! dial-peer voice 10 voip media flow-around ! dial-peer voice 101 voip end Example for Configuring Overlap Dialing for SCCP IP Phones The following example shows the overlap-signal command configured in telephony-service configuration mode, ephone template 10, and ephone 10: The following example shows the overlap-signal command configured in telephony-service configuration mode, ephone template 10, and ephone 10: Router# show running config ! ! telephony-service max-ephones 25 max-dn 15 load 7906 SCCP11.8-5-3S.loads load 7911 SCCP11.8-5-3S.loads load 7921 CP7921G-1.3.3.LOADS load 7941 SCCP41.8-5-3S.loads load 7942 SCCP42.8-5-3S.loads load 7961 SCCP41.8-5-3S.loads load 7962 SCCP42.8-5-3S.loads max-conferences 12 gain -6 web admin system name cisco password cisco Cisco Unified Communications Manager Express System Administrator Guide 217 System-Level Parameters Example for Configuring Overlap Dialing for SCCP IP Phones transfer-system full-consult create cnf-files version-stamp Jan 01 2002 00:00:00 overlap-signal ! ephone-template 1 button-layout 1 line button-layout 3-6 blf-speed-dial ! ephone-template 9 feature-button 1 Endcall feature-button 3 Mobility ! ! ephone-template 10 feature-button 1 Park feature-button 2 MeetMe feature-button 3 CallBack button-layout 1 line button-layout 2-4 speed-dial button-layout 5-6 blf-speed-dial overlap-signal ! ephone 10 device-security-mode none mac-address 02EA.EAEA.0010 overlap-signal Example for Configuring Overlap Dialing for SIP IP Phones The following example shows the overlap-signal configured in voice register global configuration mode and voice register pool 10: Router# show running config ! ! ! voice service voip ip address trusted list Cisco Unified Communications Manager Express System Administrator Guide 218 System-Level Parameters Example for Configuring Overlap Dialing for SIP IP Phones ipv4 20.20.20.1 media flow-around allow-connections sip to sip ! voice class media 10 media flow-around ! ! voice register global max-pool 10 overlap-signal ! voice register pool 5 overlap-signal ! ! ! Where to Go Next After configuring system-level parameters, you are ready to configure phones for making basic calls in Cisco Unified CME. • To use Extension Assigner to assign extension numbers to the phones in your Cisco Unified CME, see Create Phone Configurations Using Extension Assigner, on page 347. • Otherwise, see Configure Phones to Make Basic Call, on page 315. Feature Information for System-Level Parameters The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Table 13: Feature Information for System-Level Parameters Feature Name Cisco Unified CME Versions Feature Information Introducesredundant routersupport for SIP phones. Redundant Router for SIP Phones 11.6 Cisco Unified Communications Manager Express System Administrator Guide 219 System-Level Parameters Where to Go Next Feature Name Cisco Unified CME Versions Feature Information Allows the Unsolicited Notify mechanism to reduce network traffic during Cisco UnifiedSIPIP phone registration using the bulk registration method. Unsolicited Notify forShared Line 9.0 and Presence Events for Cisco Unified SIP IP Phones Provides download support forSIP and SCCP IP phone firmware, scripts, midlets, and configuration files using the HTTP File-Fetch Server (HFS) infrastructure. HFS Download Support for IP 8.8 PhoneFirmware and Configuration Files Introduces bulk registration support for SIP phones. Introduces bulk registration for registering a block of phone numbers with an external registrar. Bulk Registration 8.6/3.4 Introduces the media flow around feature, which eliminates the need to terminate RTP and re-originate on Cisco Unified CME, reducing media switching latency and increasing the call handling capacity for Cisco Unified CME SIP trunk. Media Flow Around for SIP-SIP 8.5 Trunks Allows the dialed digits from the SIP or SCCP IP phones to pass across the PRI/BRI trunks as overlap digits and not as enbloc digits, enabling overlap dialing on the PRI/BRI trunks. Overlap Dialing forSCCPandSIP 8.5 Phones Supports DSCPpacket marking for Cisco Unified IPPhonesto specify the class ofservice for each packet. DSCP 7.1 The max-ephones command sets the maximum number of SCCP phones that can register to Cisco Unified CME, without limiting the number that can be configured. Maximum number of phones that can be configured is 1000. Maximum Ephones 7.0/4.3 Allows SIP phones to synchronize to an NTP server. Network Time Protocol for SIP 4.1 Phones Cisco Unified Communications Manager Express System Administrator Guide 220 System-Level Parameters Feature Information for System-Level Parameters Feature Name Cisco Unified CME Versions Feature Information Blocks IP phones that are not explicitly configured in Cisco Unified CME from registering. Blocking Automatic Registration 4.0 Defines a location other than system for storing configuration files and specifies the type of configuration files to generate. Per-Phone ConfigurationFiles and 4.0 Alternate Location Introduces redundant router capability. Redundant Router for SCCP 4.0 Phones Introduces support for SIP endpoints directly connected to Cisco Unified CME. SIP phones in Cisco Unified CME 3.4 Cisco Unified Communications Manager Express System Administrator Guide 221 System-Level Parameters Feature Information for System-Level Parameters Cisco Unified Communications Manager Express System Administrator Guide 222 System-Level Parameters Feature Information for System-Level Parameters CHAPTER 7 Configuring Phones to Make Basic Calls This chapter describes how to configure Cisco Unified IPphonesin Cisco Unified Communications Manager Express (Cisco Unified CME) so that you can make and receive basic calls. The Interactive Voice Response (IVR) media prompts feature is only available on the IAD2435 when running IOS version 15.0(1)M or later. Caution • Prerequisites for Configuring Phones to Make Basic Calls, page 223 • Restrictions for Configuring Phones to Make Basic Calls, page 224 • Information About Configuring Phones to Make Basic Calls, page 224 • Configure Phones for a PBX System, page 253 • Configure Phones for a Key System, page 282 • Configure Cisco ATA, Analog Phone Support, Remote Phones, Cisco IP Communicator, and Secure IP Phone (IP-STE), page 295 • Configure Phones to Make Basic Call, page 315 • SIP Phone Models Validated for CME using Fast-track Configuration, page 328 • Configuration Examples for Making Basic Calls, page 328 • Where To Go Next, page 341 • Feature Information for Configuring Phones to Make Basic Calls, page 341 Prerequisites for Configuring Phones to Make Basic Calls • Cisco IOSsoftware and Cisco Unified CME software, including phone firmware filesfor Cisco Unified IP phones to be connected to Cisco Unified CME, must be installed in router flash memory. See Install Cisco Unified CME Software, on page 105. Cisco Unified Communications Manager Express System Administrator Guide 223 • For Cisco Unified IP phones that are running SIP and are connected directly to Cisco Unified CME, Cisco Unified CME 3.4 or a later version must be installed on the router.See Install Cisco Unified CME Software, on page 105. • Procedures in NetworkParameters, on page 121 and ConfigureSystem-LevelParameters, on page 167 must be completed before you start the procedures in this section. Restrictions for Configuring Phones to Make Basic Calls When you are configuring dial peers or ephone-dns, including park slots and conferencing extensions, on Cisco Integrated Services Router Voice Bundles, the following message may appear to warn you that free memory is not available: %DIALPEER_DB-3-ADDPEER_MEM_THRESHOLD: Addition of dial-peerslimited by available memory To configure more dial peers or ephone-dns, increase the DRAM in the system. A moderately complex configuration may exceed the default 256 MB DRAM and require 512 MB DRAM. Note that many factors contribute to memory usage, in addition to the number of dial peers and ephone-dns configured. Information About Configuring Phones to Make Basic Calls Phones in Cisco Unified CME An ephone, or “Ethernet phone,” for SCCP or a voice-register pool for SIP is the software configuration for a phone in Cisco Unified CME. This phone can be either a Cisco Unified IP phone or an analog phone. Each physical phone in your system must be configured as an ephone or voice-register pool on the Cisco Unified CME router to receive support in the LAN environment. Each phone has a unique tag, or sequence number, to identify it during configuration. For information on the phones supported in Cisco Unified CME Release 8.8 and later versions, see Phone Feature Support Guide for Unified CME, Unified SRST, Unified E-SRST, and Unified Secure SRST. Directory Numbers A directory number, also known as an ephone-dn for SCCP or a voice-register dn for SIP, is the software configuration in Cisco Unified CME that representsthe line connecting a voice channel to a phone. A directory number has one or more extension or telephone numbers associated with it to allow call connections to be made. Generally, a directory number is equivalent to a phone line, but not always. There are several types of directory numbers, which have different characteristics. Each directory number has a unique dn-tag, or sequence number, to identify it during configuration. Directory numbers are assigned to line buttons on phones during configuration. One virtual voice port and one or more dial peers are automatically created for each directory number, depending on the configuration for SCCP phones, or for SIP phones, when the phone registers in Cisco Unified CME. Because each directory number represents a virtual voice port in the router, the number of directory numbers that you create corresponds to the number of simultaneous calls that you can have. This means that if you Cisco Unified Communications Manager Express System Administrator Guide 224 Configuring Phones to Make Basic Calls Restrictions for Configuring Phones to Make Basic Calls want more than one call to the same number to be answered simultaneously, you need multiple directory numbers with the same destination number pattern. The directory number is the basic building block of a Cisco Unified CME system. Six different types of directory numbers can be combined in different ways for different call coverage situations. Each type will help with a particular type of limitation or call-coverage need. For example, if you want to keep the number of directory numbers low and provide service to a large number of people, you might use shared directory numbers. Or if you have a limited quantity of extension numbers that you can use and you need to have a large quantity of simultaneous calls, you might create two or more directory numbers with the same number. The key is knowing how each type of directory number works and its advantages. Not all types of directory numbers can be configured for all phones or for all protocols. In the remaining information about directory numbers, we have used SCCP in the examples presented but that does not imply exclusivity. The following sections describe the types of directory numbers in a Cisco Unified CME system: Single-Line A single-line directory number has the following characteristics: • Makes one call connection at a time using one phone line button. A single-line directory number has one telephone number associated with it. • Should be used when phone buttons have a one-to-one correspondence to the PSTN lines that come into a Cisco Unified CME system. • Should be used for lines that are dedicated to intercom, paging, message-waiting indicator (MWI), loopback, and music-on-hold (MOH) feed sources. • Must have more than one single-line directory number on a phone when used with multiple-line features like call waiting, call transfer, and conferencing. • Can be combined with dual-line directory numbers on the same phone. You must make the choice to configure each directory number in your system as either dual-line or single-line when you initially create configuration entries. If you need to change from single-line to dual-line later, you must delete the configuration for the directory number, then recreate it. Note Figure 6: Single-Line Directory Number, on page 225 shows a single-line directory number for an SCCP phone in Cisco Unified CME. Figure 6: Single-Line Directory Number Dual-Line A dual-line directory number has the following characteristics: Cisco Unified Communications Manager Express System Administrator Guide 225 Configuring Phones to Make Basic Calls Directory Numbers • Has one voice port with two channels. • Supported on IP phones that are running SCCP; not supported on IP phones that are running SIP. • Can make two call connections at the same time using one phone line button. A dual-line directory number has two channels for separate call connections. • Can have one number or two numbers (primary and secondary) associated with it. • Should be used for a directory number that needs to use one line button for features like call waiting, call transfer, or conferencing. • Cannot be used for lines that are dedicated to intercom, paging, message-waiting indicator (MWI), loopback, and music-on-hold (MOH) feed sources. • Can be combined with single-line directory numbers on the same phone. You must make the choice to configure each directory number in your system as either dual-line or single-line when you initially create configuration entries. If you need to change from single-line to dual-line later, you must delete the configuration for the directory number, then recreate it. Note Figure 7: Dual-Line Directory Number, on page 226 shows a dual-line directory number for an SCCP phone in Cisco Unified CME. Figure 7: Dual-Line Directory Number Octo-Line An octo-line directory number supports up to eight active calls, both incoming and outgoing, on a single button of a SCCP phone. Unlike a dual-line directory number, which is shared exclusively among phones (after a call is answered, that phone owns both channels of the dual-line directory number), an octo-line directory number can split its channels among other phones that share the directory number. All phones are allowed to initiate or receive calls on the idle channels of the shared octo-line directory number. Because octo-line directory numbers do not require a different ephone-dn for each active call, one octo-line directory number can handle multiple calls. Multiple incoming calls to an octo-line directory number ring simultaneously. After a phone answers a call, the ringing stops on that phone and the call-waiting tone plays for the other incoming calls. When phones share an octo-line directory number, incoming calls ring on phones without active calls and these phones can answer any of the ringing calls. Phones with an active call hear the call-waiting tone. After a phone answers an incoming call, the answering phone is in the connected state. Other phones that share the octo-line directory number are in the remote-in-use state. After a connected call on an octo-line directory number is put on-hold, any phone that shares this directory number can pick up the held call. If a phone user is in the process of initiating a call transfer or creating a conference, the call is locked and other phones that share the octo-line directory number cannot steal the call. Cisco Unified Communications Manager Express System Administrator Guide 226 Configuring Phones to Make Basic Calls Directory Numbers Figure 8: Octo-Line Directory Number, on page 227 shows an octo-line directory number for SCCP phones in Cisco Unified CME. Figure 8: Octo-Line Directory Number The Barge and Privacy features control whether other phones are allowed to view call information or join calls on the shared octo-line directory number. Feature Comparison by Directory Number Line-Mode on SCCP Phones Table 14: Feature Comparison by Line Mode on SCCP Phones , on page 227 lists some common directory number features and their support based on the type of line mode defined with the ephone-dn command. Table 14: Feature Comparison by Line Mode on SCCP Phones Feature Single-Line Dual-Line Octo-Line Barge — — Yes Busy Trigger — — Yes Conferencing (8-party) — 4 directory numbers 1 directory number FXO Trunk Optimization Yes Yes — Huntstop Channel — Yes Yes Intercom Yes — — Key System (one call per Yes — — button) Maximum Calls — — Yes Cisco Unified Communications Manager Express System Administrator Guide 227 Configuring Phones to Make Basic Calls Directory Numbers Feature Single-Line Dual-Line Octo-Line MWI Yes — — Overlay directory Yes Yes — numbers (c, o, x) Paging Yes — — Park Yes — — Privacy — — Yes SIP Shared-Line (Nonexclusive) Cisco Unified CME 7.1 and later versionssupportSIPshared linesto allow multiple phonesto share a common directory number. All phones sharing the directory number can initiate and receive calls at the same time. Calls to the shared line ring simultaneously on all phones without active calls and any of these phones can answer the incoming calls. After a phone answers a call, the ringing stops on all phones and the call-waiting tone plays for other incoming calls to the connected phone. The phone that answers an incoming call is in the connected state. Other phones that share the directory number are in the remote-in-use state. The first user that answers the call on the shared line is connected to the caller and the remaining users see the call information and status of the shared line. Calls on a shared line can be put on hold like calls on a non-shared line. When a call is placed on hold, other phones with the shared-line directory number receive a hold notification so all phones sharing the line are aware of the held call. Any shared-line phone user can resume the held call. If the call is placed on hold as part of a conference or call transfer operation, the call cannot be resumed by other shared-line phone users. The ID of the held call is used by other shared-line members to resume the call. Notifications are sent to all associated phones when a held call is resumed on a shared line. Shared lines support up to 16 calls, depending on the configuration in Cisco Unified CME, which rejects any new call that exceeds the configured limit. For configuration information, see Create Directory Numbers for SIP Phones, on page 263. The Barge and Privacy features control whether other phones are allowed to view call information or join calls on the shared-line directory number. See Barge and Privacy, on page 1047. When theno supplementary-service siphandle-replaces command is configured,SIPshared-line is not supported on CME. Note Two Directory Numbers with One Telephone Number Two directory numbers with one telephone or extension number have the following characteristics: • Have the same telephone number but two separate virtual voice ports, and therefore can have two separate call connections. Cisco Unified Communications Manager Express System Administrator Guide 228 Configuring Phones to Make Basic Calls Directory Numbers • Can be dual-line (SCCP only) or single-line directory numbers. • Can appear on the same phone on different buttons or on different phones. • Should be used when you want the ability to make more call connections while using fewer numbers. Figure 9: Two Directory Numbers with One Number on One Phone, on page 230 shows a phone with two buttons that have the same number, extension 1003. Each button has a different directory number (button 1 is directory number 13 and button 2 is directory number 14), so each button can make one independent call connection if the directory numbers are single-line and two call connections(for a total of four) if the directory numbers are dual-line. Figure 10: Two Directory Numbers with One Number on Two Phones, on page 230 shows two phones that each have a button with the same number. Because the buttons have different directory numbers, the calls that are connected on these buttons are independent of one another. The phone user at phone 4 can make a call on extension 1003, and the phone user on phone 5 can receive a different call on extension 1003 at the same time. The two directory numbers-with-one-number situation is different than a shared line, which also has two buttons with one number but has only one directory number for both of them. A shared directory number will have the same call connection at all the buttons on which the shared directory number appears. If a call on a shared directory number is answered on one phone and then placed on hold, the call can be retrieved from the second phone on which the shared directory number appears. But when there are two directory numbers with one number, a call connection appears only on the phone and button at which the call is made or received. In the example in Figure 10: Two Directory Numbers with One Number on Two Phones, on page 230, if the user at phone 4 makes a call on button 1 and puts it on hold, the call can be retrieved only from phone 4. For more information about shared lines, see Shared Line (Exclusive), on page 231 section. The examples inFigure 9: Two Directory Numbers with One Number on OnePhone, on page 230 andFigure 10: Two Directory Numbers with One Number on TwoPhones, on page 230 show how two directory numbers with one number are used to provide a small hunt group capability. In Figure 9: Two Directory Numbers with One Number on One Phone, on page 230, if the directory number on button 1 is busy or does not answer, an incoming call to extension 1003 rolls over to the directory number associated with button 2 because the Cisco Unified Communications Manager Express System Administrator Guide 229 Configuring Phones to Make Basic Calls Directory Numbers appropriate related commands are configured. Similarly, if button 1 on phone 4 is busy, an incoming call to 1003 rolls over to button 1 on phone 5. Figure 9: Two Directory Numbers with One Number on One Phone Figure 10: Two Directory Numbers with One Number on Two Phones Dual-Number A dual-number directory number has the following characteristics: • Has two telephone numbers, a primary number and a secondary number. • Can make one call connection if it is a single-line directory number. • Can make two call connections at a time if it is a dual-line directory number (SCCP only). • Should be used when you want to have two different numbers for the same button without using more than one directory number. Cisco Unified Communications Manager Express System Administrator Guide 230 Configuring Phones to Make Basic Calls Directory Numbers Figure 11: Dual-Number Directory, on page 231 shows a directory number that has two numbers, extension 1006 and extension 1007. Figure 11: Dual-Number Directory Shared Line (Exclusive) An exclusively shared directory number has the following characteristics: • Has a line that appears on two different phones but uses the same directory number, and extension or phone number. • Can make one call at a time and that call appears on both phones. • Should be used when you want the capability to answer or pick up a call at more than one phone. Because this directory number is shared exclusively among phones, if the directory number is connected to a call on one phone, that directory number is unavailable for calls on any other phone. If a call is placed on hold on one phone, it can be retrieved on the second phone. This is like having a single-line phone in your house with multiple extensions. You can answer the call from any phone on which the number appears, and you can pick it up from hold on any phone on which the number appears. Note Transcoding is not supported for Shared Lines. Figure 12: Shared Directory Number (Exclusive), on page 231 shows a shared directory number on phones that are running SCCP. Extension 1008 appears on both phone 7 and phone 8. Figure 12: Shared Directory Number (Exclusive) Mixed Shared Lines Cisco Unified CME 9.0 and later versionssupport the mixed Cisco UnifiedSIP/SCCPshared line. Thisfeature allows Cisco Unified SIP and SCCP IP phones to share a common directory number. Cisco Unified Communications Manager Express System Administrator Guide 231 Configuring Phones to Make Basic Calls Directory Numbers The mixed shared line supports up to 16 calls, depending on the configuration in Cisco Unified CME, which rejects any new call that exceeds the configured limit. For configuration information, see Create Directory Numbers for SCCP Phones, on page 253 and Create Directory Numbers for SIP Phones, on page 263. Incoming and Outgoing Calls All phones sharing the common directory number can initiate and receive calls at the same time. Calls to the mixed shared line ring simultaneously on all phones without active calls and any of these phones can answer the incoming calls. After a phone answers a call, the ringing stops on all phones and the call-waiting tone plays for other incoming calls to the connected phone. The phone that answers an incoming call is in the connected state. Other phones that share the common directory number are in the remote-in-use state. The first user who answers the call on the mixed shared line is connected to the caller and the remaining users see the call information and status of the mixed shared line. When a mixed shared-line user makes an outgoing call on the shared line, all the other shared-line users are notified of the outgoing call. When the called party answers, the caller is connected while the remaining shared-line users see the call information and the status of the call on the mixed shared line. Hold and Resume Calls on a mixed shared line can be put on hold like calls on a non-shared line. When a call is placed on hold, other phones with the shared-line directory number receive a hold notification so all phones sharing the line are aware of the call on hold. Any shared-line phone user can resume the call on hold. The ID of the call on hold is used by other shared-line members to resume the call. Notifications are sent to all associated phones when a call on hold is resumed on a mixed shared line. If the call is placed on hold as part of a conference or call transfer operation, the resume feature is not allowed. Privacy on Hold The Privacy on Hold feature prevents other phone users from viewing call information or retrieving a call put on hold by another phone sharing a common directory number. Only the caller who put the call on hold can see the status of the held call. By default, Privacy on Hold feature is disabled for all phones on a shared line. Use the privacy-on-hold command in telephony-service configuration mode to enable the Privacy feature for calls that are on hold on Cisco Unified SCCP IP phones on a mixed shared line. Use the privacy-on-hold command in voice register global configuration mode to enable the Privacy feature for calls that are on hold on Cisco Unified SIP IP phones on a mixed shared line. The no privacy and privacy off commands override the privacy-on-hold command. Call Transfer and Forwarding Both blind transfer and consult transfer are supported on a mixed shared line. A mixed shared line can be the one transferring the call, the one receiving the transferred call, or the call being transferred. There are four types of call forwarding: all calls, no answer, busy, and night service. Any of these can be configured under a shared SCCP ephone-dn or a shared SIP voice register dn. However, the user must keep the call forwarding parameters for the SCCP and SIP lines synchronized with each other. A mixed shared line can be the one forwarding the call, the one receiving the forwarded call, or the call being forwarded. Cisco Unified Communications Manager Express System Administrator Guide 232 Configuring Phones to Make Basic Calls Directory Numbers For more information, see Configure Call Transfer and Forwarding, on page 1178. Call Pickup The CallPickup feature issupported on a mixed shared line when the call-parksystem applicationcommand is configured in telephony-service configuration mode. A user can answer a call that: • Originates from a shared line • Rings on a shared line • Originates from one shared line and rings on another shared line For more information, see Call Pickup, on page 1243. Call Park The Call Park feature is supported on a mixed shared line when the call-park system application command is configured in telephony-service configuration mode. For more information, see Call Park, on page 1081. Message Waiting Indication SCCP and SIP message-waiting indication (MWI) services are supported on Cisco Unity and Cisco Unity voice mails on mixed shared lines: The following are two ways of registering a mixed shared line for an MWI service from a SIP-based MWI server with the shared-line option: • Configure the mwi sip command in ephone-dn or ephone-dn-template configuration mode. • Configure the mwi command in voice register dn configuration mode. For SCCP MWI service on a mixed shared line, use the mwi {off |on | on-off} command in ephone-dn configuration mode to enable a specific Cisco Unified IP phone extension to receive MWI notification from an external voice-messaging system. Software Conferencing A local software conference can be created on a mixed shared line, with the mixed shared line acting as a conference creator and a conference participant. For software conferencing on a mixed shared line, other shared-line users remain in remote-in-use state and do not see the calls on hold when the conference call is put on hold by a mixed-shared-line user acting as the conference creator. Note Only the conference creator, who put a conference call on hold, can resume the conference call. Cisco Unified Communications Manager Express System Administrator Guide 233 Configuring Phones to Make Basic Calls Directory Numbers Dial Plan A dial plan pattern enables abbreviated extensions to be expanded into fully qualified E.164 numbers and builds additional dial peers for the expanded numbers it creates. Features are effectively supported on a mixed shared line when dial-plan patterns have matching configurations in telephony-service and voice register global configuration modes using the dialplan pattern command. Busy Lamp Field Speed-Dial Monitoring A mixed shared line only supports directory number-based Busy-Lamp-Field (BLF) Speed-Dial monitoring and not device-based monitoring. Restrictions For Mixed Shared Lines The following features are not supported on mixed Cisco Unified SIP/SCCP shared lines: • Privacy • Barge • cBarge • Single Number Reach • Hardware Conferencing • Remote-resume on a local software conference call • Video calls • Overlay DNs on Cisco Unified SCCP IP phones • Features in the CTI CSTA protocol suite Overlaid Directory Numbers An overlaid directory number has the following characteristics: • Is a member of an overlay set, which includes all the directory numbers that have been assigned together to a particular phone button. • Can have the same telephone or extension number as other members of the overlay set or different numbers. • Can be single-line or dual-line, but cannot be mixed single-line and dual-line in the same overlay set. • Can be shared on more than one phone. Overlaid directory numbers provide call coverage similar to shared directory numbers because the same number can appear on more than one phone. The advantage of using two directory numbers in an overlay arrangement rather than as a simple shared line is that a call to the number on one phone does not block the use of the same number on the other phone, as would happen if it were a shared directory number. For information about configuring call coverage using overlaid ephone-dns, see Configure Call Coverage Features, on page 1278. Cisco Unified Communications Manager Express System Administrator Guide 234 Configuring Phones to Make Basic Calls Directory Numbers You can overlay up to 25 lines on a single button. A typical use of overlaid directory numbers would be to create a “10x10” shared line, with 10 lines in an overlay set shared by 10 phones, resulting in the possibility of 10 simultaneous calls to the same number. For configuration information, see Creating Directory Numbers for a Simple Key System on SCCP Phone, on page 282. Auto Registration of SIP Phones on Cisco Unified CME Cisco Unified CME supports auto registration of both SIP and SCCP phones. When the auto registration feature is enabled, the voice register pool and voice register dn commands do not need to be manually configured for the phones. The configuration is automatically created when the phone registers. The auto registration feature for SIP phones is enabled with the auto-register command under voice register global configuration mode.For more information on auto-register command,see Cisco Unified Communications Manager Express Command Reference. The auto registration ofSCCPphonesis enabled with the auto-reg-ephone command under telephony-service configuration mode. For more information on auto-register command, see Cisco Unified Communications Manager Express Command Reference. As part of the auto-register command, certain CLI sub-mode configuration options are available to the administrator to successfully register phones using auto-registration on Unified CME. Router(config-register-global)#auto-register Router(config-voice-auto-register)# Router(config-voice-auto-register)# ? VOICE auto register configuration commands: auto-assign Define DN range for auto assignment default Set a command to its defaults exit Exit from voice register group configuration mode no Negate a command or set its defaults password Default password for auto-register phones service-enable Enable SIP phone Auto-Registration template Default template for auto-register phones For details on the configuration steps for auto registration of SIP phones, see Configure Auto Registration for SIP Phones, on page 315. Service Enable —If the administrator needs to temporarily disable or enable auto registration without losing configurations such as DN range, and password, the no form of the CLI option service-enable is used (no service-enable). Once auto-register command is entered, the service is enabled by default. To re-enable the auto registration feature, use the command service-enable. It is a sub-mode option in the CLI command auto-register. To disable auto registration including removal of configurations such as password and DN range, the no form of the CLI command auto-register (under voice register global) is used. Router(config)#voice register global Router(config-register-global)#auto-register Router(config-voice-auto-register)#no service-enable ? Password —As part of the auto registration feature, authentication of phones registering on Unified CME is enabled. When the phone registers with Unified CME, it is mandatory for the administrator to configure the password credentials; username is assigned by default. However, the administrator can modify the username and password credentials under the corresponding voice register pool that gets created after auto registration. Router(config)#voice register global Router(config-register-global)#auto-register Router(config-voice-auto-register)#password ? WORD Password string Cisco Unified Communications Manager Express System Administrator Guide 235 Configuring Phones to Make Basic Calls Auto Registration of SIP Phones on Cisco Unified CME It is mandatory thatpasswordis configured before DN range (auto-assign) while registering phones using auto registration. Note Auto Assign —It is mandatory to define a directory number (DN) range for auto-registration feature to work. The DN range that can be assigned to phones registering on Unified CME is configured using auto-assign to , which is a submode option of the CLI command auto-register (under voice register global). The DN numbers assigned to the phones through auto registration are always within the DN range that is defined. However, ensure that the defined DN range is within the maximum DNs recommended for the supported platform. Router(config)#voice register global Router(config-register-global)#auto-register Router(config-voice-auto-register)#auto-assign ? <1-4294967295> First DN number Router(config-voice-auto-register)#auto-assign 1001 ? <1-4294967295> Last DN number Router(config-voice-auto-register)#auto-assign 1001 to 1010 The automatic registration feature also provides the administrators with the option to enhance a predefined DN range. The enhancement of an existing DN range is supported such that the new first-dn is not greater that the existing first-dn and the new last-dn is not less than the existing last-dn. For example, the DN range 8001-8006 can be enhanced as 7999-8006, 8000-8007, but not as 8002-8006 or 8001 to 8005. Router# show running-config | section voice register global voice register global mode cme source-address 8.41.20.1 port 5060 auto-register password xxxx auto-assign 8001 to 8006 max-dn 50 max-pool 40 Router(config-register-global)#auto-assign 8002 to 8006 Start DN should not be greater than existing First DN Router(config-register-global)#auto-assign 8001 to 8005 Stop DN should not be less than existing Last DN The DN assigned to phone using the auto registration feature does not duplicate a manually configured DN. When the defined DN range includes a previously registered DN, that DN is skipped as part of the auto registration process. However, when a previously registered DN deregisters and the corresponding configuration for the DN and pool are removed, it can be assigned to a phone registering on Unified CME using auto registration. The assignment of DN range is done in round robin fashion and the first available free DN is assigned to the phone that is auto registering with Unified CME. We recommend that administrators choose different DN rangesfor manually configured and auto configured phones. Note Template —Administrators are provided the option to create a basic configuration template that can be applied to all phones registering automatically on Unified CME. This basic configuration template supports all the configurations currently supported by the voice register template. It is mandatory that voice register template is configured with the same template tag. Router(config)#voice register global Router(config-register-global)#auto-register Router(config-voice-auto-register)#template ? Cisco Unified Communications Manager Express System Administrator Guide 236 Configuring Phones to Make Basic Calls Auto Registration of SIP Phones on Cisco Unified CME <1-10> template tag> Router(config-voice-auto-register)#template 10 All phone configurations such as voice-register-pool and voice-register-dn that are generated as part of the auto registration process are persistent configurations. These configurations will be available on the Unified CME even after an event of router reload. The CLI commands show voice register pool all and show voice register pool all brief distinctly mention the registration process for phones as registered or unregistered for manual registration, and registered* or unregistered* for automatic registration. However, the registration status for auto-registered phones are reset in the event of a router reload. Then, phone registration status displays only as registered or unregistered. Syslog Messages Unified CME generatesSyslog messages as part of the auto registration feature, when the phone registers and unregisters with the Cisco Unified CME. Also, based on the DN range configured, the administrator gets syslog message providing updates on the registration status of assigned DNs. The syslog messagesthat provide updates are generated at two instances; at 80% utilization of available DNs, and at 100% utilization of DNs. The Unified CME system generates the following syslog messages as part of auto registration. • Syslog message when phone registers with Unified CME: *Mar 28 21:44:08.795 IST: %SIPPHONE-6-REGISTER: VOICE REGISTER POOL-8 has registered. Name:SEP2834A2823843 IP:8.41.20.58 DeviceType:Phone • Syslog message at 80% utilization of DN range: *Mar 28 21:42:25.732 IST: %SIPPHONE-6-AUTOREGISTER80: AUTO-REGISTER: 80% of DN range is consumed • Syslog message at 100% utilization of DN range: *Mar 28 21:44:03.328 IST: %SIPPHONE-6-AUTOREGISTER100: AUTO-REGISTER: 100% of DN range is consumed • Syslog message when phone unregisters with Unified CME: *Mar 28 18:03:41.748 IST: %SIPPHONE-6-UNREGISTER: VOICE REGISTER POOL-6 has unregistered. Name:SEPB000B4BAF3DA IP:8.41.20.53 DeviceType:Phone Monitor Mode for Shared Lines In Cisco CME 3.0 and later versions, monitor mode for shared lines provides a visible line status indicating whether the line is in-use or not. A monitor-line lamp is off or unlit only when its line is in the idle call state. The idle state occurs before a call is made and after a call is completed. For all other call states, the monitor line lamp islit. A receptionist who monitorsthe line can see that it isin use and can decide not to send additional calls to that extension, assuming that other transfer and forwarding options are available, or to report the information to the caller; for example, “Sorry, that extension is busy, can I take a message?” In Cisco CME 3.2 and later versions, consultative transfers can occur during Direct Station Select (DSS) for transferring calls to idle monitored lines. The receptionist who transfers a call from a normal line can press the Transfer button and then press the line button of the monitored line, causing the call to be transferred to the phone number of the monitored line. For information about consultative transfer with DSS, see Configure Call Transfer and Forwarding, on page 1178. In Cisco Unified CME 4.0(1) and later versions, the line button for a monitored line can be used as a DSS for a call transfer when the monitored line isidle or in-use, provided that the call transfer can succeed; for example, when the monitored line is configured for Call Forward Busy or Call Forward No Answer. Cisco Unified Communications Manager Express System Administrator Guide 237 Configuring Phones to Make Basic Calls Monitor Mode for Shared Lines Typically, Cisco Unified CME does not attempt a transfer that causes the caller (transferee) to hear a busy tone. However, the system does not check the state of subsequent target numbers in the call-forward path when the transferred call is transferred more than once. Multiple transfers can occur because a call-forward-busy target is also busy and configured for Call Forward Busy. Note In Cisco Unified CME 4.3 and later versions, a receptionist can use the Transfer to Voicemail feature to transfer a caller directly to a voice-mail extension for a monitored line. For configuration information, see Transfer to Voice Mail, on page 551. For configuration information for monitor mode, see Create Directory Numbers for SCCP Phones, on page 253. Monitor mode is intended for use only in the context of shared lines so that a receptionist can visually monitor the in-use status of several users’ phone extensions; for example, for Busy Lamp Field (BLF) notification. To monitor all lines on an individual phone so that a receptionist can visually monitor the in-use status of that phone, see Watch Mode for Phones, on page 238. For BLF monitoring of speed-dial buttons and directory call-lists, see Configure Presence Service, on page 879. Watch Mode for Phones In Cisco Unified CME 4.1 and later versions, a line button that is configured for watch mode on one phone provides BLFnotification for all lines on another phone (watched phone) for which watched directory number is the primary line. Watch mode allows a phone user, such as a receptionist, to visually monitor the in-use status of an individual phone. A user can use the line button that has been set in watch mode as a speed-dial to call the first extension of the watched phone. The watching phone button displays a red light when the watched phone is unregistered in a DND state or in an offhook state. Pressing the button when it is not displaying a red light will dial the number in the same manner it would for a monitor button or the speed-dial button. Incoming calls on a line button that is in watch mode do not ring and do not display caller ID or call-waiting caller ID. The line button for a watched phone can also be used as a DSS for a call transfer when the watched phone is idle. In this case, the phone user who transfers a call from a normal line can press the Transfer button and then press the line button of the watched directory number, causing the call to be transferred to the phone number associated with the watched directory number. For configuration information, see Create Directory Numbers for SCCP Phones, on page 253. If the watched directory number is a shared line and the shared line is not idle on any phone with which it is associated, then in the context of watch mode, the status of the line button indicates that the watched phone is in use. For best results when monitoring the status of an individual phone based on a watched directory number, the directory number configured for watch mode should not be a shared line. To monitor a shared line so that a receptionist can visually monitor the in-use status of several users’ phone extensions, see Monitor Mode for Shared Lines, on page 237. For BLF monitoring of speed-dial buttons and directory call-lists, see Presence Service, on page 875. Cisco Unified Communications Manager Express System Administrator Guide 238 Configuring Phones to Make Basic Calls Watch Mode for Phones PSTN FXO Trunk Lines In Cisco CME 3.2 and later versions, IPphonesrunningSCCPcan be configured to have buttonsfor dedicated PSTN FXO trunk lines, also known as FXO lines. FXO lines may be used by companies whose employees require private PSTN numbers. For example, a salesperson may need a special number that customers can call without having to go through a main number. When a call comes in to the direct number, the salesperson knows that the caller is a customer. In the salesperson’s absence, the customer can leave a voice mail. FXO lines can use PSTN service provider voice mail: when the line button is pressed, the line is seized, allowing the user to hear the stutter dial tone provided by the PSTN to indicate that voice messages are available. BecauseFXO lines behave as private lines, users do not have to dial a prefix,such as 9 or 8, to reach an outside line. To reach phone users within the company, FXO-line users must dial numbers that use the company's PSTN number. For calls to non-PSTN destinations, such as local IP phones, a second directory number must be provisioned. Calls placed to or received on anFXO line have restricted Cisco Unified CME services and cannot be transferred by Cisco Unified CME. However, phone users are able to access hookflash-controlled PSTN services using the Flash softkey. In Cisco Unified CME 4.0(1), the followingFXO trunk enhancements were introduced to improve the keyswitch emulation behavior of PSTN lines on phones running SCCP in a Cisco Unified CME system: • FXO port monitoring—Allows the line button on IP phones to reliably show the status of an FXO port when the port is in use. The status indicator, either a lamp or an icon, depending on the phone model, accurately displays the status of the FXO port during the duration of the call, even after the call is forwarded or transferred. The sameFXO port can be monitored by multiple phones using multiple trunk ephone-dns. • Transfer recall—If a transfer-to phone does not answer after a specified timeout, the call is returned to the phone that initiated the transfer and it resumes ringing on theFXO line button. The directory number must be dual-lined. • Transfer-to button optimization—When an FXO call is transferred to a private extension button on another phone, and that phone has a shared line button for the FXO port, after the transfer is committed and the call is answered, the connected call displays on the FXO line button of the transfer-to phone. Thisfrees up the private extension line on the transfer-to phone. The directory number n must be dual-line. • Dual-line ephone-dns— Directory numbersforFXO lines can now be configured for dual-line to support the FXO monitoring, transfer recall, and transfer-to button optimization features. For configuration information, see Configure Trunk Lines for a Key System on SCCP Phone, on page 284. Codecs for Cisco Unified CME Phones In Cisco CME 3.4, support for connecting and provisioning SIP phones was added. The default codec of the POTS dial peer for an SCCP phone is G.711 and the default codec of a VoIP dial peer for a SIP phone is G.729. If neither the SCCP phone nor the SIP phone in Cisco Unified CME is specifically configured to change the codec, calls between the two phones on the same router will produce a busy signal caused by the mismatched default codecs. To avoid codec mismatch, specify the codec for individual IP phones in Cisco Unified CME. Modify the configuration for either SIP or SCCP phones to ensure that the codec for all phones match. Do not modify the configuration for bothSIPandSCCPphones.For configuration information, see Configure Codecs of Individual Phones for Calls Between Local Phones, on page 280. Cisco Unified Communications Manager Express System Administrator Guide 239 Configuring Phones to Make Basic Calls PSTN FXO Trunk Lines In Cisco Unified CME 4.3, support for G.722-64K and the Internet Low Bit Rate Codec (iLBC) was added. This enables Cisco Unified CME to support the same codecs that are used in newer Cisco Unified IP phones, mobile wireless networks, and internet telephony without transcoding. This feature provides support for the following: • iLBC and G.722-capable SIP and SCCP IP phones in Cisco Unified CME. • iLBC-capable SCCP analog endpoints and remote phones in Cisco Unified CME. • Conferencing support for G.722 and ILBC. • Supplementary services, such as transfer, call forward, MOH, support for G.722 and iLBC, including any supplementary services that require transcoding between G.722 and any other codec. • Transcoding for G.722 and iLBC, including G.722 to G.711 and G.722 to any other codec. With the introduction of G.722 and iLBC codecs, there can be a disparity between codec capabilities of different phones and different firmware versions on same phone type. For example, when a H.323 call is established, the codec is negotiated based on the dial-peer codec and the assumption isthat the codecssupported on H.323 side are supported by the phones. This assumption is not valid after G.722 and ILBC codec are introduced in your network. If the phones do not support the codecs on the H.323 side, a transcoder is required. To avoid transcoding in this situation, configure incoming dial-peers so that G.722 and iLBC codecs are not used for calls to phones that are not capable of supporting these codecs. Instead, configure these phones for G.729 or G.711. Also, when configuring shared directory numbers, ensure that phones with the same codec capabilities are connected to the shared directory number. G.722-64K TraditionalPSTN telephony codecs, including G.711 and G.729, are classified as narrowband codecs because they encode audio signals in a narrow audio bandwidth, giving telephone calls a characteristic “tinny” sound. Wideband codecs, such as G.722, provide a superior voice experience because wideband frequency response is 200 Hz to 7 kHz compared to narrowband frequency response of 300 Hz to 3.4 kHz. At 64 kbps, the G.722 codec offers conferencing performance and good music quality. A wideband handset for certain Cisco Unified IP phones, such as the Cisco Unified IP Phone 7906G, 7911G, 7941G-GE, 7942G, 7945G, 7961G-GE, 7962G, 7965G, and 7975G, take advantage of the higher voice quality provided by wideband codecs to enhance end-user experience with high-fidelity wideband audio. When users use a headset that supports wideband, they experience improved audio sensitivity when the wideband setting on their phones is enabled. You can configure phone-user access to the wideband headset setting on IPphones by setting the appropriate VendorConfig parameters in the phone’s configuration file. For configuration information, see Modify Cisco Unified IP Phone Options, on page 1437. If the system is not configured for a wideband codec, phone users may not detect any additional audio sensitivity, even when they are using a wideband headset. You can configure the G.722-64K codec at a system-level for all calls through Cisco Unified CME. For configuration information, see Modify the Global Codec, on page 278. To configure individual phones and avoid codec mismatch for calls between local phones, see Configure Codecs of Individual Phones for Calls Between Local Phones, on page 280. iLBC codec Internet Low Bit Rate Codec (iLBC) enables graceful speech quality degradation in a network where frames get lost. Consider iLBC suitable for real-time communications, such as telephony and video conferencing, streaming audio, archival, and messaging. This codec is widely used by internet telephony softphones.The SIP, SCCP, and MGCP call protocols support use of the iLBC as an audio codec. iLBC provides better voice Cisco Unified Communications Manager Express System Administrator Guide 240 Configuring Phones to Make Basic Calls Codecs for Cisco Unified CME Phones quality than G.729 but less than G.711. Supporting codecs that have standardized use in other networks, such as iLBC, enables end-to-end IP calls without the need for transcoding. To configure individual SIP or SCCP phones, including analog endpoints in Cisco Unified CME, and avoid codec mismatch for calls between local phones,see Configure Codecs of IndividualPhonesfor Calls Between Local Phones, on page 280. Analog Phones Cisco Unified CME supports analog phones and fax machines using Cisco Analog Telephone Adaptors(ATAs) or FXS ports in SCCP, H.323 mode, and fax pass-through mode. The FXS ports used for analog phones or fax can be on a Cisco Unified CME router, Cisco VG224 voice gateway, or integrated services router (ISR). This section provides information on the following topics: Cisco ATAs in SCCP Mode You can configure the Cisco ATA 186 or Cisco ATA 188 to cost-effectively support analog phones using SCCP in Cisco IOS Release 12.2(11)T and later versions. Each Cisco ATA enables two analog phones to function as IP phones. For configuration information, see Configure Cisco ATA Support, on page 295. FXS Ports in SCCP Mode FXS ports on Cisco VG224 Voice Gateways and Cisco 2800 Series and Cisco 3800 Series ISRs can be configured for SCCP supplementary features. For information about using SCCP supplementary features on analogFXSports on a Cisco IOSgateway under the control of a Cisco Unified CME router,seeSupplementary Services Features for FXS Ports on Cisco IOS Voice Gateways Configuration Guide. FXS Ports in H.323 Mode FXS ports on platforms that cannot enable SCCP supplementary features can use H.323 mode to support call waiting, caller ID, hookflash transfer, modem pass-through, fax (T.38, Cisco fax relay, and pass-through), andPLAR. These features are provisioned as Cisco IOSvoice features and not as Cisco Unified CME features. When using Cisco Unified CME, you can configureFXSportsin H.323 mode for call waiting or hookflash transfer, but not both at the same time. Note Fax Support Cisco Unified CME 4.0 introduced the use of G.711 fax pass-through for SCCP on the Cisco VG224 voice gateway and Cisco ATA. In Cisco Unified CME 4.0(3) and later versions, fax relay using the Cisco-proprietary fax protocol isthe only supported fax option forSCCP-controlledFXSports on the Cisco VG224 and integrated service routers. For more information on fax relay, see Fax Relay, on page 749. Cisco Unified Communications Manager Express System Administrator Guide 241 Configuring Phones to Make Basic Calls Analog Phones Cisco ATA-187 Cisco Unified CME 9.0 and later versions provide voice and fax support on Cisco ATA-187. Cisco ATA-187 is aSIP-based analog telephone adaptor that turnstraditional telephone devicesinto IPdevices. Cisco ATA-187 can connect with a regular analog FXS phone or fax machine on one end, while the other end is an IP side that uses SIP for signaling and registers to Cisco Unified CME as a Cisco Unified SIP IP phone. Cisco ATA-187 functions as a Cisco Unified SIP IP phone that supports T.38 fax relay and fax pass-through, enabling the real-time transmission of fax over IP networks. The fax rate is from 7.2 to 14.4 kbps. For information on how to configure voice and fax support on Cisco ATA-187, see Configure Voice and T.38 Fax Relay on Cisco ATA-187, on page 298. For information on the features supported in Cisco ATA-187, see Phone Feature Support Guide for Unified CME, Unified SRST, Unified E-SRST, and Unified Secure SRST. For more information on Cisco ATA-187, see Cisco ATA 187 Analog Telephone Adaptor Administration Guide for SIP. Cisco VG202, VG204, and VG224 Auto Configuration The Auto Configuration feature in Cisco Unified CME 7.1 and later versions allows you to automatically configure the Cisco VG202, VG204, and VG224 Analog Phone Gateway. You can configure basic voice gateway information in Cisco Unified CME, which then generates XML configuration files for the gateway and saves the files to either the default location in system:/its/ or to a location you define in system memory, flash memory, or an external TFTPserver. When the voice gateway powers up, it downloadsthe configuration files from Cisco Unified CME and based on the information in the files, the voice gateway provisions its analog voice ports and creates the corresponding dial peers. Using this Auto Configuration feature with the existing Auto Assign feature allows you to quickly set up analog phones to make basic calls. After the voice gateway is properly configured and it downloads its XML configuration files from Cisco Unified CME, the SCCP telephony control (STC) application registers each configured voice port to Cisco Unified CME. If you enable the Auto Assign feature, the gateway automatically assigns the next available directory number from the pool set by the auto assign command, binds that number to the requesting voice port, and creates an ephone entry associated with the voice port. The MAC address for the ephone entry is calculated based on the MAC address of the gateway and the port number. You can manually assign a directory number to each of the voice ports by creating the ephone-dn and corresponding ephone entry. You can initiate a reset or restart of the analog endpoints from Cisco Unified CME, which triggers the autoconfiguration process. The voice gateway downloads its configuration files from Cisco Unified CME and applies the new changes. For configuration information, see Auto-Configuration for Cisco VG202, VG204, and VG224, on page 302. Internet Protocol - Secure Telephone Equipment Support Cisco Unified CME 8.0 addssupport for a new secure endpoint, InternetProtocol -Secure Telephone Equipment (IP-STE). IP-STE is a standalone, V.150.1 capable device which functions like a 7960 phone with secure communication capability. IP-STE has native state signaling events (SSE /SPRT) support and supportsSCCP protocol. IP-STE usesthe device ID 30035 when registering to aSCCPserver. However, only V.150.1 modem Cisco Unified Communications Manager Express System Administrator Guide 242 Configuring Phones to Make Basic Calls Internet Protocol - Secure Telephone Equipment Support relay is implemented in an IP-STE stack and V150.1 modem passthrough is not supported. Therefore, the response to capability query from Cisco Unified CME only includes media_payload_XV150_MR_711U and media_payload_xv150_MR_729A. For configuration information, see Configure Secure IP Phone (IP-STE) on SCCP Phone, on page 311. The following support is added for IP-STE endpoints: • The IP-STE endpoint allowssecure communication between gateway-connected legacy analogSTE/STU devices and IP STE devices using existing STE devices in voice networks. • Secure voice and secure data modes from STE/STU devices connected to Cisco IOS gateway foreign exchange station (FXS) and BRI ports to an IP-STE. • Support for the state signaling events (SSE) protocol, allowing for modem signaling end-to-end and VoIP to modem over IP (MoIP) transition and operation. • Interoperation between line-side and trunk-side gateways and Cisco Unified CME to determine codec support and V.150.1 negotiation. You can configure gateway-attached devices to support either modem relay, modem pass-through, both modem transport methods, or neither method. Secure Communications Between STU, STE, and IP-STE Secure Telephone Equipment (STE) and Secure Telephone Units (STUs) encrypt voice and data streams with government proprietary algorithms (Type-1 encryption). To provide support for the legacy STEs and STUs and next generation IP Secure Telephone Equipment (IP-STE), voice gateways must be able to support voice and data in secure mode within the IPnetwork and be able to pass calls within and also to and from government voice networks. In earlier versions of Cisco Unified CME, Cisco IOSgatewayssupported secure voice and data communication between legacy STE and STU devices using modem pass-through method. Cisco Unified CME 8.0 and later versions control the secure endpoints by implementing a subset of v.150.1 modem relay protocol and ensures secure communications between IP-STE endpoints andSTE/STU endpoints. This allows Cisco Unified CME SCCP controlled secure endpoints to communicate with the IP-STE or legacy endpoints in secure mode. SCCP Media Control for Secure Mode IP-STE endpoints use the V.150.1 modem relay transport method usingFuture Narrow Band Digital Terminal (FNBDT)signaling over a V.32 or V.34 data pump forsecure communication with other legacySTE endpoints. However, IP-STE endpoints cannot communicate withSTU endpoints becauseSTU endpoints use the modem pass-through method using a proprietary data pump and do not support the FNBDT signaling. Secure communication between IP-STE endpoints and legacy STE endpoints support the following encryption-capable endpoints: • STE—Specialized encryption-capable analog or BRI phonesthat can communicate over V.150.1 modem relay or over modem pass-through, also known as Voice Band Data (VBD). • IP-STE—Specialized encryption-capable IP phones that communicate only over V.150.1 modem relay. • STU—Specialized encryption-capable analog phones that operate only over NSE-based modem pass-through connections. Cisco Unified Communications Manager Express System Administrator Guide 243 Configuring Phones to Make Basic Calls Internet Protocol - Secure Telephone Equipment Support Table 15: Supported Secure Call Scenarios and Modem Transport Methods , on page 244 lists call scenarios between devices along with modem transport methods that the IP-STE endpoints use to communicate with STE endpoints. Table 15: Supported Secure Call Scenarios and Modem Transport Methods Device Type STU STE IP-STE STU Pass-through Pass-through None STE Pass-through Pass-through Relay IP-STE None Relay Relay Secure Communication Between STE, STU, and IP-STE Across SIP Trunk The Secure Device Provisioning (SDP) for SIP end-to end negotiation includes four proprietary media types for secure communication between Cisco Unified CME and SIP trunk. These proprietary VBD or Modem Relay (MR) media types can be encoded into media attributes of SDP media lines. VBD capabilities are signaled using theSDPextension mechanism and Cisco proprietary nomenclature. MR capabilities are signaled through V.150.1. The following example shows VBD capabilities. The SDP syntax are based on RFC 2327 and V.150.1 Appendix E. a=rtpmap:100 X-NSE/8000 a=rtpmap:118 v150fw/8000 a=sqn:0 a=cdsc:1 audio RTP/AVP 118 0 18 a=cdsc: 4 audio udsprt 120 a=cpar: a=sprtmap: 120 v150mr/8000 Remote Teleworker Phones IP phones or a Cisco IP Communicator can be connected to a Cisco Unified CME system over a WAN to support teleworkers who have offices that are remote from the Cisco Unified CME router. The maximum number of remote phones that can be supported is determined by the available bandwidth. IP addressing is a determining factor in the most critical aspect of remote teleworker phone design. The following two scenarios represent the most common designs, the second one is the most common for small and medium businesses: • Remote site IP phones and the hub Cisco Unified CME router use globally routable IP addresses. • Remote site IP phones use NAT with unroutable private IP addresses and the hub Cisco Unified CME router uses a globally routable address (see Figure 13: Remote Site IP Phones Using NAT, on page 245). This scenario results in one-way audio unless you use one of the following workarounds: ◦Configure static NAT mapping on the remote site router (for example, a Cisco 831 Ethernet Broadband Router) to convert between a private address and a globally routable address. This solution uses fewer Cisco Unified CME resources, but voice is unencryped across the WAN. ◦Configure an IPsec VPN tunnel between the remote site router (For example, a Cisco 831 Ethernet Broadband Router) and the Cisco Unified CME router. Thissolution requires Advanced IPServices Cisco Unified Communications Manager Express System Administrator Guide 244 Configuring Phones to Make Basic Calls Remote Teleworker Phones or higher image on the Cisco Unified CME router if thisrouter is used to terminate the VPN tunnel. Voice will be encrypted across the WAN. This method will also work with the Cisco VPN client on a PC to support a Cisco IP Communicator. Figure 13: Remote Site IP Phones Using NAT Media Termination Point for Remote Phones Media termination point (MTP) configuration is used to ensure that Real-Time Transport Protocol (RTP) media packets from remote phones always transit through the Cisco Unified CME router. Without the MTP feature, a phone that is connected in a call with another phone in the same Cisco Unified CME system sends its media packets directly to the other phone, without the packets going through the Cisco Unified CME router. MTP forces the packets to be sourced from the Cisco Unified CME router. When this configuration is used to instruct a phone to alwayssend its media packetsto the Cisco Unified CME router, the router acts as an MTP or proxy and forwards the packets to the destination phone. If a firewall is present, it can be configured to pass the RTP packets because the router uses a specified UDP port for media packets. In this way, RTP packets from remote IP phones can be delivered to IP phones on the same system though they must pass through a firewall. You must use the mtp command to explicitly enable MTP for each remote phone that sends media packets to Cisco Unified CME. One factor to consider is whether you are using multicast music on hold (MOH) in your system. Multicast packets generally cannot be forwarded to phones that are reached over a WAN. The multicast MOH feature checks to see if MTP is enabled for a phone and if it is, MOH is not sent to that phone. If you have a WAN configuration that can forward multicast packets and you can allow RTP packets through your firewall, you can decide not to use MTP. For configuration information, see Enable Remote Phone, on page 307. G.729r8 Codec on Remote Phones You can select the G.729r8 codec on a remote IP phone to help save network bandwidth. The default codec is G.711 mu-law. If you use the codec g729r8 command without the dspfarm-assist keyword, the use of the G.729 codec is preserved only for calls between two phones on the Cisco Unified CME router (such as between an IP phone and another IP phone or between an IP phone and an FXS analog phone). The codec g729r8 command has no effect on a call directed through a VoIP dial peer unless the dspfarm-assist keyword is also used. For configuration information, see Enable Remote Phone, on page 307. For information about transcoding behavior when using the G.729r8 codec, see Transcoding When a Remote Phone Uses G.729r8, on page 478. Cisco Unified Communications Manager Express System Administrator Guide 245 Configuring Phones to Make Basic Calls Remote Teleworker Phones Busy Trigger and Channel Huntstop for SIP Phones Cisco Unified CME 7.1 introduced busy trigger and huntstop channel support for SIP phones, such as the Cisco Unified IP Phone 7941G, 7941GE, 7942G, 7945G, 7961G, 7961GE, 7962G, 7965G, 7970G, 7971GE, 7975G, and 7985.For theseSIPphones, the number of channelssupported islimited by the amount of memory on the phone. To prevent incoming calls from overloading the phone, you can configure a busy trigger and a channel huntstop for the directory numbers on the phone. The Channel Huntstop feature limitsthe number of channels available for incoming callsto a directory number. If the number of incoming calls reaches the configured limit, Cisco Unified CME does not present the next incoming call to the directory number. This reserves the remaining channels for outgoing calls or for features, such as call transfer and conferencing. The Busy Trigger feature limits the calls to a directory number by triggering a busy response. After the number of active calls, both incoming and outgoing, reaches the configured limit, Cisco Unified CME forwards the next incoming call to the Call Forward Busy destination or rejects the call with a busy tone if Call Forward Busy is not configured. The busy-trigger limit applies to all directory numbers on a phone. If a directory number is shared among multiple SIP phones, Cisco Unified CME presents incoming calls to those phones that have not reached their busy-trigger limit. Cisco Unified CME initiates the busy trigger for an incoming call only if all the phones sharing the directory number exceed their limit. For configuration information,see Create Directory NumbersforSIPPhones, on page 263 and Assign Directory Numbers to SIP Phones, on page 266. Multiple Calls Per Line Cisco Unified CME 9.0 provides support for the Multiple Calls Per Line (MCPL) feature on Cisco Unified 6921, 6941, 6945, and 6961 SIP IP phones and Cisco Unified 8941 and 8945 SCCP and SIP IP phones. Before Cisco Unified CME 9.0, the maximum number of calls supported for every directory number (DN) on Cisco Unified 8941 and 8945 SCCP IP phones was restricted to two. With Cisco Unified CME 9.0, the MCPL feature overcomes the limitation on the maximum number of calls per line. In Cisco Unified CME 9.0, the MCPL feature is not supported on Cisco Unified 6921, 6941, 6945, and 6961 SCCP IP phones. Cisco Unified 8941 and 8945 SCCP IP Phones Before Cisco Unified CME 9.0, Cisco Unified 8941 and 8945 SCCP IP phones only supported two incoming calls per line and a third channel was reserved for call transfers or conference calls. These phones were also hardcoded with ephone-dn octo-line, huntstop-channel 2,max-calls -per-button 3, and busy-trigger-per-button 2. In Cisco Unified CME 9.0, you can configure the ephone-dn dn-tag [dual-line | octo-line] in global configuration mode and the max-calls-per-button and busy-trigger-per-button commands in ephone or ephone-template configuration mode for Cisco Unified 8941 and 8945 SCCP IP phones to configure a DN and enable the number of calls per DN, set the maximum number of calls allowed on an octo-line DN, and set the maximum number of calls allowed on an octo-line DN before activating a busy tone. For configuration information, see Configure the Maximum Number of Calls on SCCP Phone, on page 319. Cisco Unified Communications Manager Express System Administrator Guide 246 Configuring Phones to Make Basic Calls Busy Trigger and Channel Huntstop for SIP Phones Cisco Unified 6921, 6941, 6945, 6961, 8941, and 8945 SIP IP Phones In Cisco Unified CME 9.0, the default values for the busy-trigger-per-button command is 1 for the Cisco Unified 6921, 6941, 6945, and 6961 SIP IP phones and 2 for the Cisco Unified 8941 and 8945 SIP IP phones. You can configure the maximum number of calls before a phone receives a busy tone. For example, if you configure busy-trigger-per-button 2 in voice register pool configuration mode for a Cisco Unified 6921, 6941, 6945, or 6961 SIP IP phone, the third incoming call to the phone receives a busy tone. For information on the Busy Trigger feature on Cisco Unified SIP IP phones, see Busy Trigger and Channel Huntstop for SIP Phones, on page 246. For configuration information, see Configure the Busy Trigger Limit on SIP Phone, on page 322. Digit Collection on SIP Phones Digit strings dialed by phone users must be collected and matched against predefined patterns to place calls to the destination corresponding to the user's input. Before Cisco Unified CME 4.1, SIP phone users had to press the DIAL softkey or # key or wait for the interdigit-timeout to trigger call processing. In Cisco Unified CME 4.1 and later versions, two methods of collecting and matching digits are supported for SIP phones, depending on the model of phone: Key Press Markup Language Digit Collection KeyPress Markup Language (KPML) usesSIPSUBSCRIBE and NOTIFY methods to report user input digit by digit. Each digit dialed by the phone user generates its own signaling message to Cisco Unified CME, which performs pattern recognition by matching a destination pattern to a dial peer as it collects the dialed digits. This process of relaying each digit immediately is similar to the process used by SCCP phones. It eliminates the need for the user to press the Dial softkey or wait for the interdigit timeout before the digits are sent to Cisco Unified CME for processing. KPML is supported on Cisco Unified IP Phones 7911G, 7941G, 7941GE, 7961G, 7961GE, 7970G, and 7971GE. For configuration information, see Enable KPML on a SIP Phone, on page 273. SIP Dial Plans A dial plan is a set of dial patterns that SIP phones use to determine when digit collection is complete after a user goes off-hook and dials a destination number. Dial plans allow SIPphonesto perform local digit collection and recognize dial patterns as user input is collected. After a pattern is recognized, the SIP phone sends an INVITE message to Cisco Unified CME to initiate the call to the number matching the user's input. All of the digits entered by the user are presented as a block to Cisco Unified CME for processing. Because digit collection is done by the phone, dial plans reduce signaling messages overhead compared to KPML digit collection. SIP dial plans eliminate the need for a user to press the Dial softkey or # key or to wait for the interdigit timeout to trigger an outgoing INVITE. You configure a SIP dial plan and associate the dial plan with a SIP phone. The dial plan is downloaded to the phone in the configuration file. You can configure SIP dial plans and associate them with the following SIP phones: • Cisco Unified IPPhones 7911G, 7941G, 7941GE, 7961G, 7961GE, 7970G, and 7971GE—These phones use dial plans and support KPML. If both a dial plan and KPML are enabled, the dial plan has priority. Cisco Unified Communications Manager Express System Administrator Guide 247 Configuring Phones to Make Basic Calls Digit Collection on SIP Phones If a matching dial plan is not found and KPML is disabled, the user must wait for the interdigit timeout before the SIP NOTIFY message is sent to Cisco Unified CME. Unlike other SIP phones, these phones do not have a Dial softkey to indicate the end of dialing, except when on-hook dialing is used. In this case, the user can press the Dial softkey at any time to send all the dialed digits to Cisco Unified CME. • Cisco Unified IP Phones 7905, 7912, 7940, and 7960—These phones use dial plans and do not support KPML. If you do not configure a SIP dial plan for these phones, or if the dialed digits do not match a dial plan, the user must press the Dial softkey or wait for the interdigit timeout before digits are sent to Cisco Unified CME. When you reset a phone, the phone requests its configuration files from the TFTP server, which builds the appropriate configuration files depending on the type of phone. • Cisco Unified IP Phones 7905 and 7912—The dial plan is a field in their configuration files. • Cisco Unified IP Phones 7911G, 7940, 7941G, 7941GE, 7960, 7961G, 7961GE, 7970G, and 7971GE—The dial plan is a separate XML file that is pointed to from the normal configuration file. For configuration information for Cisco Unified CME, see Configure Dial Plans for SIP Phones, on page 269. Session Transport Protocol for SIP Phones In Cisco Unified CME 4.1 and later versions, you can select TCP as the transport protocol for connecting supported SIP phones to Cisco Unified CME. Previously only UDP was supported. TCP is selected for individualSIPphones by using the session-transport command in voice register pool or voice register template configuration mode. For configuration information, see Select Session-Transport Protocol for a SIP Phone, on page 275. Real-Time Transport Protocol Call Information Display Enhancement Before Cisco Unified CME 8.8, active RTP call information on ephone call legs were determined only by parsing the show ephone registered or show ephone offhook command output. The show voip rtp connections command showed active call information in the system but it did not apply to ephone call legs. In Cisco Unified CME 8.8 and later versions, you can display information on active RTP calls, including the ephone tag number of the phone with an active call, the channel of the ephone-dn, and the caller and called party’s numbersfor the connection for both local and remote endpoints, using the show ephone rtpconnections command. The output from this command provides an overview of all the connectionsin the system, narrowing the criteria for debugging pulse code modulation and Cisco Unified CME packets without a sniffer. When an ephone to non-ephone call is made, information on the non-ephone does not appear in a show ephone rtpconnections command output. To display the non-ephone call information, use the show voip rtp connections command. Note The following sample output shows all the connected ephones in the Cisco Unified CME system. The sample output shows five active ephone connections with one of the phones having the dspfarm-assist keyword configured to transcode the code on the local leg to the indicated codec. The output also shows four ephone-to-ephone calls, represented in the CallID columns of both the RTP connection source and RTP connection destination by zero values. Cisco Unified Communications Manager Express System Administrator Guide 248 Configuring Phones to Make Basic Calls Session Transport Protocol for SIP Phones Normally, a phone can have only one active connection but in the presence of a whisper intercom call, a phone can have two. In the sample output, ephone-40 has two active calls: it is receiving both a normal call and a whisper intercom call. The whisper intercom call is being sent by ephone-6, which has an invalid LocalIP of 0.0.0.0. The invalid LocalIP indicates that it does not receive RTP audio because it only has a one-way voice connection to the whisper intercom call recipient. Router# show ephone rtp connections Ephone RTP active connections : Ephone Line DN Chan SrcCallID DstCallID Codec (xcoded?) SrcNum DstNum LocalIP RemoteIP ephone-5 1 5 1 15 14 G729 (Y) 1005 1102 [192.168.1.100]:23192 [192.168.1.1]:2000 ephone-6 2 35 1 0 0 G711Ulaw64k (N) 1035 1036 [0.0.0.0]:0 [192.168.1.81]:21256 ephone-40 1 140 1 0 0 G711Ulaw64k (N) 1140 1141 [192.168.1.81]:21244 [192.168.1.70]:20664 ephone-40 2 36 1 0 0 G711Ulaw64k (N) 1035 1036 [192.168.1.81]:21256 [192.168.1.1]:2000 ephone-41 1 141 1 0 0 G711Ulaw64k (N) 1140 1141 [192.168.1.70]:20664 [192.168.1.81]:21244 Found 5 active ephone RTP connections Ephone-Type Configuration In Cisco Unified CME 4.3 and later versions, you can dynamically add a new phone type to your configuration without upgrading your Cisco IOS software. New phone models that do not introduce new features can easily be added to your configuration without requiring a software upgrade. The ephone-type configuration template is a set of commands that describe the features supported by a type of phone, such as the particular phone type's device ID, number of buttons, and security support. Other phone-related settings under telephony-service, ephone-template, and ephone configuration mode can override the features set within the ephone-type template. For example, an ephone-type template can specify that a particular phone type supports security and another configuration setting can disable this feature. However, if an ephone-type template specifies that this phone does not support security, the other configuration cannot enable support for the security feature. Cisco Unified CME uses the ephone-type template to generate XML files to provision the phone. System-defined phone types continue to be supported without using the ephone-type configuration. Cisco Unified CME checks the ephone-type against the system-defined phone types. If there is conflict with the phone type or the device ID, the configuration is rejected. For configuration information, see Configure Ephone-Type Templates for SCCP Phones, on page 256. 7926G Wireless SCCP IP Phone Support Cisco Unified CME 8.6 adds support for the Cisco Unified 7926G Wireless SCCP IP phone. The 7926G wireless phone is phone similar to the 7925 wireless phone with a 2D barcode and EA15 module attached. The 7926G wireless phone is capable of scanning functionality. For more details on phone features and functionality, see Cisco Unified IP Phone 7900 Series User Guide. Cisco Unified CME 8.6 supports the scanning function on the 7926G SCCP wireless phone using the ephone built-in device type. Table 16: Supported Values for Ephone-Type Command , on page 250 shows supported values for the ephone-type for 7926G wireless phone. Cisco Unified Communications Manager Express System Administrator Guide 249 Configuring Phones to Make Basic Calls Ephone-Type Configuration Table 16: Supported Values for Ephone-Type Command Supported Device device-id device-type num-buttons max-presentation Cisco Unified 577 7926 6 2 Wireless IP Phone 7926G To support service provisioning, an XML file is constructed externally and applied to the ephone-template of the phone. To allow the phone to read the external XML file, you are required to create-cnf and download the XML file to the ephone. For more information on configuring PhoneServices XML file, see Configure Phone Services XML File for Cisco Unified Wireless Phone 7926G, on page 313. The following is an example of the XML file: 0 Missed Calls Application:Cisco/MissedCalls Store Ops Store Ops http://1.4.206.105/Midlets/StoreOps.jad?StoreNumber=1777 CiscoSystems 0.0.82 KEM Support for Cisco Unified SIP IP Phones For information on the KEM support for Cisco Unified 8851/51NR, 8861, 8961, 9951, and 9971 SIP IP Phones, see Phone Feature Support Guide for Unified CME, Unified SRST, Unified E-SRST, and Unified Secure SRST. Key Mapping The mapping of configured keys on a phone depends on the number of KEMs attached to the phone. If only one KEM is attached to a phone and the number of keys configured is 114, only 36 keys on the KEM are mapped to the configured keys on the phone. The rest of the keys are not visible on the phone or the KEM. Call Control All call control features are supported by KEMs on Cisco Unified 8961 SIP IP phones. Any feature that can be configured on the phone keys can also be configured on the KEM. Because the Transfer, Hold, and Conference keys are built-in keys on Cisco Unified 8851/51NR, 8861, 8961, 9951 and 9971 SIP IP Phones, these features cannot be mapped to the keys on the KEMs. Cisco Unified Communications Manager Express System Administrator Guide 250 Configuring Phones to Make Basic Calls KEM Support for Cisco Unified SIP IP Phones XML Updates • There is no separate firmware for KEMs, instead they are built in as part of the phones. • The number of XML entries in the configuration file increases with the number of keys configured. • The device type for KEMs is CKEM and the maximum number of supported keys on each KEM device is 36. Restrictions for KEM Support • KEMs are not supported for Cisco Unified SCCP IP phones and Cisco Unified SIP IP phones other than the Cisco Unified 8851/51NR, 8861, 8961, 9951, and 9971 SIP IP phones. • Features configured on keys are disabled when supported Cisco Unified SIP IP phones are in Cisco Unified SIP SRST. • All Cisco Unified 8851/51NR, 8861, 8961, 9951, and 9971 SIP IP phone restrictions and limitations apply to KEMs. • All Cisco Unified CME and Cisco UnifiedSIPSRST feature restrictions and limitations apply to KEMs. For more information on how the blf-speed-dial, number, and speed-dial commands, in voice register pool configuration mode, have been modified, see Cisco Unified Communications Manager Express Command Reference. For information on installing KEMs on Cisco Unified IP Phone, see “Installing a Key Expansion Module on the Cisco Unified IP Phone” section of Cisco Unified IP Phone 8961, 9951, and 9971 Administration Guide for Cisco Unified Communications Manager 10.0 . For information on installing KEMs on Cisco Unified 8811, 8841, 8851, 8851NR, and 8861Phones,see Cisco IP Phone Key Expansion Module section of Cisco IP Phone 8800 Series Administration Guide for Cisco Unified Communications Manager. Fast-Track Configuration Approach for Cisco Unified SIP IP Phones In Cisco Unified CME Release 10.0, theFast-Track Configuration feature provides a new configuration utility using which you can input the phone characteristics of a new SIP phone model. This utility allows you to configure the existingSIPline featuresto the new SIPphone models. In the fast-track configuration, an option is provided to input an existing SIP phone as a reference phone. This feature is supported only on new SIP phone models that do not need any changes in the software protocols and the Cisco Unified CME application. To deploy Cisco UnifiedSIPIPphones on Cisco Unified CME using the fast-track configuration approach, you require Cisco IOS Release 15.3(3)M or a later release. Note Forward Compatibility When a new SIPphone model is configured using the fast-track configuration approach. and the Cisco Unified CME is upgraded to a later version that supports the new SIP phone model, the fast-track configuration Cisco Unified Communications Manager Express System Administrator Guide 251 Configuring Phones to Make Basic Calls Fast-Track Configuration Approach for Cisco Unified SIP IP Phones pertaining to that SIP phone model is removed automatically. If the Cisco Unified CME is downgraded to a version that does not have the built-in support, the fast-track configuration should be applied again. To support Fast-Track Configuration feature, the voice register pool-type command has been introduced in the global configuration mode. The properties of the new SIPphone can be configured under the voice register pool-type submode. In addition to the explicit configuration of the phone’s properties, the reference-pooltype option can be used to inherit the properties of an existing SIP phone. Localization support CME supportslocalization for phonesin fast-track mode through locale installer. However, the locale package should have .jar files for a specific phone model to make the feature work. To use the locale installer, see Locale Installer for Cisco Unified SIP IP Phones, on page 411 . For new SIPphone models validated usingFast-track configuration and the supported locale package version, see Phone Feature Support Guide for Unified CME, Unified SRST, Unified E-SRST, and Unified Secure SRST. Restrictions for Fast-Track Support • The fast-track configuration does not allow you to use the following phone models as reference phone: ◦ATA—Cisco ATA-186 and Cisco ATA-188 ◦7905—Cisco Unified IP Phone 7905 and Cisco Unified IP Phone 7905G ◦7912—Cisco Unified IP Phone 7912 and Cisco Unified IP Phone 7912G ◦7940—Cisco Unified IP Phone 7940 and Cisco Unified IP Phone 7940G ◦7960—Cisco Unified IP Phone 7960 and Cisco Unified IP Phone 7960G ◦P100—PingTel Xpressa 100 ◦P600—Polycom SoundPoint IP 600 ◦Existing Cisco Unified SIP IP phones are not allowed to be configured as new Cisco Unified SIP IP phones using the fast-track configuration approach. ◦The reference-pooltype functionality is allowed only on existing SIP phone models. New SIP phone models configured using the fast-track configuration approach cannot be used as a reference phone. ◦The fast-track configuration approach supports only the XML format and not support the text format for phone configuration. ◦The fast-track approach does not support the new SIP phone models that have a new call flow, new message flow, or a new configuration file format that are not supported by the Cisco Unified CME. For configuration information, see Provision SIP Phones to Use the Fast-Track Configuration Approach, on page 325. For configuration examples, see Example for Fast-Track Configuration Approach, on page 340. Cisco Unified Communications Manager Express System Administrator Guide 252 Configuring Phones to Make Basic Calls Fast-Track Configuration Approach for Cisco Unified SIP IP Phones Configure Phones for a PBX System This section contains the following tasks: Create Directory Numbers for SCCP Phones To create a directory number in Cisco Unified CME for a SCCP phone, intercom line, voice port, or a message-waiting indicator (MWI), perform the following steps for each directory number to be created. Each ephone-dn becomes a virtual line, or extension, on which call connections can be made. Each ephone-dn configuration automatically creates one or more virtual dial peers and virtual voice ports to make those call connections. To create and assign directory numbersto be included in an overlay set,see Configure Overlaid Ephone-dns on SCCP Phones, on page 1326. Note Restriction • The Cisco Unified IP Phone 7931G is a SCCP keyset phone and, when configured for a key system, does not support the dual-line option for a directory number. To configure a Cisco Unified IP Phone 7931G, see Configure Phones for a Key System, on page 282. • Octo-line directory numbers are not supported by the Cisco Unified IP Phone 7902, 7920, or 7931, or by analog phones connected to the Cisco VG224 or Cisco ATA. • Octo-line directory numbers are not supported in button overlay sets. • Octo-line directory numbers do not support the trunk command. Before You Begin • Maximum number of directory numbers must be changed from the default of 0 by using the max-dn command. • Octo-line directory numbers are supported in Cisco Unified CME 4.3 and later versions. SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-dn dn-tag [dual-line | octo-line] 4. number number [secondary number] [no-reg [both | primary]] 5. huntstop [channel number] 6. name name 7. end Cisco Unified Communications Manager Express System Administrator Guide 253 Configuring Phones to Make Basic Calls Configure Phones for a PBX System DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters ephone-dn configuration mode to create a directory number for a SCCP phone. ephone-dn dn-tag [dual-line | octo-line] Example: Router(config)# ephone-dn 7 octo-line Step 3 • dual-line—(Optional) Enablestwo calls per directory number.Supports features such as call waiting, call transfer, and conferencing with a single ephone-dn. • octo-line—(Optional) Enables eight calls per directory number. Supported in Cisco Unified CME 4.3 and later versions. • To change the line mode of a directory number, for example from dual-line to octo-line or the reverse, you must first delete the ephone-dn and then recreate it. number number [secondary number] Configures an extension number for this directory number. [no-reg [both | primary]] Step 4 • Configuring a secondary numbersupportsfeaturessuch as call waiting, call transfer, and conferencing with a single ephone-dn. Example: Router(config-ephone-dn)# number 2001 (Optional) Enables Channel Huntstop, which keeps a call from hunting to the next channel of a directory number if the first channel is busy or does not answer. huntstop [channel number] Example: Router(config-ephone-dn)# huntstop channel 4 Step 5 • channel number—Number of channels available to accept incoming calls. Remaining channels are reserved for outgoing calls and features such as call transfer, call waiting, and conferencing. Range: 1 to 8. Default: 8. • number argument is supported for octo-line directory numbers only. Step 6 name name (Optional) Associates a name with this directory number. Example: Router(config-ephone-dn)# name Smith, John • Name is used for caller-ID displays and in the local directory listings. • Must follow the name order that is specified with the directory command. Cisco Unified Communications Manager Express System Administrator Guide 254 Configuring Phones to Make Basic Calls Create Directory Numbers for SCCP Phones Command or Action Purpose end Returns to privileged EXEC mode. Example: Router(config-ephone-dn)# end Step 7 Example for Nonshared Octo-Line Directory Number In the following example, ephone-dn 7 is assigned to phone 10 and not shared by any other phone. There are two active calls on ephone-dn 7. Because the busy-trigger-per-button command is set to 2, a third incoming call to extension 2001 is either rejected with a busy tone or forwarded to another destination if Call Forward Busy is configured. The phone user can still make an outgoing call or transfer or conference a call on ephone-dn 7 because the max-calls-per-button command is set to 3, which allows a total of three calls on ephone-dn 7. ephone-dn 7 octo-line number 2001 name Smith, John huntstop channel 4 ! ! ephone 10 max-calls-per-button 3 busy-trigger-per-button 2 mac-address 00E1.CB13.0395 type 7960 button 1:7 Example for Shared Octo-Line Directory Number In the following example, ephone-dn 7 is shared between phone 10 and phone 11. There are two active calls on ephone-dn 7. A third incoming call to ephone-dn 7 rings only phone 11 because itsbusy-trigger-per-button command is set to 3. Phone 10 allows a total of three calls, but it rejects the third incoming call because its busy-trigger-per-button command is set to 2. A fourth incoming call to ephone-dn 7 on ephone 11 is either rejected with a busy tone or forwarded to another destination if Call Forward Busy is configured. The phone user can still make an outgoing call or transfer or conference a call on ephone-dn 7 on phone 11 because the max-calls-per-button command is set to 4, which allows a total of four calls on ephone-dn 7 on phone 11. ephone-dn 7 octo-line number 2001 name Smith, John huntstop channel 4 ! ! ephone 10 max-calls-per-button 3 busy-trigger-per-button 2 mac-address 00E1.CB13.0395> type 7960 button 1:7 ! ! ! ephone 11 max-calls-per-button 4 busy-trigger-per-button 3 mac-address 0016.9DEF.1A70 type 7960 button 1:7 Cisco Unified Communications Manager Express System Administrator Guide 255 Configuring Phones to Make Basic Calls Create Directory Numbers for SCCP Phones What to Do Next After creating directory numbers, you can assign one or more directory numbers to a Cisco Unified IP Phone. See Assign Directory Numbers to SCCP Phones, on page 260. Configure Ephone-Type Templates for SCCP Phones Ephone-type templates are not supported for system-defined phone types. For a list of system-defined phone types, see the type command in Cisco Unified CME Command Reference. Restriction Before You Begin Cisco Unified CME 4.3 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-type phone-type [addon] 4. device-id number 5. device-name name 6. device-type phone-type 7. num-buttons number 8. max-presentation number 9. addon 10. security 11. phoneload 12. utf8 13. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Cisco Unified Communications Manager Express System Administrator Guide 256 Configuring Phones to Make Basic Calls Configure Ephone-Type Templates for SCCP Phones Command or Action Purpose Enters ephone-type configuration mode to create an ephone-type template. ephone-type phone-type [addon] Example: Router(config)# ephone-type E61 Step 3 • phone-type—Unique label that identifies the type of IP phone for which the phone-type template is being defined. • addon—(Optional) Phone type is an add-on module, such as the Cisco Unified IP Phone 7915 Expansion Module. Step 4 device-id number Specifies the device ID for the phone type. Example: Router(config-ephone-type)# device-id 376 • This device ID must match the predefined device ID for the specific phone model. • If this command is set to the default value of 0, the ephone-type is invalid. • See Table 17: Supported Values for Ephone-Type Commands , on page 258 for a list of supported device IDs. Step 5 device-name name Assigns a name to the phone type. Example: Router(config-ephone-type)# device-name E61 Mobile Phone • See Table 17: Supported Values for Ephone-Type Commands , on page 258 for a list of supported device types. device-type phone-type Specifies the device type for the phone. Example: Router(config-ephone-type)# device-type E61 Step 6 Step 7 num-buttons number Number of line buttons supported by the phone type. Example: Router(config-ephone-type)# num-buttons 1 • number—Range: 1 to 100. Default: 0. • See Table 17: Supported Values for Ephone-Type Commands , on page 258 for the number of buttons supported by each phone type. Step 8 max-presentation number Number of call presentation lines supported by the phone type. Example: Router(config-ephone-type)# max-presentation 1 • number—Range: 1 to 100. Default: 0. • See Table 17: Supported Values for Ephone-Type Commands , on page 258 for the number of presentation linessupported by each phone type. (Optional) Specifies that this phone type supports an add-on module, such as the Cisco Unified IP Phone 7915 Expansion Module. addon Example: Router(config-ephone-type)# addon Step 9 Cisco Unified Communications Manager Express System Administrator Guide 257 Configuring Phones to Make Basic Calls Configure Ephone-Type Templates for SCCP Phones Command or Action Purpose Step 10 security (Optional) Specifies that this phone type supports security features. Example: Router(config-ephone-type)# security • This command is enabled by default. (Optional)Specifiesthat this phone type requiresthat the loadcommand be configured. phoneload Example: Router(config-ephone-type)# phoneload Step 11 • This command is enabled by default. Step 12 utf8 (Optional) Specifies that this phone type supports UTF8. Example: Router(config-ephone-type)# utf8 • This command is enabled by default. end Exits to privileged EXEC mode. Example: Router(config-ephone-type)# end Step 13 Ephone-Type Parameters for Supported Phone Types Table 17: Supported Values for Ephone-Type Commands , on page 258 lists the required device ID, device type, and the maximum number of buttons and call presentation lines that are supported for each phone type that can be added with ephone-type templates. Table 17: Supported Values for Ephone-Type Commands Supported Device device-id device-type num-buttons max-presentation Cisco Unified IP 547 6901 1 1 Phoone 6901 Cisco Unified IP 548 6911 10 1 Phone 6911 Cisco Unified IP 564 6945 4 2 Phone 6945 Cisco Unified IP 227 7915 12 0 (default) Phone 7915 Expansion Module with 12 buttons Cisco Unified Communications Manager Express System Administrator Guide 258 Configuring Phones to Make Basic Calls Configure Ephone-Type Templates for SCCP Phones Supported Device device-id device-type num-buttons max-presentation Cisco Unified IP 228 7915 24 0 Phone 7915 Expansion Module with 24 buttons Cisco Unified IP 229 7916 12 0 Phone 7916 Expansion Module with 12 buttons Cisco Unified IP 230 7916 24 0 Phone 7916 Expansion Module with 24 buttons Cisco Unified 484 7925 6 4 Wireless IP Phone 7925 Cisco Unified IP 431 7937 1 6 Conference Station 7937G Cisco Unified IP 586 8941 4 3 Phone 8941 Cisco Unified IP 585 8945 4 3 Phone 8945 Cisco Unified IP 586 8941 4 3 Phone 8941 with Fast-Track configuration support Cisco Unified IP 586 8945 4 3 Phone 8945 with Fast-Track configuration support Nokia E61 376 E61 1 1 Example Cisco Unified Communications Manager Express System Administrator Guide 259 Configuring Phones to Make Basic Calls Configure Ephone-Type Templates for SCCP Phones The following example shows the Nokia E61 added with an ephone-type template, which is then assigned to ephone 2: ephone-type E61 device-id 376 device-name E61 Mobile Phone num-buttons 1 max-presentation 1 no utf8 no phoneload ! ephone 2 mac-address 001C.821C.ED23 type E61 button 1:2 Assign Directory Numbers to SCCP Phones This task sets up the initial ephone-dn-to-ephone relationships: how and which extensions appear on each phone. To create and modify phone-specific parameters for individual SCCP phones, perform the following steps for each SCCP phone to be connected in Cisco Unified CME. While using the GUI to administer ephone-dns on CME, ensure ephone-dns value is lower than the max-dns value. To create and assign directory numbersto be included in an overlay set,see Configure Overlaid Ephone-dns on SCCP Phones, on page 1326. Note Restriction • For Watch mode. If the watched directory number is associated with several phones, then the watched phone is the one on which the watched directory number is on button 1 or the one on which the watched directory number is on the button that is configured by using theauto-line command, with auto-line having priority.For configuration information,see Automatic LineSelection, on page 1041. • Octo-line directory numbers are not supported by the Cisco Unified IP Phone 7902, 7920, or 7931, or by analog phones connected to the Cisco VG224 or Cisco ATA. • Octo-line directory numbers are not supported in button overlay sets. Before You Begin • To configure a phone line for Watch (w) mode by using the button command, Cisco Unified CME 4.1 or a later version. • To configure a phone line for Monitor (m) mode by using the button command, Cisco CME 3.0 or a later version. • To assign a user-defined phone type in Cisco Unified CME 4.3 or a later version, you must first create an ephone-type template. See Configure Ephone-Type Templates for SCCP Phones, on page 256. Cisco Unified Communications Manager Express System Administrator Guide 260 Configuring Phones to Make Basic Calls Assign Directory Numbers to SCCP Phones SUMMARY STEPS 1. enable 2. configure terminal 3. ephone phone-tag 4. mac-address [mac-address] 5. type phone-type [addon 1 module-type [2 module-type]] 6. button button-number {separator}dn-tag [, dn-tag...] [button-number {x} overlay-button-number] [button-number...] 7. max-calls-per-button number 8. busy-trigger-per-button number 9. keypad-normalize 10. nte-end-digit-delay [milliseconds] 11. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 ephone phone-tag Enters ephone configuration mode. Example: Router(config)#ephone 6 • phone-tag—Unique sequence number that identifies this ephone during configuration tasks. The maximum number of ephones is version and platform-specific. Type ? to display range. Step 4 mac-address [mac-address] Specifies the MAC address of the IP phone that is being configured. Example: Router(config-ephone)#mac-address 2946.3f2.311 • mac-address—(Optional) For CiscoUnifiedCME 3.0 and later versions, it is not required to register phones before configuring the phone because CiscoUnifiedCME can detect MAC addresses and automatically populate phone configurations with the MAC addresses and phone types for individual phones. Not supported for voice-mail ports. type phone-type [addon 1 module-type Specifies the type of phone. [2 module-type]] Step 5 • CiscoUnifiedCME 4.0 and later versionsThe only types to which you can apply an add-on module are 7960, 7961,7961GE, and 7970. Cisco Unified Communications Manager Express System Administrator Guide 261 Configuring Phones to Make Basic Calls Assign Directory Numbers to SCCP Phones Command or Action Purpose Example: Router(config-ephone)# type 7960 addon 1 7914 • CiscoCME 3.4 and earlier versionsThe only type to which you can apply an add-on module is 7960. Associates a button number and line characteristics with an extension (ephone-dn). Maximum number of buttons is determined by phone type. button button-number {separator}dn-tag [, dn-tag...] Step 6 [button-number {x} The CiscoUnified IPPhone7910 has only one line button but can be given two ephone-dn tags. Note overlay-button-number] [button-number...] Example: Router(config-ephone)# button 1:10 2:11 3b12 4o13,14,15 (Optional) Sets the maximum number of calls, incoming and outgoing, allowed on an octo-line directory number on this phone. max-calls-per-button number Example: Router(config-ephone)# max-calls-per-button 3 Step 7 • number—Range: 1 to 8. Default: 8. • This command is supported in CiscoUnifiedCME4.3 and later versions. • This command must be set to a value that is more than or equal to the value set with the busy-trigger-per-button command. • This command can also be configured in ephone-template configuration mode and applied to one or more phones. The ephone configuration has priority over the ephone-template configuration. (Optional) Sets the maximum number of calls allowed on this phones octo-line directory numbers before triggering Call Forward Busy or a busy tone. busy-trigger-per-button number Example: Router(config-ephone)# busy-trigger-per-button 2 Step 8 • number—Range: 1 to 8. Default: 0 (disabled). • This command is supported in CiscoUnifiedCME4.3 and later versions. • After the number of existing calls, incoming and outgoing, on an octo-line directory number exceeds the number of calls set with this command, the next incoming call to the directory number isforwarded to the CallForward Busy destination if configured, or the call is rejected with a busy tone. • This command must be set to a value that is less than or equal to the value set with the max-calls-per-button command. • This command can also be configured in ephone-template configuration mode and applied to one or more phones. The ephone configuration has priority over the ephone-template configuration. (Optional) Imposes a 200-millisecond delay before each keypad message from an IP phone. keypad-normalize Example: Router(config-ephone)# keypad-normalize Step 9 • When used with thente-end-digit-delay command, this command ensures that the delay configured for a dtmf-end event is always honored. Cisco Unified Communications Manager Express System Administrator Guide 262 Configuring Phones to Make Basic Calls Assign Directory Numbers to SCCP Phones Command or Action Purpose (Optional)Specifiesthe amount of time that each digit in the RTP NTE end event in an RFC2833 packet is delayed before being sent. nte-end-digit-delay [milliseconds] Example: Router(config-ephone)# nte-end-digit-delay 150 Step 10 • This command is supported in CiscoUnifiedCME 4.3 and later versions. • milliseconds—length of delay. Range: 10 to 200. Default: 200. • To enable the delay, you must also configure thedtmf-interworking rtp-nte command in voice-service or dial-peer configuration mode.For information, see Enable DTMF Integration Using RFC 2833, on page 562. • This command can also be configured in ephone-template configuration mode. The value set in ephone configuration mode has priority over the value set in ephone-template mode. end Returns to privileged EXEC mode. Example: Router(config-ephone)# end Step 11 Example for assigning directory number to SCCP Phone The following example assigns extension 2225 in the Accounting Department to button 1 on ephone 2: ephone-dn 25 number 2225 name Accounting ephone 2 mac-address 00E1.CB13.0395 type 7960 button 1:25 What to Do Next • If you have SIP and SCCP phones connected to the same Cisco Unified CME, see Configure Codecs of Individual Phones for Calls Between Local Phones, on page 280. • After configuring phones in Cisco Unified CME to make basic calls, you are ready to generate configuration files for the phones to be connected. See Generate Configuration Files for SCCP Phones, on page 388. Create Directory Numbers for SIP Phones To create a directory number in Cisco Unified CME for a SIP phone, intercom line, voice port, or a message-waiting indicator (MWI), perform the following steps for each directory number to be created. Cisco Unified Communications Manager Express System Administrator Guide 263 Configuring Phones to Make Basic Calls Create Directory Numbers for SIP Phones Restriction • Valid characters in voice register dn include 0-9, '.', '+', '*', and '#'. • To allow insertion of '#' at any place in voice register dn, the CLI "allow-hash-in-dn" is configured in voice register global mode. • When the CLI "allow-hash-in-dn" is configured, the user isrequired to change the dial-peer terminator from '#' (default terminator) to another valid terminator in configuration mode. The other terminators that are supported include '0'-'9', 'A'-'F', and '*'. • Maximum number of directory numbers supported by a router is version and platform dependent. • CallForward All,Presence, and message-waiting indication (MWI) featuresin Cisco Unified CME 4.1 and later versions require that SIP phones be configured with a directory number using the dn keyword with the number command; direct line numbers are not supported. • SIP endpoints are not supported on H.323 trunks. SIP endpoints are supported on SIP trunks only. • The MediaFlow-around feature configured with the media flow-aroundcommand is not supported by Cisco Unified CME with SIP phones. • SIP shared-line directory numbers are not supported by the Cisco Unified IP Phone 7902, 7920, 7931, 7940, or 7960, or by analog phones connected to the Cisco VG224 or Cisco ATA. • For Unified CME 12.1 and prior releases, SIP shared-line directory numbers cannot be members of hunt groups. Before You Begin • Cisco CME 3.4 or a later version. • SIP shared-line directory numbers are supported in Cisco Unified CME 7.1 and later versions. • registrar server command must be configured.For configuration information, see Enable Calls in Your VoIP Network, on page 125. • In Cisco Unified CME 7.1 and later versions, the maximum number of directory numbers must be changed from the default of 0 by using the max-dn (voice register global) command. For configuration information, see Set Up Cisco Unified CME for SIP Phones, on page 192. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register dn dn-tag 4. number number 5. shared-line [max-calls number-of-calls] 6. huntstop channel number-of-channels 7. end Cisco Unified Communications Manager Express System Administrator Guide 264 Configuring Phones to Make Basic Calls Create Directory Numbers for SIP Phones DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register dn configuration mode to define a directory number for aSIPphone, intercom line, voice port, or a message-waiting indicator (MWI). voice register dn dn-tag Example: Router(config)# voice register dn 17 Step 3 number number Defines a valid number for a directory number. Example: Router(config-register-dn)# number 7001 Step 4 Step 5 shared-line [max-calls number-of-calls] (Optional) Creates a shared-line directory number. Example: Router(config-register-dn)# shared-line max-calls 6 • max-calls number-of-calls(Optional)—Maximum number of calls, both incoming and outgoing. Range: 2 to 16. Default: 2. • Must be set to a value that is more than or equal to the value set with the busy-trigger-per-button command. • This command is supported in Cisco Unified CME 7.1 and later versions. (Optional) Enables Channel Huntstop, which keeps a call from hunting to the next channel of a directory number if the first channel is busy or does not answer. huntstop channel number-of-channels Example: Router(config-register-dn)# huntstop channel 3 Step 6 • number-of-channels—Number of channels available to accept incoming calls on the directory number. Remaining channels are reserved for outgoing calls and features, such as Call Transfer, Call Waiting, and Conferencing. Range: 1 to 50. Default: 0 (disabled). • This command is supported in Cisco Unified CME 7.1 and later versions. end Exits to privileged EXEC mode. Example: Router(config-register-dn)# end Step 7 Cisco Unified Communications Manager Express System Administrator Guide 265 Configuring Phones to Make Basic Calls Create Directory Numbers for SIP Phones Example for assigning directory numbers to SIP Phones The following example shows directory number 24 configured as a shared line and assigned to phone 124 and phone 125: voice register dn 24 number 8124 shared-line max-calls 6 ! voice register pool 124 id mac 0017.E033.0284 type 7965 number 1 dn 24 ! voice register pool 125 id mac 00E1.CB13.0395 type 7965 number 1 dn 24 Assign Directory Numbers to SIP Phones This task sets up which extensions appear on each phone. To create and modify phone-specific parameters for individual SIP phones, perform the following steps for each SIP phone to be connected in Cisco Unified CME. If your Cisco Unified CME system supports SCCP and SIP phones, do not connect your SIP phones to your network until after you have verified the configuration profile for the SIP phone. Note SUMMARY STEPS 1. enable 2. configure terminal 3. voice register pool pool-tag 4. id {network address mask mask | ip address mask mask | mac address} 5. type phone-type 6. number tag dn dn-tag 7. busy-trigger-per-button number-of-calls 8. username username password password 9. dtmf-relay {[cisco-rtp] [rtp-nte] [sip-notify]} 10. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Cisco Unified Communications Manager Express System Administrator Guide 266 Configuring Phones to Make Basic Calls Assign Directory Numbers to SIP Phones Command or Action Purpose Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register pool configuration mode to set phone-specific parameters for a SIP phone. voice register pool pool-tag Example: Router(config)# voice register pool 3 Step 3 Explicitly identifies a locally available individual SIP phone to support a degree of authentication. id {network address mask mask | ip address mask mask | mac address} Example: Router(config-register-pool)# id mac 0009.A3D4.1234 Step 4 type phone-type Defines a phone type for the SIP phone being configured. Example: Router(config-register-pool)# type 7960-7940 Step 5 Step 6 number tag dn dn-tag Associates a directory number with theSIPphone being configured. Example: Router(config-register-pool)# number 1 dn 17 • dn dn-tag—identifies the directory number for this SIP phone as defined by the voice register dn command. (Optional)Sets the maximum number of calls allowed on any of this phones directory numbers before triggering Call Forward Busy or a busy tone. busy-trigger-per-button number-of-calls Example: Router(config-register-pool)# busy-trigger-per-button 2 Step 7 • number-of-calls—Maximum number of calls allowed before Cisco Unified CME forwardsthe next incoming call to the Call Forward Busy destination, if configured, or rejects the call with a busy tone. Range: 1 to 50. • This command issupported in Cisco Unified CME 7.1 and later versions. Cisco Unified Communications Manager Express System Administrator Guide 267 Configuring Phones to Make Basic Calls Assign Directory Numbers to SIP Phone Command or Action Purpose (Optional) Required only if authentication is enabled with the authenticate command. Creates an authentication credential. username username password password Example: Router(config-register-pool)# username smith password 123zyx Step 8 This command is not for SIP proxy registration. The password will not be encrypted. All lines in a phone will share the same credential. Note • username—identifies a local Cisco Unified IP phone user. Default: Admin. (Optional) Specifies a list of DTMF relay methods that can be used by the SIP phone to relay DTMF tones. dtmf-relay {[cisco-rtp] [rtp-nte] [sip-notify]} Example: Router(config-register-pool)# dtmf-relay rtp-nte Step 9 SIP phones natively support in-band DTMF relay as specified in RFC 2833. Note end Returns to privileged EXEC mode. Example: Router(config-register-pool)# end Step 10 Example for configuring SIP Nonshared Line In the following example, voice register dn 23 is assigned to phone 123. The fourth incoming call to extension 8123 is not presented to the phone because the huntstop channel command is set to 3. Because the busy-trigger-per-button command is set to 2 on phone 123 and Call Forward Busy is configured, the third incoming call to extension 8123 is forwarded to extension 8200. voice register dn 23 number 8123 call-forward b2bua busy 8200 huntstop channel 3 ! voice register pool 123 busy-trigger-per-button 2 id mac 0009.A3D4.1234 type 7965 number 1 dn 23 Example for configuring SIP Shared Line In the following example, voice register dn 24 is shared by phones 124 and 125. The first two incoming calls to extension 8124 ring both phones. A third incoming call rings only phone 125 because its busy-trigger-per-button command is set to 3. The fourth incoming call to extension 8124 triggers Call Forward Busy because the busy trigger limit on all phones is exceeded. voice register dn 24 number 8124 call-forward b2bua busy 8200 shared-line max-calls 6 huntstop channel 6 Cisco Unified Communications Manager Express System Administrator Guide 268 Configuring Phones to Make Basic Calls Assign Directory Numbers to SIP Phones ! voice register pool 124 busy-trigger-per-button 2 id mac 0017.E033.0284 type 7965 number 1 dn 24 ! voice register pool 125 busy-trigger-per-button 3 id mac 00E1.CB13.0395 type 7965 number 1 dn 24 What to Do Next • If you have SIP and SCCP phones connected to the same Cisco Unified CME, see Configure Codecs of Individual Phones for Calls Between Local Phones, on page 280. • If you want to select the session-transport protocol for aSIPphone,seeSelectSession-TransportProtocol for a SIP Phone, on page 275. • If you are finished configuring phones to make basic calls, you are ready to generate configuration files for the phones to be connected. See Generate Configuration Profiles for SIP Phones, on page 391. Configure Dial Plans for SIP Phones Dial plans enable SIP phones to recognize digit strings dialed by users. After the phone recognizes a dial pattern, it automatically sends a SIP INVITE message to the Cisco Unified CME to initiate the call and does not require the user to press the Dial key or wait for the interdigit timeout. To define a dial plan for a SIP phone, perform the following steps. Before You Begin • Cisco Unified CME 4.1 or a later version. • mode cme command must be enabled in Cisco Unified CME. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register dialplan dialplan-tag 4. type phone-type 5. pattern tag string [button button-number] [timeout seconds] [user {ip | phone}] or filename filename 6. exit 7. voice register pool pool-tag 8. dialplan dialplan-tag 9. end Cisco Unified Communications Manager Express System Administrator Guide 269 Configuring Phones to Make Basic Calls Configure Dial Plans for SIP Phones DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register dialplan configuration mode to define a dial plan for SIP phones. voice register dialplan dialplan-tag Example: Router(config)# voice register dialplan 1 Step 3 Step 4 type phone-type Defines a phone type for the SIP dial plan. Example: Router(config-register-dialplan)# type 7905-7912 • 7905-7912—Cisco Unified IP Phone 7905, 7905G, 7912, or 7912G. • 7940-7960-others—Cisco Unified IP Phone 7911, 7940, 7940G, 7941, 7941GE, 7960, 7960G, 7961, 7961GE, 7970, or 7971. • The phone type specified with this command must match the type of phone for which the dial plan is used. If this phone type does not match the type assigned to the phone with the type command in voice register pool mode, the dial-plan configuration file is not generated. • You must enter this command before using the pattern or filename command in the next step. pattern tag string [button Defines a dial pattern for a SIP dial plan. button-number] [timeoutseconds] [user {ip | phone}] or filename filename Step 5 • tag—Number that identifies the dial pattern. Range: 1 to 24. Example: Router(config-register-dialplan)# pattern 1 52... • string—Dial pattern, such as the area code, prefix, and first one or two digits of the telephone number, plus wildcard characters or dots (.) for the remainder of the dialed digits. • buttonbutton-number—(Optional) Button to which the dial pattern applies. or Router(config-register-dialplan)# filename dialsip • timeout seconds— (Optional) Time, in seconds, that the system waits before dialing the number entered by the user. Range: 0 to 30. To have the number dialed immediately, specify 0. If you do not use this parameter, the phone's default interdigit timeout value is used (10 seconds). • user—(Optional) Tag that automatically gets added to the dialed number. Do not use this keyword if Cisco Unified CME is the only SIP call agent. • ip—Uses the IP address of the user. • phone—Uses the phone number of the user. Cisco Unified Communications Manager Express System Administrator Guide 270 Configuring Phones to Make Basic Calls Configure Dial Plans for SIP Phones Command or Action Purpose • Repeat this command for each pattern that you want to include in this dial plan. or Specifies a custom XML file that contains the dial patterns to use for the SIP dial plan. • You must load the custom XML file must into flash and the filename cannot include the .xml extension. • The filename command is not supported for the Cisco Unified IP Phone 7905 or 7912. exit Exits dialplan configuration mode. Example: Router(config-register-dialplan)# exit Step 6 Enters voice register pool configuration mode to set phone-specific parameters for a SIP phone. voice register pool pool-tag Example: Router(config)# voice register pool 4 Step 7 • pool-tag—Unique sequence number of the SIP phone to be configured. Range is version and platform-dependent; type ? to display range. You can modify the upper limit for this argument by using the the max-pool command. Step 8 dialplan dialplan-tag Assigns a dial plan to a SIP phone. Example: Router(config-register-pool)# dialplan 1 • dialplan-tag—Number that identifies the dial plan to use for this SIP phone. This is the number that was used with the voice register dialplan command in Step 3. Range: 1 to 24. end Exits to privileged EXEC mode. Example: Router(config-register-global)# end Step 9 Examples The following example shows the configuration for dial plan 1, which is assigned to SIP phone 1: voice register dialplan 1 type 7940-7960-others pattern 1 2... timeout 10 user ip pattern 2 1234 user ip button 4 pattern 3 65... pattern 4 1...! Cisco Unified Communications Manager Express System Administrator Guide 271 Configuring Phones to Make Basic Calls Configure Dial Plans for SIP Phones ! voice register pool 1 id mac 0016.9DEF.1A70 type 7961GE number 1 dn 1 number 2 dn 2 dialplan 1 dtmf-relay rtp-nte codec g711ulaw Troubleshooting Tips for Configuring Dial Plans for SIP If you create a dial plan by downloading a custom XML dial pattern file to flash and using the filename command, and the XML file contains an error, the dial plan might not work properly on a phone. We recommend creating a dial pattern file using the pattern command. To remove a dial plan that was created using a custom XML file with the filename command, you must remove the dial plan from the phone, create a new configuration profile, and then use the reset command to reboot the phone. You can use the restart command after removing a dial plan from a phone only if the dial plan was created using the pattern command. To use KPML if a matching dial plan is not found, when both a dial plan and KPML are enabled on a phone, you must configure a dial pattern with a single wildcard character (.) as the last pattern in the dial plan. For example: voice register dialplan 10 type 7940-7960-others pattern 1 66... pattern 2 91....... What to Do Next If you are done modifying parameters for SIP phones, you must generate a new configuration profile and restart the phones. See Configuration Files for Phones, on page 387. Verify SIP Dial Plan Configuration Step 1 show voice register dialplan tag This command displays the configuration information for a specific SIP dial plan. Example: Router# show voice register dialplan 1 Dialplan Tag 1 Config: Type is 7940-7960-others Pattern 1 is 2..., timeout is 10, user option is ip, button is default Pattern 2 is 1234, timeout is 0, user option is ip, button is 4 Pattern 3 is 65..., timeout is 0, user option is phone, button is default Pattern 4 is 1..., timeout is 0, user option is phone, button is default Step 2 show voice register pool tag This command displays the dial plan assigned to a specific SIP phone. Cisco Unified Communications Manager Express System Administrator Guide 272 Configuring Phones to Make Basic Calls Verify SIP Dial Plan Configuration Example: Router# show voice register pool 29 Pool Tag 29 Config: Mac address is 0012.7F54.EDC6 Number list 1 : DN 29 Proxy Ip address is 0.0.0.0 DTMF Relay is disabled Call Waiting is enabled DnD is disabled keep-conference is enabled dialplan tag is 1 kpml signal is enabled service-control mechanism is not supported . . . Step 3 show voice register template tag This command displays the dial plan assigned to a specific template. Example: Router# show voice register template 3 Temp Tag 3 Config: Attended Transfer is disabled Blind Transfer is enabled Semi-attended Transfer is enabled Conference is enabled Caller-ID block is disabled DnD control is enabled Anonymous call block is disabled Voicemail is 62000, timeout 15 Dialplan Tag is 1 Transport type is tcp Enable KPML on a SIP Phone To enable KPML digit collection on a SIP phone, perform the following steps. Restriction • Thisfeature issupported only on Cisco Unified IPPhones 7911G, 7941G, 7941GE, 7961G, 7961GE, 7970G, and 7971GE. • A dial plan assigned to a phone has priority over KPML. Before You Begin Cisco Unified CME 4.1 or a later version. Cisco Unified Communications Manager Express System Administrator Guide 273 Configuring Phones to Make Basic Calls Enable KPML on a SIP Phone SUMMARY STEPS 1. enable 2. configure terminal 3. voice register pool pool-tag 4. digit collect kpml 5. end 6. show voice register dial-peers DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register pool configuration mode to set phone-specific parameters for a SIP phone. voice register pool pool-tag Example: Router(config)# voice register pool 4 Step 3 • pool-tag—Unique sequence number of the SIP phone to be configured. Range is version and platform-dependent; type ? to display range. You can modify the upper limit for this argument by using the max-pool command. Step 4 digit collect kpml Enables KPML digit collection for the SIP phone. Example: Router(config-register-pool)# digit collect kpml This command is enabled by default for supported phones in Cisco Unified CME. Note end Exits to privileged EXEC mode. Example: Router(config-register-pool)# end Step 5 Displays details of all dynamically created VoIPdial peers associated with the Cisco Unified CME SIP register, including the defined digit collection method. show voice register dial-peers Example: Router# show voice register dial-peers Step 6 Cisco Unified Communications Manager Express System Administrator Guide 274 Configuring Phones to Make Basic Calls Enable KPML on a SIP Phone What to Do Next If you are done modifying parameters for SIP phones, you must generate a new configuration profile and restart the phones. See Configuration Files for Phones, on page 387. Select Session-Transport Protocol for a SIP Phone To change the session-transport protocol for a SIP phone from the default of UDP to TCP, perform the following steps. Restriction • TCP is not supported as a session-transport protocol for the Cisco Unified IP Phone 7905, 7912, 7940, or 7960. If TCP is assigned to an unsupported phone, calls to that phone will not complete successfully. However, the phone can originate calls using UDP, although TCP has been assigned. Before You Begin • Cisco Unified CME 4.1 or a later version. • Directory number must be assigned toSIPphone to which configuration isto be applied.For configuration information, see Assign Directory Numbers to SIP Phones, on page 266. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register pool pool-tag 4. session-transport {tcp | udp} 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register pool configuration mode to set phone-specific parameters for a SIP phone in Cisco Unified CME. voice register pool pool-tag Example: Router(config)# voice register pool 3 Step 3 Cisco Unified Communications Manager Express System Administrator Guide 275 Configuring Phones to Make Basic Calls Select Session-Transport Protocol for a SIP Phone Command or Action Purpose (Optional) Specifies the transport layer protocol that a SIP phone uses to connect to Cisco Unified CME. session-transport {tcp | udp} Example: Router(config-register-pool)# session-transport tcp Step 4 • This command can also be configured in voice register template configuration mode and applied to one or more phones. The voice register pool configuration has priority over the voice register template configuration. Exits voice register pool configuration mode and enters privileged EXEC mode. end Example: Router(config-register-pool)# end Step 5 What to Do Next When TCP is used as session-transport for the SIP phones, and if the TCP Connection aging timer is less than the SIP Register expire timer; then after every TCP connection aging timer expires, the phone will be reset and will re-register to CME. If this is not desired, then modify the TCP Connection aging timer and/orSIP Register expire timerso thatSIP Register expire timer islessthan TCP Connection aging timer. Note • If you want to disable SIP Proxy registration for an individual directory number, see Disable SIP Proxy Registration for a Directory Number, on page 276. • If you have SIP and SCCP phones connected to the same Cisco Unified CME, see Configure Codecs of Individual Phones for Calls Between Local Phones, on page 280. • If you are finished configuring phones to make basic calls, you are ready to generate configuration files for the phones to be connected. See Generate Configuration Profiles for SIP Phones, on page 391. Disable SIP Proxy Registration for a Directory Number To prevent a particular directory number from registering with an external SIP proxy server, perform the following steps. Phone numbers that are registered under a voice register dn must belong to a SIP phone that is registered in Cisco Unified CME. Restriction Before You Begin • Cisco Unified CME 3.4 or a later version. • Bulk registration is configured at system level. For configuration information, see Configure Bulk Registration, on page 172. Cisco Unified Communications Manager Express System Administrator Guide 276 Configuring Phones to Make Basic Calls Disable SIP Proxy Registration for a Directory Number SUMMARY STEPS 1. enable 2. configure terminal 3. voice register dn dn-tag 4. number number 5. no-reg 6. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register dn configuration mode to define a directory number for a SIP phone, intercom line, voice port, or an MWI. voice register dn dn-tag Example: Router(config-register-global)# voice register dn 1 Step 3 Defines a valid number for a directory number to be assigned to a SIP phone in Cisco Unified CME. number number Example: Router(config-register-dn)# number 4085550152 Step 4 Prevents directory number being configured from registering with an external proxy server. no-reg Example: Router(config-register-dn)# no-reg Step 5 Exits voice register dn configuration mode and enters privileged EXEC mode. end Example: Router(config-register-dn)# end Step 6 Cisco Unified Communications Manager Express System Administrator Guide 277 Configuring Phones to Make Basic Calls Disable SIP Proxy Registration for a Directory Number What to Do Next • If you want to configure the G.722-64K codec for all calls through your Cisco Unified CME system, see Modify the Global Codec, on page 278. • If you have SIP and SCCP phones connected to the same Cisco Unified CME, see Configure Codecs of Individual Phones for Calls Between Local Phones, on page 280. • If you want to configure individual phones to support some codec other than the system-level codec or some codec other than the phone s native codec, see Codecs for Cisco Unified CME Phones, on page 239. • If you are finished configuring phones to make basic calls, you are ready to generate configuration files for the phones to be connected. See Generate Configuration Profiles for SIP Phones, on page 391. Modify the Global Codec To change the global codec from the default (G.711ulaw) to G.722-64K for all calls through Cisco Unified CME, perform the following steps. If G.722-64K codec is configured globally and a phone does not support the codec, the fallback codec is G.711ulaw. Restriction Before You Begin Cisco Unified CME 4.3 or later versions. SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. codec {g711-ulaw | g722-64k} 5. service phone g722CodecSupport {0 | 1 | 2} 6. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Cisco Unified Communications Manager Express System Administrator Guide 278 Configuring Phones to Make Basic Calls Modify the Global Codec Command or Action Purpose Enters telephony service configuration mode to set parameters for SCCP and SIP phones in Cisco Unified CME. telephony-service Example: Router(config)# telephony-service Step 3 Step 4 codec {g711-ulaw | g722-64k} Specifies the preferred codec for phones in Cisco Unified CME. Example: Router(config-telephony)# codec g722-64k • Required only if you want to modify codec from the default (G.711ulaw) to G.722-64K. service phone g722CodecSupport {0 | 1 Causes all phonesto advertise the G.722-64K codec to Cisco Unified CME. | 2} Step 5 • Required only if you configured the codec g722-64k command in telephony-service configuration mode. Example: Router(config)# service phone g722CodecSupport 2 • g722CodecSupport—Default: 0, phone default set by manufacturer and equal to enabled or disabled. • Cisco phone firmware 8.2.1 or a later version is required to support the G.722-64K codec on G.722-capable SCCP phones. • Cisco phone firmware 8.3.1 or a later version is required to support the G.722-64K codec on G.722-capable SIP phones. • For SCCP only: This command can also be configured in ephonetemplate configuration mode and applied to one or more SCCP phones. Exitsthe telephony service configuration mode and enters privileged EXEC mode. end Example: Router(config-telephony)# end Step 6 What to Do Next • If you have SIP and SCCP phones connected to the same Cisco Unified CME, see Configure Codecs of Individual Phones for Calls Between Local Phones, on page 280. • If you want to configure individual phones to support some codec other than the system-level codec or some codec other than the phone s native codec, see Configure Codecs of Individual Phones for Calls Between Local Phones, on page 280. • If you are finished configuringSCCPphonesto make basic calls, you are ready to generate configuration files for the phones to be connected. See Generate Configuration Files for SCCP Phones, on page 388. Cisco Unified Communications Manager Express System Administrator Guide 279 Configuring Phones to Make Basic Calls Modify the Global Codec Configure Codecs of Individual Phones for Calls Between Local Phones To designate a codec for individual phones to ensure connectivity between a variety of phones connected to the same Cisco Unified CME router, perform the following steps for each SCCP or SIP phone. If codec values for the dial peers of an internal connection do not match, the call fails.For calls to external phones, that is, phones that are not in the same Cisco Unified CME, such as VoIP calls, the codec is negotiated based on the protocol that is used for the call, such as H.323. Cisco Unified CME plays no part in the negotiation. Note Restriction • Not all phones support all codecs. To verify whether your phone supports a particular codec, see your phone documentation. • For SIP and SCCP phones in Cisco Unified CME: Modify the configuration for either SIP or SCCP phones to ensure that the codec for all phones match. Do not modify the configuration for both SIP and SCCP phones. • If G.729 is the desired codec for Cisco ATA-186 and Cisco ATA-188, then only one port of the Cisco ATA device should be configured in Cisco Unified CME. If a call is placed to the second port of the Cisco ATA device, it will be disconnected gracefully. If you want to use both Cisco ATA ports simultaneously, then configure G.711 in Cisco Unified CME. • If G.722-64K or iLBC codecs are configured in ephone configuration mode and the phone does not support the codec, the fallback is the global codec or G.711ulaw if the global codec is not supported. To configure a global codec, see Modify the Global Codec, on page 278. Before You Begin • For SIP phones in Cisco Unified CME: Cisco Unified CME 3.4 or a later version. • For G.722-64K and iLBC codecs: Cisco Unified CME 4.3 or a later version. • To support G.722-64K on an individual phone: Cisco phone firmware 8.2.1 or a later version for SCCP phones and 8.3.1 or a later version for SIP phones. For information about upgrading Cisco phone firmware, see Install Cisco Unified CME Software, on page 105 . • To support iLBC on an individual phone: Cisco phone firmware 8.3.1 or a later version for SCCP and SIP phones. For information about upgrading Cisco phone firmware, see Install Cisco Unified CME Software, on page 105. • Cisco Unified IPphone to which the codec isto be applied must be already configured.For configuration information forSIPphones,see Assign Directory NumberstoSIPPhones, on page 266.For configuration information for SCCP phones, see Assign Directory Numbers to SCCP Phones, on page 260. Cisco Unified Communications Manager Express System Administrator Guide 280 Configuring Phones to Make Basic Calls Configure Codecs of Individual Phones for Calls Between Local Phones SUMMARY STEPS 1. enable 2. configure terminal 3. ephone ephone-tag or voice register pool pool-tag 4. codec codec-type 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters ephone configuration mode to set phone-specific parameters for a SCCP phone in Cisco Unified CME. ephone ephone-tag or voice register pool pool-tag Step 3 Example: Router(config)# voice register pool 1 or Enters voice register pool configuration mode to set phone-specific parameters for a SIP phone in Cisco Unified CME. Step 4 codec codec-type Specifies the codec for the dial peer for the IP phone being configured. Example: Router(config-ephone)# codec g729r8 • codec-type—Type? for a list of codecs. • This command overrides any previously configured codec selection set with the voice-class codec command. or Router(config-register-pool)# codec • This command overrides any previously configured codec selection set with the codec command in telephony-service configuration mode. g711alaw • SCCP only—This command can also be configured in ephone-template configuration mode and applied to one or more phones. end Exits the configuration mode and enters privileged EXEC mode. Example: Router(config-ephone)# end Step 5 or Router(config-register-pool)# end Cisco Unified Communications Manager Express System Administrator Guide 281 Configuring Phones to Make Basic Calls Configure Codecs of Individual Phones for Calls Between Local Phones What to Do Next • If you want to select the session-transport protocol for aSIPphone,seeSelectSession-TransportProtocol for a SIP Phone, on page 275. • If you are finished configuring SIP phones to make basic calls, you are ready to generate configuration files for the phones to be connected. See Generate Configuration Profiles for SIP Phones, on page 391. • If you are finished configuringSCCPphonesto make basic calls, you are ready to generate configuration files for the phones to be connected. See Generate Configuration Files for SCCP Phones, on page 388. Configure Phones for a Key System Creating Directory Numbers for a Simple Key System on SCCP Phone To create a set of directory numbers with the same number to be associated with multiple line buttons on an IP phone and provide support for call waiting and call transfer on a key system phone, perform the following steps. Restriction • Do not configure directory numbers for a key system for dual-line mode because this does not conform to the key system one-call-per-line button usage model for which the phone is designed. • Provisioning support for the Cisco Unified IP Phone 7931 is available only in Cisco Unified CME 4.0(2) and later versions. SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-dn dn-tag 4. number number [secondary number] [no-reg [both | primary]] 5. preference preference-order 6. no huntstop or huntstop 7. mwi-type {visual | audio | both} 8. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Cisco Unified Communications Manager Express System Administrator Guide 282 Configuring Phones to Make Basic Calls Configure Phones for a Key System Command or Action Purpose Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 ephone-dn dn-tag Enters ephone-dn configuration mode to create a directory number. Example: Router(config)# ephone-dn 11 Step 3 number number [secondary number] Configures a valid phone or extension number for this directory number. [no-reg [both | primary]] Step 4 Example: Router(config-ephone-dn)# number 101 Sets dial-peer preference order for a directory number associated with a Cisco Unified IP phone. preference preference-order Example: Router(config-ephone-dn)# preference 1 Step 5 • Default: 0. • Increments the preference order for all subsequent instances within a set of ephone dns with the same number to be associated with a key system phone. That is, the first instance of the directory number is preference 0 by default and you must specify 1 for the second instance of the same number, 2 for the next, and so on. This allows you to create multiple buttons with the same number on an IP phone. • Required to support call waiting and call transfer on a key system phone. Step 6 no huntstop or huntstop Explicitly enables call hunting behavior for a directory number. Example: Router(config-ephone-dn)# no huntstop • Configurenohuntstopfor all instances, except the final instance, within a set of ephone dns with the same number to be associated with a key system phone. or Router(config-ephone-dn)# huntstop • Required to allow call hunting across multiple line buttons with the same number on an IP phone. or Disables call hunting behavior for a directory number. • Configure the huntstop command for the final instance within a set of ephone dns with the same number to be associated with a key system phone. • Required to limit the call hunting to a set of multiple line buttons with the same number on an IP phone. Cisco Unified Communications Manager Express System Administrator Guide 283 Configuring Phones to Make Basic Calls Creating Directory Numbers for a Simple Key System on SCCP Phone Command or Action Purpose Step 7 mwi-type {visual | audio | both} Specifies the type of MWI notification to be received. Example: Router(config-ephone-dn)# mwi-type audible • This command is supported only by Cisco Unified IP Phone 7931s and Cisco Unified IP Phone 7911s. • This command can also be configured in ephone-dn-template configuration mode. The value set in ephone-dn configuration mode has priority over the value set in ephone-dn-template mode. end Exits to privileged EXEC mode. Example: Router(config-ephone-dn)# end Step 8 What to Do Next The following example shows the configuration for six instances of directory number 101, assigned to the first six buttons of an IP phone: ephone-dn 10 number 101 no huntstop ephone-dn 11 number 101 preference 1 no huntstop ephone-dn 12 number 101 preference 2 no huntstop ephone-dn 13 number 101 preference 3 no huntstop ephone-dn 14 number 101 preference 4 no huntstop ephone-dn 15 number 101 preference 5 ephone 1 mac-address 0001.2345.6789> type 7931 button 1:10 2:11 3:12 4:13 5:14 6:15 Configure Trunk Lines for a Key System on SCCP Phone To set up trunk lines for your key system, perform only one of the following procedures: Cisco Unified Communications Manager Express System Administrator Guide 284 Configuring Phones to Make Basic Calls Configure Trunk Lines for a Key System on SCCP Phone • To only enable directstatus monitoring of theFXO port on the line button of the IPphone,see Configure a Simple Key System Phone Trunk Line Configuration on SCCP Phone, on page 285. • To enable directstatus monitoring and allow transferredPSTN FXO line callsto be automatically recalled if the transfer target does not answer, see Configure an Advanced Key System Phone Trunk Line Configuration on SCCP Phone, on page 289. Configure a Simple Key System Phone Trunk Line Configuration on SCCP Phone Perform the steps in this section to: • Create directory numbers corresponding to each FXO line that allows phones to have shared or private lines connected directly to the PSTN. • Enable direct status monitoring of the FXO port on the line button of the IP phone. The line button indicator, either a lamp or an icon depending on the phone, shows the in-use status of the FXO port during the duration of the call. Cisco Unified Communications Manager Express System Administrator Guide 285 Configuring Phones to Make Basic Calls Configure Trunk Lines for a Key System on SCCP Phone Restriction • Directory number with a trunk line cannot be configured for call forward, busy, or no answer. • Numbers entered after a trunk line is seized will not be displayed. Only the trunk tag is displayed on IP phones. • Numbers entered after trunk line isseized will not appear in call history or call detail records(CDRs) of a Cisco Unified CME router. Only the trunk tag is logged for calls made from trunk lines. • FXO trunk lines do not support the CFwdALL, Transfer, Pickup, GPickUp, Park, CallBack, and NewCall softkeys. • FXO trunk lines do not support conference initiator dropoff. • FXO trunk lines do not support on-hook redial. The phone user must explicitly select the FXO trunk line before pressing the Redial button. • FXO trunk lines do not support call transfer to IP phones. However, the call initiator can conference an FXO line with an IP phone by pressing the Hold button, which leaves the FXO trunk line and IP phone connected. The conference initiator is unable to participate in the conference, but can place calls on other lines. • FXO trunk lines do not support bulk speed dial. • FXO port monitoring has the following restrictions: ◦Not supported before Cisco Unified CME 4.0. ◦Supported only for analog FXO loop-start and ground-start ports and T1/E1 FXO CAS ports. FXS loop-start and ground-start ports and PRI/BRI PSTN trunks are not supported. ◦Not supported for analog ports on the Cisco VG224 or Cisco ATA 180 Series. ◦T1 CAS DS0 group must be configured per time slot (cannot bundle more than one time slot into a ds0-group). • Transfer recall and transfer-to button optimization are supported on dual-line directory numbers only in Cisco Unified CME 4.0 and later versions. • Transfer-to button optimization is not supported for call forwarding, call-park recall, call pickup on hold, or call pickup at alert. Before You Begin • FXO port for a private line automatic ringdown (PLAR) off-premises extension (OPX) connection must be configured; for example: voice-port 1/0/0 connection p lar-opx 801 <<----Private number • Dial peers for FXO port must be configured; for example: dial-peer voice 111 pots destination-pattern 811 <<----Trunk-tag port 1/0/0 Cisco Unified Communications Manager Express System Administrator Guide 286 Configuring Phones to Make Basic Calls Configure Trunk Lines for a Key System on SCCP Phone SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-dn dn-tag 4. number number [secondary number] [no-reg [both | primary]] 5. trunk trunk-tag [timeout seconds] monitor-port port 6. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 ephone-dn dn-tag Enters ephone-dn configuration mode to create a directory number. Example: Router(config)# ephone-dn 51 • Configure this command in the default single line mode, without the dual-line keyword, when configuring a simple key system trunk line. Configures a valid phone or extension number for this directory number. number number [secondary number] [no-reg [both | primary]] Example: Router(config-ephone-dn)# number 801 Step 4 trunk trunk-tag [timeout seconds] monitor-port Associates a directory number with an FXO port. port Step 5 • The monitor-port keyword is not supported before Cisco Unified CME 4.0. Example: Router(config-ephone-dn)# trunk 811 monitor-port 1/0/0 • The monitor-port keyword is not supported on directory numbersfor analog ports on the Cisco VG224 or Cisco ATA 180 Series. end Returns to privileged EXEC mode. Example: Router(config-ephone-dn)# end Step 6 Cisco Unified Communications Manager Express System Administrator Guide 287 Configuring Phones to Make Basic Calls Configure Trunk Lines for a Key System on SCCP Phone Examples The following example shows the configuration for six instances of directory number 101, assigned to the first six buttons of an IP phone, plus four PSTN line appearances that are assigned to buttons 7 to 10: ephone-dn 10 number 101 no huntstop ephone-dn 11 number 101 preference 1 no huntstop ephone-dn 12 number 101 preference 2 no huntstop ephone-dn 13 number 101 preference 3 no huntstop ephone-dn 14 number 101 preference 4 no huntstop ephone-dn 15 number 101 preference 5 ephone-dn 51 number 801 trunk 811 monitor-port 1/0/0> ephone-dn 52 number 802 trunk 812 monitor-port 1/0/1 ephone-dn 53 number 803 trunk 813 monitor-port 1/0/2 ephone-dn 54 number 804 trunk 814 monitor-port 1/0/3 ephone 1 mac-address 0001.2345.6789 type 7931 button 1:11 2:12 3:13 4:14 5:15 6:16 7:51 8:52 9:53 10:54 voice-port 1/0/0 connection plar opx 801 voice-port 1/0/1 connection plar opx 802 voice-port 1/0/2 connection plar opx 803 voice-port 1/0/3 connection plar opx 804 dial-peer voice 811 pots destination-pattern 811 port 1/0/0 dial-peer voice 812 pots Cisco Unified Communications Manager Express System Administrator Guide 288 Configuring Phones to Make Basic Calls Configure Trunk Lines for a Key System on SCCP Phone destination-pattern 812 port 1/0/1 dial-peer voice 813 pots destination-pattern 813 port 1/0/2 dial-peer voice 814 pots destination-pattern 814 port 1/0/3 What to Do Next You are ready to configure each individual phone and assign button numbers, line characteristics, and directory numbers to buttons on the phone. See Configure Individual IP Phones for Key System on SCCP Phone, on page 293. Configure an Advanced Key System Phone Trunk Line Configuration on SCCP Phone Perform the steps in this section to: • Create directory numbers corresponding to each FXO line that allows phones to have shared or private lines connected directly to the PSTN. • Enable direct status monitoring of the FXO port on the line button of the IP phone. The line button indicator, either a lamp or an icon depending on the phone, shows the in-use status of the FXO port during the duration of the call. • Allow transferredPSTN FXO line callsto be automatically recalled if the transfer target does not answer after the specified number of seconds. The call is withdrawn from the transfer-to phone and the call resumes ringing on the phone that initiated the transfer. Cisco Unified Communications Manager Express System Administrator Guide 289 Configuring Phones to Make Basic Calls Configure Trunk Lines for a Key System on SCCP Phone Restriction • Ephone-dn with a trunk line cannot be configured for call forward, busy, or no answer. • Numbers entered after a trunk line is seized will not be displayed. Only the trunk tag is displayed on IP phones. • Numbers entered after a trunk line is seized will not appear in call history or call detail records (CDRs) of a Cisco Unified CME router. Only the trunk tag is logged for calls made from trunk lines. • FXO trunk lines do not support the CFwdALL, Transfer, Pickup, GPickUp, Park, CallBack, and NewCall softkeys. • FXO trunk lines do not support conference initiator dropoff. • FXO trunk lines do not support on-hook redial. The phone user must explicitly select the FXO trunk line before pressing the Redial button. • FXO trunk lines do not support call transfer to IP phones. However, the call initiator can conference an FXO line with an IP phone by pressing the Hold button, which leaves the FXO trunk line and IP phone connected. The conference initiator is unable to participate in the conference, but can place calls on other lines. • FXO trunk lines do not support bulk speed dial. • FXO port monitoring has the following restrictions: ◦Not supported before Cisco Unified CME 4.0. ◦Supported only for analog FXO loop-start and ground-start ports and T1/E1 FXO CAS ports. FXS loop-start and ground-start ports and PRI/BRI PSTN trunks are not supported. ◦Not supported for analog ports on the Cisco VG224 or Cisco ATA 180 Series. ◦T1 CAS DS0 group must be configured per time slot (cannot bundle more than one time slot into a ds0-group). • Transfer recall and transfer-to button optimization is supported on dual-line directory numbers only in Cisco Unified CME 4.0 and later. • Transfer-to button optimization is not supported for call forwarding, call-park recall, call pickup on hold, or call pickup at alert. • Transfer recall is not supported for analog ports on the Cisco VG224 or Cisco ATA 180 Series. Before You Begin • FXO port for a private line automatic ringdown (PLAR) off-premises extension (OPX) connection must be configured; for example: voice-port 1/0/0 connection plar-opx 801 <<----Private number • Dial peers for FXO port must be configured; for example: dial-peer voice 111 pots destination-pattern 811 <<----Trunk-tag port 1/0/0 Cisco Unified Communications Manager Express System Administrator Guide 290 Configuring Phones to Make Basic Calls Configure Trunk Lines for a Key System on SCCP Phone SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-dn dn-tag dual-line 4. number number [secondary number] [no-reg [both | primary]] 5. trunk digit-string [timeout seconds] [transfer-timeout seconds] [monitor-port port] 6. huntstop [channel] 7. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters ephone-dn configuration mode for the purpose of creating and configuring a telephone or extension number. ephone-dn dn-tag dual-line Example: Router(config)# ephone-dn 51 dual-line Step 3 • dual-line—Required when configuring an advanced key system phone trunk line. Dual-line mode provides a second call channel for the directory number on which to place an outbound consultation call during the call transfer attempt. This also allows the phone to remain part of the call to monitor the progress of the transfer attempt and if the transfer is not answered, to pull the call back to the phone on the original PSTN line button. Configures a valid telephone number or extension number for this directory number. number number [secondary number] [no-reg [both | primary]] Example: Router(config-ephone-dn)# number 801 Step 4 trunk digit-string [timeout seconds] Associates this directory number with an FXO port. [transfer-timeout seconds] [monitor-port port] Step 5 • transfer-timeout seconds—For dual-line ephone-dns only. Range: 5 to 60000. Default: Disabled. Example: Router(config-ephone-dn)# trunk 811 transfer-timeout 30 monitor-port 1/0/0 • The monitor-port keyword is not supported before Cisco Unified CME 4.0. Cisco Unified Communications Manager Express System Administrator Guide 291 Configuring Phones to Make Basic Calls Configure Trunk Lines for a Key System on SCCP Phone Command or Action Purpose • The monitor-port and transfer-timeout keywords are notsupported on directory numbers for analog ports on the Cisco VG224 or Cisco ATA 180 Series. Disables call hunting to the second channel of this directory number if the first channel is busy or does not answer. huntstop [channel] Example: Router(config-ephone-dn)# huntstop channel Step 6 • channel—Required when configuring an advanced key system phone trunk line. Reserves the second channel created by configuring dual-line mode for the ephone-dn command so that an outbound consultation call can be placed during a call transfer attempt. end Exits to privileged EXEC mode. Example: Router(config-ephone-dn)# end Step 7 Examples The following example shows the configuration for six instances of directory number 101, assigned to the first six buttons of an IP phone, plus four PSTN line appearances that are assigned to buttons 7 to 10. These four PSTN line appearances are configured as dual lines to provide a second call channel on which to place an outbound consultation call during a call transfer attempt. This configuration allows the phone to remain part of the call to monitor the progress of the transfer attempt, and if the transfer is not answered, to pull the call back to the phone on the original PSTN line button. ephone-dn 10 number 101 no huntstop ephone-dn 11 number 101 preference 1 no huntstop ephone-dn 12 number 101 preference 2 no huntstop ephone-dn 13 number 101 preference 3 no huntstop ephone-dn 14 number 101 preference 4 no huntstop ephone-dn 15 number 101 preference 5 ephone-dn 51 dual-line Cisco Unified Communications Manager Express System Administrator Guide 292 Configuring Phones to Make Basic Calls Configure Trunk Lines for a Key System on SCCP Phone number 801 trunk 811 transfer-timeout 30 monitor-port 1/0/0 huntstop channel ephone-dn 52 dual-line number 802 trunk 812 transfer-timeout 30 monitor-port 1/0/1 huntstop channel ephone-dn 53 dual-line number 803 trunk 813 transfer-timeout 30 monitor-port 1/0/2 huntstop channel ephone-dn 54 dual-line number 804> trunk 814 transfer-timeout 30 monitor-port 1/0/3 huntstop channel ephone 1 mac-address 0001.2345.6789 type 7931 button 1:11 2:12 3:13 4:14 5:15 6:16 7:51 8:52 9:53 10:54 voice-port 1/0/0 connection plar opx 801 voice-port 1/0/1 connection plar opx 802 voice-port 1/0/2 connection plar opx 803 voice-port 1/0/3 connection plar opx 804 dial-peer voice 811 pots destination-pattern 811 port 1/0/0 dial-peer voice 812 pots destination-pattern 812 port 1/0/1 dial-peer voice 813 pots destination-pattern 813 port 1/0/2 dial-peer voice 814 pots destination-pattern 814 port 1/0/3 Configure Individual IP Phones for Key System on SCCP Phone To assign button numbers, line characteristics, and directory numbers to buttons on an individual phone that will operate as a key system phone, perform the following steps. Cisco Unified Communications Manager Express System Administrator Guide 293 Configuring Phones to Make Basic Calls Configure Individual IP Phones for Key System on SCCP Phone Restriction • Provisioning for Cisco Unified IP Phone 7931G is available only in Cisco Unified CME 4.0(2) and later versions. • Cisco Unified IP Phone 7931G can support only one call waiting overlaid per directory number. • Cisco Unified IP Phone 7931G cannot support overlays that contain directory numbers configured for dual-line mode. SUMMARY STEPS 1. enable 2. configure terminal 3. ephone phone-tag 4. mac-address [mac-address] 5. type phone-type 6. button button-number {separator} dn-tag [,dn-tag...] [button-number{x}overlay-button-number] [button-number...] 7. mwi-line line-number 8. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 ephone phone-tag Enters ephone configuration mode. Example: Router(config)# ephone 1 Step 3 Specifies the MAC address of the IP phone that is being configured. mac-address [mac-address] Example: Router(config-ephone)# mac-address 0001.2345.6789 Step 4 Cisco Unified Communications Manager Express System Administrator Guide 294 Configuring Phones to Make Basic Calls Configure Individual IP Phones for Key System on SCCP Phone Command or Action Purpose type phone-type Specifies the type of phone that is being configured. Example: Router(config-ephone)# type 7931 Step 5 Associates a button number and line characteristics with an ephone-dn. Maximum number of buttons is determined by phone type. buttonbutton-number {separator} dn-tag [,dn-tag...] [button-number{x}overlay-button-number] [button-number...] Step 6 Example: Router(config-ephone)# button 1:11 2:12 3:13 4:14 5:15 6:16 7:51 8:52 9:53 10:54 The line button layout for the Cisco Unified IP Phone 7931G is a bottom-up array. Button 1 is at the bottom right of the array and button 24 is at the top left of the array. Tip Selects a phone line to receive MWI treatment; when a message is waiting for the selected line, the message waiting indicator is activated. mwi-line line-number Example: Router(config-ephone)# mwi-line 3 Step 7 • line-number—Range: 1 to 34. Default: 1. Exits ephone configuration mode and enters privileged EXEC mode. end Example: Router(config-ephone)# end Step 8 What to Do Next • If you have SIP and SCCP phones connected to the same Cisco Unified CME, see Configure Codecs of Individual Phones for Calls Between Local Phones, on page 280. • To select a fixed-button layout for a Cisco Unified IP Phone 7931G, see Select Button Layout for a Cisco Unified SCCP IP Phone 7931G, on page 1453. • If you are finished configuring phones to make basic calls, you are ready to generate configuration files for the phones to be connected. See Generate Configuration Files for SCCP Phones, on page 388. Configure Cisco ATA, Analog Phone Support, Remote Phones, Cisco IP Communicator, and Secure IP Phone (IP-STE) Configure Cisco ATA Support To enable an analog phone that uses a Cisco ATA to register with Cisco Unified CME, perform the following steps. Cisco Unified Communications Manager Express System Administrator Guide 295 Configuring Phones to Make Basic Calls Configure Cisco ATA, Analog Phone Support, Remote Phones, Cisco IP Communicator, and Secure IP Phone (IP-STE) For a Cisco ATA that is registered to a Cisco Unified CME system to participate in fax calls, it must have its ConnectMode parameter set to use the same RTP payload type as the Cisco voice gateway that is performing the fax pass-through. Cisco voice gateways use standard payload type 0/8, which is selected on Cisco ATAs by setting bit 2 of the ConnectMode parameter to 1. For more information, see the Parameters and Defaults chapter in Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator's Guide for SCCP (version 3.0). Restriction Step 1 Install the Cisco ATA. See the Installing the Cisco ATA chapter in Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator's Guide for SCCP (version 3.0). Step 2 Configure the Cisco ATA. See the Configuring the Cisco ATA for SCCP chapter in Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator's Guide for SCCP (version 3.0). Step 3 Upgrade the firmware to the latest Cisco ATA image. If you are using either the v2.14 or v2.14ms Cisco ATA 186 image based on the 2.14 020315a build for H.323/SIP or the 2.14 020415a build for MGCP or SCCP, you must upgrade to the latest version to install a security patch. This patch fixes a security hole in the Cisco ATA Web server that allows users to bypass the user interface password. For information about upgrading firmware, see Install Cisco Unified CME Software, on page 105. Alternatively, you can use a manual method, as described in the Upgrading the Cisco ATA Signaling Image chapter of Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator's Guide for SCCP (version 3.0). Step 4 Set the following network parameters on the Cisco ATA: • DHCP parameter to 1 (enabled). • TFTP parameter to 1 (enabled). • TFTPURL parameter to the IP address of the router running Cisco Unified CME. • SID0 parameter to a period (.) or the MAC address of the Cisco ATA (to enable the first port). • SID1 parameter to a period (.) or a modified version the Cisco ATA’s MAC address, with the first two hexadecimal numbers removed and 01 appended to the end, if you want to use the second port.For example, if the MAC address of the Cisco ATA is 00012D01073D, set SID1 to 012D01073D01. • Nprintf parameter to the IP address and port number of the host to which all Cisco ATA debug messages are sent. The port number is usually set to 9001. • To prevent tampering and unauthorized access to the Cisco ATA 186, you can disable the web-based configuration. However, if you disable the web configuration page, you must use either a TFTP server or the voice configuration menu to configure the Cisco ATA 186. Step 5 In Cisco Unified CME, configure analog phones that use a Cisco ATA in the same way as a Cisco Unified IP phone. In the type command, use the ata keyword. For information on how to provision phones, see Create Directory Numbers for SCCP Phones, on page 253. Cisco Unified Communications Manager Express System Administrator Guide 296 Configuring Phones to Make Basic Calls Configure Cisco ATA Support What to Do Next • If you have SIP and SCCP phones connected to the same Cisco Unified CME, see Configure Codecs of Individual Phones for Calls Between Local Phones, on page 280. • To select a fixed-button layout for a Cisco Unified IP Phone 7931G, see Select Button Layout for a Cisco Unified SCCP IP Phone 7931G, on page 1453. • If you are finished configuring phones to make basic calls, you are ready to generate configuration files for the phones to be connected. See Generate Configuration Files for SCCP Phones, on page 388 and Generate Configuration Profiles for SIP Phones, on page 391. Verify Cisco ATA Support Use the show ephone ata command to display SCCP phone configurations with the type ata command. The following is sample output for a Cisco Unified CME configured for two analog phones using a Cisco ATA with MAC address 000F.F758.E70E: ephone-30 Mac:000F.F758.E70E TCP socket:[2] activeLine:0 REGISTERED in SCCP ver 1 and Server in ver 1 mediaActive:0 offhook:0 ringing:0 reset:0 reset_sent:0 paging 0 debug:0 caps:7 IP:1.4.188.72 15325 ATA Phone keepalive 7 max_line 2 dual-line button 1: dn 80 number 8080 CH1 IDLE CH2 IDLE ephone-31 Mac:0FF7.58E7.0E01 TCP socket:[3] activeLine:0 REGISTERED in SCCP ver 1 and Server in ver 1 mediaActive:0 offhook:0 ringing:0 reset:0 reset_sent:0 paging 0 debug:0 caps:3 IP:1.4.188.72 15400 ATA Phone keepalive 7 max_line 2 dual-line button 1: dn 81 number 8081 CH1 IDLE CH2 IDLE Troubleshooting Cisco ATA Support Use the debug ephone detail command to diagnose problems with analog phones that use Cisco ATAs. Call Pickup and Group Call Pickup with Cisco ATA Most of the procedures for using Cisco ATAs with Cisco Unified CME are the same as those for using Cisco ATAs with Cisco Unified Communications Manager, as described in the How to Use Pre-Call and Mid-Call Services chapter of Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for SCCP (version 3.0). However, the call pickup and group call pickup procedures are different when using Cisco ATAs with Cisco Unified CME, as described below: Call Pickup When using Cisco ATAs with Cisco Unified CME: • To pickup the last parked call, press **3*. • To pickup a call on a specific extension, press **3 and enter the extension number. • To pickup a call from a park slot, press **3 and enter the park slot number. Cisco Unified Communications Manager Express System Administrator Guide 297 Configuring Phones to Make Basic Calls Verify Cisco ATA Support Group Call Pickup When using Cisco ATAs with Cisco Unified CME: • To answer a phone within your call pickup group, press **4*. • To answer a phone outside of your call pickup group, press **4 and the group ID number. Note If there is only one pickup group, you do not need to enter the group ID after the **4 to pickup a call. Configure Voice and T.38 Fax Relay on Cisco ATA-187 Restriction • H.323 trunk calls are not supported. • Hardware conferencing with DSPFarm resource is notsupported on Cisco ATA-187 in Cisco Unified CME 9.0. With the correct firmware (9.2(3) or a later version), local three-way conferencing is supported. Before You Begin Cisco Unified CME 9.0 or a later version. Cisco Unified Communications Manager Express System Administrator Guide 298 Configuring Phones to Make Basic Calls Configure Voice and T.38 Fax Relay on Cisco ATA-187 SUMMARY STEPS 1. enable 2. configure terminal 3. voice register global 4. authenticate realm string 5. exit 6. voice service {voip | voatm} 7. allow-connections from-type to to-type 8. fax protocol t38 [ls_redundancy value [hs_redundancy value]] [fallback {cisco | none | pass-through {g711ulaw | g711alaw}}] 9. exit 10. voice register pool pool-tag 11. id mac address 12. type phone-type 13. ata-ivr-pwd password 14. session-transport {tcp | udp} 15. number tag dn dn-tag 16. username username [password password] 17. codec codec-type [bytes] 18. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 voice register global Enters voice register global configuration mode. Example: Router(config)# voice register global Step 3 Step 4 authenticate realm string • realm string—Realm parameter for challenge and response as specified in RFC 2617 is authenticated. Example: Router(config-register-global)# authenticate realm xxxxx Cisco Unified Communications Manager Express System Administrator Guide 299 Configuring Phones to Make Basic Calls Configure Voice and T.38 Fax Relay on Cisco ATA-187 Command or Action Purpose exit Exits voice register global configuration mode. Example: Router(config-register-global)# exit Step 5 Enters voice-service configuration mode to specify a voice encapsulation type. voice service {voip | voatm} Example: Router(config)# voice service voip Step 6 • voip—Specifies Voice over IP (VoIP) parameters. • voatm—Specifies Voice over ATM (VoATM) parameters. Step 7 allow-connections from-type to to-type Allows connections between specific types of endpointsin a VoIPnetwork. Example: Router(config-voi-serv)# allow-connections sip to sip • from-type—Originating endpoint type. The following choices are valid: ◦sip—Session Interface Protocol. • to—Indicates that the argument that follows is the connection target. • to-type—Terminating endpoint type. The following choices are valid: ◦sip—Session Interface Protocol. Specifies the global default ITU-T T.38 standard fax protocol to be used for all VoIP dial peers. fax protocol t38 [ls_redundancy value [hs_redundancy value]] [fallback {cisco | Step 8 none | pass-through {g711ulaw | g711alaw}}] • ls_redundancy value—(Optional) (T.38 fax relay only) Specifies the number of redundant T.38 fax packetsto be sent for the low-speed Example: Router(config-voi-serv)# fax protocol t38 ls-redundancy 0 hs-redundancy 0 fallback pass-through g711ulaw V.21-based T.30 fax machine protocol. Range varies by platform from 0 (no redundancy) to 5 or 7. Default is 0. • hs_redundancy value—(Optional) (T.38 fax relay only) Specifies the number of redundant T.38 fax packets to be sent for high-speed V.17, V.27, and V.29 T.4 or T.6 fax machine image data. Range varies by platform from 0 (no redundancy) to 2 or 3. Default is 0. • fallback—(Optional) A fallback mode is used to transfer a fax across a VoIPnetwork if T.38 fax relay could not be successfully negotiated at the time of the fax transfer. • pass-through—(Optional) The fax stream uses one of the following high-bandwidth codecs: ◦g711ulaw—Uses the G.711 u-law codec. ◦g711alaw—Uses the G.711 a-law codec. Cisco Unified Communications Manager Express System Administrator Guide 300 Configuring Phones to Make Basic Calls Configure Voice and T.38 Fax Relay on Cisco ATA-187 Command or Action Purpose exit Exits voice-service configuration mode. Example: Router(config-voi-serv)# exit Step 9 Enters voice register pool configuration mode to set phone-specific parameters for a Cisco Unified SIP phone in Cisco Unified CME. voice register pool pool-tag Example: Router(config)# voice register pool 11 Step 10 • pool-tag—Unique number assigned to the pool. Range: 1 to 100. Step 11 id mac address identifies a locally available Cisco Unified SIP IP phone. Example: Router(config-register-pool)# id mac 93FE.12D8.2301 • mac address—Identifies the MAC address of a particular Cisco Unified SIP IP phone. type phone-type Defines a phone type for the SIP phone being configured. Example: Router(config-register-pool)# type ATA-187 Step 12 (Optional) Defines a password to access interactive voice response (IVR) and change the default phone settings on Cisco Analog Telephone Adaptors. ata-ivr-pwd password Example: Router(config-register-pool)# ata-ivr-pwd 1234 Step 13 • password—Four-digit or five-digit string to be used as password to access IVR. Password string must contain numbers 0 to 9. (Optional) Specifies the transport layer protocol that a Cisco Unified SIP IP phone uses to connect to Cisco Unified CME. session-transport {tcp | udp} Example: Router(config-register-pool)# session-transport tcp Step 14 • tcp—Transmission Control Protocol (TCP) is used. • udp—User Datagram Protocol (UDP) is used. This is the default. Indicates the E.164 phone numbers that the registrar permits to handle the Register message from the Cisco Unified SIP IP phone. number tag dn dn-tag Example: Router(config-register-pool)# number 1 dn 33 Step 15 • tag—Identifiesthe telephone number when there are multiple number commands. Range: 1 to 10. • dndn-tag—Identifiesthe directory number tag for this phone number as defined by the voice register dn command. Range: 1 to 150. Assigns an authentication credential to a phone user so that the SIP phone can register in Cisco Unified CME. username username [password password] Example: Router(config-register-pool)# username ata112 password cisco Step 16 • username—Username of the local Cisco IP phone user. Default: Admin. • password—Enables password for the Cisco IP phone user. Cisco Unified Communications Manager Express System Administrator Guide 301 Configuring Phones to Make Basic Calls Configure Voice and T.38 Fax Relay on Cisco ATA-187 Command or Action Purpose • password—Password string. Specifies the codec to be used when setting up a call for a SIP phone or group of SIP phones in Cisco Unified CME. codec codec-type [bytes] Example: Router(config-register-pool)# codec g711ulaw Step 17 • codec-type—Preferred codec; values are as follows: ◦g711alaw—G.711 A law 64K bps. ◦g711ulaw—G.711 micro law 64K bps. ◦g722r64—G.722-64K at 64K bps. ◦g729r8—G.729 8K bps (default). ◦ilbc— internet Low Bitrate Codec (iLBC) at 13,330 bps or 15,200 bps. end Exits to privileged EXEC mode. Example: Router(config-register-pool)# end Step 18 Auto-Configuration for Cisco VG202, VG204, and VG224 Restriction Supported only for the Cisco VG202, VG204, and VG224 voice gateways. Before You Begin • Cisco Unified CME 7.1 or a later version. The Cisco Unified CME router must be configured and running before you boot the analog voice gateway. See Set Up Cisco Unified CME for SCCP Phones , on page 175. • Default location of configuration files is system:/its/. To define an alternate location at which to save the gateway configuration files, see Define Per-Phone Configuration Files and Alternate Location for SCCP Phones, on page 181. • To automatically assign the next available directory number to the voice port as it registers to Cisco Unified CME, and create an ephone entry associated with each voice port, enable the auto assign command in Cisco Unified CME. Cisco Unified Communications Manager Express System Administrator Guide 302 Configuring Phones to Make Basic Calls Auto-Configuration for Cisco VG202, VG204, and VG224 SUMMARY STEPS 1. enable 2. configure terminal 3. voice-gateway system tag 4. mac-address mac-address 5. type {vg202 | vg204 | vg224} 6. voice-port port-range 7. network-locale locale-code 8. create cnf-files 9. reset or restart 10. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice gateway configuration mode and creates a voice gateway configuration. voice-gateway system tag Example: Router(config)# voice-gateway system 1 Step 3 mac-address mac-address Defines the MAC address of the voice gateway to autoconfigure. Example: Router(config-voice-gateway)# mac-address Step 4 type {vg202 | vg204 | vg224} Defines the type of voice gateway to autoconfigure. Example: Router(config-voice-gateway)# type vg224 Step 5 Identifies the ports on the voice gateway that register to Cisco Unified CME. voice-port port-range Example: Router(config-voice-gateway)# voice-port 0-23 Step 6 Cisco Unified Communications Manager Express System Administrator Guide 303 Configuring Phones to Make Basic Calls Auto-Configuration for Cisco VG202, VG204, and VG224 Command or Action Purpose Selects a geographically specific set of tones and cadences for the voice gateway s analog endpoints that register to Cisco Unified CME. network-locale locale-code Example: Router(config-voice-gateway)# network-locale FR Step 7 Generates the XML configuration files that are required for the voice gateway to autoconfigure its analog ports that register to Cisco Unified CME. create cnf-files Example: Router(config-voice-gateway)# create cnf-files Step 8 (Optional) Performs a complete reboot of all analog phones associated with the voice gateway and registered to Cisco Unified CME. reset or restart Example: Router(config-voice-gateway)# reset Step 9 or or Router(config-voice-gateway)# restart (Optional) Performs a fast restart of all analog phones associated with the voice gateway after simple changes to buttons, lines, or speed-dial numbers. • Use these commands to download new configuration files to the analog phones after making configuration changes to the phones in Cisco Unified CME. end Exits to privileged EXEC mode. Example: Router(config-voice-gateway)# end Step 10 The following example shows the voice gateway configuration in Cisco Unified CME: voice-gateway system 1 network-locale FR type VG224 mac-address 001F.A30F.8331 voice-port 0-23 create cnf-files What to Do Next • Cisco VG202 or VG204 voice gateway Enable the gateway for autoconfiguration. See the Auto-Configuration on the Cisco VG202 and Cisco VG204 Voice Gateways section in Cisco VG202 and Cisco VG204 Voice Gateways Software Configuration Guide. • Cisco VG224 analog phone gateway Enable SCCP and the STC application on the gateway. See the Configuring FXS Ports for Basic Calls chapter in Supplementary Services Features for FXS Ports on Cisco IOS Voice Gateways Configuration Guide. Cisco Unified Communications Manager Express System Administrator Guide 304 Configuring Phones to Make Basic Calls Auto-Configuration for Cisco VG202, VG204, and VG224 Configure Phones on SCCP Controlled Analog (FXS) Ports Configuring Cisco Unified CME to support calls and features on analog endpoints connected toSCCPcontrolled analog (FXS) ports is basically the same as configuring any SCCP phone in Cisco Unified CME. This section describes only the steps that have special meaning for phones connected to a Cisco VG224 Analog Phone Gateway. Restriction FXS ports on Cisco VG248 analog phone gateways are not supported by Cisco Unified CME. Before You Begin • For phones connected to analogFXSports on the Cisco VG224 AnalogPhone Gateway: Cisco CME 3.2.2 or a later version. • For phones connected to analogFXSports on the Cisco IntegratedServices Routers(ISR) voice gateway: Cisco Unified CME 4.0 or a later version. • Cisco ISR voice gateway or Cisco VG224 analog phone gateway isinstalled and configured for operation. For information, see the appropriate Cisco configuration documentation. • Prior to Cisco IOS Release 12.4(11)T, set the timeouts ringing command to infinity for all SCCP-controlled analog ports. In Cisco IOS Release 12.4(11)T and later, the default for this command is infinity. • SCCP is enabled on the Cisco IOS voice gateway. For configuration information, see Supplementary Services Features for FXS Ports on Cisco IOS Voice Gateways Configuration Guide. Step 1 Set up ephone-dns for up to 24 endpoints on the Cisco IOS gateway. Use the ephone-dn command: Example: ephone-dn 1 dual-line number 1000 . . . ephone-dn 24 dual-line number 1024 Step 2 Set the maximum number of ephones. Use the max ephones command to set a number equal to or greater than the total number of endpoints that you intend to register on the Cisco Unified CME router, including both IP and analog endpoints. For example, if you have 6 IP phones and 12 analog phones, set the max ephones command to 18 or greater. Step 3 Assign ephone-dns to ephones. Use the auto assign command to enable the automatic assignment of an available ephone-dn to each phone as the phone contacts the Cisco Unified CME router to register. Cisco Unified Communications Manager Express System Administrator Guide 305 Configuring Phones to Make Basic Calls Configure Phones on SCCP Controlled Analog (FXS) Ports The order of ephone-dn assignment is not guaranteed. For example, if you have analog endpoints on ports 2/0 through 2/23 on the Cisco IOSgateway, port 2/0 does not necessarily become ephone 1. Use one of the following commands to enable automatic ephone-dn assignment. Note • auto assign 1 to 24—You do not need to use the type keyword if you have only analog endpoints to be assigned or if you want all endpoints to be automatically assigned. • auto assign 1 to 24 type anl—Use the type keyword if you have other phone types in the system and you want only the analog endpoints to be assigned to ephone-dns automatically. An alternative to using the auto assign command is to manually assign ephone-dns to ephones (analog phones on FXS ports). This method is more complicated, but you might need to use it if you want to assign a specific extension number (ephone-dn) to a particular ephone. The reason that manual assignment is more complicated is because a unique device ID is required for each registering ephone and analog phones do not have unique MAC addresses like IP phones do. To create unique device IDs for analog phones, the auto assign process uses a particular algorithm. When you make manual ephone assignments, you have to use the same algorithm for each phone that receives a manual assignment. The algorithm uses the single 12-digitSCCPlocal interface MAC address on the Cisco IOSgateway as the base to create unique 12-digit device IDs for all the FXS ports on the Cisco IOS gateway. The rightmost 9 digits of the SCCP local interface MAC address are shifted left three places and are used as the leftmost 9 digits for all 24 individual device IDs. The remaining 3 digits are the hexadecimal translation of the binary representation of the port’s slot number (3 digits), subunit number (2 digits), and port number (7 digits). The following example shows the use of the algorithm to create a unique device ID for one port: 1 The MAC address for the Cisco VG224 SCCP local interface is 000C.8638.5EA6. 2 TheFXSport has a slot number of 2 (010), a subunit number of 0 (00), and a port number of 1 (0000001). The binary digits are strung together to become 0100 0000 0001, which is then translated to 401 in hexadecimal to create the final device ID for the port and ephone. 3 The resulting unique device ID for this port is C863.85EA.6401. When manually setting up an ephone configuration for an analog port, assign it just one button because the port represents a single-line device. Thebuttoncommand can use the “:” (colon, for normal), “o” (overlay) and “c” (call-waiting overlay) modes. Once you have assigned ephone-dns to all the ephones that you want to assign manually, you can use the auto assign command to automatically assign the remaining ports. Note Step 4 Set up feature parameters as desired. The following list includes commonly configured features.For information aboutsupported features,seeSupplementary Services Features for FXS Ports on Cisco IOS Voice Gateways Configuration Guide. • Call transfer—To use call transfer from analog endpoints, the transfer-system command must be configured for the full-blind orfull-consult keyword in telephony-service configuration mode on the Cisco Unified CME router. This is the recommended setting for Cisco CME 3.0 and later versions, but it is not the default. • Call forwarding—Call forwarding destinations are specified for all, busy, and no-answer conditions for each ephone-dn using the call-forward all, call-forward busy, and call-forward noan commands in ephone-dn configuration mode. • Call park—Call-park slots are created using thepark-slot command in ephone-dn configuration mode.Phone users must be instructed how to transfer calls to the call-park slots and use directed pickup to retrieve the calls. • Call pickup groups—Extensions are added to pickup groups using the pickup-group command in ephone-dn configuration mode. Phone users must be told which phones are in which groups. Cisco Unified Communications Manager Express System Administrator Guide 306 Configuring Phones to Make Basic Calls Configure Phones on SCCP Controlled Analog (FXS) Ports • Caller ID—Caller names are defined using the name command in ephone-dn configuration mode. Caller numbers are defined using the number command in ephone-dn configuration mode. • Speed dial—Numbers to be speed-dialed are stored with their associated speed-dial codes using the speed-dial command in ephone configuration mode. • Speed dial to voice mail—The voice-mail number is defined using the voicemail command in telephony-service configuration mode. Step 5 Set up feature restrictions as desired. Featuressuch astransfer, conference, park, pickup, group pickup (gpickup), and call forward all (cfwdall) can be restricted from individual ephones using the appropriate Cisco Unified CME softkey template command, even though analog phones do not have softkeys. Simply create a template that leaves out the softkey that represents the feature you want to restrict and apply the template to the ephone for which you want the feature restricted. For more information about softkey template customization, see Customize Softkeys, on page 925. What to Do Next • If you have SIP and SCCP phones connected to the same Cisco Unified CME, see Configure Codecs of Individual Phones for Calls Between Local Phones, on page 280. • To select a fixed-button layout for a Cisco Unified IP Phone 7931G, see Select Button Layout for a Cisco Unified SCCP IP Phone 7931G, on page 1453. • After configuring phones in Cisco Unified CME to make basic calls, you are ready to generate configuration files for the phones to be connected. See Generate Configuration Files for SCCP Phones, on page 388. Verify Analog Phone Support Use the following show commands to display information about analog endpoints. • show ephone anl—Displays MAC address, registration status, ephone-dn, and speed-dial numbers for analog ephones. • show telephony-service ephone-dn—Displays call forward, call waiting, pickup group, and more information about ephone-dns. • show running-config—Displays running configuration nondefault values. Enable Remote Phone To enable IP phones or instances of Cisco IP Communicator to connect to a Cisco Unified CME system over a WAN, perform the following steps. Cisco Unified Communications Manager Express System Administrator Guide 307 Configuring Phones to Make Basic Calls Verify Analog Phone Support Restriction • Because Cisco Unified CME is not designed for centralized call processing, remote phones are supported only for fixed teleworker applications, such as working from a home office. • Cisco Unified CME does not support CAC for remote SCCP phones, so voice quality can degrade if a WAN link is oversubscribed. High-bandwidth data applications used over a WAN can cause degradation of voice quality for remote IP phones. • Cisco Unified CME does notsupport Emergency 911 (E911) callsfrom remote IPphones. Teleworkers using remote phones connected to Cisco Unified CME over a WAN should be advised not to use these phones for E911 emergency services because the local public safety answering point (PSAP) will not be able to obtain valid calling-party information from them. We recommend that you make all remote phone users aware of this issue. One way is to place a label on all remote teleworker phones that reminds users not to place 911 emergency calls on remote IP phones. Remote workers should place any emergency calls through locally configured hotel, office, or home phones (normal land-line phones) whenever possible. Inform remote workers that if they must use remote IP phones for emergency calls, they should be prepared to provide specific location information to the answering PSAP personnel, including street address, city, state, and country. Before You Begin • The WAN link supporting remote teleworker phonesshould be configured with a Call Admission Control (CAC) or Resource ReservationProtocol (RSVP)solution to prevent the oversubscription of bandwidth, which can degrade the quality of all voice calls. • If DSPfarms will be used for transcoding, you must configure them separately.See Configure Transcoding Resources, on page 479. • A SCCP phone to be enabled as a remote phone is configured in Cisco Unified CME. For configuration information, see Create Directory Numbers for SCCP Phones, on page 253. SUMMARY STEPS 1. enable 2. configure terminal 3. ephone phone-tag 4. mtp 5. codec {g711ulaw | g722r64 | g729r8 [dspfarm-assist]} 6. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. Cisco Unified Communications Manager Express System Administrator Guide 308 Configuring Phones to Make Basic Calls Enable Remote Phone Command or Action Purpose configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 ephone phone-tag Enters ephone configuration mode. Example: Router(config)# ephone 36 • phone-tag—Unique sequence number that identifiesthis ephone during configuration tasks. mtp Sends media packets to the Cisco Unified CME router. Example: Router(config-ephone)# mtp Step 4 codec {g711ulaw | g722r64 | g729r8 (Optional) Selects a preferred codec for setting up calls. [dspfarm-assist]} Step 5 • Default: G.711 mu-law codec. Example: Router(config-ephone)# codec g729r8 dspfarm-assist • The g722r64 keyword requires Cisco Unified CME 4.3 and later versions. • dspfarm-assist—Attempts to use DSP-farm resources for transcoding the segment between the phone and the Cisco Unified CME router if G.711 is negotiated for the call. Thedspfarm-assist keyword isignored if theSCCPendpoint type is ATA, VG224, or VG248. Note end Returns to privileged EXEC mode. Example: Router(config-ephone)# end Step 6 What to Do Next • If you have SIP and SCCP phones connected to the same Cisco Unified CME, see Configure Codecs of Individual Phones for Calls Between Local Phones, on page 280. • To select a fixed-button layout for a Cisco Unified IP Phone 7931G, see Select Button Layout for a Cisco Unified SCCP IP Phone 7931G, on page 1453. • After configuring phones in Cisco Unified CME to make basic calls, you are ready to generate configuration files for the phones to be connected. See Generate Configuration Files for SCCP Phones, on page 388. Cisco Unified Communications Manager Express System Administrator Guide 309 Configuring Phones to Make Basic Calls Enable Remote Phone Verify Remote Phones Use the show running-config command or the show telephony-service ephone command to verify parameter settings for remote ephones. Configure Cisco IP Communicator Support on SCCP Phone To enable support for Cisco IP Communicator, perform the following steps. Before You Begin • Cisco Unified CME 4.0 or a later version. • IP address of the Cisco Unified CME TFTP server. • PC for Cisco IP Communicator isinstalled.For hardware and platform requirements,see the appropriate Cisco IP Communicator User Guide. • Audio devices, such as headsets and handsets for users, are installed. You can install audio devices any time, but the ideal time to do this is before you install and launch Cisco IP Communicator. • Directory numbers and ephone configuration for Cisco IP Communicator are configured in Cisco Unified CME. For information, see Configure Phones for a PBX System, on page 253. Step 1 Download Cisco IP Communicator 2.0 or a later version software from the software download site at http://www.cisco.com/ cgi-bin/tablebuild.pl/ip-iostsp. Step 2 Install the software on your PC, then launch the Cisco IP Communicator application. For information, see the Installing and Launching Cisco IP Communicator section in the appropriate Cisco IP Communicator User Guide. Step 3 Complete the configuration and registration tasks on the Cisco IP Communicator as required, including the following: a) Configure the IP address of the Cisco Unified CME TFTP server. • Right-click on the Cisco IP Communicator interface, then choose Preferences > Network > Use these TFTP servers. • Enter the IP address of the Cisco Unified CME TFTP server in the field. b) Disable the Optimize for low bandwidth parameter to ensure that Cisco IP Communicator sends voice packets for all calls. Cisco Unified Communications Manager Express System Administrator Guide 310 Configuring Phones to Make Basic Calls Verify Remote Phones The following steps are required to enable Cisco IP Communicator to support the G.711 codec, which is the fallback codec for Cisco Unified CME. You can compensate for disabling the optimization parameter by using the codec command in ephone configuration mode to configure G.729 or another advanced codec as the preferred codec for Cisco IP Communicator. This helps to ensure that the codec for a VoIP(For example, SIP or H.323) dial-peer is supported by Cisco IP Communicator and can prevent audio problems caused by insufficient bandwidth. Note • Right-click on the Cisco IP Communicator interface and choose Preferences > Audio. • Uncheck the checkbox next to Optimize for low bandwidth. Step 4 Wait for the Cisco IP Communicator application to connect and register to Cisco Unified CME. Step 5 Test Cisco IP Communicator. For more information, see Verify Cisco IP Communicator Support on SCCP Phone, on page 311. Verify Cisco IP Communicator Support on SCCP Phone Step 1 Use the show running-config command to display ephone-dn and ephone information associated with this phone. Step 2 After Cisco IP Communicator registers with Cisco Unified CME, it displays the phone extensions and softkeys in its configuration. Verify that these are correct. Step 3 Make a local call from the phone and have someone call you. Verify that you have a two-way voice path. Troubleshooting Cisco IP Communicator Support on SCCP Phone Use the debug ephone detail command to diagnose problems with calls. For more information, see Cisco Unified CME Command Reference. Configure Secure IP Phone (IP-STE) on SCCP Phone To configure an IP-STE phone on Cisco Unified CME, perform the following steps. Cisco Unified Communications Manager Express System Administrator Guide 311 Configuring Phones to Make Basic Calls Verify Cisco IP Communicator Support on SCCP Phone Restriction • Detection or conversion between Network Transmission Equipment (NTE) and Session Signaling Event (SSE) is not supported. • Transcoding or trans-compress rate support for different Voice Band Data (VBD) and Modem Relay (MR) media type is not supported. • IP-STE supports only single-line calls, dual-line and octo-line calls are not supported. • Speed-dial can only be configured manually on the IP-STE. Before You Begin Cisco Unified CME 8.0 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. ephone phone-tag 4. mac-address [mac-address] 5. type ip-ste 6. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 ephone phone-tag Enters ephone configuration mode. Example: Router(config)# ephone 6 • phone-tag—Unique sequence number that identifiesthis ephone during configuration tasks. The maximum number of ephones is version and platform-specific. Type ? to display range. Specifies the MAC address of the IP phone that is being configured. mac-address [mac-address] Example: Router(config-ephone)# mac-address 2946.3f2.311 Step 4 Cisco Unified Communications Manager Express System Administrator Guide 312 Configuring Phones to Make Basic Calls Configure Secure IP Phone (IP-STE) on SCCP Phone Command or Action Purpose type ip-ste Specifies the type of phone. Example: Router(config-ephone)# type ip-ste Step 5 end Returns to privileged EXEC mode. Example: Router(config-ephone)# end Step 6 Configure Phone Services XML File for Cisco Unified Wireless Phone 7926G To configure the phone services XML file for Cisco Unified Wireless phone 7926G, perform the following steps: Before You Begin Cisco Unified CME 8.6 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. ephone phone-tag 4. mac-address [mac-address] 5. type phone-type 6. button button-number 7. ephone-template template tag 8. service [phone parameter name parameter value] | [xml-config append phone_service xml filename] 9. telephony-service 10. cnf-file perphone 11. create cnf-files 12. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. Cisco Unified Communications Manager Express System Administrator Guide 313 Configuring Phones to Make Basic Calls Configure Phone Services XML File for Cisco Unified Wireless Phone 7926G Command or Action Purpose configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 ephone phone-tag Enters ephone configuration mode. Example: Router(config)# ephone 1 Step 3 Specifies the MAC address of the IP phone that is being configured. mac-address [mac-address] Example: Router(config-ephone)# mac-address 0001.2345.6789 Step 4 type phone-type Specifies the type of phone that is being configured. Example: Router(config-ephone)# type 7926 Step 5 button button-number Creates a set of ephone-dns overlaid on a single button. Example: Router(config-ephone)# button 1:1 Step 6 Enters ephone-template configuration mode to create an ephone template. ephone-template template tag Example: Router(config)#ephone-template 5 Step 7 Sets parametersfor all IPphonesthatsupport the configured functionality and to which this template is applied. service [phone parameter name parameter value] | [xml-config append phone_service xml filename] Step 8 Example: Router(config-ephone-template)#service xml-config append flash:7926_phone_services.xml • parameter name—The parameter name is word and case-sensitive. See Cisco Unified CME Command Reference. • phone_service xml filename—Allows the addition of a phone services xml file. telephony-service Enters telephony-service configuration mode. Example: Router(config)telephony-service Step 9 Specifies that the system generates a separate configuration XML file for each IP phone. cnf-file perphone Example: (config-telephony)# cnf-file perphone Step 10 • Separate configuration files for each endpoint are required for security. Cisco Unified Communications Manager Express System Administrator Guide 314 Configuring Phones to Make Basic Calls Configure Phone Services XML File for Cisco Unified Wireless Phone 7926G Command or Action Purpose create cnf-files Builds XML configuration files required for SCCP phones. Example: Router(config-telephony)# create cnf-files Step 11 end Returns to privileged EXEC mode. Example: Router(config-telephony)#end Step 12 Configure Phones to Make Basic Call Configure Auto Registration for SIP Phones To configure automatic registration ofSIPphones with the Cisco Unified CME system, perform the following steps. Restriction • The DNs assigned to auto registered phones cannot be configured as shared line DNs. • Only Cisco Unified 7800 and 8800 series phones are supported with auto registration. Before You Begin • Cisco CME 11.5 or a later version. • It is recommended that administrators choose different DN ranges for manually configured and auto configured phones. • It is mandatory thatpasswordis configured before DN range (auto-assign) while registeringSIPphones using auto registration. Cisco Unified Communications Manager Express System Administrator Guide 315 Configuring Phones to Make Basic Calls Configure Phones to Make Basic Call SUMMARY STEPS 1. enable 2. configure terminal 3. voice register global 4. auto-register 5. password string 6. auto-assign First DN number to Last DN number 7. service-enable 8. template tag 9. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 voice register global Enters voice register global configuration mode. Example: Router(config)# voice register global Step 3 Enters auto registration mode forSIPphonesregistering with Unified CME. auto-register Example: Router(config-register-global)# auto-register Step 4 Step 5 password string Configures the default password for SIP phones that auto register. Example: Router(config-voice-auto-register)# password cisco • string—Configures the mandatory word string that administrator provides for auto registration of phones on Unified CME. Configures the range of directory numbers for phones that auto register on Unified CME. auto-assign First DN numbertoLast DN number Example: Router(config-voice-auto-register)# auto-assign 1 to 10 Step 6 • First DN number to Last DN number—Range is 1 to 4294967295. Cisco Unified Communications Manager Express System Administrator Guide 316 Configuring Phones to Make Basic Calls Configure Auto Registration for SIP Phones Command or Action Purpose Enables the auto registration of SIP phones on Unified CME. Once auto-register command is entered, the service is enabled by default. service-enable Example: Router(config-voice-auto-register)# service-enable Step 7 To temporarily disable auto registration feature without losing DN and password configurations, use the no form of this command. Configures a basic configuration template that supports all the configurations available on the voice register template. template tag Example: Router(config-voice-auto-register) template 10 Step 8 • It is mandatory that voice register template is configured with the same template tag. • tag—Range is 1 to 10. end Exits to privileged EXEC mode. Example: Router(config-voice-auto-register)# end Step 9 Configure a Mixed Shared Line To configure a mixed shared line between Cisco Unified SIP IP and Cisco Unified SCCP IP phones, perform the following steps. Restriction • Cisco Unified SCCP trunk-dn is not supported. • Mixed shared lines can only be configured on one of several common directory numbers. • Mixed shared lines are not supported in Cisco Unified SRST. Before You Begin Cisco Unified CME 9.0 or a later version. Cisco Unified Communications Manager Express System Administrator Guide 317 Configuring Phones to Make Basic Calls Configure a Mixed Shared Line SUMMARY STEPS 1. enable 2. configure terminal 3. voice register dn dn-tag 4. number number 5. shared-line [max-calls number-of-calls] 6. exit 7. ephone-dn dn-tag [dual-line | octo-line] 8. number number 9. shared-line sip 10. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 voice register dn dn-tag Enters voice register dn configuration mode. Example: Router(config)# voice register dn 1 • dn-tag—Unique sequence number that identifies a particular directory number during configuration tasks. Range is 1 to 150 or the maximum defined by the max-dn command. Associates a telephone or extension number with a Cisco Unified SIP IP phone in a Cisco Unified CME system. number number Example: Router(config-register-dn)# number 1001 Step 4 • number—String of up to 16 characters that represents an E.164 telephone number. Normally, the string is composed of digits, but the string may contain alphabetic characters when the number is dialed only by the router, as with an intercom number. Creates a directory number to be shared by multiple Cisco Unified SIP IP phones. shared-line [max-calls number-of-calls] Example: Router(config-register-dn)# shared-line max-calls 4 Step 5 • max-calls number-of-calls—(Optional) Maximum number of active calls allowed on the shared line. Range: 2 to 16. Default: 2. Cisco Unified Communications Manager Express System Administrator Guide 318 Configuring Phones to Make Basic Calls Configure a Mixed Shared Line Command or Action Purpose exit Exits voice register dn configuration mode. Example: Router(config-register-dn)# exit Step 6 Enters ephone-dn configuration mode to configure a directory number for an IP phone line. ephone-dn dn-tag [dual-line | octo-line] Example: Router(config)# ephone-dn 1 octo-line Step 7 • dn-tag—Unique number that identifies an ephone-dn during configuration tasks. Range is 1 to the number set by the max-dn command. • dual-line—(Optional) Enables two calls per directory number. • octo-line—(Optional) Enables eight calls per directory number. Step 8 number number Associates a telephone or extension number with this ephone-dn. Example: Router(config-ephone-dn)# number 1001 • number—String of up to 16 characters that represents an E.164 telephone number. Normally, the string is composed of digits, but the string may contain alphabetic characters when the number is dialed only by the router, as with an intercom number. Adds an ephone-dn as a member of a shared directory number in the database of theShared-LineService Module for a mixed shared line between Cisco Unified SIP and Cisco Unified SCCP IP phones. shared-line sip Example: Router(config-ephone-dn)# shared-line sip Step 9 end Exits to privileged EXEC mode. Example: Router(config-ephone-dn)# end Step 10 Troubleshooting Tips for Mixed Shared Line Use the debug ephone shared-line-mixed command to display debugging information about mixed shared lines. Configure the Maximum Number of Calls on SCCP Phone To configure the maximum number of calls on a Cisco Unified SCCP IP phone in Cisco Unified CME 9.0, perform the following steps. Cisco Unified Communications Manager Express System Administrator Guide 319 Configuring Phones to Make Basic Calls Configure the Maximum Number of Calls on SCCP Phone Before You Begin • Cisco Unified CME 9.0 and later versions. • Correct firmware, 9.2(1) or a later version, is installed. SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-dn dn-tag [dual-line | octo-line] 4. number number 5. exit 6. ephone phone-tag 7. mac-address mac-address 8. type phone-type 9. busy-trigger-per-button number-of-calls 10. max-calls-per-button number-of-calls 11. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters ephone-dn configuration mode to configure a directory number for an IP phone line. ephone-dn dn-tag [dual-line | octo-line] Example: Router(config)# ephone-dn 6 octo-line Step 3 • dn-tag—Unique number that identifies an ephone-dn during configuration tasks. Range is 1 to the number set by the max-dn command. • dual-line—(Optional) Enables two calls per directory number. • octo-line—(Optional) Enables eight calls per directory number. Associates a telephone or extension number with an ephone-dn in a Cisco Unified CME. number number Example: Router(config-ephone-dn)# number 1007 Step 4 • number—String of up to 16 characters that represents an E.164 telephone number. Normally the string is composed of digits, but Cisco Unified Communications Manager Express System Administrator Guide 320 Configuring Phones to Make Basic Calls Configure the Maximum Number of Calls on SCCP Phone Command or Action Purpose the string may contain alphabetic characters when the number is dialed only by the router, as with an intercom number. One or more periods (.) can be used as wildcard characters. exit Exits ephone-dn configuration mode. Example: Router(config-ephone-dn)# exit Step 5 Step 6 ephone phone-tag Enters ephone configuration mode. Example: Router(config)# ephone 98 • phone-tag—Unique sequence number that identifies this ephone during configuration tasks. The maximum number of ephones is version and platform-specific. Type ? to display range. Associates the MAC address of a Cisco IP phone with an ephone configuration in a Cisco Unified CME. mac-address mac-address Example: Router(config-ephone)# mac-address ABCD.1234.56EF Step 7 • mac-address—Identifying MAC address of an IP phone. type phone-type Assigns a phone type to an SCCP phone. Example: Router(config-ephone)# type 8941 Step 8 Sets the maximum number of calls allowed on an octo-line directory number before activating Call Forward Busy or a busy tone. busy-trigger-per-button number-of-calls Example: Router(config-ephone)# busy-trigger-per-button 6 Step 9 • number-of-calls—Maximum number of calls. Range: 1 to 8. Default: 0 (disabled). Sets the maximum number of calls allowed on an octo-line directory number on an SCCP phone. max-calls-per-button number-of-calls Example: Router(config-ephone)# max-calls-per-button 4 Step 10 • number-of-calls—Maximum number of calls. Range: 1 to 8. Default: 8. end Exits configuration mode and enters privileged EXEC mode. Example: Router(config-ephone)# end Step 11 Cisco Unified Communications Manager Express System Administrator Guide 321 Configuring Phones to Make Basic Calls Configure the Maximum Number of Calls on SCCP Phone Configure the Busy Trigger Limit on SIP Phone To configure the busy trigger limit on a Cisco Unified SIP IP phone in Cisco Unified CME 9.0, perform the following steps. You cannot configure the maximum number of calls per line. The phone controls the maximum number of outgoing calls. Table 18: Maximum Number of Incoming and Outgoing Calls , on page 322 shows the maximum number of outgoing calls allowed by a phone and the maximum number of incoming calls that can be configured using the busy-trigger-per-button command for Cisco Unified 6921, 6941, 6945, 6961, 8941, and 8945 SIP IP Phones in Cisco Unified CME 9.0. Table 18: Maximum Number of Incoming and Outgoing Calls Maximum Number of Incoming Calls Before Busy Tone (Configurable) Maximum Number of Outgoing Calls (Controlled by Phones) Cisco Unified SIP IP Phones Restriction 6921 12 12 6941 24 24 6945 24 24 6961 72 72 8941 24 24 8945 24 24 Before You Begin • Cisco Unified CME 9.0 and later versions. • Correct firmware is installed: ◦9.2(1) or a later version for Cisco Unified 6921, 6941, 6945 and 6961 SIP IP phones. ◦9.2(2) or a later version for Cisco Unified 8941 and 8945 SIP IP phones. Cisco Unified Communications Manager Express System Administrator Guide 322 Configuring Phones to Make Basic Calls Configure the Busy Trigger Limit on SIP Phone SUMMARY STEPS 1. enable 2. configure terminal 3. voice register pool pool-tag 4. type phone-type 5. busy-trigger-per-button number 6. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register pool configuration mode and creates a pool configuration for a SIP IP phone in Cisco Unified CME. voice register pool pool-tag Example: Router(config)# voice register pool 20 Step 3 pool-tag—Unique number assigned to the pool. Range is 1 to 100. For Cisco Unified CME systems, the upper limit for this argument is defined by the max-pool command. Note type phone-type Defines a phone type for a SIP phone. Example: Router(config-register-pool)# type 6921 Step 4 Sets the maximum number of calls allowed on a SIP directory number before activating Call Forward Busy or a busy tone. busy-trigger-per-button number Example: Router(config-register-pool)# busy-trigger-per-button 25 Step 5 • number—Maximum number of calls. Range: 1 to the maximum number of incoming calls listed in Step 6. The default values are 1 for the Cisco Unified 6921, 6941, 6945, and 6961SIPIPphones and 2 for the Cisco Unified 8941 and 8945 SIP IP phones. end Exits configuration mode and enters privileged EXEC mode. Example: Router(config-register-pool)# end Step 6 Cisco Unified Communications Manager Express System Administrator Guide 323 Configuring Phones to Make Basic Calls Configure the Busy Trigger Limit on SIP Phone Configure KEMs on SIP Phones To configure KEMs for Cisco Unified 8961, 9951, or 9971 SIP IP phones, perform the following steps. Before You Begin Cisco Unified CME 9.1 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register pool pool-tag 4. type phone-type [addon 1 CKEM [2 CKEM [3 CKEM]]] DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register pool configuration mode and creates a pool configuration for a Cisco Unified SIP IP phone in Cisco Unified CME. voice register pool pool-tag Example: Router(config)# voice register pool 29 Step 3 • pool-tag—Unique number assigned to the pool. Range is 1 to 100. For Cisco Unified CME systems, the upper limit for this argument is defined by the max-pool command. Note type phone-type [addon 1 CKEM [2 Defines a phone type for a Cisco Unified SIP IP phone. CKEM [3 CKEM]]] Step 4 The following keywords increase the number of speed-dial, busy-lamp-field, and directory number keys that can be configured: Example: Router(config-register-pool)# type 9971 addon 1 CKEM 2 CKEM 3 CKEM • addon 1 CKEM—(Optional) Tells the router that a Cisco SIP IP Phone CKEM 36-Button Line Expansion Module is being added to this Cisco Unified SIP IP Phone. This option is available to Cisco Unified 8961, 9951, and 9971 SIP IP phones only. Note • 2 CKEM (Optional)—Tells the router that a second Cisco SIP IP Phone CKEM 36-Button Line Expansion Module is being added to this Cisco Unified SIP IP Phone. Cisco Unified Communications Manager Express System Administrator Guide 324 Configuring Phones to Make Basic Calls Configure KEMs on SIP Phones Command or Action Purpose This option is available to Cisco Unified 9951 and 9971 SIP IP phones only. Note • 3 CKEM—(Optional) Tellsthe router that a third CiscoSIPIPPhone CKEM 36-Button Line Expansion Module is being added to this Cisco Unified SIP IP Phone. This option is available to Cisco Unified 9971 SIP IP phones only. Note Provision SIP Phones to Use the Fast-Track Configuration Approach To provision the Cisco UnifiedSIPIPphones using the fast-track configuration approach, perform the following steps. When a new Cisco Unified SIP IP phone is configured on Cisco Unified CME using the fast-track configuration approach, and the Cisco Unified CME is upgraded to a later version that supports the new phone type, the fast-track configuration pertaining to that SIP IP phone is removed automatically. Restriction Before You Begin You require Cisco Unified CME Release 10 or a later release. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register pool-type pool-type 4. addons max-addons 5. description string 6. gsm-support 7. num-lines max-lines 8. Phoneload-support 9. reference-pooltype phone-type 10. telnet-support 11. transport {udp | TCP} 12. Xml-config {maxNumCalls | busyTrigger | custom} 13. exit 14. end Cisco Unified Communications Manager Express System Administrator Guide 325 Configuring Phones to Make Basic Calls Provision SIP Phones to Use the Fast-Track Configuration Approach DETAILED STEPS Command or Action Purpose Enables the privileged EXEC mode. Enter your password if prompted. enable Example: Router> enable Step 1 configure terminal Enters the global configuration mode. Example: Router# configure terminal Step 2 Enters the voice register pool configuration mode and creates a pool configuration for a Cisco Unified SIP IP phone in Cisco Unified CME. voice register pool-type pool-type Example: Router(config)# voice register pool-type 9900 Step 3 If the new phone type is an existing phone that is supported on Cisco Unified CME release, you get the following error message: ERROR: 8945 is built-in phonemodel, cannot be changed Defines the maximum number of add-on modules supported in Cisco Unified SIP IP phones. addons max-addons Example: Router(config-register-pooltype)# addons 3 Step 4 • max-addons—The maximum allowed value is 3. The configured add-on modules can be used while defining the pool for the new SIP phone model using the existing type command as shown below: type [addon 1 module-type [2 module-type]] description string Defines the description string for the new phone type. Example: Router(config-register-pooltype)# description TEST PHON Step 5 Defines phone support for Global System for Mobile Communications (GSM) support. gsm-support Example: Router(config-register-pooltype)# gsm-support Step 6 Step 7 num-lines max-lines Definesthe maximum number of linessupported by the new phone. Example: Router(config-register-pooltype)# num-lines 12 • max-lines—If this parameter is not configured, the default value 1 is used. Cisco Unified Communications Manager Express System Administrator Guide 326 Configuring Phones to Make Basic Calls Provision SIP Phones to Use the Fast-Track Configuration Approach Command or Action Purpose Defines phone support for firmware download from Cisco Unified CME. You can use the load command in the voice register global Phoneload-support Example: Router(config-register-pooltype)# Phoneload-support Step 8 mode to configure the corresponding phone load for the new phone type if it supports phone load. Defines the nearest phone family from which the SIP IP phone in fast-track mode will inherit the properties. reference-pooltype phone-type Example: voice register pool-type 7821? Step 9 • phone-type—Unique number that representsthe phone model. description Cisco IP Phone 7821 Default There is no reference point to inherit the properties. reference-pooltype 6921 telnet-support Defines phone support for Telnet access. Example: Router(config-register-pooltype)# telnet-support Step 10 Step 11 transport {udp | TCP} Defines the default transport type supported by the new phone. Example: Router(config-register-pooltype)# transport TCp If this parameter is not configured, UDPis used asthe default value. The session-transport command configured at the voice register pool takes priority over this configuration. Definesthe phone-specific XML tagsto be used in the configuration file. Xml-config {maxNumCalls | busyTrigger | custom} Step 12 Example: Router(config-register-pooltype)#xml-config • maxNumCalls—Defines the maximum number of calls allowed per line. • busyTrigger—Defines the number of calls that triggers Call Forward Busy per line on the SIP phone. busyTrigger 2 Router(config-register-pooltype)#xml-config maxNumCalls 4 • custom—Defines custom XML tags which can be appended at the end of the phone specific CNF file. Router(config-register-pooltype)#xml-config custom 1 These parameters are used while generating the configuration profile file. CUCME does not use these configuration values for any other purpose. exit Exits the voice register-pooltype configuration mode. Example: Router(config-register-pooltype)# exit Step 13 end Exits the privileged EXEC configuration mode. Example: Router(config)# end Step 14 Cisco Unified Communications Manager Express System Administrator Guide 327 Configuring Phones to Make Basic Calls Provision SIP Phones to Use the Fast-Track Configuration Approach SIP Phone Models Validated for CME using Fast-track Configuration For information on the SIP phone models validated for Cisco Unified CME using fast-track configuration, see Phone Feature Support Guide for Unified CME, Unified SRST, Unified E-SRST, and Unified Secure SRST. Configuration Examples for Making Basic Calls This section contains the following examples of the required Cisco Unified CME configurations with some of the additional options that are discussed in other modules. Example for Configuring SCCP Phones for Making Basic Calls The following is a sample output of the show running-config command, showing how an SCCP phone is configured to make basic calls: Router# show running-config version 12.4 service tcp-keepalives-in service tcp-keepalives-out service timestamps debug datetime msec service timestamps log datetime msec no service password-encryption ! hostname CME40 ! boot-start-marker boot-end-marker ! logging buffered 2000000 debugging ! no aaa new-model ! resource policy ! clock timezone PST -8 clock summer-time PDT recurring no network-clock-participate slot 2 voice-card 0 no dspfarm dsp services dspfarm ! voice-card 2 dspfarm ! no ip source-route ip cef ! ! ! ip domain name cisco.com ip multicast-routing Cisco Unified Communications Manager Express System Administrator Guide 328 Configuring Phones to Make Basic Calls SIP Phone Models Validated for CME using Fast-track Configuration ! ! ftp-server enable ftp-server topdir flash: isdn switch-type primary-5ess ! ! ! voice service voip allow-connections h323 to sip allow-connections sip to h323 no supplementary-service h450.2 no supplementary-service h450.3 h323 call start slow ! ! ! controller T1 2/0/0 framing esf linecode b8zs pri-group timeslots 1-24 ! controller T1 2/0/1 framing esf linecode b8zs ! ! interface GigabitEthernet0/0 ip address 192.168.1.1 255.255.255.0 ip pim dense-mode duplex auto speed auto media-type rj45 negotiation auto ! interface Service-Engine1/0 ip unnumbered GigabitEthernet0/0 service-module ip address 192.168.1.2 255.255.255.0 service-module ip default-gateway 192.168.1.1 ! interface Serial2/0/0:23 no ip address encapsulation hdlc isdn switch-type primary-5ess isdn incoming-voice voice isdn map address ^.* plan unknown type international no cdp enable ! ! ip route 0.0.0.0 0.0.0.0 192.168.1.254 ip route 192.168.1.2 255.255.255.255 Service-Engine1/0 ip route 192.168.2.253 255.255.255.255 10.2.0.1 ip route 192.168.3.254 255.255.255.255 10.2.0.1 ! ! ip http server ip http authentication local no ip http secure-server ip http path flash: ! ! ! ! tftp-server flash:P00307020300.loads tftp-server flash:P00307020300.sb2 tftp-server flash:P00307020300.sbn ! control-plane ! ! ! voice-port 2/0/0:23 Cisco Unified Communications Manager Express System Administrator Guide 329 Configuring Phones to Make Basic Calls Example for Configuring SCCP Phones for Making Basic Calls ! ! ! sccp local GigabitEthernet0/0 sccp ccm 192.168.1.1 identifier 1 sccp ! sccp ccm group 1 associate ccm 1 priority 1 associate profile 1 register MTP0013c49a0cd0 keepalive retries 5 ! dspfarm profile 1 transcode codec g711ulaw codec g711alaw codec g729ar8 codec g729abr8 codec gsmfr codec g729r8 maximum sessions 90 associate application SCCP ! ! dial-peer voice 9000 voip mailbox-selection last-redirect-num destination-pattern 78.. session protocol sipv2 session target ipv4:192.168.1.2 dtmf-relay sip-notify codec g711ulaw no vad ! dial-peer voice 2 pots incoming called-number . direct-inward-dial port 2/0/0:23 forward-digits all ! dial-peer voice 1 pots destination-pattern 9[2-9]...... port 2/0/0:23 forward-digits 8 ! dial-peer voice 3 pots destination-pattern 91[2-9]..[2-9]...... port 2/0/0:23 forward-digits 12! ! gateway timer receive-rtp 1200 ! ! telephony-service load 7960-7940 P00307020300 max-ephones 100 max-dn 300 ip source-address 192.168.1.1 port 2000 system message CCME 4.0 sdspfarm units 1 sdspfarm transcode sessions 128 sdspfarm tag 1 MTP0013c49a0cd0 voicemail 7800 max-conferences 24 gain -6 call-forward pattern .T moh music-on-hold.au multicast moh 239.1.1.1 port 2000 web admin system name admin password sjdfg transfer-system full-consult transfer-pattern .T secondary-dialtone 9 create cnf-files version-stamp Jan 01 2002 00:00:00 ! ! Cisco Unified Communications Manager Express System Administrator Guide 330 Configuring Phones to Make Basic Calls Example for Configuring SCCP Phones for Making Basic Calls ephone-dn-template 1 ! ! ephone-template 1 keep-conference endcall local-only codec g729r8 dspfarm-assist ! ! ephone-template 2 ! ! ephone-dn 1 number 6001 call-forward busy 7800 call-forward noan 7800 timeout 10 ! ! ephone-dn 2 number 6002 call-forward busy 7800 call-forward noan 7800 timeout 10 ! ! ephone-dn 10 number 6013 paging ip 239.1.1.1 port 2000 ! ! ephone-dn 20 number 8000.... mwi on ! ! ephone-dn 21 number 8001.... mwi off ! ! ! ! ephone 1 device-security-mode none username "user1" mac-address 002D.264E.54FA codec g729r8 dspfarm-assist type 7970 button 1:1 ! ! ! ephone 2 device-security-mode none username "user2" mac-address 001C.821C.ED23 type 7960 button 1:2 ! ! ! line con 0 stopbits 1 line aux 0 stopbits 1 line 66 no activation-character no exec transport preferred none transport input all transport output all line 258 no activation-character no exec transport preferred none Cisco Unified Communications Manager Express System Administrator Guide 331 Configuring Phones to Make Basic Calls Example for Configuring SCCP Phones for Making Basic Calls transport input all transport output all line vty 0 4 exec-timeout 0 0 privilege level 15 password sgpxw login ! scheduler allocate 20000 1000 ntp server 192.168.224.18 ! ! end Example for Configuring SIP Phones for Making Basic Calls The following is a configuration example for SIP phones running on Cisco Unified CME: voice service voip allow-connections sip to sip sip registrar server expires max 600 min 60 ! voice class codec 1 codec preference 1 g711ulaw ! voice hunt-group 1 parallel final 8000 list 2000,1000,2101 timeout 20 pilot 9000 ! voice hunt-group 2 sequential final 1000 list 2000,2300 timeout 25 pilot 9100 secondary 9200 ! voice hunt-group 3 peer final 2300 list 2100,2200,2101,2201 timeout 15 hops 3 pilot 9300 preference 5 ! voice hunt-group 4 longest-idle final 2000 list 2300,2100,2201,2101,2200 timeout 15 hops 5 pilot 9400 secondary 9444 preference 5 secondary 9 ! voice register global mode cme ! external-ring bellcore-dr3 ! voice register dn 1 number 2300 mwi ! voice register dn 2 number 2200 call-forward b2bua all 1000 call-forward b2bua mailbox 2200 mwi ! voice register dn 3 Cisco Unified Communications Manager Express System Administrator Guide 332 Configuring Phones to Make Basic Calls Example for Configuring SIP Phones for Making Basic Calls number 2201 after-hour exempt ! voice register dn 4 number 2100 call-forward b2bua busy 2000 mwi voice register dn 5 number 2101 mwi voice register dn 76 number 2525 call-forward b2bua unreachable 2300 mwi ! voice register template 1 ! voice register template 2 no conference enable voicemail 7788 timeout 5 ! voice register pool 1 id mac 000D.ED22.EDFE type 7960 number 1 dn 1 template 1 preference 1 no call-waiting codec g711alaw ! voice register pool 2 id mac 000D.ED23.CBA0 type 7960 number 1 dn 2 number 2 dn 2 template 1 preference 1 ! dtmf-relay rtp-nte speed-dial 3 2001 speed-dial 4 2201 ! voice register pool 3 id mac 0030.94C3.053E type 7960 number 1 dn 3 number 3 dn 3 template 2 ! voice register pool 5 id mac 0012.019B.3FD8 type ATA number 1 dn 5 preference 1 dtmf-relay rtp-nte codec g711alaw ! voice register pool 6 id mac 0012.019B.3E88 type ATA number 1 dn 6 number 2 dn 7 template 2 dtmf-relay-rtp-nte call-forward b2bua all 7778 ! voice register pool 7 ! voice register pool 8 id mac 0006.D737.CC42 type 7940 Cisco Unified Communications Manager Express System Administrator Guide 333 Configuring Phones to Make Basic Calls Example for Configuring SIP Phones for Making Basic Calls number 1 dn 8 template 2 preference 1 codec g711alaw ! voice-port 1/0/0 ! voice-port 1/0/1 ! dial-peer voice 100 pots destination-pattern 2000 port 1/0/0 ! dial-peer voice 101 pots destination-pattern 2010 port 1/0/1 ! dial-peer voice 1001 voip preference 1 destination-pattern 1... session protocol sipv2 session target ipv4:10.15.6.13 codec g711ulaw ! sip-ua mwi-server ipv4:1.15.6.200 expires 3600 port 5060 transport udp ! telephony-service load 7960-7940 P0S3-07-2-00 max-ephones 24 max-dn 96 ip source-address 10.15.6.112 port 2000 create cnf-files version-stamp Aug 24 2004 00:00:00 max-conferences 8 after-hours block pattern 1 1... after-hours day Mon 17:00 07:00 Example for Disabling a Bulk Registration for a SIP Phone The following example shows that all phone numbers that match the pattern “408555..” can register with the SIP proxy server (IP address 1.5.49.240) except directory number 1, number “4085550101,” for which bulk registration is disabled: voice register global mode cme bulk 408555…. ! voice register dn 1 number 4085550101 no-reg sip-ua registrar ipv4:1.5.49.240 Example for Configuring a Mixed Shared Line on a Second Common Directory Number The following example shows how configuring a mixed shared line on a second common directory number is rejected: Router(config)#ephone-dn 14 octo-line Router(config-ephone-dn)#number 2502 Router(config-ephone-dn)#shared-line sip Router(config)#ephone-dn 20 octo-line Cisco Unified Communications Manager Express System Administrator Guide 334 Configuring Phones to Make Basic Calls Example for Disabling a Bulk Registration for a SIP Phone Router(config-ephone-dn)#number 2502 Router(config-ephone-dn)#shared-line sip DN number already exists in the shared line database Example for Cisco ATA The following example shows the configuration for two analog phones using a single Cisco ATA with MAC address 000F.F758.E70E. The analog phone attached to the first port uses the MAC address of the Cisco ATA. The analog phone attached to the second port uses a modified version of the Cisco ATA’s MAC address; the first two hexadecimal numbers are removed and 01 is appended to the end. telephony-service conference hardware load ATA ATA030203SCCP051201A.zup ! ephone-dn 80 dual-line number 8080 ! ephone-dn 81 dual-line number 8081 ! ephone 30 mac-address 000F.F758.E70E type ata button 1:80 ! ephone 31 mac-address 0FF7.58E7.0E01 type ata button 1:81 Example for SCCP Analog Phone The following partial sample output from a Cisco Unified CME configuration sets transfer type to full-blind and sets the voice-mail extension to 5200. Ephone-dn 10 has the extension 4443 and is assigned to Tommy; that number and name will be used for caller-ID displays. The description field under ephone-dn is used to indicate that this ephone-dn is on the Cisco VG224 voice gateway at port 1/3. Extension 4443 is assigned to ephone 7, which is an analog phone type with 10 speed-dial numbers. CME_Router# show running-config . . . telephony-service load 7910 P00403020214 load 7960-7940 P00305000301 load 7905 CP79050101SCCP030530B31 max-ephones 60 max-dn 60 ip source-address 10.8.1.2 port 2000 auto assign 1 to 60 create cnf-files version-stamp 7960 Sep 28 2004 17:23:02 voicemail 5200 mwi relay mwi expires 99999 max-conferences 8 gain -6 web admin system name cisco password lab web admin customer name ac2 password cisco dn-webedit time-webedit transfer-system full-blind transfer-pattern 6... transfer-pattern 5... ! Cisco Unified Communications Manager Express System Administrator Guide 335 Configuring Phones to Make Basic Calls Example for Cisco ATA ! ephone-dn 10 dual-line number 4443 secondary 9191114443 pickup-group 5 description vg224-1/3 name tommy ! ephone 7 mac-address C863.9018.0402 speed-dial 1 4445 speed-dial 2 4445 speed-dial 3 4442 speed-dial 4 4441 speed-dial 5 6666 speed-dial 6 1111 speed-dial 7 1112 speed-dial 8 9191114441 speed-dial 9 9191114442 speed-dial 10 9191114442 type anl button 1:10 Example for Remote Teleworker Phones The following example shows the configuration for ephone 270, a remote teleworker phone with its codec set to G.729r8. Thedspfarm-assist keyword is used to ensure that callsfrom this phone will use DSPresources to maintain the G.729r8 codec when calls would normally be switched to a G.711 codec. ephone 270 button 1:36 mtp codec g729r8 dspfarm-assist description teleworker remote phone Example for Secure IP Phone (IP-STE) The following example showsthe configuration forSecure IPPhone IP-STE. IP-STE isthe phone type required to configure a secure phone. ephone-dn 1 number 3001 ... ephone 9 mac-address 0004.E2B9.1AD1 max-calls-per-button 1 type IP-STE button 1:1 2:2 3:3 4:4 Example for Configuring Phone Services XML File for Cisco Unified Wireless Phone 7926G The following example shows phone type 7926 configured in ephone 1 and service xml-config file configured in ephone template 1: ! ! ! telephony-service max-ephones 58 max-dn 192 ip source-address 1.4.206.105 port 2000 Cisco Unified Communications Manager Express System Administrator Guide 336 Configuring Phones to Make Basic Calls Example for Remote Teleworker Phones cnf-file perphone create cnf-files ! ephone-template 1 service xml-config append flash:7926_phone_services.xml ! ephone-dn 1 octo-line number 1001 ! ephone 1 mac-address AAAA.BBBB.CCCC ephone-template 1 type 7926 button 1:1 ! Example for Monitoring the Status of Key Expansion Modules Show commands are used to monitor the status and other details of Key Expansion Modules (KEMs). The following example demonstrates how the show voice register all command displays KEM details with all the Cisco Unified CME configurations and registration information: show voice register all VOICE REGISTER GLOBAL ===================== CONFIG [Version=9.1] ======================== ............ Pool Tag 5 Config: Mac address is B4A4.E328.4698 Type is 9971 addon 1 CKEM Number list 1 : DN 2 Number list 2 : DN 3 Proxy Ip address is 0.0.0.0 DTMF Relay is disabled Call Waiting is enabled DnD is disabled Video is enabled Camera is enabled Busy trigger per button value is 0 keep-conference is enabled registration expires timer max is 200 and min is 60 kpml signal is enabled Lpcor Type is none The following example demonstrates how the show voice registerpool type command displays all the phones configured with add-on KEMs in Cisco Unified CME: Router# show voice register pool type CKEM Pool ID IP Address Ln DN Number State ==== =============== =============== == === ==================== ============ 4 B4A4.E328.4698 9.45.31.111 1 4 5589$ REGISTERED The following example demonstrates how the show voice register pool type summary command displays all the SIP phones (both registered and unregistered) configured with add-on KEMs in Cisco Unified CME: Router# show voice register pool type summary Phone Type Configured Registered Unregistered ========== ========== ========== ============ Unknown type 2 0 2 7821 1 0 1 9951 1 1 0 DX650 1 0 1 ====================================================== Cisco Unified Communications Manager Express System Administrator Guide 337 Configuring Phones to Make Basic Calls Example for Monitoring the Status of Key Expansion Modules Total Phones 5 1 4 ====================================================== Cisco Unified Communications Manager Express System Administrator Guide 338 Configuring Phones to Make Basic Calls Example for Monitoring the Status of Key Expansion Modules Cisco IOS Commands for Monitoring and Maintaining Cisco Unified CME To monitor and maintain Cisco Unified Communications Manager Express(CME), use the following commands in privileged EXEC mode. Command Purpose Displays the detailed configuration of all the Cisco Unified IP phones, voice ports, and dial peers of the Cisco Unified CME Router. Router# show call-manager-fallback all Displays the output of the dial peers of the Cisco Unified CME Router. Router# show call-manager-fallback dial-peer Displays Cisco Unified IPPhone destination numbers when in call manager fallback mode. Router# show call-manager-fallback ephone-dn Router# show call-manager-fallback voice-port Displays output for the voice ports. Router# show dial-peer voice summary Displays a summary of all voice dial peers. Router# show ephone phone Displays Cisco Unified IP Phone status. Displays Cisco Unified IPPhone statusfor all phones that are off hook. Router# show ephone offhook Displays Cisco Unified IPPhone statusfor all phones that are currently registered. Router# show ephone registered Displays Cisco Unified IP Phone status for all nonlocal phones (phones that have no Address Resolution Protocol [ARP] entry). Router# show ephone remote Displays Cisco Unified IPPhone statusfor all phones that are ringing. Router# show ephone ringing Router# show ephone summary Displays a summary of all Cisco Unified IP Phones. Displays a brief summary of all Cisco Unified SCCP phones. Router# show ephone summary brief Displays a summary of all types of Cisco Unified SCCP phones. Router# show ephone summary types Displays a summary of all registered Cisco Unified SCCP phones. Router# show ephone registered summary Displays a summary of all unregistered Cisco Unified SCCP phones. Router# show ephone unregistered summary Cisco Unified Communications Manager Express System Administrator Guide 339 Configuring Phones to Make Basic Calls Cisco IOS Commands for Monitoring and Maintaining Cisco Unified CME Command Purpose Router# show ephone telephone-number phone-number Displays Unified IPPhone statusfor a specific phone number. Displays Unified IP Phone status for all unregistered phones. Router# show ephone unregistered Router# show ephone-dn tag Displays Unified IP Phone destination numbers. Displays a summary of all Cisco Unified IP Phone destination numbers. Router# show ephone-dn summary Displays Cisco Unified IPPhone destination numbers in loopback mode. Router# show ephone-dn loopback Router# show running-config Displays the configuration. Router # show sip-ua status registrar Display SIP registrar clients. Router# show voice port summary Displays a summary of all voice ports. Displays all SIP SRST configurations , SIP phone registrations and dial peer info. Router # show voice register all Router # show voice register global Displays voice register global config. Displays all config SIP phone voice register pool detail info. Router # show voice register pool all Displays a summary of all registered and unregistered Cisco SIP Phones. Router # show voice register pool type summary DisplaysspecificSIPphone voice register pool detail info. Router # show voice register pool Router # show voice register dial-peers Displays SIP-CME created dial peer. Router # show voice register dn all Displays all config voice register dn detail info. Router # show voice register dn Displays specific voice register dn detail info. Example for Fast-Track Configuration Approach The following example shows how to enable the new Cisco Unified 9900SIPIPphone to inherit the properties of the Cisco Unified SIP IP phone 9951 and overwrite some of the phone’s properties: voice register pool-type 9900 reference-pooltype 9951 description SIP Phone 9900 addon module Cisco Unified Communications Manager Express System Administrator Guide 340 Configuring Phones to Make Basic Calls Example for Fast-Track Configuration Approach num-lines 24 addons 3 no phoneload-support xml-config custom "custom-sftp"1"/custom-sftp" voice register pool 1 type 9900 addon 1 CKEM 2 CKEM 3 CKEM id mac 1234.4567.7891 voice register global mode cme load 9900 P0S3-06-0-00 The following example shows how to inherit the existing properties of a reference phone type (Cisco Unified SIP IP phone 6921) using the fast-track configuration approach. voice register pooltype 6922 reference-pooltype 6921 device-name “SIP Phone 6922” voice register pool 11 type 6922 id mac 1234.4567.7890 Where To Go Next To select a fixed-button layout for a Cisco Unified IP Phone 7931G, see Select Button Layout for a Cisco Unified SCCP IP Phone 7931G, on page 1453. After configuring phones in Cisco Unified CME to make basic calls, you are ready to generate configuration files for the phones to be connected to your router. See Generate Configuration Files for Phones, on page 388. Feature Information for Configuring Phones to Make Basic Calls The Interactive Voice Response (IVR) media prompts feature is only available on the IAD2435 when running IOS version 15.0(1)M or later. Caution The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Table 19: Feature Information for Basic Call Features Cisco Unified CME Feature Information Versions Feature Name Increasesline key and feature key appearances, speed dials, or programmable buttons on Cisco Unified SIP IP phones. KEM Support for Cisco 9.1 Unified 8961, 9951, and 9971 SIP IP Phones Cisco Unified Communications Manager Express System Administrator Guide 341 Configuring Phones to Make Basic Calls Where To Go Next Cisco Unified CME Feature Information Versions Feature Name Supports T.38 fax relay and fax pass-through on Cisco ATA-187. Cisco ATA-187 9.0 Adds SIP support for the following phone types: • Cisco Unified 6901 and 6911 IP Phones • Cisco Unified 6921, 6941, 6945, and 6961 IP Phones • Cisco Unified 8941 and 8945 IP Phones Cisco Unified SIP IP Phones Allows Cisco UnifiedSIPand SCCP IP phones to share a common directory number. Mixed Shared Lines Overcomes the limitation on the maximum number of calls per line. Multiple Calls Per Line Allows you to display information on active RTP calls using the show ephone rtp connections command. The output from this command provides an overview of all the connections in the system, narrowing the criteria for debugging pulse code modulation and Cisco Unified CME packets without a sniffer. Real-Time TransportProtocol 8.8 Call Information Display Enhancement Adds support for SIP phones connected to a Cisco Unified CME system. Support for Cisco Unified 3905 SIP IP Phones Adds support for SCCP phones connected to a Cisco Unified CME system. Support for Cisco Unified 6945, 8941, and 8945 SCCP IP Phones Added support for 7926G Wireless SCCP IP Phone. Support for 7926G Wireless 8.6 SCCP IP Phone Cisco Unified Communications Manager Express System Administrator Guide 342 Configuring Phones to Make Basic Calls Feature Information for Configuring Phones to Make Basic Calls Cisco Unified CME Feature Information Versions Feature Name Adds support for Secure IP Phone (IP-STE). Secure IP Phones 8.0 Adds support for nonexclusive shared lines on SIP phones. SIP Shared Lines 7.1 Adds autoconfiguration for the Cisco VG202, VG204, and VG224 Analog Phone Gateway. Autoconfiguration for Cisco VG202, VG204, and VG224 Addssupport for dynamically adding new phone types without upgrading Cisco IOS software. Ephone-Type Templates 7.0/4.3 Adds octo-line directory numbers that support up to eight active calls. Octo-Line Directory Numbers Adds support for the G.722-64K and iLBC codecs. G.722 and iLBC Transcoding and Conferencing Support in Cisco Unified CME Adds support for dial plans for SIP phones. Dial Plans for SIP Phones 4.1 Adds support for KPML for SIP phones. KPML Adds selection for session-transport protocol for SIP phones. Session Transport Protocol Provides Busy Lamp Field (BLF) notification on a line button that is configured for watch mode on one phone for all lines on another phone (watched phone) for which the watched directory number is the primary line. Watch Mode Introduces support for teleworker remote phones. Remote Teleworker Phones 4.0 Cisco Unified Communications Manager Express System Administrator Guide 343 Configuring Phones to Make Basic Calls Feature Information for Configuring Phones to Make Basic Calls Cisco Unified CME Feature Information Versions Feature Name Introducessupport for analog phones with SCCP supplementary features using FXS ports on CiscoIntegratedServicesRouters. Analog Phones 4.0 Introducessupport for analog phones with SCCP supplementary features using FXS ports on a Cisco VG224 voice gateway. 3.2.1 Introduces support for Cisco ATA 186 and Cisco ATA 188. 3.0 Introducessupport for analog phones in H.323 mode using FXS ports. 1.0 Introduces support for Cisco IP Communicator. Cisco IP Communicator 4.0 Cisco Unified Communications Manager Express System Administrator Guide 344 Configuring Phones to Make Basic Calls Feature Information for Configuring Phones to Make Basic Calls Cisco Unified CME Feature Information Versions Feature Name Adds enhancements to improve the keyswitch emulation behavior of PSTN lines in a Cisco Unified CME system, including the following: • Status monitoring of the FXO port on the line button of an IP phone. • Transfer recall if a transfer-to phone does not answer after a specified timeout. • Transfer-to button optimization to free up the private extension line on the transfer-to phone • Directory numbers for FXO lines can be configured for dual-line to support the FXO monitoring, transfer recall, and transfer-to button optimization features. Direct FXO Trunk Lines 4.0 Introduces direct FXO trunk line capability. 3.2 Adds support for SIP phones connected to Cisco CME system. SIP Phones 3.4 Provides a visible line status indicating whether the line is in-use or not. Monitor Mode for Shared 3.0 Lines Cisco Unified Communications Manager Express System Administrator Guide 345 Configuring Phones to Make Basic Calls Feature Information for Configuring Phones to Make Basic Calls Cisco Unified Communications Manager Express System Administrator Guide 346 Configuring Phones to Make Basic Calls Feature Information for Configuring Phones to Make Basic Calls CHAPTER 8 Create Phone Configurations Using Extension Assigner • Prerequisites for Extension Assigner, page 347 • Restrictions for Extension Assigner, page 348 • Information About Extension Assigner, page 348 • Configure Extension Assigner, page 354 • Configure Extension Assigner Synchronization, page 375 • Assign Extension Numbers Onsite by Using Extension Assigner, page 378 • Verify Extension Assigner Configuration for SCCP Phones, page 380 • Verify Extension Assigner Configuration for SIP Phones, page 380 • Configuration Examples for Extension Assigner, page 380 Prerequisites for Extension Assigner • Cisco Unified CME 11.6 or a later version for SIP phones. • Cisco Unified CME 4.0(3) or a later version for SCCP phones. • For Extension Assigner Synchronization, Cisco Unified CME 4.2(1) or a later version. • The auto-register-phone command must be enabled (default) forSCCPphones, and auto-register must be enabled for SIP phones. • DHCP must be configured. For configuration information, see Network Parameters. • You have a valid Cisco.com account. • You have access to a TFTP server for downloading files. Cisco Unified Communications Manager Express System Administrator Guide 347 Restrictions for Extension Assigner • The number of phones that you install cannot exceed the maximum number of phones supported by the router chassis. To find the maximum number of phones for a particular router and Cisco Unified CME version, see the appropriate Cisco Uniified CME Supported Firmware, Platforms, Memory, and Voice Products for your Cisco IOS release. • For Extension AssignerSynchronization, automatic synchronization only appliesto configuration changes made by Cisco Unified CME Extension Assigner. Information About Extension Assigner Extension Assigner Overview From Cisco Unified CME Release 11.6 onwards, Extension Assigner feature is supported for both SIP and SCCPphones. Thisfeature enablesinstallation techniciansto assign extension numbersto Cisco Unified CME phones without administrative access to the server, typically during the installation of new phones or the replacement of broken phones. However, before an installation technician can use this feature, the system administrator must first configure Cisco Unified CME to allow specific extensions to be assigned. The system administrator must also provide the installation technician with the information necessary for assigning extension numbers to phones. The installation technician can then assign extension numbers to phones with access to only the phones themselves and with no further intervention from the administrator. To configure this feature, tasks must be performed on the Cisco router by an administrator and onsite by installation technicians. Procedure for System Administrators Before an installation technician can assign new extension numbersto phones, you must complete the following tasks: 1 Determine which extension numbers will be assigned to the new phones and plan your configuration. 2 Download the appropriate Tcl script and associated audio prompt files and place them in the correct directory. 3 Configure the Cisco Unified CME router to: • Configure and load the appropriate Tcl script. • Specify the extension that the installation technician calls to assign extension numbers. • Optionally specify whether the extension used to assign extension numbers is dialed automatically. • Specify the password that the installation technician enters to assign extension numbers. • Configure the extension assigner feature. • Configure ephone-dns with temporary extension numbers (applicable only for SCCP phones). • Configure ephone-dns and voice register dns with the extension numbersthat the installation technician can assign to phones. Cisco Unified Communications Manager Express System Administrator Guide 348 Create Phone Configurations Using Extension Assigner Restrictions for Extension Assigner • Configure ephones and voice register pools with temporary MAC addresses for each phone that will be assigned an extension number by the installation technician. • Optionally configure the router to automatically save your configuration. All phone configurations such as dn and pool that are generated as part of the auto registration process are persistent configurations(If the command background save interval is configured under telephony-service). These phone configurations are available on Unified CME even after an event of router reload. Note 4 Provide the installation technician with the information needed to assign extension numbers to the new phones. Before you can configure this feature, you must understand how the extension assigner application works and what information the installation technician needs to assign extension numbers to phones. Other information you must provide to the installation technician involves the tasks that the installation technician must perform. These tasks include: • Dialing a configurable extension number to access the extension assigner application. • Entering a configurable password. • Entering a tag (provision-tag for SIP phones, and ephone-tag or provision-tag for SCCP phones) that identifies the extension number that will be assigned to the phone. Therefore, you must make the following decisions: • Which extension number must be dialed to access the extension assigner application. • Whether the number is dialed automatically when a phone goes off hook. • What password the installation technician must enter to access the extension assigner application. • What type of tag (provision-tag for SIP phones, and ephone-tag or provision-tag for SCCP phones) numbers to use to identify the extension number to assign to the phone. • What specific tag numbers to use to identify the extension number to assign to the phone. The first three decisions are straightforward, but the last two tag number decisions require some knowledge of how the extension assigner feature works. This feature is implemented using a Tcl script and audio files. To run this script, the installation technician plugs in the phone, waits for a random extension number to be automatically assigned, and dials a specified extension assigner number to invoke the extension assigner service. After the phones have registered and received their temporary extension numbers, the installation technician can access extension assigner and enter a tag number. Thistag number is used to identify the extension number and must match either an ephone tag (only for SCCP phones) or a similar new tag called the provision-tag (applicable to both SIP and SCCP phones). For SCCP phones, you must decide on which tag you want to use before you configure your ephone and ephone-dn entries. The advantage of using the provision-tag is that you can make it easier for the installation technician to assign extension numbers because you can configure the tag to match the primary extension number or some other Cisco Unified Communications Manager Express System Administrator Guide 349 Create Phone Configurations Using Extension Assigner Extension Assigner Overview unique identifier for the phone, such as a jack number. We recommend you to configure provision-tag same as the primary extension number. The disadvantage isthat you configure an additional keyword for each ephone entry, asshown in the following example: ephone 1 provision-tag 9001 mac-address 02EA.EAEA.0001 button 1:1 voice register pool 1 provision-tag 1001 mac-address 02EA.EAEA.0001 number 1 dn 101 ForSCCPphones, if you decide to use the ephone tag, it requires less configuration. However, the installation technician enters an arbitrary tag number instead of the actual extension number when configuring a phone. This restriction is because the number of ephone tags that you can configure is limited by your license. For example, if you use the ephone tag and you have a 100-user license, the installation technician cannot enter 9001 for the tag because you can configure only ephone 1 to ephone 100. Note that each ephone entry that you configure must also include a temporary MAC address. As shown in the above example, this address should begin with 02EA.EAEA and can end with any unique number. We strongly recommend that you can configure this unique number to match the ephone tag for SCCP phones. ForSCCPphones, you do not have to configure any ephone entriesfor the extension number that are randomly assigned. The auto assign feature automatically creates an ephone entry for each new phone when it registers. The auto assign feature then automatically assigns an ephone-dn entry if there is an available ephone-dn that has one of the tag numbers specified by the auto assign command. The resulting ephone pool configurations have the actual MAC address of the phone and a button with the first available ephone-dn designated for the auto assign feature. For more information, see Configure Temporary Extension Numbers for SCCP Phones That Use Extension Assigner, on page 361. For SIP phones, you do not have to configure voice register pool or voice register dn. You need to configure auto-register command for automatic registration ofSIPphones on Cisco Unified CME.For more information, see Configure Temporary Extension Numbers for SCCP Phones That Use Extension Assigner, on page 361. For manually registered phones, ephone (or voice register pool) and ephone-dn (or voice register dn) are manually created. Note As shown in the following example, you configure at least one ephone-dn for a temporary extension and specify which ephone-dns the autoassign feature will assign to the temporary ephone entries: telephony-service auto assign 101 to 105 ephone-dn 101 number 0001 When the installation technician assigns an extension number to a phone, the temporary MAC address is replaced by the actual MAC address and the ephone entry created by the auto register feature is deleted. The number of ephone-dns that you configure for the auto assign feature determines how many phones you can plug in at one time and get an automatically assigned extension. If you define four ephone-dns for auto assign and you plug in five phones, one phone will not get a temporary extension number until you assign an extension to one of the other four phones and reset the fifth phone. You are permitted to set the max-ephone value higher than the number of users and phones supported by your Cisco Unified CME phone licenses for the purpose of enrolling licensed phones using Extension Assigner. Cisco Unified Communications Manager Express System Administrator Guide 350 Create Phone Configurations Using Extension Assigner Extension Assigner Overview In addition to configuring one ephone-dn for each temporary extension number that is assigned automatically, you also must configure an ephone-dn entry for each extension number that is assigned by the installation technician. For more details on configuring extension numbers that technicians can assign to SCCP phones, see Configure Extension Numbers That Installation Technicians Can Assign to SCCP Phones, on page 364. For SIP Phones, the temporary MAC address is replaced by the actual MAC address and voice register pool entry created by the auto-register feature is deleted when the installation technician assigns an extension number to a phone. The number of voice register dns that you configure for the auto assign feature determines how many phones you can plug in at one time and get an automatically assigned extension. If you define four voice register dns for auto assign and you plug in five phones, one phone will not get a temporary extension number until you assign an extension to one of the other four phones and reset the fifth phone. You are permitted to set the max-pool value higher than the number of users and phones supported by your Cisco Unified CME phone licenses for the purpose of enrolling licensed phones using Extension Assigner.For more details on configuring extension numbers that technicians can assign to SIP phones, see Configure Extension Numbers That Installation Technicians Can Assign to SIP Phones, on page 366. Note For SIP Phones, you need not create temporary dn if auto registration is used. To complete the configuration, as shown in the following example, you must: • Specify whether to use the ephone or the provision-tag number to identify the extension number to assign to the phone. Set this when the feature is enabled with the new extension-assigner tag-type command provided with this feature. • Configure an ephone-dn for each temporary extension number that is assigned automatically. • Configure an ephone-dn or voice register dn for each extension number that you want the installation technician to assign to a phone. • Configure an ephone or voice register pool with a temporary MAC addressfor each phone that is assigned an extension number by the installation technician. Optionally, this ephone definition can include the new provision-tag.ForSIPphones, it is necessary to have provision-tag information under voice register pool. For more information, see Configure Ephones with Temporary MAC Addresses, on page 368. telephony-service extension-assigner tag-type provision-tag auto assign 101 to 105 ephone-dn 1 dual-line number 6001 ephone-dn 101 number 0001 label Temp-Line-not assigned yet ephone 1 provision-tag 6001 mac-address 02EA.EAEA.0001 button 1:1 *********************************** voice register pool 1 provision-tag 1001 mac-address 02EA.EAEA.0001 number 1 dn 101 Because you must configure two ephone-dns or voice register dns for each extension number that you want to assign, you may exceed your max-dn setting. You are permitted to set the max-dn value higher than the number allowed by your license for the purpose of enrolling licensed phones using extension assigner. Assuming that your max-dn setting is set high enough, your max-ephone or max-pool setting determines how many phones you can plug in at one time. For example, if your max-ephone or max-pool setting is ten more Cisco Unified Communications Manager Express System Administrator Guide 351 Create Phone Configurations Using Extension Assigner Extension Assigner Overview than the number of phones to which you want to assign extension numbers, then you can plug in ten phones at a time. If you plug in eleven phones, one phone will not register or get a temporary extension number until you assign an extension to one of the first ten phones and reset the eleventh phone. After you have configured your ephone or voice register pool, and ephone-dn or voice register dn entries, you can complete your router configuration by optionally configuring the router to automatically save your configuration. If the router configuration is not saved, any extension assignments made by the installation technician will be lost when the router is restarted. The alternative to this optional procedure is to have the installation technician connect to the router and enter the write memory command to save the router configuration. The final task of the system administrator is to document the information that the installation technician needs to assign extension numbers to the new phones. You can also use this documentation as a guide when you configure Cisco Unified CME to implement this feature. This information includes: • How many phones the installation technician can plug in at one time • Which extension number to dial to access the extension assigner application • Whether the number is dialed automatically when a phone goes off hook • What password to enter to access the application • Which tag numbers to enter to assign an extension to each phone Because this feature is implemented using a Tcl script and audio files, you must place the script and associated audio prompt files in the correct directory. Do not edit this script; just configure Cisco Unified CME to load the appropriate script. Note Extension Assigner in Mixed Deployment From Cisco Unified CME release 11.6 onwards, extension assigner feature supports mixed deployment of SCCP and SIP phones. In a mixed deployment scenario, you sometimes have to migrate or replace an SCCP phone with a SIP phone or vice versa. The extension assigner functionality ensures a seamless migration experience in this scenario by letting you assign extension numbers to the new phone (irrespective of SIP or SCCP). In mixed mode deployment, you can reassign any current extension number to a new phone. When you dial in to the extension assigner system to perform this task, you are redirected to the unassign menu. You need to unassign the current extension number so that it is no more assigned to any phone. After successfully unassigning the extension number, the call is disconnected. When you dial in to the extension assigner again, you can reassign the extension number to your new phone. For more information, see Reassign the Current Extension Number, on page 379. You cannot unassign the extension number of a phone if it is in use. The phone has to be in idle or unregistered state. Note Cisco Unified Communications Manager Express System Administrator Guide 352 Create Phone Configurations Using Extension Assigner Extension Assigner Overview Procedures for Installation Technicians This feature is implemented using a Tcl script and audio prompt files that enable the installation technician to assign an extension number to a new Cisco Unified CME phone by performing the following procedure The system administrator provides the installation technician with all of the information required to perform this procedure. Step 1 Plug in a specified number of new phones. Step 2 Wait for the phones to be assigned temporary, random extension numbers. Step 3 Dial a specified number to access the extension assigner application. Step 4 Enter a specified password. Step 5 Enter a tag that identifies an extension number and enables the installation technician to perform one of the following tasks: • Assign a new extension number to a phone. • Unassign the current extension number. • Reassign an extension number. Files Included in this Release The app-cme-ea-2.0.0.0.tar or later archive file provided for the extension assigner feature includes a readme file, a Tcl script, and several audio prompt files. If you want to replace the audio files with files that use a language other than English, do not change the name of the files. The Tcl script is written to use only the following list of the filenames: • app-cme-ea-2.0.0.0.tcl (script) • en_cme_tag_assign_phone.au (audio file) • en_cme_tag_assigned_to_phone.au (audio file) • en_cme_tag_assigned_to_phone_idle.au (audio file) • en_cme_tag_assigned_to_phone_inuse.au (audio file) • en_cme_tag_assigned_to_phone_unreg.au (audio file) • en_cme_tag_available.au (audio file) • en_cme_tag_extension.au (audio file) • en_cme_tag_invalid.au (audio file) • en_cme_tag_unassign_phone.au (audio file) • en_cme_tag_action_cancelled.au (audio file) • en_cme_tag_assign_failed.au (audio file) Cisco Unified Communications Manager Express System Administrator Guide 353 Create Phone Configurations Using Extension Assigner Files Included in this Release • en_cme_tag_assign_success.au (audio file) • en_cme_tag_contact_admin.au (audio file) • en_cme_tag_disconnect.au (audio file) • en_cme_tag_ephone_tagid.au (audio file) • en_cme_tag_invalid_password.au (audio file) • en_cme_tag_invalidoption.au (audio file) • en_cme_tag_noentry.au (audio file) • en_cme_tag_password.au (audio file) • en_cme_tag_unassign_failed.au (audio file) • en_cme_tag_unassign_success.au (audio file) • en_eight.au (audio file) • en_five.au (audio file) • en_four.au (audio file) • en_nine.au (audio file) • en_one.au (audio file) • en_seven.au (audio file) • en_six.au (audio file) • en_three.au (audio file) • en_two.au (audio file) • en_zero.au (audio file) • readme.txt Extension Assigner Synchronization Extension AssignerSynchronization enablesthe secondary backup router to automatically receive any changes made by Extension Assigner to ephone or voice register pool mac-addresses in the primary router. The synchronization is performed using the Cisco Unified CME XML interface. The Cisco Unified CME XML client encapsulates the configuration changes into an ISexecCLI request and sends it to the secondary backup router using HTTP. The server on the secondary backup side processes the incoming XML request and calls the Cisco IOS CLI parser to perform the updates. For configuration information, see Configure Extension Assigner Synchronization. Configure Extension Assigner The following tasks are performed by an administrator or other personnel who is responsible for configuring Extension Assigner: Cisco Unified Communications Manager Express System Administrator Guide 354 Create Phone Configurations Using Extension Assigner Extension Assigner Synchronization Determine Extension Numbers to Assign to the New Phones and Plan Your Configuration After you determine which extension number to assign to each phone, you must make the following decisions: • Which extension number must be dialed to access the extension assigner application. • Whether the number is dialed automatically when a phone goes off hook. • What password the installation technician must enter to access the extension assigner application. • Whether to use ephone-tag (applicable only for SCCP phones) or the provision-tag number to identify the extension number to assign to the phone. • How many temporary extension numbers to configure. This will determine how many temporary ephone-dns or voice register dns, and temporary MAC addresses to configure. • What specific tag numbers to use to identify the extension number to assign to the phone. Download the Tcl Script and Audio Prompt Files To download the Tcl script and audio prompt files for the extension assigner feature, perform the following steps. For more information about how to use Tcl scripts, see the Cisco IOS Tcl IVR and Voice XML Application Guide for your Cisco IOS release. Note Do not edit the Tcl script SUMMARY STEPS 1. Go to the Cisco Unified CME software download website at http://software.cisco.com/download/ type.html?mdfid=277641082&catid=null. 2. Download the Cisco Unified CME extension assigner tar archive to a TFTP server that is accessible to the Cisco Unified CME router. 3. enable 4. archive tar /xtract source-url destination-url DETAILED STEPS Command or Action Purpose Go to the Cisco Unified CME software download Gives you access to Cisco Unified CME software downloads. website at http://software.cisco.com/download/ type.html?mdfid=277641082&catid=null. Step 1 Cisco Unified Communications Manager Express System Administrator Guide 355 Create Phone Configurations Using Extension Assigner Determine Extension Numbers to Assign to the New Phones and Plan Your Configuration Command or Action Purpose Download the Cisco Unified CME extension assigner tar archive to a TFTP server that is accessible to the Cisco Unified CME router. Step 2 • This tar archive contains the extension assigner Tcl script and the default audio files that you need for the extension assigner service. enable Enters global configuration mode. Example: Router> enable Step 3 Uncompresses the files in the archive file and copies them to a location that is accessible by the Cisco Unified CME router. archive tar /xtract source-url destination-url Example: Router# archive tar /xtract tftp://192.168.1.1/app-cme-ea-2.0.0.0.tar flash: Step 4 • source-url—URL of the source of the extension assigner TAR file. Valid URLs can refer to TFTP or HTTP servers or to flash memory. • location—URL of the destination of the extension assigner TAR file, including its Tcl script and audio files. Valid URLs can refer to TFTP or HTTP servers or to flash memory. Configure the Tcl Script To configure and load the Tcl script for the extension assigner feature and create the password that installation technicians enter to access the extension assigner application, perform the following steps. For more information about how to use Tcl scripts, see the Cisco IOS Tcl IVR and Voice XML Application Guide for your Cisco IOS release. To change the password, you must remove the existing extension assignerservice and create a new service that defines a new password. Note Cisco Unified Communications Manager Express System Administrator Guide 356 Create Phone Configurations Using Extension Assigner Configure the Tcl Script SUMMARY STEPS 1. enable 2. configure terminal 3. application 4. service service-name location 5. param ea-password password 6. paramspace english index number 7. paramspace english language en 8. paramspace english location location 9. paramspace english prefix en 10. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters application configuration mode to configure packages and services. application Example: Router(config)# application Step 3 Enters service parameter configuration mode to configure parameters for the call-queue service. service service-name location Example: Router(config-app)# service EA flash:/EA/ Step 4 • service-name—Name of the extension assigner service. This arbitrary name is used to identify the service during configuration tasks. • location—URL of the Tclscript for the extension assignerservice. Valid URLs can refer to TFTP or HTTP servers or to flash memory. Sets the password that installation technicians enter to access the extension assigner application. param ea-password password Example: Router(config-app-param)# param ea-password 1234 Step 5 • password—Numerical password that installation technicians enter to accessthe extension assigner application. Length: 2 to 10 digits. Cisco Unified Communications Manager Express System Administrator Guide 357 Create Phone Configurations Using Extension Assigner Configure the Tcl Script Command or Action Purpose Defines the language of audio files that are used for dynamic prompts by an IVR application. paramspace english index number Example: Router(config-app-param)# paramspace english index 0 Step 6 • For the Extension Assigner, language must be English and prefix is en. Defines the language of audio files that are used for dynamic prompts by an IVR application. paramspace english language en Example: Router(config-app-param)# paramspace english language en Step 7 • For the Extension Assigner, language must be English and prefix is en. Defines the location of audio files that are used for dynamic prompts by an IVR application. paramspace english location location Example: Router(config-app-param)# paramspace english location flash:/EA/ Step 8 • For the Extension Assigner, language must be English. • location—URL of the Tclscript for the extension assignerservice. Valid URLs can refer to TFTP or HTTP servers or to flash memory. Defines the prefix of audio files that are used for dynamic prompts by an IVR application. paramspace english prefix en Example: Router(config-app-param)# paramspace english prefix en Step 9 • For the Extension Assigner, language must be English and prefix is en. end Returns to privileged EXEC mode. Example: Router(config-app-param)# end Step 10 Specify the Extension for Accessing Extension Assigner Application To specify the extension number that installation technicians must dial to access the extension assigner application during onsite installation, perform the following steps. Cisco Unified Communications Manager Express System Administrator Guide 358 Create Phone Configurations Using Extension Assigner Specify the Extension for Accessing Extension Assigner Application SUMMARY STEPS 1. enable 2. configure terminal 3. dial-peer voice tag voip 4. service service-name out-bound 5. destination-pattern string 6. session protocol sipv2 7. session target ipv4: destination-address 8. dtmf-relay rtp-nte 9. codec g711ulaw 10. no vad 11. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 dial-peer voice tag voip Enters dial-peer configuration mode. Example: Router(config)# dial-peer voice 5999 voip Step 3 • tag—Number used during configuration tasks to identify this dial peer. Loads and configures the extension assigner application on a dial peer. service service-name out-bound Example: Router(config-dial-peer)# service extensionassigner out-bound Step 4 • service-name—Name must match the name that you used to load the extension assigner Tcl script in the Configuring the Tcl Script section. • outbound—Required for Extension Assigner. Specifies either the prefix or the full E.164 telephone number (depending on the dial plan) for a dial peer. destination-pattern string Example: Router(config-dial-peer)# destination pattern 1010 Step 5 • string—Number that the installation technician calls when assigning an extension number to a phone. Cisco Unified Communications Manager Express System Administrator Guide 359 Create Phone Configurations Using Extension Assigner Specify the Extension for Accessing Extension Assigner Application Command or Action Purpose session protocol sipv2 Designates aSIPloopback trunk for Extension Assigner application. Example: Router(config-dial-peer)# session protocol sipv2 Step 6 Designates a network-specific address to receive calls from a VoIP dial peer. session target ipv4: destination-address Example: Router(config-dial-peer)# session target ipv4:172.16.200.200 Step 7 • destination-IP address for the Cisco Unified CME interface on this router. Specifiesthe method for relaying dual tone multifrequency (DTMF) tones between two devices as per RFC2833. dtmf-relay rtp-nte Example: Router(config-dial-peer)# dtmf-relay rtp-nte Step 8 Step 9 codec g711ulaw Specifies the voice coder rate of speech for a dial peer. Example: Router(config-dial-peer)# codec g711ulaw • g711ulaw-Option that represents the correct voice decoder rate. g711ulaw is the only codec supported with Extension Assigner application. Disables voice activity detection (VAD) for the calls using a particular dial peer. no vad Example: Router(config-dial-peer)# no vad Step 10 • Required for Extension Assigner. end Returns to privileged EXEC mode. Example: Router(config-dial-peer)# end Step 11 Configure Provision-Tags for the Extension Assigner Feature To modify Extension Assigner to use provision-tags, perform the following steps. By default, the extension assigner is enabled and uses ephone tags. SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. extension-assigner tag-type { ephone-tag | provision-tag } 5. end Cisco Unified Communications Manager Express System Administrator Guide 360 Create Phone Configurations Using Extension Assigner Configure Provision-Tags for the Extension Assigner Feature DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 3 Specifies tag type to use to identify extension numbers for Extension Assigner. extension-assigner tag-type { ephone-tag | provision-tag } Step 4 Example: Router(config-telephony)# extension-assigner tag-type provision-tag • ephone-tag -Specifies that extension assigner use the ephone tag to identify the extension number that is assigned to a phone. The installation technician enters this number to assign an extension number to a phone. • provision-tag-Specifies that extension assigner use the provision-tag to identify the extension number that is assigned to a phone. The installation technician enters this number to assign an extension number to a phone. end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 5 Configure Temporary Extension Numbers for SCCP Phones That Use Extension Assigner To create ephone-dn that is used as temporary extension numbers for phones to which an extension number will be assigned by Extension Assigner, perform the following steps for each temporary number to be created. The readme file that is included with the script contains some sample entries for this procedure that you can edit to fit your needs. Tip Cisco Unified Communications Manager Express System Administrator Guide 361 Create Phone Configurations Using Extension Assigner Configure Temporary Extension Numbers for SCCP Phones That Use Extension Assigner SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-dn dn-tag [dual-line] 4. number number [secondary number] [no-reg [both | primary]] 5. trunk digit-string [timeout seconds] 6. name name 7. exit 8. telephony-service 9. auto assign dn-tag to dn-tag 10. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters ephone-dn configuration mode, creates an ephone-dn, and optionally assigns it dual-line status. ephone-dn dn-tag [dual-line] Example: Router(config)# ephone-dn 90 Step 3 We recommend that you use single-line mode for your temporary extension numbers. Note number number [secondary number] [no-reg Configures a valid extension number for this ephone-dn instance. [both | primary]] Step 4 Example: Router(config-ephone-dn)# number 9000 (Optional) Configures extension number to be automatically dialed for accessing the extension assigner application. trunk digit-string [timeout seconds] Example: Router(config-ephone-dn)# trunk 5999 Step 5 • digit-string - Must match the number that you configured in the Specify the Extension for Accessing Extension Assigner Application section. (Optional) Associates a name with this ephone-dn instance. This name is used for caller-ID displays and in the local directory listings. name name Example: RRouter(config-ephone-dn)# name hardware Step 6 • Must follow the name order that is specified with the directory command. Cisco Unified Communications Manager Express System Administrator Guide 362 Create Phone Configurations Using Extension Assigner Configure Temporary Extension Numbers for SCCP Phones That Use Extension Assigner Command or Action Purpose exit Exits ephone-dn configuration mode. Example: Router(config-ephone-dn)# exit Step 7 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 8 Automatically assigns ephone-dn tags to Cisco Unified IP phones as they register for service with a Cisco Unified CME router. auto assign dn-tag to dn-tag Example: Router(config-telephony)# auto assign 90 to 99 Step 9 • Must match the tags that you configured in earlier step. end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 10 Configure Temporary Extension Numbers for SIP Phones That Use Extension Assigner To create voice register dns to use as temporary extension numbers for phones in which an extension number is assigned by Extension Assigner, perform the following steps for each temporary number to be created. The readme file that is included with the script contains some sample entries for this procedure that you can edit to fit your needs. Tip SUMMARY STEPS 1. enable 2. configure terminal 3. voice register global 4. auto-register 5. password string 6. auto-assign first dn to last dn 7. end Cisco Unified Communications Manager Express System Administrator Guide 363 Create Phone Configurations Using Extension Assigner Configure Temporary Extension Numbers for SIP Phones That Use Extension Assigner DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 voice register global Enters voice register global configuration mode. Example: Router(config)# voice register global Step 3 auto-register Enters auto-register configuration mode. Example: Router(config-register-global)# auto-register Step 4 password string Specifies default password for auto registered phones. Example: Router(config-voice-auto-register)# password xxxx Step 5 Automatically assigns voice register dn with these extensionsto Cisco Unified IPphones asthey register for service with a Cisco Unified CME router. auto-assign first dn to last dn Example: Router(config-voice-auto-register)# auto-assign 90 to 99 Step 6 end Returns to privileged EXEC mode. Example: Router(config-voice-auto-register)# end Step 7 Configure Extension Numbers That Installation Technicians Can Assign to SCCP Phones To create ephone-dns for an extension numbers that the installation technicians can assign to phones, perform the following steps for each directory number to be created. Tip The readme file provided with this feature contains sample entries that you can edit to fit your needs. Cisco Unified Communications Manager Express System Administrator Guide 364 Create Phone Configurations Using Extension Assigner Configure Extension Numbers That Installation Technicians Can Assign to SCCP Phones SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-dn dn-tag [dual-line] 4. number number [ secondary number] [ no-reg [ both | primary ]] 5. trunk digit-string [ timeout seconds ] 6. name name 7. exit 8. telephony-service 9. auto assign dn-tag to dn-tag 10. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters ephone-dn configuration mode, creates an ephone-dn, and optionally assigns it dual-line status. ephone-dn dn-tag [dual-line] Example: Router(config)# ephone-dn 20 Step 3 To change an ephone-dn from dual-line to single-line mode or the reverse, first delete the ephone-dn and then recreate it. Note number number [ secondary number] [ no-reg Configures a valid extension number for this ephone-dn instance. [ both | primary ]] Step 4 Example: Router(config-ephone-dn)# number 9000 (Optional) Configures extension number to be automatically dialed for accessing the extension assigner application. trunk digit-string [ timeout seconds ] Example: Router(config-ephone-dn)# trunk 5999 Step 5 • digit-string - Must match the number that you configured in the Specify the Extension for Accessing Extension Assigner Application section. (Optional) Associates a name with this ephone-dn instance. This name is used for caller-ID displays and in the local directory listings. name name Example: Router(config-ephone-dn)# name hardware Step 6 Cisco Unified Communications Manager Express System Administrator Guide 365 Create Phone Configurations Using Extension Assigner Configure Extension Numbers That Installation Technicians Can Assign to SCCP Phones Command or Action Purpose • Must follow the name order that isspecified with thedirectory command. exit Exits ephone-dn configuration mode Example: Router(config-ephone-dn)# exit Step 7 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 8 Automatically assigns ephone-dn tags to Cisco Unified IP phones as they register for service with a Cisco Unified CME router. auto assign dn-tag to dn-tag Example: Router(config-telephony)# auto assign 90 to 99 Step 9 • Must match the tags that you configured in earlier step. end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 10 Configure Extension Numbers That Installation Technicians Can Assign to SIP Phones To create voice register dns for an extension numbers that the installation technicians can assign to phones, perform the following steps for each directory number to be created. Tip The readme file provided with this feature contains sample entries that you can edit to fit your needs. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register dn tag 4. number number 5. name name 6. end Cisco Unified Communications Manager Express System Administrator Guide 366 Create Phone Configurations Using Extension Assigner Configure Extension Numbers That Installation Technicians Can Assign to SIP Phones DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register dn configuration mode, and creates a voice register dn. voice register dn tag Example: Router(config)# voice register dn 20 Step 3 Configures a valid extension number for this voice register dn instance. number number Example: Router(config-register-dn)# number 20 Step 4 (Optional) Associates a name with this voice register dn instance. This name is used for caller-ID displays and in the local directory listings. name name Example: Router(config-register-dn)# name hardware Step 5 • Must follow the name order that is specified with the directory command. end Returns to privileged EXEC mode. Example: Router(config-register-dn)# end Step 6 Cisco Unified Communications Manager Express System Administrator Guide 367 Create Phone Configurations Using Extension Assigner Configure Extension Numbers That Installation Technicians Can Assign to SIP Phones Configure Ephones with Temporary MAC Addresses To create an ephone configuration with temporary MAC address for a Cisco Unified CME phone to which you want the installation technician to assign extension numbers, perform the following steps for each phone. Restriction • Max-ephone setting determines how many phones you can plug in at one time. For example, if your max-ephone setting is ten more than the number of phones to which you want to assign extension numbers, the you can plug in ten phones at a time. If you plug in eleven phones, one phone will not register or get a temporary extension number until you assign an extension to one of the first ten phones and reset the eleventh phone. • For Cisco VG224 analog voice gateways with extension assigner, a minimum of 24 temporary ephones is required. The readme file provided with this feature contains some sample entries for this procedure that you can edit to fit your needs. Tip Before You Begin The max-ephone command must be configured for a value equal to at least one greater than the number of phonesto which you want to assign extension numbersto allow the autoregister feature to automatically create at least one ephone for your temporary extension numbers. You are permitted to set the max-ephone value higher than the number of users supported by your Cisco Unified CME licenses for the purpose of enrolling licensed phones using Extension Assigner. Note SUMMARY STEPS 1. enable 2. configure terminal 3. enable phone-tag 4. provision-tag number 5. mac-address 02EA.EAEA. number 6. type phone-type [ addon 1 module-type [2 module-type]] 7. button button-number{separator}dn-tag 8. end Cisco Unified Communications Manager Express System Administrator Guide 368 Create Phone Configurations Using Extension Assigner Configure Ephones with Temporary MAC Addresses DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 enable phone-tag Enters ephone configuration mode. Example: Router(config)# ephone 20 Step 3 • phone-tag-Maximum number is version and platform- specific. Type ? to display range. • Number that the installation technician enters when assigning an extension to a phone if Extension Assigner uses ephone-tags (default). (Optional) Creates a unique sequence number to be used by Extension Assigner to identify extension numbers to be assigned. provision-tag number Example: Router(config-ephone)# provision-tag 20 Step 4 • required only if you configured theprovision-tag keyword with the extension-assigner tag-type command. Step 5 mac-address 02EA.EAEA. number Specifies a temporary MAC address number for this ephone. Example: Router(config-ephone)# mac-address 02EA. EAEA. 0020 • For Extension Assigner, MAC address must begin with 02EA.EAEA. • number - we strongly recommend that you make this number the same as the ephone number. type phone-type [ addon 1 module-type [2 Specifies the type of phone. module-type]] Step 6 Example: Router(config-ephone)# type 7960 addon 1 7914 Associates a button number and line characteristics with an extension (ephone-dn). button button-number{separator}dn-tag Example: Router(config-ephone)# button 1:1 Step 7 • Maximum number of buttons is determined by phone type. The Cisco Unified IP Phone 7910 has only one line button, but can be given two ephone-dn tags. Note Cisco Unified Communications Manager Express System Administrator Guide 369 Create Phone Configurations Using Extension Assigner Configure Ephones with Temporary MAC Addresses Command or Action Purpose end Returns to privileged EXEC mode Example: Router(config-ephone)# end Step 8 Configure Voice Register Pools with Temporary MAC Addresses Restriction • Max-pool setting determines how many phones you can plug in at one time. For example, if your max-pool setting is ten more than the number of phones to which you want to assign extension numbers, the you can plug in ten phones at a time. If you plug in eleven phones, one phone will not register or get a temporary extension number until you assign an extension to one of the first ten phones and reset the eleventh phone. The readme file provided with this feature contains some sample entries for this procedure that you can edit to fit your needs. Tip Before You Begin The max-pool command must be configured for a value equal to at least one greater than the number of phones to which you want to assign extension numbers to allow the autoregister feature to automatically create at least one ephone for your temporary extension numbers. Note • You are permitted to set the max-pool value higher than the number of userssupported by your Cisco Unified CME licenses for the purpose of enrolling licensed phones using Extension Assigner. • For a phone that needs to invoke Extension Assigner application for assign or unassign operations, g711ulaw codec and dtmf-relay as rtp-nte needs to be configured in voice register pool. Cisco Unified Communications Manager Express System Administrator Guide 370 Create Phone Configurations Using Extension Assigner Configure Voice Register Pools with Temporary MAC Addresses SUMMARY STEPS 1. enable 2. configure terminal 3. voice register pool pool-tag 4. provision-tag number 5. mac-address 02EA.EAEA. number 6. type phone-type [ addon 1 module-type [2 module-type]] 7. number number dn dn-tag 8. dtmf-relay rtp-nte 9. codec g711ulaw 10. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 voice register pool pool-tag Enters voice register pool configuration mode. Example: Router(config)# voice register pool 20 Step 3 • phone-tag-Maximum number is version and platform- specific. Type ? to display range. • Number that the installation technician enters when assigning an extension to a phone. Creates a unique sequence number to be used by Extension Assigner to identify extension numbers to be assigned. provision-tag number Example: Router(config-register-pool)# provision-tag 20 Step 4 • required only if you configured theprovision-tag keyword with the extension-assigner tag-type command. Step 5 mac-address 02EA.EAEA. number Specifies a temporary MAC address number for this phone. Example: Router(config-register-pool)# mac-address 02EA. EAEA. 0020 • For Extension Assigner, MAC address must begin with 02EA.EAEA. • number - we strongly recommend that you make this number same as the voice register pool number. Cisco Unified Communications Manager Express System Administrator Guide 371 Create Phone Configurations Using Extension Assigner Configure Voice Register Pools with Temporary MAC Addresses Command or Action Purpose type phone-type [ addon 1 module-type [2 Specifies the type of phone. module-type]] Step 6 Example: Router(config-register-pool)# type 8860 addon 1 CKEM 2 Associates number and line characteristics with an extension (voice register dn). number number dn dn-tag Example: Router(config-register-pool)# number 1 dn 1 Step 7 (Optional)Specifiesthe method for relaying dual tone multifrequency (DTMF) tones between two devices as per RFC2833. dtmf-relay rtp-nte Example: Router(config-register-pool)# dtmf-relay rtp-nte Step 8 This configuration is required only to perform assign or unassign operation using Extension Assigner application. (Optional) Specifies the voice coder rate of speech for a dial peer. This configuration is required only to perform assign or unassign operation using Extension Assigner application. codec g711ulaw Example: Router(config-register-pool)# codec g711ulaw Step 9 • g711ulaw-Option that represents the correct voice decoder rate. g711ulaw is the only codec supported with Extension Assigner application. end Returns to privileged EXEC mode. Example: Router(config-register-pool)# end Step 10 Configure the Router to Automatically Save Your Configuration To automatically save your router configuration when the router is restarted, perform the following steps. Cisco Unified Communications Manager Express System Administrator Guide 372 Create Phone Configurations Using Extension Assigner Configure the Router to Automatically Save Your Configuration SUMMARY STEPS 1. enable 2. configure terminal 3. kron policy-list list-name 4. cli write 5. exit 6. kron occurrence occurrence-name [ user username] [[ in numdays: ]numhours: ]nummin { oneshot | recurring } 7. policy-list list-name 8. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Specifies a name for a new or existing Command Scheduler policy list and enters kron-policy configuration mode. kron policy-list list-name Example: Router(config)# kron policy-list save-config Step 3 • If the value of the list-name argument is new, a new policy list structure is created. • If the value of the list-name argument exists, the existing policy list structure is accessed. No editor function is available, and the policy list is run in the order in which it was configured. You can also use the CLI command background save interval configured under telephony-service to automatically save configurations on Unified CME. This is as an alternative for thekron command. Note Specifiesthe fully-qualified EXEC command and associated syntax to be added as an entry in the Command Scheduler policy list. cli write Example: Router(config-kron-policy)# cli write Step 4 exit Returns to global configuration mode. Example: Router(config-kron-policy)# exit Step 5 Cisco Unified Communications Manager Express System Administrator Guide 373 Create Phone Configurations Using Extension Assigner Configure the Router to Automatically Save Your Configuration Command or Action Purpose Specifiesschedule parametersfor a CommandScheduler occurrence and enters kron-occurrence configuration mode. kron occurrence occurrence-name [ user username] [[ in numdays: Step 6 ]numhours: ]nummin { oneshot | recurring } • We recommend that you configure your router to save your configuration every 30 minutes. Example: Router(config)# kron occurrence backup in 30 recurring • occurrence-name-Specifies the name of the occurrence. Length of occurrence-name is from 1 to 31 characters. If the occurrence-name is new, an occurrence structure is created. If the occurrence-name is not new, the existing occurrence is edited. • user-(Optional) Used to identify a particular user. • username-Name of user. • in-Identifies that the occurrence is to run after a specified time interval. The timer starts when the occurrence is configured. • numdays:- (Optional) Number of days. If used, add a colon after the number. • numhours:- (Optional) Number of hours. If used, add a colon after the number. • nummin:- (Optional) Number of minutes. • oneshot-Identifies that the occurrence is to run only one time. After the occurrence has run, the configuration is removed. • recurring-Identifies that the occurrence is to run on a recurring basis. policy-list list-name Specifies a Command Scheduler policy list. Example: Router(config-kron-occurrence)# policy-list save-config Step 7 end Returns to privileged EXEC mode. Example: Router(config-kron-occurrence)# end Step 8 Provide the Installation Technician with the Required Information Before the installation technician can assign extension numbers to the new phones, you must provide the following information: • How many phones the installation technician can plug in at one time. This is determined by the number of temporary MAC addresses that you configured. Cisco Unified Communications Manager Express System Administrator Guide 374 Create Phone Configurations Using Extension Assigner Provide the Installation Technician with the Required Information • Which extension number to dial to access the extension assigner application. • Whether the number is dialed automatically when a phone goes off hook (applicable only to SCCP phones). • What password to enter to access the application. • Which tag numbers to enter to assign an extension to each phone. Configure Extension Assigner Synchronization Configure the XML Interface for the Secondary Backup Router To configure the secondary backup router to activate the XML interface required to receive configuration change information from the primary router, perform the following steps. If there are HTTP connection issues between the primary router and the secondary backup router during automatic synchronization, the extension assigner synchronization changes are lost. Note Restriction • Automatic synchronization for new or replacement routers is not supported. • Extension assigner preconfiguration must be manually performed on the secondary backup router. Before You Begin • The XML interface, provided through the Cisco IOS XML Infrastructure (IXI), must be configured.See Information About XML API. SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service | voice register global 4. xml user user-name password password privilege-level 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Cisco Unified Communications Manager Express System Administrator Guide 375 Create Phone Configurations Using Extension Assigner Configure Extension Assigner Synchronization Command or Action Purpose Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enterstelephony service configuration mode or voice register global mode. telephony-service | voice register global Example: Router(config)# telephony-service Router(config)# voice register global Step 3 Step 4 xmluser user-namepasswordpassword privilege-level Defines an authorized user. Example: Router(config-telephony)# xml user user23 • user-name—Username of the authorized user. • password—Password to use for access. password 3Rs92uzQ 15 • privilege-level—Level of access to Cisco IOS commands to be granted to this user. Only the Router(config-register-global)# xml user user23 password 3Rs92uzQ 15 commands with the same or a lower level can be executed via XML. Range is 0 to 15. end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Router(config-register-global)# end Step 5 Configure Extension Assigner Synchronization on the Primary Router To configure the primary router to enable automatic synchronization to the secondary backup router, perform the following steps. Before You Begin • XML interface for secondary backup router is configured. See Configure the XML Interface for the Secondary Backup Router. • The secondary backup router’s IP address must already be configured using the ip source-address command in telephony-service configuration mode. Cisco Unified Communications Manager Express System Administrator Guide 376 Create Phone Configurations Using Extension Assigner Configure Extension Assigner Synchronization on the Primary Router Phone configurations such as MAC address, pool-tag, and phone type are saved as part of synchronization for Extension Assigner feature. Note SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service | voice register global 4. standby username username password password 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters telephony service configuration mode or voice register global mode. telephony-service | voice register global Example: Router(config)# telephony-service Router(config)# voice register global Step 3 Step 4 standby username username password password Defines an authorized user. Example: Router(config-telephony)# standby username user23 • Same username and password that was previously defined for the XML interface on the secondary backup router. password 3Rs92uzQ Router(config-register-global)# standby username user23 password 3Rs92uzQ end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Router(config-register-global)# end Step 5 Cisco Unified Communications Manager Express System Administrator Guide 377 Create Phone Configurations Using Extension Assigner Configure Extension Assigner Synchronization on the Primary Router Assign Extension Numbers Onsite by Using Extension Assigner The following tasks are performed by the installation technician at the customer’s site: Assign New Extension Numbers Initially, when you install a phone, it is assigned a temporary, random extension number. To access Extension Assigner and assign the appropriate extension number to this phone, perform the following steps. Step 1 Get the information you need to use extension assigner from your system administrator. For a list of this information, see Provide the Installation Technician with the Required Information. Step 2 Dial the appropriate extension number to access the extension assigner system. Step 3 Enter the password for the extension assigner and press #. Step 4 Enter the ID number that represents this phone’s extension and press #. Step 5 If the extension is not assigned to another phone, press 1 to confirm that you want to assign the extension to your phone, then hang up. After the phone resets, the assignment is complete. Step 6 If the extension is assigned to another phone that is idle: a) Press 2 to confirm that you want to unassign the extension from the other phone. b) Hang up. c) Repeat this procedure beginning at Step 2, on page 378. Step 7 If the extension is assigned to another phone that is in use, either: • Return to Step 5, on page 378 to enter another extension number. • Perform the procedures in the Unassign an Extension Number section and then repeat this procedure beginning at Step 2, on page 378. Unassign an Extension Number After the new extension number is assigned, you may find that you assigned the wrong number or that your original dial plan has changed. To unassign the wrong numberso that it can be used by another phone, perform the following steps. Cisco Unified Communications Manager Express System Administrator Guide 378 Create Phone Configurations Using Extension Assigner Assign Extension Numbers Onsite by Using Extension Assigner You can unassign the extension number of the phone that is used to dial in to the Extension Assigner or the extension number of another phone that has a provision-tag configured. Note Step 1 Get the information you need to use extension assigner from your system administrator. For a list of this information, see Provide the Installation Technician with the Required Information. Step 2 Dial the appropriate extension number to access the extension assigner system. Step 3 Enter the password for the extension assigner and press #. Step 4 Enter the provision-tag of the phone that needs to be unassigned, and press #. Step 5 When you enter the provision-tag for the phone extension that needs to be unassigned, you are prompted to press 2 followed by # to confirm that you want to unassign the extension from the phone. Step 6 Hang up. Reassign the Current Extension Number • If you must replace a broken phone or you want to reassign an extension number, perform the following steps. Note You can reassign a number to a phone only if that number: • Is not assigned to another phone • Is assigned to another phone and that phone is idle • Is assigned to another phone and you first unassign the extension Step 1 Get the information you need to use extension assigner from your system administrator. For a list of this information, see Provide the Installation Technician with the Required Information. Step 2 Dial the appropriate extension number to access the extension assigner system. Step 3 Enter the password for the extension assigner and press #. Step 4 Enter the ID number that represents this phone’s extension and press #. Step 5 If the extension is not assigned to another phone, press 1 to confirm that you want to assign the extension to your phone, then hang up. After the phone resets, the reassignment is complete. Step 6 If the extension is assigned to another phone that is idle: • Press 2 to confirm that you want to unassign the extension from the other phone. • Hang up. • Perform the procedure in the Assign New Extension Numbers section. Cisco Unified Communications Manager Express System Administrator Guide 379 Create Phone Configurations Using Extension Assigner Reassign the Current Extension Number Step 7 If the extension is assigned to another phone that is in use, either: • Return to Step 5, on page 379 to enter another extension number. • Perform the procedures in the Unassign an Extension Number section and the Assign New Extension Numbers section. Verify Extension Assigner Configuration for SCCP Phones Step 1 Use the debug ephone extension-assigner command to display status messages produced by the extension assigner application. Step 2 Use thedebug voipapplicationscript command to display status messages produced by the server asit runsthe assigner application Tcl script. Step 3 Use the debug ephone state command as described in the Cisco IOS Debug Command Reference. Verify Extension Assigner Configuration for SIP Phones Step 1 Use the debug voice register events and debug voice register error commands to display status messages produced by the extension assigner application. Step 2 Use thedebug voipapplicationscript command to display status messages produced by the server asit runsthe assigner application Tcl script. Step 3 Use thedebug ccsip messages anddebug ccsiperror commandsto display status messagesfor unregistration of phones. Configuration Examples for Extension Assigner Example for Extension Assigner on SCCP Phone This example shows a router configuration with the following characteristics: • The extension that the installation technician dials to access the extension assigner application is 0999. • The password that the installation technician enters to access the extension assigner application is 1234. • The auto assign command is configured to assign extensions 0001 to 0005. Cisco Unified Communications Manager Express System Administrator Guide 380 Create Phone Configurations Using Extension Assigner Verify Extension Assigner Configuration for SCCP Phones • The installation technician can use extension assigner to assign extension numbers 6001 to 6005. • The extension assigner uses the provision-tag to identify which ephone configuration and extension numbers to assign to the phone. • The auto-reg-ephone command is shown but required, since it is enabled by default. • The kron command is used to automatically save the router configuration. • The max-ephone and max-dn settings of 51 are high enough to allow the installation technician to assign extensions to 50 phones, plugging them in one at a time. If the installation technician is assigning extensions to 40 phones, 11 can be plugged in one at a time. The exception is if you use Cisco VG224 Analog Voice Gateways. Extension assigner creates 24 ephones for each Cisco VG224 Analog Voice Gateway, one for each port. Router# show running-config version 12.4 no service password-encryption ! hostname Test-Router ! boot-start-marker boot system flash:c2800nm-ipvoice-mz.2006-05-31.GOPED_DEV boot-end-marker ! enable password ww ! no aaa new-model ! resource policy ! ip cef no ip dhcp use vrf connected ! ip dhcp pool pool21 network 172.21.0.0 255.255.0.0 default-router 172.21.200.200 option 150 ip 172.30.1.60 Cisco Unified Communications Manager Express System Administrator Guide 381 Create Phone Configurations Using Extension Assigner Example for Extension Assigner on SCCP Phone ! no ip domain lookup ! application service EA flash:ea/app-cme-ea-2.0.0.0.tcl paramspace english index 0 paramspace english language en param ea-password 1234 paramspace english location flash:ea/ paramspace english prefix en ! interface GigabitEthernet0/0 no ip address duplex auto speed 100 no keepalive ! interface GigabitEthernet0/0.21 encapsulation dot1Q 21 ip address 172.21.200.200 255.255.0.0 ip http server ! control-plane ! dial-peer voice 999 voip service EA out-bound destination-pattern 0999 session target ipv4:172.21.200.200 dtmf-relay h245-alphanumeric codec g711ulaw no vad ! telephony-service extension-assigner tag-type provision-tag max-ephones 51 max-dn 51 ip source-address 172.21.200.200 port 2000 auto-reg-ephone auto assign 101 to 105 system message Test-CME create cnf-files version-stamp 7960 Jun 14 2006 05:37:34 ! ephone-dn 1 dual-line number 6001 ! ephone-dn 2 dual-line number 6002 ! ephone-dn 3 dual-line number 6003 ! ephone-dn 4 dual-line number 6004 ! ephone-dn 5 dual-line number 6005 ! ephone-dn 101 number 0101 label Temp-Line-not assigned yet ! ephone-dn 102 number 0102 label Temp-Line-not assigned yet ! ephone-dn 103 number 0103 label Temp-Line-not assigned yet ! ephone-dn 104 number 0104 label Temp-Line-not assigned yet ! Cisco Unified Communications Manager Express System Administrator Guide 382 Create Phone Configurations Using Extension Assigner Example for Extension Assigner on SCCP Phone ephone-dn 105 number 0105 label Temp-Line-not assigned yet ! ephone 1 provision-tag 101 mac-address 02EA.EAEA.0001 button 1:1 ! ephone 2 provision-tag 102 mac-address 02EA.EAEA.0002 button 1:2 ! ephone 3 provision-tag 103 mac-address 02EA.EAEA.0003 button 1:3 ! ephone 4 provision-tag 104 mac-address 02EA.EAEA.0004 button 1:4 ! ephone 5 provision-tag 105 mac-address 02EA.EAEA.0005 button 1:5 ! kron occurrence backup in 30 recurring policy-list writeconfig ! kron policy-list writeconfig cli write ! line con 0 line aux 0 line vty 0 4 logging synchronous ! no scheduler max-task-time scheduler allocate 20000 1000 ! end Example for Extension Assigner on SIP Phone The following example shows that provision tag 1001 is configured for voice register pool 1 and provision tag 1002 is configured for voice register pool 2: voice register global auto-register password cisco1234 auto assign 101-102 voice register dn 1001 number 1001 voice register dn 1002 number 1002 voice register pool 1 Cisco Unified Communications Manager Express System Administrator Guide 383 Create Phone Configurations Using Extension Assigner Example for Extension Assigner on SIP Phone provision-tag 1001 mac-address 02EA.EAEA.0001 number 1 dn 1001 voice register pool 2 provision-tag 1002 mac-address 02EA.EAEA.0002 number 2 dn 1002 Example for Extension Assigner Synchronization Primary Router: Example The extension assigner is authorized to send configuration change information from the primary router to the secondary backup router. telephony-service standby username user555 password purplehat Secondary Backup Router: Example System components are enabled and the XML interface isreadied to receive configuration change information. ip http server ixi transport http no shutdown ixi application cme no shutdown telephony-service xml user user555 password purplehat 15 Feature Information for Extension Assigner The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Table 20: Feature Information for Extension Assigner Feature Name Cisco Unfiied CME Version Feature Information Enablesthe installation technicians to assign extension numberstoSIP Phones configured on Cisco Unified CME. Extension Assigner forSIPPhones 11.6 Enables the secondary backup router to automatically receive any changes made to ephone mac-addresess in the primary router. Extension Assigner 4.2(1) Synchronization Cisco Unified Communications Manager Express System Administrator Guide 384 Create Phone Configurations Using Extension Assigner Example for Extension Assigner Synchronization Feature Name Cisco Unfiied CME Version Feature Information Enables installation technicians to assign extension numbers to Cisco Unified CME SCCP phones without accessing the server. Extension Assigner 4.0(3) Cisco Unified Communications Manager Express System Administrator Guide 385 Create Phone Configurations Using Extension Assigner Feature Information for Extension Assigner Cisco Unified Communications Manager Express System Administrator Guide 386 Create Phone Configurations Using Extension Assigner Feature Information for Extension Assigner CHAPTER 9 Configuration Files for Phones • Information About Configuration Files, page 387 • Generate Configuration Files for Phones, page 388 • Where To Go Next, page 395 Information About Configuration Files Configuration Files for Phones When a phone requests service from Cisco Unified CME, the registrar confirms the username, i.e. the phone number for the phone. The phone accesses its configuration profile on the TFTP server, typically the Cisco Unified CME router, and processes the information contained in the file, registers itself, and puts the phone number on the phone console display. Minimally, a configuration profile containsthe MAC address, the type, and the phone number that is permitted by the registrar to handle the Register message for a particular Cisco Unified IP phone. Any time you create or modify parameters for either an individual phone or a directory number, generate a new phone configuration to properly propagate the parameters. By default, there is one shared XML configuration file located in system:/its/ for all Cisco Unified IP phones that are running SCCP. For SIP phones directly connected to Cisco Unified CME, an individual configuration profile is created for each phone and stored in system:/cme/sipphone/. When an IP phone comes online or is rebooted, it automatically gets information about itself from the appropriate configuration file. The Cisco universal application loader for phone firmware files allows you to add additional phone features across all protocols. To do this, a hunt algorithm searches for multiple configuration files. After a phone is reset or restarted, the phone automatically selects protocol depending on which matching configuration file is found first. To ensure that Cisco Unified IP phones download the appropriate configuration for the desired protocol,SCCPorSIP, you must properly configure the IPphones before connecting or rebooting the phones. The hunt algorithm searches for files in the following order: 1 CTLSEP file for a SCCP phone—For example, CTLSEP003094C25D2E.tlv Cisco Unified Communications Manager Express System Administrator Guide 387 2 SEP file for a SCCP phone—For example, SEP003094C25D2E.cnf.xml 3 SIP file for a SIP phone—For example, SIP003094C25D2E.cnf or gk003069C25D2E 4 XML default file for SCCP phones—For example, SEPDefault.cnf.xmls 5 XML default file for SIP phones—For example, SIPDefault.cnf In Cisco Unified CME 4.0 and later for SCCP and in Cisco CME 3.4 and later for SIP, you can designate one of the following locations in which to store configuration files: • System (Default)—For SCCP phones, one configuration file is created, stored, and used for all phones in the system. For SIP phones, an individual configuration profile is created for each phone. • Flash or slot 0—When flash or slot 0 memory on the router is the storage location, you can create additional configuration files to be applied per phone type or per individual phone, such as user or network locales. • TFTP—When an external TFTP server is the storage location, you can create additional configuration files to be applied per phone type or per individual phone, which are required for multiple user and network locales. Per-Phone Configuration Files If configurations files for SCCP phones are to be stored somewhere other than in the default location, the following individual configuration files can be created for SCCP phones: • Per phone type—Creates separate configuration files for each phone type and all phones of the same type use the same configuration file. This method is not supported if the configuration files are to be stored in the system location. • Per phone—Creates a separate configuration file for each phone, by MAC address. This method is not supported if the configuration files are to be stored in the system location. For configuration information, see Define Per-Phone Configuration Files and Alternate Location for SCCP Phones, on page 181. Generate Configuration Files for Phones Generate Configuration Files for SCCP Phones To generate the configuration profile files that are required by the SCCP phones in Cisco Unified CME and write them to either system memory or to the location specified by the cnf-file location command, follow the steps in this section. Cisco Unified Communications Manager Express System Administrator Guide 388 Configuration Files for Phones Per-Phone Configuration Files Restriction • Externally stored and per-phone configuration files are not supported on the Cisco Unified IPPhone 7902G, 7910, 7910G, or 7920, or the Cisco Unified IP Conference Station 7935 and 7936. • TFTPdoes notsupport file deletion. When configuration files are updated, they overwrite any existing configuration files with the same name. If you change the configuration file location, files are not deleted from the TFTP server. • Generating configuration files on flash or slot 0 can take up to a minute, depending on the number of files being generated. • Forsmaller routerssuch as Cisco 2600 seriesrouters, you must manually enter the squeeze command to erase files after changing the configuration file location or entering any commands that trigger the deletion of configuration files. Unless you use the squeeze command, the space used by the moved or deleted configuration files is not usable by other files. SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. create cnf-files 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 3 Builds the XML configuration files required for IP phones. create cnf-files Example: Router(config-telephony)# create cnf-files Step 4 Cisco Unified Communications Manager Express System Administrator Guide 389 Configuration Files for Phones Generate Configuration Files for SCCP Phones Command or Action Purpose end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 5 Verify Configuration Files for SCCP Phones To verify the Cisco Unified CME phone configuration, perform the following steps. Step 1 show telephony-service all Use this command to verify the configuration for phones, directory numbers, voice ports, and dial peers in Cisco Unified CME. Example: Router# show telephony-service all CONFIG (Version=4.0(0)) ===================== Version 4.0(0) Cisco Unified CallManager Express For on-line documentation please see: www.cisco.com/en/US/products/sw/voicesw/ps4625/tsd_products_support_series_home.html ip source-address 10.0.0.1 port 2000 max-ephones 24 max-dn 24 dialplan-pattern 1 408734.... voicemail 11111 transfer-pattern 510734.... keepalive 30 ephone-dn 1 number 5001 huntstop ephone-dn 2 number 5002 huntstop call-forward noan 5001 timeout 8 Step 2 show telephony-service tftp-bindings Use this command to display the current configuration files accessible to IP phones. Example: Router# show telephony-service tftp-bindings tftp-server system:/its/SEPDEFAULT.cnf tftp-server system:/its/SEPDEFAULT.cnf alias SEPDefault.cnf tftp-server system:/its/XMLDefault.cnf.xml alias XMLDefault.cnf.xml tftp-server system:/its/ATADefault.cnf.xml Cisco Unified Communications Manager Express System Administrator Guide 390 Configuration Files for Phones Verify Configuration Files for SCCP Phones tftp-server system:/its/XMLDefault7960.cnf.xml alias SEP00036B54BB15.cnf.xml tftp-server system:/its/germany/7960-font.xml alias German_Germany/7960-font.xml tftp-server system:/its/germany/7960-dictionary.xml alias German_Germany/7960-dictionary.xml tftp-server system:/its/germany/7960-kate.xml alias German_Germany/7960-kate.xml tftp-server system:/its/germany/SCCP-dictionary.xml alias German_Germany/SCCP-dictionary.xml tftp-server system:/its/germany/7960-tones.xml alias Germany/7960-tones.xml Generate Configuration Profiles for SIP Phones To generate the configuration profile files that are required by the SIP phones in Cisco Unified CME and write them to the location specified by the tftp-path (voice register global) command, follow the steps in this section. Any time you create or modify parameters under the voice register dn or voice register pool configuration modes, generate a new configuration profile and properly propagate the parameters. If your Cisco Unified CME system supports SCCP and also SIP phones, do not connect your SIP phones to the network until after you have verified the phone configuration profiles. Caution Before You Begin • Cisco Unified CME 3.4 or a later version. • The mode cme command must be enabled in Cisco Unified CME. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register global 4. file text 5. create profile 6. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. Cisco Unified Communications Manager Express System Administrator Guide 391 Configuration Files for Phones Generate Configuration Profiles for SIP Phones Command or Action Purpose configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register global configuration mode to set parameters for all supported SIP phones in Cisco Unified CME. voice register global Example: Router(config)# voice register global Step 3 (Optional) Generates ASCII text files of the configuration profiles generated for Cisco Unified IP Phone 7905s and 7905Gs, file text Example: Router(config-register-global)# file text Step 4 Cisco Unified IP Phone 7912s and 7912Gs, Cisco ATA-186, or Cisco ATA-188. • Default—System generates binary files to save disk space. Generates configuration profile files required for SIP phones and writes the files to the location specified with tftp-path command. create profile Example: Router(config-register-global;)# create profile Step 5 end Exits configuration mode and enters privileged EXEC mode. Example: Router(config-register-global)# end Step 6 Verify Configuration Profiles for SIP Phones To verify the configuration profiles, perform the following steps. SIP phones to be connected to Cisco Unified CME can register and minimally, have an assigned phone number, only if the configuration is correct. Step 1 show voice register tftp-bind Use this command to display a list of configuration profiles that are accessible to SIP phones using TFTP. The file name includes the MAC address for each SIP phone, such as SIP .cnf. Verify that a configuration profile is available for each SIP phone in Cisco Unified CME. The following is sample output from this command: Example: Router(config)# show voice register tftp-bind Cisco Unified Communications Manager Express System Administrator Guide 392 Configuration Files for Phones Verify Configuration Profiles for SIP Phones tftp-server SIPDefault.cnf url system:/cme/sipphone/SIPDefault.cnf> tftp-server syncinfo.xml url system:/cme/sipphone/syncinfo.xml tftp-server SIP0009B7F7532E.cnf url system:/cme/sipphone/SIP0009B7F7532E.cnf tftp-server SIP000ED7DF7932.cnf url system:/cme/sipphone/SIP000ED7DF7932.cnf tftp-server SIP0012D9EDE0AA.cnf url system:/cme/sipphone/SIP0012D9EDE0AA.cnf tftp-server gk123456789012 url system:/cme/sipphone/gk123456789012 tftp-server gk123456789012.txt url system:/cme/sipphone/gk123456789012.txt Step 2 show voice register profile Use this command to display the contents of the ASCII format configuration profile for a particular voice register pool. To generate ASCII text files of the configuration profiles for Cisco Unified IP Phone 7905s and 7905Gs, Cisco Unified IP Phone 7912s and 7912Gs, Cisco ATA-186s, and Cisco ATA-188s, use the file text command. Note Example: The following is sample output from this command displaying information in the configuration profile for voice register pool 4. Router# show voice register profile text 4 Pool Tag: 4 # txt AutoLookUp:0 DirectoriesUrl:0 … CallWaiting:1 CallForwardNumber:0 Conference:1 AttendedTransfer:1 BlindTransfer:1 … SIPRegOn:1 UseTftp:1 UseLoginID:0 UIPassword:0 NTPIP:0.0.0.0 UID:2468 Step 3 more system Use this command to display the contents of the configuration profile for a particular Cisco Unified IP Phone 7940, Cisco Unified IP Phone 7905G, Cisco Unified IP Phone 7960, or Cisco Unified IP Phone 7960G. The following is sample output from this command displaying information in two SIP configuration profile files. The SIPDefault.cnf configuration profile is a shared file and SIP < MAC address > .cnf is the SIP configuration profile for the SIP phone with the designated MAC address. Router# more system:/cme/sipphone/SIPDefault.cnf image_version: "P0S3-07-4-00"; proxy1_address: "10.1.18.100"; proxy2_address: ""; proxy3_address: ""; proxy4_address: ""; proxy5_address: ""; proxy6_address: ""; proxy1_port: "5060"; proxy2_port: ""; proxy3_port: ""; proxy4_port: ""; proxy5_port: ""; proxy6_port: ""; Cisco Unified Communications Manager Express System Administrator Guide 393 Configuration Files for Phones Verify Configuration Profiles for SIP Phones proxy_register: "1"; time_zone: "EST"; dst_auto_adjust: "1"; dst_start_month: "April"; dst_start_day: ""; dst_start_day_of_week: "Sun"; dst_start_week_of_month: "1"; dst_start_time: "02:00"; dst_stop_month: "October"; dst_stop_day: ""; dst_stop_day_of_week: "Sun"; dst_stop_week_of_month: "8"; dst_stop_time: "02:00"; date_format: "M/D/Y"; time_format_24hr: "0"; local_cfwd_enable: "1"; directory_url: ""; messages_uri: "2000"; services_url: ""; logo_url: ""; stutter_msg_waiting: "0"; sync: "0000200155330856"; telnet_level: "1"; autocomplete: "1"; call_stats: "0"; Domain_Name: ""; dtmf_avt_payload: "101"; dtmf_db_level: "3"; dtmf_inband: "1"; dtmf_outofband: "avt"; dyn_dns_addr_1: ""; dyn_dns_addr_2: ""; dyn_tftp_addr: ""; end_media_port: "32766"; http_proxy_addr: ""; http_proxy_port: "80"; nat_address: ""; nat_enable: "0"; nat_received_processing: "0"; network_media_type: "Auto"; network_port2_type: "Hub/Switch"; outbound_proxy: ""; outbound_proxy_port: "5060"; proxy_backup: ""; proxy_backup_port: "5060"; proxy_emergency: ""; proxy_emergency_port: "5060"; remote_party_id: "0"; sip_invite_retx: "6"; sip_retx: "10"; sntp_mode: "directedbroadcast"; sntp_server: "0.0.0.0"; start_media_port: "16384"; tftp_cfg_dir: ""; Cisco Unified Communications Manager Express System Administrator Guide 394 Configuration Files for Phones Verify Configuration Profiles for SIP Phones timer_invite_expires: "180"; timer_register_delta: "5"; timer_register_expires: "3600"; timer_t1: "500"; timer_t2: "4000"; tos_media: "5"; voip_control_port: "5060"; Router# more system:/cme/sipphone/SIP000CCE62BCED.cnf image_version: "P0S3-07-4-00"; user_info: "phone"; line1_name: "1051"; line1_displayname: ""; line1_shortname: ""; line1_authname: "1051"; line1_password: "ww"; line2_name: ""; line2_displayname: ""; line2_shortname: ""; line2_authname: ""; line2_password: ""; auto_answer: "0"; speed_line1: ""; speed_label1: ""; speed_line2: ""; speed_label2: ""; speed_line3: ""; speed_label3: ""; speed_line4: ""; speed_label4: ""; speed_line5: ""; speed_label5: ""; call_hold_ringback: "0"; dnd_control: "0"; anonymous_call_block: "0"; callerid_blocking: "0"; enable_vad: "0"; semi_attended_transfer: "1"; call_waiting: "1"; cfwd_url: ""; cnf_join_enable: "1"; phone_label: ""; preferred_codec: "g711ulaw"; Where To Go Next After you generate a configuration file for a Cisco Unified IP phone connected to the Cisco Unified CME router, you are ready to download the file to the phone. See Reset and Restart Phones, on page 399. Cisco Unified Communications Manager Express System Administrator Guide 395 Configuration Files for Phones Where To Go Next Cisco Unified Communications Manager Express System Administrator Guide 396 Configuration Files for Phones Where To Go Next CHAPTER 10 Reset and Restart Cisco Unified IP Phones • Information About Resetting and Restarting Phones, page 397 • Reset and Restart Phones, page 399 • Feature Information for Reset and Restart Phones, page 405 Information About Resetting and Restarting Phones Differences between Resetting and Restarting IP Phones Cisco Unified IPphones must be rebooted after configuration changes in order for the changes to be effective. Configurations for phones in Cisco Unified CME are downloaded when a phone is rebooted or reset. You can reboot a single phone or you can reboot all phones in a Cisco Unified CME system. The differences between reboot types are summarized in Table 21: reset and restart Command Differences, on page 397. When rebooting multiple IP phones, it is possible for a conflict to occur if too many phones attempt to access changed Cisco Unified CME configuration information via TFTP simultaneously. Note Table 21: reset and restart Command Differences reset Command restart Command Similar to power-off, power-on Quick restart. reboot. Type of Reboot Downloads configurations for IP phones. Downloads configurations for IP phones. Phone Configurations Cisco Unified Communications Manager Express System Administrator Guide 397 reset Command restart Command Phones contact the TFTPserver for updated configuration information and reregister without contacting the DHCP server. This command was introduced forSIPphones in Cisco Unified CME 4.1. Note Contacts DHCP and TFTP servers for updated configuration information. This command was introduced forSIPphones in Cisco CME 3.4. Note DHCP and TFTP Faster processing for multiple phones. Takes longer to process when updating multiple phones. Processing Time • Directory numbers • Phone buttons • Speed-dial numbers • Date and time settings • Network locale • Phone firmware • Source address • TFTP path • URL parameters • User locale • Voicemail access number Can be used when updating the following: • Directory numbers • Phone buttons • Speed-dial numbers When Required Cisco Unified CME TAPI Enhancement Before Cisco Unified CME 7.0(1), the only method to clear a session between a Microsoft Windows Workstation and an SCCP phone that was out-of-sync was to reboot the router. In Cisco Unified CME 7.0(1) and later versions, you can clear a Telephony Application Programming Interface (TAPI) session that is in a frozen state or out ofsynchronization by using a Cisco IOSsoftware command.For configuration information, see Reset a Session Between a TAPI Application and an SCCP Phone, on page 401. This enhancement also automatically handles ephone-TAPI registration error conditions. No additional configuration is required for this new feature. Cisco Unified Communications Manager Express System Administrator Guide 398 Reset and Restart Cisco Unified IP Phones Cisco Unified CME TAPI Enhancement Reset and Restart Phones If phones are not yet plugged in, resetting or restarting phones is not necessary. Instead, connect your IP phones to your network to boot the phone and download the required configuration files. Note Use the reset Command on SCCP Phones To reboot and reregister one or more SCCP phones, including contacting the DHCP server for updated information, perform the following steps. Before You Begin • Phones to be rebooted are connected to the Cisco Unified CME router. SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service or ephone ephone-tag 4. reset {all [time-interval] | cancel | mac-address mac-address | sequence-all} or reset 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 telephony-service or ephone ephone-tag Enters telephony-service configuration mode. Example: Router(config)# telephony-service or Enters ephone configuration mode. or Router(config)# ephone 1 Cisco Unified Communications Manager Express System Administrator Guide 399 Reset and Restart Cisco Unified IP Phones Reset and Restart Phones Command or Action Purpose Performs a complete reboot of the specified or all phones running SCCP, including contacting the DHCP and TFTP servers for the latest configuration information. reset {all [time-interval] | cancel | mac-address mac-address | sequence-all} or reset Example: Router(config-telephony)# reset all Step 4 or Performs a complete reboot of the individual SCCP phone being configured. or Router(config-ephone)# reset end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 5 or Router(config-ephone)# end Use the restart Command on SCCP Phones To fast reboot and reregister one or more SCCP phones, perform the following steps. Before You Begin • Phones to be rebooted are connected to the Cisco Unified CME router. SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service or ephone ephone-tag 4. restart {all [time-interval] | mac-address} or restart 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Cisco Unified Communications Manager Express System Administrator Guide 400 Reset and Restart Cisco Unified IP Phones Use the restart Command on SCCP Phones Command or Action Purpose Step 3 telephony-service or ephone ephone-tag Enters telephony-service configuration mode. Example: Router(config)# telephony-service or Enters ephone configuration mode. or Router(config)# ephone 1 Performs a fast reboot of the specified phone or all phones runningSCCPassociated with this Cisco Unified CME router. Does not contact the DHCP server for updated information. restart {all [time-interval] | mac-address} or restart Example: Router(config-telephony)# restart all Step 4 or Performs a fast reboot of the individual SCCP phone being configured. or Router(config-ephone)# restart end Returns to privileged EXEC mode. Example: Router(config-ephone)# end Step 5 Reset a Session Between a TAPI Application and an SCCP Phone To clear a TAPI session that is in a frozen state or out of synchronization, perform the following steps. Before You Begin • Cisco Unified CME 7.0(1) or a later version SUMMARY STEPS 1. enable 2. configure terminal 3. ephone phone-tag 4. reset tapi 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Cisco Unified Communications Manager Express System Administrator Guide 401 Reset and Restart Cisco Unified IP Phones Reset a Session Between a TAPI Application and an SCCP Phone Command or Action Purpose Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 ephone phone-tag Enters ephone configuration mode. Example: Router(config)# ephone 36 • phone-tag—Unique sequence number that identifies this ephone during configuration tasks. Resets the connection between a Telephony Application Programmer'sInterface (TAPI) application and theSCCPphone. reset tapi Example: Router(config-ephone)# reset tapi Step 4 end Returns to privileged EXEC mode. Example: Router(config-ephone)# end Step 5 Use the reset Command on SIP Phones To reboot and reregister one or moreSIPphones, including contacting the DHCPserver for updated information, perform the following steps. Before You Begin • Cisco Unified CME 3.4 or later. • The mode cme command must be enabled in Cisco Unified CME. • Phones to be rebooted are connected to the Cisco Unified CME router. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register global or voice register pool pool-tag 4. reset 5. end Cisco Unified Communications Manager Express System Administrator Guide 402 Reset and Restart Cisco Unified IP Phones Use the reset Command on SIP Phones DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register global configuration mode to set parameters for all supported SIP phones in Cisco Unified CME. voice register global or voice register pool pool-tag Step 3 Example: Router(config)# voice register global or Enters voice register pool configuration mode to set phone-specific parameters for SIP phones or Router(config)# voice register pool 1 Performs a complete reboot of all phones connected to thisrouter that are running SIP, including contacting the DHCP and TFTP servers for the latest configuration information. reset Example: Router(config-register-global)# reset Step 4 or Performs a complete reboot of the individual SIP phone being configured. or Router(config-register-pool)# reset end Exits to privileged EXEC mode. Example: Router(config-register-global)# end Step 5 or Router(config-register-pool)# end Use the restart Command on SIP Phones To fast reboot and reregister one or more SIP phones, perform the following steps. Before You Begin • Cisco Unified CME 4.1 or later. • The mode cme command must be enabled in Cisco Unified CME. • Phones to be rebooted are connected to the Cisco Unified CME router. Cisco Unified Communications Manager Express System Administrator Guide 403 Reset and Restart Cisco Unified IP Phones Use the restart Command on SIP Phones SUMMARY STEPS 1. enable 2. configure terminal 3. voice register global or voice register pool pool-tag 4. restart 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register global configuration mode to set parameters for all supported SIP phones in Cisco Unified CME. voice register global or voice registerpool pool-tag Example: Router(config)# voice register global Step 3 or Enters voice register pool configuration mode to set phone-specific parameters for SIP phones. or Router(config)# voice register pool 1 Performs a fast reboot all SIP phones associated with this Cisco Unified CME router. Does not contact the DHCP server for updated information. restart Example: Router(config-register-global)# restart Step 4 or Performs a fast reboot of the individual SIP phone being configured. or Router(config-register-pool)# restart end Exits configuration mode and enters privileged EXEC mode. Example: Router(config-register-global)# end Step 5 or Router(config-register-pool)# end Cisco Unified Communications Manager Express System Administrator Guide 404 Reset and Restart Cisco Unified IP Phones Use the restart Command on SIP Phones Verify Basic Call To verify that Cisco IP phones in Cisco Unified CME can place and receive calls through the voice ports, perform the following steps. Step 1 Test local phone operation. Make calls between phones on the Cisco Unified CME router. Step 2 Place a call from a phone in Cisco Unified CME to a number in the local calling area. Step 3 Place a call to a phone in Cisco Unified CME from a phone outside this Cisco Unified CME system. Feature Information for Reset and Restart Phones The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Table 22: Feature Information for Reset and Restart Phones Feature Name Cisco Unified CME Version Feature Information Disassociates and reestablishes a TAPI session that is in a frozen state or out of synchronization by using a Cisco IOS command. This enhancement also automatically handles ephone-TAPI registration error conditions. Cisco Unified CME TAPI 7.0(1) Enhancement Cisco Unified Communications Manager Express System Administrator Guide 405 Reset and Restart Cisco Unified IP Phones Verify Basic Call Cisco Unified Communications Manager Express System Administrator Guide 406 Reset and Restart Cisco Unified IP Phones Feature Information for Reset and Restart Phones CHAPTER 11 Localization Support This chapter describes the localization support in Cisco Unified Communications Manager Express (Cisco Unified CME) for languages other than English and network tones and cadences not specific to the United States. • Information About Localization, page 407 • Configure Localization Support on SCCP Phones, page 411 • Configure Localization Support on SIP Phones, page 427 • Configuration Examples for Localization, page 437 • Configuration Examples for Locale Installer on SCCP Phones, page 440 • Where to Go Next, page 443 • Feature Information for Localization Support, page 443 Information About Localization Localization Enhancements in Cisco Unified CME Cisco Unified CME supportstheFrench locale butsome phrasesinFranceFrench and CanadianFrench differ. In Cisco Unified CME 9.5, Canadian French is supported as a user-defined locale on Cisco Unified SIP IP phones and Cisco Unified SCCP IP phones when the correct locale package is installed. Note Some abbreviations such as BLF, SNR, and CME are not localized. Prerequisites • Cisco Unified CME 9.5 or later version • Locale package version 9.5.2.6 is required Cisco Unified Communications Manager Express System Administrator Guide 407 All the localization enhancements are supported in Cisco Unified CME only. They are not supported in Cisco UnifiedSRST. Table 23: Language Codesfor User-Defined Locales, on page 408 showsthe language codes used in the filenames of locale files. Table 23: Language Codes for User-Defined Locales Language Language Code Restriction Canadian French fr_CA For configuration information, see Install User-Defined Locales, on page 415. System-Defined Locales Cisco Unified CME provides built-in,system-defined localization support for 12 languagesincluding English and 16 countries including the United States. Network locales specify country-specific tones and cadences; user locales specify the language to use for text displays. Configuring system-defined locales depends on the type of IP phone: • Cisco Unified IP Phone 7905, 7912, 7940, and 7960—System-defined network locales and user locales are preloaded into Cisco IOS software. No external files are required. Use the network-locale and user-locale commands to set the locales for these phones. • Cisco Unified IP Phone 6921, 6945, 7906, 7911, 7921, 7931, 7941, 7961, 7970, 7971, 8941, 8945, and Cisco IP Communicator—You must download locale files to support the system-defined locales and store the filesin flash memory,slot 0, or on an external TFTPserver.See InstallSystem-Defined Locales for Cisco Unified IP Phone 6921, 6945, 7906, 7911, 7921, 7931, 7941, 7961, 7970, 7971, and Cisco IP Communicator, on page 411. • Cisco Unified 3905, 6941, 6945, 8961, 9951, and 9971 SIP IP Phones—You must download locale files to support the system-defined locales and store the files in flash memory, slot 0, or on an external TFTP server. TFTP aliases for localization are not automatically created for Cisco Unified SIP IP phones in a Cisco Unified CME system. For more information on how to manually create TFTP aliases, see Install System-Defined Locales for Cisco Unified IP Phone 8961, 9951, and 9971, on page 427. Note Cisco Unified CME 10.5 Release onwards, the System defined locales are deprecated and User-defined locales are recommended. Note Cisco Unified 3905 SIP IP Phones and Cisco Unified 6945, 8941, and 8945 SCCP IP Phones have support for all locales up to Cisco Unified CME 8.8. Cisco Unified Communications Manager Express System Administrator Guide 408 Localization Support System-Defined Locales Localization Support for Cisco Unified SIP IP Phones Cisco Unified CME 8.6 provides localization support for 12 languages including English and 16 countries including the UnitedStates. Network localesspecify country-specific tones and cadences; user localesspecify the language to use for text displays. Create additional localization support with user-defined locales. For more information about user-defined locales, see User-Defined Locales, on page 409. In Cisco Unified CME 9.0 and later versions, localization is enhanced to support Cisco Unified 6941 and 6945 SIP IP Phones. The load command supports both user-defined and system-defined locales. Note The locale files must be stored in the same location as the configuration files. User-Defined Locales The user-defined locale feature allows you to support network and user locales other than the system-defined locales that are predefined in Cisco IOS software. For example, if your site has phones that must use the language and tones for Traditional Chinese, which is not one of the system-defined choices, you must install the locale files for Traditional Chinese. In Cisco Unified CME 4.0 and later versions, you can download files to support a particular user and network locale and store the files in flash memory, slot 0, or an external TFTP server. These files cannot be stored in the system location. User-defined locales can be assigned to all phones or to individual phones. User-defined language codes for user locales are based on ISO 639 codes, which are available at the Library of Congress website at http://www.loc.gov/standards/iso639-2/. User-defined country codes for network locales are based on ISO 3166 codes. For configuration information, see Install User-Defined Locales, on page 415. Localization Support for Phone Displays On the Cisco Unified IP Phone 8961, 9951, and 9971, menus and prompts that are managed by the locale file for the IPphone type (.jar) or the Cisco Unified CME dictionary file are localized. Display options configured through Cisco IOS commands are not localized. The following display items are localized by the IP phone (.jar file): • System menus accessed with feature buttons (for example, messages, directories, services, settings, and information) • Call processing messages • Softkeys (for example, Redial and CFwdALL) The following display items are localized by the dictionary file for Cisco Unified CME: • Directory Service (Local Directory, Local Speed Dial, and Personal Speed Dial) • Status Line Cisco Unified Communications Manager Express System Administrator Guide 409 Localization Support Localization Support for Cisco Unified SIP IP Phones Display options configured through Cisco IOS commands are not localized and can only be displayed in English. For example, this includes features such as: • Caller ID • Header Bar • Phone Labels • System Message Multiple Locales In Cisco Unified CME 8.6 and later versions, you can specify up to five user and network locales and apply different locales to individual ephones or groups of ephones using ephone templates. For example, you can specify French for phones A, B, and C; German for phones D, E, and F; and English for phones G, H, and I. Only one user and network locale can be applied to each phone. Each of the five user and network locales that you can define in a multilocale system is identified by a locale tag. The locale identified by tag 0 is always the default locale, although you can define this default to be any supported locale. For example, if you define user locale 0 to be JP (Japanese), the default user locale for all phones is JP. If you do not specify a locale for tag 0, the default is US (United States). To apply alternative localesto different phones, you must use per-phone configuration filesto build individual configuration files for each phone. The configuration files automatically use the default user-locale 0 and network-locale 0. You can override these defaults for individual phones by configuring alternative locale codes and then creating ephone-templates to assign the locales to individual ephones. For configuration information, see Configure Multiple Locales on SCCP Phones, on page 422. Locale Installer for Cisco Unified SCCP IP Phones Before Cisco Unified CME 7.0(1), configuring localization required up to 16 steps, most of which were manual and some of which required filename changes. In Cisco Unified CME 7.0(1) and later versions, the following enhancements for installing locales are supported: • Locale installer that supports a single procedure for all SCCP IP phones. • Cisco Unified CME parses new firmware-load text files and automatically creates the TFTP aliases for localization, eliminating the requirement for you to manually create up to five aliases for files in the TAR file. To use thisfeature in Cisco Unified CME 7.0(1), you must use the complete filename, including the file suffix, when you configure the load command for phone firmware versions later than version 8-2-2 for all phone types. For example: Router(config-telephony)# load 7941 SCCP41.8-3-3S.loads In Cisco Unified CME 4.3 and earlier versions, you do not include the file suffix for any phone type except Cisco ATA and Cisco Unified IP Phone 7905 and 7912. For example: Router(config-telephony)# load 7941 SCCP41.8-2-2SR2S Note • Backward compatibility with the configuration method in Cisco Unified CME 7.0 and earlier versions. Cisco Unified Communications Manager Express System Administrator Guide 410 Localization Support Multiple Locales For configuration information, see Use the Locale Installer in Cisco Unified CME 7.0(1) and Later Versions, on page 419. Locale Installer for Cisco Unified SIP IP Phones Cisco Unified CME 9.0 and later versions support the following enhancements for installing locales for Cisco Unified SIP IP phones: • Locale installer that supports a single procedure for all Cisco Unified SIP IP phones. • New load keyword that requires you to use the complete filename, including the file suffix (.tar), when you configure the user-locale command for all Cisco Unified SIP IP phone types. The command syntax isuser-locale [user-locale-tag] {[user-defined-code] country-code} [loadTAR-filename].For example, Router(config-register-global)#user-locale 2 DE load CME-locale-de_DE-German-8.6.3.0.tar With the locale installer, you do not need to perform manual configuration. Instead, you copy the locale file using the copy command in privileged EXEC configuration mode. You must copy the locale file into the /its directory (flash:/its or slot0:/its) when you store the locale files on the Cisco Unified CME router. Note For example, Router# copy tftp://12.1.1.100/CME-locale-de_DE-German-8.6.3.0.tar flash:/its For configuration information, see Use the Locale Installer in Cisco Unified CME 9.0 and Later Versions, on page 431. Configure Localization Support on SCCP Phones Install System-Defined Locales for Cisco Unified IP Phone 6921, 6945, 7906, 7911, 7921, 7931, 7941, 7961, 7970, 7971, and Cisco IP Communicator Network locale files allow an IP phone to play the proper network tone for the specified country. You must download and install a tone file for the country you want to support. User locale files allow an IP phone to display the menus and prompts in the specified language. You must download and install JAR files and dictionary files for each language you want to support. To download and install locale files for system-defined locales, perform the following steps. The locale installer simplifies the installation and configuration of system- and user-defined locales in Cisco Unified CME 7.0(1) and later versions. To use the locale installer in Cisco Unified CME 7.0(1) and later versions, see Use the Locale Installer in Cisco Unified CME 7.0(1) and Later Versions, on page 419. Tip Cisco Unified Communications Manager Express System Administrator Guide 411 Localization Support Locale Installer for Cisco Unified SIP IP Phones Restriction • Localization is not supported for SIP phones. • Phone firmware, configuration files, and locale files must be in the same directory, except the directory file for Japanese and Russian, which must be in flash memory. Before You Begin • Cisco Unified CME 4.0(2) or a later version. • You must create per-phone configuration files as described in Define Per-Phone Configuration Files and Alternate Location for SCCP Phones, on page 181. • You must have an account on Cisco.com to download locale files. Step 1 Go to http://www.cisco.com/cgi-bin/tablebuild.pl/CME-Locale. You must have an account on Cisco.com to access the Software Download Center. If you do not have an account or if you have forgotten your username or password, click the appropriate button at the login dialog box and follow the instructions that appear. Step 2 Navigate to Downloads Home > Products > Unified Communications > Call Control > Mid-Market Call Control > Cisco Unified Communications Manager Express > Unified Communications Manager Express Individual File Set and select your version of Cisco Unified CME. Step 3 Select the TAR file for the locale you want to install. Each TAR file contains locale files for a specific language and country and uses the following naming convention: CME-locale-language_country-CMEversion Example: For example, CME-locale-de_DE-4.0.2-2.0 is German for Germany for Cisco Unified CME 4.0(2). Step 4 Download the TAR file to a TFTP server that is accessible to the Cisco Unified CME router. Each file contains all the firmware required for all phone types supported by that version of Cisco Unified CME. Step 5 Use the archive tar command to extract the files to flash memory, slot 0, or an external TFTP server. Example: Router# archive tar /xtract source-urlflash:/file-url Example: For example, to extract the contents of CME-locale-de_DE-4.0.2-2.0.tar from TFTP server 192.168.1.1 to router flash memory, use this command: Router# archive tar /xtract tftp://192.168.1.1/cme-locale-de_DE-4.0.2-2.0.tar flash: Step 6 See Table 24: Phone-Type Codes for Locale JAR Files, on page 413 and Table 25: System-Defined User and Network Locales, on page 413 for a description of the codes used in the filenames and the list of supported directory names. Each phone type has a JAR file that uses the following naming convention: language-phone-sccp.jar Example: Cisco Unified Communications Manager Express System Administrator Guide 412 Localization Support Install System-Defined Locales for Cisco Unified IP Phone 6921, 6945, 7906, 7911, 7921, 7931, 7941, 7961, 7970, 7971, and Cisco IP Communicator For example, de-td-sccp.jar is for German on the Cisco Unified IP Phone 7970. Each TAR file also includes the file g3-tones.xml for country-specific network tones and cadences. Table 24: Phone-Type Codes for Locale JAR Files Phone Type Phone Code 6921 rtl 6945 rtl 7906/7911 tc 7931 gp 7941/7961 mk 7970/7971 td 8941/8945 gh CIPC ipc Table 25: System-Defined User and Network Locales Network-Locale Directory Name User-Locale Country Code Directory Name Language Language Code English_United_States US United_States 2 English en English_United_Kingdom UK United_Kingdom CA Canada Danish dk Danish_Denmark DK Denmark Dutch nl Dutch_Netherlands NL Netherlands French fr French_France FR France CA Canada German de German_Germany DE Germany AT Austria CH Switzerland Cisco Unified Communications Manager Express System Administrator Guide 413 Localization Support Install System-Defined Locales for Cisco Unified IP Phone 6921, 6945, 7906, 7911, 7921, 7931, 7941, 7961, 7970, 7971, and Cisco IP Communicator Network-Locale Directory Name User-Locale Country Code Directory Name Language Language Code Italian it Italian_Italy IT Italy Japanese jp Japanese_Japan JP Japan 3 Norwegian no Norwegian_Norway NO Norway Portuguese pt Portuguese_Portugal PT Portugal Russian ru Russian_Russia RU Russian_Federation Spanish es Spanish_Spain ES Spain Swedish se Swedish_Sweden SE Sweden 2 English for the United States is the default language. You do not need to install the JAR file for U.S. English unless you assign a different language to a phone and then want to reassign English. 3 Katakana is supported by Cisco Unified IP Phone 7905, 7912, 7940, and 7960. Kanji is supported by Cisco Unified IP Phone 7911, 7941, 7961, 7970, and 7971. Step 7 If you store the locale files in flash memory or slot 0 on the Cisco Unified CME router, create a TFTP alias for the user locale (text displays) and network locale (tones) using this format: Example: Router(config)# tftp-server flash:/jar_filealias directory_name/td-sccp.jar Router(config)# tftp-server flash:/g3-tones.xml aliasdirectory_name/g3-tones.xml Use the appropriate directory name shown in Table 25: System-Defined User and Network Locales, on page 413 and remove the two-letter language code from the JAR file name. For example, the TFTP aliases for German and Germany for the Cisco Unified IP Phone 7970 are: Router(config)# tftp-server flash:/de-td-sccp.jar alias German_Germany/td-sccp.jar Router(config)# tftp-server flash:/g3-tones.xml alias Germany/g3-tones.xml On Cisco 3800 series routers, you must include /its in the directory name (flash:/its or slot0:/its). For example, the TFTPaliasfor German for the Cisco Unified IPPhone 7970 is: Router# tftp-server flash:/its/de-td-sccp.jar alias German_Germany/td-sccp.jar Note Step 8 If you store the locale files on an external TFTP server, create a directory under the TFTP root directory for each user and network locale. Use the appropriate directory name shown in Table 25: System-Defined User and Network Locales, on page 413 and remove the two-letter language code from the JAR file name. Example: For example, the user-locale directory for German and the network-locale directory for Germany for the Cisco Unified IP Phone 7970 are: TFTP-Root/German_Germany/td-sccp.jar TFTP-Root/Germany/g3-tones.xml Step 9 For Russian and Japanese, you must copy the UTF8 dictionary file into flash memory to use special phrases. Cisco Unified Communications Manager Express System Administrator Guide 414 Localization Support Install System-Defined Locales for Cisco Unified IP Phone 6921, 6945, 7906, 7911, 7921, 7931, 7941, 7961, 7970, 7971, and Cisco IP Communicator Only flash memory can be used for these locales. Copy russian_tags_utf8_phrases for Russian; Japanese_tags_utf8_phrases for Japanese. • • Use the user-locale jp and user-locale ru command to load the UTF8 phrases into Cisco Unified CME. Step 10 Assign the locales to phones. To set a default locale for all phones, use the user-locale and network-locale commands in telephony-service configuration mode. Step 11 To support more than one user or network locale, see Configure Multiple Locales on SCCP Phones, on page 422. Step 12 Use the create cnf-files command to rebuild the configuration files. Step 13 Use the reset command to reset the phones and see the localized displays. Install User-Defined Locales You must download XML files for locales that are not predefined in the system. To install up to five user-defined locale files to use with phones, perform the following steps. From Cisco Unified CME 10.5 Release onwards, theSystem defined locales are deprecated and User-defined locales are recommended. However, the older locale packages can be still used but some phrases may be displayed in English. Note Restriction • User-defined locales are not supported on the Cisco Unified IP Phone 7920 or 7936. • User-defined locales are not supported if the configuration file location is “system:”. • When you use the setup tool from the telephony-service setup command to provision phones, you can only choose a default user locale and network locale and you are limited to selecting a locale code that is supported in the system. You cannot use multiple locales or user-defined locales with the setup tool. • When using a user-defined locale, the phone normally displays text using the user-defined fonts, except for any strings that are interpreted by Cisco Unified CME, such as “Cisco/Personal Directory,” “Speed Dial/Fast Dial,” and so forth. Before You Begin • Cisco Unified CME 4.0(3) or a later version. • You must create per-phone configuration files as described in Define Per-Phone Configuration Files and Alternate Location for SCCP Phones, on page 181. • You must have an account on Cisco.com to download locale files. Step 1 Go to http://www.cisco.com/cgi-bin/tablebuild.pl/CME-Locale. Cisco Unified Communications Manager Express System Administrator Guide 415 Localization Support Install User-Defined Locales You must have an account on Cisco.com to access the Software Download Center. If you do not have an account or if you have forgotten your username or password, click the appropriate button at the login dialog box and follow the instructions that appear. Step 2 Navigate to Downloads Home > Products > Unified Communications > Call Control > Mid-Market Call Control > Cisco Unified Communications Manager Express > Unified Communications Manager Express Individual File Set and select your version of Cisco Unified CME. Step 3 Select the TAR file for the locale that you want to install. Each TAR file contains locale files for a specific language and country and uses the following naming convention: CME-locale-language_country-CMEversion-fileversion. Example: For example, CME-locale-zh_CN-4.0.3-2.0 is Traditional Chinese for China for Cisco Unified CME 4.0(3). Step 4 Download the TAR file to a TFTP server that is accessible to the Cisco Unified CME router. Each file contains all the firmware required for all phone types supported by that version of Cisco Unified CME. Step 5 Use the archive tar command to extract the files to slot 0, flash memory, or an external TFTP server. Example: Router# archive tar /xtract source-urlflash:/file-url For example, to extract the contents of CME-locale-zh_CN-4.0.3-2.0.tar from TFTP server 192.168.1.1 to router flash memory, use this command: Router# archive tar /xtract tftp://192.168.1.1/cme-locale-zh_CN-4.0.3-2.0.tar flash: Step 6 For Cisco Unified IP Phone 7905, 7912, 7940, or 7960, go to Step 11, on page 418. For Cisco Unified IP Phone 7911, 7941, 7961, 7970, or 7971, go to Step 7, on page 416. Step 7 Each phone type has a JAR file that uses the following naming convention: language-type-sccp.jar Example: For example, zh-td-sccp.jar is Traditional Chinese for the Cisco Unified IP Phone 7970. See Table 26:Phone-Type Codesfor LocaleFiles, on page 416 and Table 27: Language Codesfor User-Defined Locales, on page 417 for a description of the codes used in the filenames. Table 26: Phone-Type Codes for Locale Files Phone Type Code 6921 rtl 6945 rtl 7906/7911 tc 7931 gp 7941/7961 mk 7970/7971 td Cisco Unified Communications Manager Express System Administrator Guide 416 Localization Support Install User-Defined Locales Phone Type Code 8941/8945 gh CIPC ipc Table 27: Language Codes for User-Defined Locales Language Language Code Bulgarian bg zh4 Chinese Croation hr Czech Republic cs Finnish fi Greek el Hungarian hu Korean ko Polish pl Portugese (Brazil) pt Romanian ro Serbian sr Slovakian sk Slovenian sl Turkish tr 4 For Cisco Unified IP Phone 7931, code for Chinese Simplified is chs; Chinese Traditional is cht. Step 8 If you store the locale files in flash memory or slot 0 on the Cisco Unified CME router, create a TFTP alias using this format: Example: Router(config)# tftp-server flash:/jar_filealias directory_name/td-sccp.jar Cisco Unified Communications Manager Express System Administrator Guide 417 Localization Support Install User-Defined Locales Remove the two-letter language code from the JAR filename and use one of five supported directory names with the following convention: user_define_number, where number is 1 to 5 For example, the alias for Chinese on the Cisco Unified IP Phone 7970 is: Router(config)# tftp-server flash:/zh-td-sccp.jar alias user_define_1/td-sccp.jar On Cisco 3800 series routers, you must include /its in the directory name (flash:/its or slot0:/its). For example, the TFTP alias for Chinese for the Cisco Unified IP Phone 7970 is: Router(config)# tftp-server flash:/its/zh-td-sccp.jar alias user_define_1/td-sccp.jar Note Step 9 If you store the locale files on an external TFTP server, create a directory under the TFTP root directory for each locale. Remove the two-letter language code from the JAR filename and use one of five supported directory names with the following convention: user_define_number, where number is 1 to 5 Example: For example, for Chinese on the Cisco Unified IP Phone 7970, remove “zh” from the JAR filename and create the “user_define_1” directory under TFTP-Root on the TFTP server: TFTP-Root/user_define_1/td-sccp.jar Step 10 Go to Step 13, on page 419. Step 11 Download one or more of the following XML files depending on your selected locale and phone type. All required files are included in the JAR file. Example: 7905-dictionary.xml 7905-font.xml 7905-kate.xml 7920-dictionary.xml 7960-dictionary.xml 7960-font.xml 7960-kate.xml 7960-tones.xml SCCP-dictionary.utf-8.xml SCCP-dictionary.xml Step 12 Rename these files and copy them to flash memory, slot 0, or an external TFTP server. Rename the files using the format user_define_number_filename where number is 1 to 5. Example: For example, use the following names if you are setting up the first user-locale: user_define_1_7905-dictionary.xml user_define_1_7905-font.xml user_define_1_7905-kate.xml user_define_1_7920-dictionary.xml user_define_1_7960-dictionary.xml user_define_1_7960-font.xml user_define_1_7960-kate.xml user_define_1_7960-tones.xml Cisco Unified Communications Manager Express System Administrator Guide 418 Localization Support Install User-Defined Locales user_define_1_SCCP-dictionary.utf-8.xml user_define_1_SCCP-dictionary.xml Step 13 Copy the language_tags_file and language_utf8_tags_file to the location of the other locale files (flash memory, slot 0, or TFTPserver). Rename the filesto user_define_number_tags_file and user_define_number_utf8_tags_file respectively, wherenumber is 1 to 5 and matches the user-defined directory. Step 14 Assign the locales to phones. See Configure Multiple Locales on SCCP Phones, on page 422. Step 15 Use the create cnf-files command to rebuild the configuration files. Step 16 Use the reset command to reset the phones and see the localized displays. Use the Locale Installer in Cisco Unified CME 7.0(1) and Later Versions To install and configure locale files to use with SCCP phones in Cisco Unified CME, perform the following steps. Cisco Unified CME 7.0(1) provides backward compatibility with the configuration method in Cisco Unified CME 4.3/7.0 and earlier versions. To use the same procedures as you used with earlier versions of Cisco Unified CME, see Install System-Defined Locales for Cisco Unified IP Phone 6921, 6945, 7906, 7911, 7921, 7931, 7941, 7961, 7970, 7971, and Cisco IP Communicator, on page 411. Tip Cisco Unified Communications Manager Express System Administrator Guide 419 Localization Support Use the Locale Installer in Cisco Unified CME 7.0(1) and Later Versions Restriction • When using an external TFTP server, you must manually create the user locale folders in the root directory. This is a limitation of the TFTP server. • Locale support is limited to phone firmware versions that are supported by Cisco Unified CME. • User-defined locales are not supported on the Cisco Unified IP Phone 7920 or 7936. • User-defined locales are not supported if the configuration file location is system. • When you use the setup tool from the telephony-service setup command to provision phones, you can only choose a default user locale and network locale, and you are limited to selecting a locale code that is supported in the system. You cannot use multiple locales or user-defined locales with the setup tool. • When using a user-defined locale, the phone normally displays text using the user-defined fonts, except for any strings that are interpreted by Cisco Unified CME, such as “Cisco/Personal Directory,” and “Speed Dial/Fast Dial.” • If you install and configure a user-defined locale using country codes U1-U5 and then you install a new locale using the same label, the phone retains the original language locale even after the phone is reset. This is a limitation of the IP phone. To work around this limitation, you must configure the new package using a different country code. • Each user-defined country code (U1-U5) can be used for only one user-locale-tag at a time. For example: Router(config-telephony)# user-locale 2 U2 load Finnish.pkg Router(config-telephony)# user-locale 1 U2 load Chinese.pkg LOCALE ERROR: User Defined Locale U2 already exists on locale index 2. Before You Begin • Cisco Unified CME 7.0(1) or a later version. • You must configure Cisco Unified CME for per-phone configuration files. See Define Per-Phone Configuration Files and Alternate Location for SCCP Phones, on page 181. • When the storage location specified by the cnf-file location command is flash memory, sufficient space must be on the flash file system for extracting the contents of the locale TAR file. • You must have an account on Cisco.com to download locale files. Step 1 Go to http://www.cisco.com/cgi-bin/tablebuild.pl/CME-Locale. You must have an account on Cisco.com to access the Software Download Center. If you do not have an account or have forgotten your username or password, click the appropriate button at the login dialog box and follow the instructions that appear. Step 2 Navigate to Downloads Home > Products > Unified Communications > Call Control > Mid-Market Call Control > Cisco Unified Communications Manager Express > Unified Communications Manager Express Individual File Set and select your version of Cisco Unified CME. Step 3 Select the TAR file for the locale you want to install. Each TAR file contains locale files for a specific language and country and uses the following naming convention: CME-locale-language_country-CMEversion Cisco Unified Communications Manager Express System Administrator Guide 420 Localization Support Use the Locale Installer in Cisco Unified CME 7.0(1) and Later Versions Example: For example, CME-locale-de_DE-7.0.1.0 is German for Germany for Cisco Unified CME 7.0(1). Step 4 Download the TAR file to the location previously specified by the cnf-file location command. Each file contains all the firmware required for all phone types supported by that version of Cisco Unified CME. a) If the cnf-file location is flash memory: Copy the TAR file to the flash:/its directory. b) If the cnf-file location is slot0: Copy the TAR file to the slot0:/its directory. c) If the cnf-file location istftp: Create a folder in the root directory of the TFTPserver for each locale using the following format and then copy the TAR file to the TFTP-Root folder. TFTP-Root/TAR-filename Example: For system-defined locales, use the locale folder name as shown in Table 28: System-Defined and User-Defined Locales, on page 421. For example, create the folder for system-defined German as follows: TFTP-Root/de_DE-7.0.1.0.tar For up to five user-defined locales, use the User_Define_n folder name as shown in Table 28: System-Defined and User-Defined Locales, on page 421. A user-defined locale is a language other than the system-defined locales that are predefined in Cisco IOSsoftware.For example, create the folder for user-defined locale Chinese (User_Define_1) as follows: TFTP-Root/CME-locale-zh_CN-7.0.1.0.tar For a list of user-defined languages supported in Cisco Unified CME, see Cisco Unified CME Localization Matrix. Note Table 28: System-Defined and User-Defined Locales Language Locale Folder Name Country Code English English_United_States US English_United_Kingdom UK CA Danish Danish_Denmark DK Dutch Dutch_Netherlands NL French French_France FR CA German German_Germany DE AT CH Italian Italian_Italy IT Cisco Unified Communications Manager Express System Administrator Guide 421 Localization Support Use the Locale Installer in Cisco Unified CME 7.0(1) and Later Versions Language Locale Folder Name Country Code Japanese Japanese_Japan JP 5 Norwegian Norwegian_Norway NO Portuguese Portuguese_Portugal PT Russian Russian_Russia RU Spanish Spanish_Spain ES Swedish Swedish_Sweden SE Un2 User_Define_n2 Un6 5 Katakana is supported by Cisco Unified IP Phone 7905, 7912, 7940, and 7960. Kanji is supported by Cisco Unified IP Phone 7911, 7941, 7961, 7970, and 7971. 6 Where “n” is a number from 1 to 5. Step 5 Use the user-locale [user-locale-tag] country-codeload TAR-filename command in telephony-service configuration mode to extract the contents of the TAR file.For country codes,see Table 28:System-Defined and User-Defined Locales, on page 421. Example: For example, to extract the contents of the CME-locale-zh_CN-7.0.1.0.tar file when U1 isthe country code for user-defined locale Chinese (User_Define_1), use this command: Router (telephony-service)# user-locale U1 load CME-locale-zh_CN-7.0.1.0.tar Step 6 Assign the locales to phones. See Configure Multiple Locales on SCCP Phones, on page 422. Step 7 Use the create cnf-files command to rebuild the configuration files. Step 8 Use the reset command to reset the phones and see the localized displays. Verify User-Defined Locales See Verify Multiple Locales on SCCP Phones, on page 426. Configure Multiple Locales on SCCP Phones To define one or more alternativesto the default user and network locales and apply them to individual phones, perform the following steps. Cisco Unified Communications Manager Express System Administrator Guide 422 Localization Support Verify User-Defined Locales Restriction • Multiple user and network locales are not supported on the Cisco Unified IP Phone 7902G, 7910, 7910G, or 7920, or the Cisco Unified IP Conference Stations 7935 and 7936. • When you use the setup tool from the telephony-service setup command to provision phones, you can only choose a default user locale and network locale and you must select a locale code that is predefined in the system. You cannot use multiple or user-defined locales with the setup tool. Before You Begin • Cisco Unified CME 4.0 or a later version. • To specify alternative user and network locales for individual phones in a Cisco Unified CME system, you must use per-phone configuration files. For more information, see Define Per-Phone Configuration Files and Alternate Location for SCCP Phones, on page 181. • You can also use user-defined locale codes as alternative locales after you download the appropriate XML files. See Install User-Defined Locales, on page 415. SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. user-locale [user-locale-tag] {[user-defined-code] country-code} 5. network-locale network-locale-tag [user-defined-code] country-code 6. create cnf-files 7. exit 8. ephone-template template-tag 9. user-locale user-locale-tag 10. network-locale network-locale-tag 11. exit 12. ephone phone-tag 13. ephone-template template-tag 14. exit 15. telephony-service 16. reset {all [time-interval]| cancel | mac-address mac-address | sequence-all} 17. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Cisco Unified Communications Manager Express System Administrator Guide 423 Localization Support Configure Multiple Locales on SCCP Phones Command or Action Purpose Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 3 user-locale [user-locale-tag] Specifies a language for phone displays. {[user-defined-code] country-code} Step 4 • user-locale-tag—Assigns a locale identifier to the locale. Range is 0 to 4. Default: 0. This argument isrequired when defining some locale other than the default (0). Example: Router(config-telephony)# user-locale 1 U1 ZH • user-defined-code—(Optional) Assigns one of the user-defined codes to the specified country code. Valid codes are U1, U2,U3, U4, and U5. • country-code—Type ? to display a list of system-defined codes. Default: US (United States). You can assign any valid ISO 639 code to a user-defined code (U1 to U5). network-locale network-locale-tag Specifies a country for tones and cadences. [user-defined-code] country-code Step 5 • network-locale-tag—Assigns a locale identifier to the country code. Range is 0 to 4. Default: 0. This argument is required when defining some locale other than the default (0). Example: Router(config-telephony)# network-locale 1 FR • user-defined-code—(Optional) Assigns one of the user-defined codes to the specified country code. Valid codes are U1, U2,U3, U4, and U5. • country-code—Type ? to display a list of system-defined codes. Default: US (United States). You can assign any valid ISO 3166 code to a user-defined code (U1 to U5). Builds the required XML configuration files for IP phones. Use this command after you update configuration file parameters such as the user locale or network locale. create cnf-files Example: Router(config-telephony)# create cnf-files Step 6 Cisco Unified Communications Manager Express System Administrator Guide 424 Localization Support Configure Multiple Locales on SCCP Phones Command or Action Purpose exit Exits telephony-service configuration mode. Example: Router(config-telephony)# exit Step 7 Step 8 ephone-template template-tag Enters ephone-template configuration mode. Example: Router(config)# ephone template 1 • template-tag—Unique sequence number that identifies this template during configuration tasks. Step 9 user-locale user-locale-tag Assigns a user locale to this ephone template. Example: Router(config-ephone-template)# user-locale 2 • user-locale-tag—A locale tag that was created in Step 4, on page 424. Range is 0 to 4. Step 10 network-locale network-locale-tag Assigns a network locale to this ephone template. Example: Router(config-ephone-template)# network-locale 2 • network-locale-tag—A locale tag that was created in Step 5, on page 424. Range is 0 to 4. exit Exits ephone-template configuration mode. Example: Router(config-ephone-template)# exit Step 11 Step 12 ephone phone-tag Enters ephone configuration mode. Example: Router(config)# ephone 36 • phone-tag—Unique sequence number that identifies this ephone during configuration tasks. Step 13 ephone-template template-tag Applies an ephone template to an ephone. Example: Router(config-ephone)# ephone-template 1 • template-tag—Number of the template to apply to this ephone. exit Exits ephone configuration mode. Example: Router(config-ephone)# exit Step 14 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 15 Cisco Unified Communications Manager Express System Administrator Guide 425 Localization Support Configure Multiple Locales on SCCP Phones Command or Action Purpose Performs a complete reboot of all phones or the specified phone, including contacting the DHCP and TFTP servers for the latest configuration information. reset {all [time-interval]| cancel | mac-address mac-address | sequence-all} Example: Router(config-telephony)# reset all Step 16 • all—All phones in the Cisco Unified CME system. • time-interval—(Optional) Time interval, in seconds, between each phone reset. Range is 0 to 60. Default is 15. • cancel—Interrupts a sequential reset cycle that was started with a reset sequence-all command. • mac-address mac-address—A specific phone. • sequence-all—Resets all phones in strict one-at-a-time order by waiting for one phone to reregister before starting the reset for the next phone. end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 17 Verify Multiple Locales on SCCP Phones Step 1 Use the show telephony-service tftp-bindings command to display a list of configuration files that are accessible to IP phones using TFTP, including the dictionary, language, and tone configuration files. Example: Router(config)# show telephony-service tftp-bindings tftp-server system:/its/SEPDEFAULT.cnf tftp-server system:/its/SEPDEFAULT.cnf alias SEPDefault.cnf tftp-server system:/its/XMLDefault.cnf.xml alias XMLDefault.cnf.xml tftp-server system:/its/ATADefault.cnf.xml tftp-server system:/its/XMLDefault7960.cnf.xml alias SEP00036B54BB15.cnf.xml tftp-server system:/its/germany/7960-font.xml alias German_Germany/7960-font.xml tftp-server system:/its/germany/7960-dictionary.xml alias German_Germany/7960-dictionary.xml tftp-server system:/its/germany/7960-kate.xml alias German_Germany/7960-kate.xml tftp-server system:/its/germany/SCCP-dictionary.xml alias German_Germany/SCCP-dictionary.xml tftp-server system:/its/germany/7960-tones.xml alias Germany/7960-tones.xml Cisco Unified Communications Manager Express System Administrator Guide 426 Localization Support Verify Multiple Locales on SCCP Phones Step 2 Ensure that per-phone configuration files are defined with the cnf-file perphone command. Step 3 Use the show telephony-service ephone-template command to check the user locale and network locale settings in each ephone template. Step 4 Use the show telephony-service ephone command to check that the correct templates are applied to phones. Step 5 If the configuration file location is not TFTP, use the debug tftp events command to see which files Cisco Unified CME is looking for and whether the files are found and opened correctly. There are usually three states (“looking for x file,” “opened x file,” and “finished x file”). The file is found when all three states are displayed. For an external TFTP server you can use the logs from the TFTP server. Configure Localization Support on SIP Phones Install System-Defined Locales for Cisco Unified IP Phone 8961, 9951, and 9971 Network locale files allow an IP phone to play the proper network tone for the specified country. You must download and install a tone file for the country you want to support. User locale files allow an IP phone to display the menus and prompts in the specified language. You must download and install JAR files and dictionary files for each language you want to support. To download and install locale files for system-defined locales, perform the following steps. Restriction Phone firmware, configuration files, and locale files must be in the same directory. Before You Begin • Cisco Unified CME 8.6 or a later version. For Cisco Unified IP Phone 9971, Cisco Unified CME 8.8 or a later version. • You must have an account on Cisco.com to download locale files. Step 1 Go to http://www.cisco.com/cgi-bin/tablebuild.pl/CME-Locale. You must have an account on Cisco.com to access the Software Download Center. If you do not have an account or if you have forgotten your username or password, click the appropriate button at the login dialog box and follow the instructions that appear. Step 2 Navigate to Downloads Home > Products > Unified Communications > Call Control > Mid-Market Call Control > Cisco Unified Communications Manager Express > Unified Communications Manager Express Individual File Set and select your version of Cisco Unified CME. Step 3 Select the TAR file for the locale you want to install. Each TAR file contains locale files for a specific language and country and uses the following naming convention: CME-locale-language_country-CMEversion Example: Cisco Unified Communications Manager Express System Administrator Guide 427 Localization Support Configure Localization Support on SIP Phones For example, CME-locale-de_DE-8.6 is German for Germany for Cisco Unified CME 8.6. Step 4 Download the TAR file to a TFTP server that is accessible to the Cisco Unified CME router. Each file contains all the firmware required for all phone types supported by that version of Cisco Unified CME. Step 5 Use the archive tar command to extract the files to flash memory, slot 0, or an external TFTP server. Example: Router# archive tar /xtract source-urlflash:/file-url For example, to extract the contents of CME-locale-de_DE-8.6.tar from TFTPserver 192.168.1.1 to router flash memory, use this command: Router# archive tar /xtract tftp://192.168.1.1/cme-locale-de_DE-8.6.tar flash: Step 6 See Table 29: Phone-Type Codes for Locale JAR Files, on page 428 and Table 30: System-Defined User and Network Locales , on page 429 for a description of the codes used in the filenames and the list of supported directory names. Each phone type has a JAR file that uses the following naming convention: language-phone-sip.jar Example: For example, de-gh-sip.jar is for German on the Cisco Unified IP Phone 8961. Each TAR file also includes the file g4-tones.xml for country-specific network tones and cadences. Table 29: Phone-Type Codes for Locale JAR Files Phone Type Phone Code 3905 cin 6941 rtl 6945 rtl 8961 gh 9951 gd 9971 gd Cisco Unified Communications Manager Express System Administrator Guide 428 Localization Support Install System-Defined Locales for Cisco Unified IP Phone 8961, 9951, and 9971 Table 30: System-Defined User and Network Locales Network-Locale Directory Name User-Locale Country Code Directory Name Language Language Code English_United_States US United_States 7 English en English_United_Kingdom UK United_Kingdom GB United_Kingdom CA Canada AU Australia Danish dk Danish_Denmark DK Denmark Dutch nl Dutch_Netherlands NL Netherlands French fr French_France FR France CA Canada German de German_Germany DE Germany AT Austria CH Switzerland Italian it Italian_Italy IT Italy Japanese jp Japanese_Japan JP Japan Norwegian no Norwegian_Norway NO Norway Portuguese pt Portuguese_Portugal PT Portugal Russian ru Russian_Russia RU Russian_Federation Spanish es Spanish_Spain ES Spain Swedish se Swedish_Sweden SE Sweden 7 English for the United States is the default language. You do not need to install the JAR file for U.S. English unless you assign a different language to a phone and then want to reassign English. Step 7 If you store the locale files in flash memory or slot 0 on the Cisco Unified CME router, create a TFTP alias for the user locale (text displays) and network locale (tones) using this format: Cisco Unified Communications Manager Express System Administrator Guide 429 Localization Support Install System-Defined Locales for Cisco Unified IP Phone 8961, 9951, and 9971 Example: Router(config)# tftp-server flash:/jar_filealias directory_name/gh-sip.jar Router(config)# tftp-server flash:/g4-tones.xml aliasdirectory_name/g4-tones.xml Use the appropriate directory name shown in Table 29:Phone-Type Codesfor Locale JAR Files, on page 428 and remove the two-letter language code from the JAR file name. For example, the TFTP aliases for German and Germany for the Cisco Unified IP Phone 8961 are: Router(config)# tftp-server flash:/de-gh-sip.jar alias German_Germany/ Router(config)# tftp-server flash:/g4-tones.xml alias Germany/g4-tones.xml Step 8 If you store the locale files on an external TFTP server, create a directory under the TFTP root directory for each user and network locale. Use the appropriate directory name shown in Table 29:Phone-Type Codesfor Locale JAR Files, on page 428 and remove the two-letter language code from the JAR file name. Example: For example, the user-locale directory for German and the network-locale directory for Germany for the Cisco Unified IP Phone 8961 are: TFTP-Root/German_Germany/gh-sip.jar TFTP-Root/Germany/g4-tones.xml Step 9 Assign the localesto the phones. To set a default locale for all phones, use theuser-locale andnetwork-locale commands in voice register global configuration mode. Step 10 To support more than one user or network locale, see Verify Multiple Locales on SIP Phones, on page 437. Step 11 Use the create profile command to rebuild the configuration files. Step 12 Use the reset command to reset the phones and see the localized displays. Cisco Unified Communications Manager Express System Administrator Guide 430 Localization Support Install System-Defined Locales for Cisco Unified IP Phone 8961, 9951, and 9971 Use the Locale Installer in Cisco Unified CME 9.0 and Later Versions Restriction • When using an external TFTP server, you must manually create the user locale folders in the root directory. This is a limitation of the TFTP server. • Locale support is limited to phone firmware versions that are supported by Cisco Unified CME. • User-defined locales are not supported if the configuration file location is “system:”. • If you install and configure a user-defined locale using country codes U1-U5 and then you install a new locale using the same label, the phone retains the original language locale even after the phone is reset. This is a limitation of the IP phone. To work around this limitation, you must configure the new package using a different country code. • Each user-defined country code (U1-U5) can be used for only one user-locale-tag at a time. For example: Router(config-register-global)# user-locale 2 U2 load Finnish.pkg Router(config-register-global)# user-locale 1 U2 load Chinese.pkg LOCALE ERROR: User Defined Locale U2 already exists on locale index 2. Before You Begin • Cisco Unified CME 9.0(1) or a later version. • When the storage location specified by the cnf-file location command is flash memory, sufficient space must be on the flash file system for extracting the contents of the locale TAR file. • You must have an account on Cisco.com to download locale files. Step 1 Go to http://www.cisco.com/cgi-bin/tablebuild.pl/CME-Locale You must have an account on Cisco.com to access the Software Download Center. If you do not have an account or have forgotten your username or password, click the appropriate button at the login dialog box and follow the instructions that appear. Step 2 Navigate to Downloads Home > Products > Unified Communications > Call Control > Mid-Market Call Control > Cisco Unified Communications Manager Express > Unified Communications Manager Express Individual File Set and select your version of Cisco Unified CME. Step 3 Select the TAR file for the locale you want to install. Each TAR file contains locale files for a specific language and country and uses the following naming convention: CME-locale-language_country-CMEversion.tar Example: For example, CME-locale-de_DE-German-8.6.3.0.tar is German for Germany for Cisco Unified CME 9.0. Step 4 Download the TAR file to the location previously specified by the cnf-file location command. Each file contains all the firmware required for all phone types supported by that version of Cisco Unified CME. With the locale installer, you do not need to perform manual configuration. Instead, you copy the locale file using the copy command in privileged EXEC configuration mode. Cisco Unified Communications Manager Express System Administrator Guide 431 Localization Support Use the Locale Installer in Cisco Unified CME 9.0 and Later Versions You must copy the locale file into the /its directory (flash:/its or slot0:/its) when you store the locale files on the Cisco Unified CME router. Note a) If the cnf-file location is flash memory: Copy the TAR file to the flash:/its directory. Example: For example, Router# copy tftp://12.1.1.100/CME-locale-de_DE-German-8.6.3.0.tar flash:/its b) If the cnf-file location is slot0: Copy the TAR file to the slot0:/its directory. c) If the cnf-file location istftp: Create a folder in the root directory of the TFTPserver for each locale using the following format and then copy the TAR file to the TFTP-Root folder. Example: TFTP-Root/TAR-filename For system-defined locales, use the locale folder name as shown in Table 31: System-Defined and User-Defined Locales , on page 432. For example, create the folder for system-defined German as follows: TFTP-Root/de_DE-8.6.3.0.tar For up to five user-defined locales, use the User_Define_n folder name as shown in Table 31: System-Defined and User-Defined Locales , on page 432. A user-defined locale is a language other than the system-defined locales that are predefined in Cisco IOSsoftware.For example, create the folder for user-defined locale Chinese (User_Define_1) as follows: TFTP-Root/CME-locale-zh_CN-Chinese-8.6.3.0.tar For a list of user-defined languages supported in Cisco Unified CME, see Cisco Unified CME Localization Matrix. Note Table 31: System-Defined and User-Defined Locales Language Locale Folder Name Country Code English English_United_States US English_United_Kingdom UK CA Danish Danish_Denmark DK Dutch Dutch_Netherlands NL French French_France FR CA Cisco Unified Communications Manager Express System Administrator Guide 432 Localization Support Use the Locale Installer in Cisco Unified CME 9.0 and Later Versions Language Locale Folder Name Country Code German German_Germany DE AT CH Italian Italian_Italy IT Japanese Japanese_Japan JP Norwegian Norwegian_Norway NO Portuguese Portuguese_Portugal PT Russian Russian_Russia RU Spanish Spanish_Spain ES Swedish Swedish_Sweden SE Un1 User_Define_n1 Un8 8 Where “n” is a number from 1 to 5. Step 5 Use theuser-locale [user-locale-tag] {[user-defined-code]country-code} [loadTAR-filename] command in voice register global configuration mode to extract the contents of the TAR file. For country codes, see Table 31: System-Defined and User-Defined Locales , on page 432. Use the complete filename, including the file suffix (.tar), when you configure the user-locale command for all Cisco Unified SIP IP phone types. Note Example: For example, to extract the contents of the CME-locale-zh_CN-Chinese-8.6.3.0.tar file when U1 is the country code for user-defined locale Chinese (User_Define_1), use this command: Router(config-register-global)# user-locale U1 load CME-locale-zh_CN-Chinese-8.6.3.0.tar Step 6 Assign the locales to the phones. See Configure Multiple Locales on SIP Phones, on page 434. Step 7 Use the create profile command in voice register global configuration mode to generate the configuration profile files required for Cisco Unified SIP IP phones. Step 8 Use the reset command to reset the phones and see the localized displays. Cisco Unified Communications Manager Express System Administrator Guide 433 Localization Support Use the Locale Installer in Cisco Unified CME 9.0 and Later Versions Configure Multiple Locales on SIP Phones To define one or more alternativesto the default user and network locales and apply them to individual phones, perform the following steps. Restriction • Multiple user and network locales are supported only on Cisco Unified IP Phone 8961, 9951, and 9971. Before You Begin • Cisco Unified CME 8.6 or a later version. For Cisco Unified IP Phone 9971, Cisco Unified CME 8.8 or a later version. • To specify alternative user and network locales for individual phones in a Cisco Unified CME system, you must use per-phone configuration files. For more information, see Install System-Defined Locales for Cisco Unified IP Phone 6921, 6945, 7906, 7911, 7921, 7931, 7941, 7961, 7970, 7971, and Cisco IP Communicator, on page 411. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register global 4. user-locale [user-locale-tag] {[user-defined-code] country-code} 5. network-locale network-locale-tag [user-defined-code] country-code 6. create profile 7. exit 8. voice register template template-tag 9. user-locale user-locale-tag 10. network-locale network-locale-tag 11. exit 12. voice register pool pool-tag 13. voice register template template-tag 14. exit 15. voice register global 16. reset 17. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Cisco Unified Communications Manager Express System Administrator Guide 434 Localization Support Configure Multiple Locales on SIP Phones Command or Action Purpose Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register global configuration mode to set parameters for all supported SIP phones in Cisco Unified CME. voice register global Example: Router(config)#voice register global Step 3 user-locale [user-locale-tag] Specifies a language for phone displays. {[user-defined-code] country-code} Step 4 • user-locale-tag—Assigns a locale identifier to the locale. Range is 0 to 4. Default: 0. This argument is required when defining some locale other than the default (0). Example: Router(config-register-global)# user-locale 1 DE • country-code—Type ? to display a list of system-defined codes. Default: US (United States). network-locale network-locale-tag Specifies a country for tones and cadences. [user-defined-code] country-code Step 5 • network-locale-tag—Assigns a locale identifier to the country code. Range is 0 to 4. Default: 0. This argument is required when defining some locale other than the default (0). Example: Router(config-register-global)# network-locale 1 FR • country-code—Type ? to display a list of system-defined codes. Default: US (United States). You can assign any valid ISO 3166 code to a user-defined code (U1 to U5). Generates provisioning files required forSIPphones and writes the file to the location specified with the tftp-path command. create profile Example: Router(config-register-global)# create profile Step 6 exit Exits voice register global configuration mode. Example: Router(config-telephony)# exit Step 7 Enters voice register template configuration mode to define a template of common parameters for SIP phones in Cisco Unified CME. voice register template template-tag Example: Router(config)voice register template 10 Step 8 • Range— 1 to 10. Step 9 user-locale user-locale-tag Assigns a user locale to this ephone template. Cisco Unified Communications Manager Express System Administrator Guide 435 Localization Support Configure Multiple Locales on SIP Phones Command or Action Purpose Example: Router(config-ephone-template)# user-locale 2 • user-locale-tag—A locale tag that was created in Step 4, on page 435. Range is 0 to 4. Step 10 network-locale network-locale-tag Assigns a network locale to this ephone template. Example: Router(config-ephone-template)# network-locale 2 • network-locale-tag—A locale tag that was created in Step 5, on page 435. Range is 0 to 4. exit Exits voice register template configuration mode. Example: Router(config-ephone-template)# exit Step 11 Enters voice register pool configuration mode to set phone-specific parameters for a SIP phone. voice register pool pool-tag Example: Router(config)#voice register pool 5 Step 12 Enters voice register template configuration mode to define a template of common parameters for SIP phones in Cisco Unified CME. voice register template template-tag Example: Router(config)voice register template 10 Step 13 • Range— 1 to 10. exit Exits voice register template configuration mode. Example: Router(config-ephone)# exit Step 14 Enters voice register global configuration mode to set parameters for all supported SIP phones in Cisco Unified CME. voice register global Example: Router(config)#voice register global Step 15 Performs a complete reboot of all phones or the specified phone, including contacting the DHCP and TFTP servers for the latest configuration information. reset Example: Router(config-register-global)# reset Step 16 end Returns to privileged EXEC mode. Example: Router(config-register-global)# end Step 17 Cisco Unified Communications Manager Express System Administrator Guide 436 Localization Support Configure Multiple Locales on SIP Phones Verify Multiple Locales on SIP Phones Step 1 Use the show voice register tftp-bind command to display a list of configuration files that are accessible to IP phones using TFTP, including the dictionary, language, and tone configuration files. Example: Router#sh voice register tftp-bind tftp-server syncinfo.xml url system:/cme/sipphone/syncinfo.xml tftp-server SIPDefault.cnf url system:/cme/sipphone/SIPDefault.cnf tftp-server softkeyDefault_kpml.xml url system:/cme/sipphone/softkeyDefault_kpml .xml tftp-server softkeyDefault.xml url system:/cme/sipphone/softkeyDefault.xml tftp-server softkey2_kpml.xml url system:/cme/sipphone/softkey2_kpml.xml tftp-server softkey2.xml url system:/cme/sipphone/softkey2.xml tftp-server featurePolicyDefault.xml url system:/cme/sipphone/featurePolicyDefau lt.xml tftp-server featurePolicy2.xml url system:/cme/sipphone/featurePolicy2.xml tftp-server SEPACA016FDC1BD.cnf.xml url system:/cme/sipphone/SEPACA016FDC1BD.cnf .xml Step 2 Use the show voice register template all command to check the user locale and network locale settings in each ephone template. Step 3 Use the show voice register pool all command to check that the correct templates are applied to phones. Step 4 If the configuration file location is not TFTP, use the debug tftp events command to see which files Cisco Unified CME is looking for and whether the files are found and opened correctly. There are usually three states (“looking for x file,” “opened x file,” and “finished x file”). The file is found when all three states are displayed. For an external TFTP server, you can use the logs from the TFTP server. Configuration Examples for Localization Example for Configuring Multiple User and Network Locales The following example sets the default locale of 0 to Germany, which defines Germany as the default user and network locale. Germany is used for all phones unless you apply a different locale to individual phones using ephone templates. telephony service cnf-file location flash: cnf-file perphone user-locale 0 DE network-locale 0 DE After using the previous commandsto define Germany asthe default user and network locale, use the following commands to return the default value of 0 to US: telephony service no user-locale 0 DE no network-locale 0 DE Cisco Unified Communications Manager Express System Administrator Guide 437 Localization Support Verify Multiple Locales on SIP Phones Another way to define Germany as the default user and network locale is to use the following commands: telephony service cnf-file location flash: cnf-file perphone user-locale DE network-locale DE After using the previous commands, use the following commands to return the default to US: telephony service no user-locale DE no network-locale DE The following example defines three alternative locales: JP(Japan),FR (France), and ES(Spain). The default is US for all phones that do not have an alternative applied using ephone templates. In this example, ephone 11 uses JP for its locales, ephone 12 uses FR, ephone 13 uses ES, and ephone 14 uses the default, US. telephony-service cnf-file location flash: cnf-file perphone create cnf-files user-locale 1 JP user-locale 2 FR user-locale 3 ES network-locale 1 JP network-locale 2 FR network-locale 3 ES create cnf-files ephone-template 1 user-locale 1 network-locale 1 ephone-template 2 user-locale 2 network-locale 2 ephone-template 3 user-locale 3 network-locale 3 ephone 11 button 1:25 ephone-template 1 ephone 12 button 1:26 ephone-template 2 ephone 13 button 1:27 ephone-template 3 ephone 14 button 1:28 Example for Configuring User-Defined Locales The following example shows user-locale tag 1 assigned to code U1, which is defined as ZH for Traditional Chinese. Traditional Chinese is not predefined in the system so you must download the appropriate XML files to support this language. In this example, ephone 11 uses Traditional Chinese (ZH) and ephone 12 uses the default, US English. The default is US English for all phones that do not have an alternative applied using ephone templates. telephony-service cnf-file location flash: cnf-file perphone Cisco Unified Communications Manager Express System Administrator Guide 438 Localization Support Example for Configuring User-Defined Locales user-locale 1 U1 ZH network-locale 1 U1 CN ephone-template 2 user-locale 1 network-locale 1 ephone 11 button 1:25 ephone-template 2 ephone 12 button 1:26 Example for Configuring Chinese as the User-Defined Locale The following is a sample output from the user-locale command when you configure the Chinese language as the user-defined locale in Cisco Unified CME: Router(config-register-global)# user-locale U1 load chinese.pkg Updating CNF files LOCALE INSTALLER MESSAGE: VER:1 LOCALE INSTALLER MESSAGE: Langcode:zh LOCALE INSTALLER MESSAGE: Language:Chinese LOCALE INSTALLER MESSAGE: Filename: 7905-dictionary.xml LOCALE INSTALLER MESSAGE: Filename: 7905-font.xml LOCALE INSTALLER MESSAGE: Filename: 7905-kate.xml LOCALE INSTALLER MESSAGE: Filename: 7960-tones.xml LOCALE INSTALLER MESSAGE: Filename: mk-sccp.jar LOCALE INSTALLER MESSAGE: Filename: td-sccp.jar LOCALE INSTALLER MESSAGE: Filename: tc-sccp.jar LOCALE INSTALLER MESSAGE: Filename: 7921-font.dat LOCALE INSTALLER MESSAGE: Filename: 7921-kate.utf-8.xml LOCALE INSTALLER MESSAGE: Filename: 7921-kate.xml LOCALE INSTALLER MESSAGE: Filename: SCCP-dictionary.utf-8.xml LOCALE INSTALLER MESSAGE: Filename: SCCP-dictionary.xml LOCALE INSTALLER MESSAGE: Filename: SCCP-dictionary-ext.xml LOCALE INSTALLER MESSAGE: Filename: 7921-dictionary.xml LOCALE INSTALLER MESSAGE: Filename: g3-tones.xml LOCALE INSTALLER MESSAGE: Filename: utf8_tags_file LOCALE INSTALLER MESSAGE: Filename: tags_file LOCALE INSTALLER MESSAGE: New Locale configured Processing file:flash:/its/user_define_1_tags_file Processing file:flash:/its/user_define_1_utf8_tags_file CNF-FILES: Clock is not set or synchronized, retaining old versionStamps CNF files updating complete Example for Configuring Swedish as the System-Defined Locale The following is a sample output from the user-locale command when you configure the Swedish language as the system-defined locale in Cisco Unified CME: Router(config-register-global)# user-locale SE load swedish.pkg Updating CNF files LOCALE INSTALLER MESSAGE: VER:1 LOCALE INSTALLER MESSAGE: Langcode:se LOCALE INSTALLER MESSAGE: Language:swedish LOCALE INSTALLER MESSAGE: Filename: g3-tones.xml LOCALE INSTALLER MESSAGE: Filename: gp-sccp.jar Cisco Unified Communications Manager Express System Administrator Guide 439 Localization Support Example for Configuring Chinese as the User-Defined Locale LOCALE INSTALLER MESSAGE: Filename: ipc-sccp.jar LOCALE INSTALLER MESSAGE: Filename: mk-sccp.jar LOCALE INSTALLER MESSAGE: Filename: tc-sccp.jar LOCALE INSTALLER MESSAGE: Filename: td-sccp.jar LOCALE INSTALLER MESSAGE: New Locale configured CNF-FILES: Clock is not set or synchronized, retaining old versionStamps CNF files updating complete Configuration Examples for Locale Installer on SCCP Phones System-Defined Locale is the Default Applied to All Phones The following example is the output from the user-locale command when you configure a system-defined locale for Cisco Unified CME and the locale is on the default locale index (user-locale-tag 0). The user-locale-tag argument is required only when using multiple locales; otherwise, the specified language is the default applied to all SCCP phones. Router(config-telephony)# user-locale SE load CME-locale-sv_SV-7.0.1.1a.tar Updating CNF files LOCALE INSTALLER MESSAGE: VER:1 LOCALE INSTALLER MESSAGE: Langcode:se LOCALE INSTALLER MESSAGE: Language:swedish LOCALE INSTALLER MESSAGE: Filename: g3-tones.xml LOCALE INSTALLER MESSAGE: Filename: gp-sccp.jar LOCALE INSTALLER MESSAGE: Filename: ipc-sccp.jar LOCALE INSTALLER MESSAGE: Filename: mk-sccp.jar LOCALE INSTALLER MESSAGE: Filename: tc-sccp.jar LOCALE INSTALLER MESSAGE: Filename: td-sccp.jar LOCALE INSTALLER MESSAGE: New Locale configured CNF-FILES: Clock is not set or synchronized, retaining old versionStamps CNF files updating complete Router(config-telephony)# create cnf-files Router(config-telephony)# ephone 3 Router(config-ephone)# reset User-Defined Locale is Default Language to be Applied to All Phones The following example isthe output from theuser-locale command when you configure a user-defined locale for Cisco Unified CME and the locale is on the default locale index (user-locale-tag 0). The user-locale-tag argument is required when using multiple locales, otherwise the specified language is the default applied to all SCCP phones. Router(config-telephone)# user-locale U1 load CME-locale-xh_CN-7.0.1.1.tar Updating CNF files LOCALE INSTALLER MESSAGE: VER:1 LOCALE INSTALLER MESSAGE: Langcode:fi LOCALE INSTALLER MESSAGE: Language:Finnish LOCALE INSTALLER MESSAGE: Filename: 7905-dictionary.xml LOCALE INSTALLER MESSAGE: Filename: 7905-kate.xml LOCALE INSTALLER MESSAGE: Filename: 7920-dictionary.xml LOCALE INSTALLER MESSAGE: Filename: 7960-dictionary.xml LOCALE INSTALLER MESSAGE: Filename: 7960-font.xml LOCALE INSTALLER MESSAGE: Filename: 7960-kate.xml LOCALE INSTALLER MESSAGE: Filename: 7960-tones.xml LOCALE INSTALLER MESSAGE: Filename: mk-sccp.jar LOCALE INSTALLER MESSAGE: Filename: tc-sccp.jar LOCALE INSTALLER MESSAGE: Filename: td-sccp.jar Cisco Unified Communications Manager Express System Administrator Guide 440 Localization Support Configuration Examples for Locale Installer on SCCP Phones LOCALE INSTALLER MESSAGE: Filename: tags_file LOCALE INSTALLER MESSAGE: Filename: utf8_tags_file LOCALE INSTALLER MESSAGE: Filename: g3-tones.xml LOCALE INSTALLER MESSAGE: Filename: SCCP-dictionary.utf-8.xml LOCALE INSTALLER MESSAGE: Filename: SCCP-dictionary.xml LOCALE INSTALLER MESSAGE: Filename: ipc-sccp.jar LOCALE INSTALLER MESSAGE: Filename: gp-sccp.jar LOCALE INSTALLER MESSAGE: New Locale configured Processing file:flash:/its/user_define_2_tags_file Processing file:flash:/its/user_define_2_utf8_tags_file CNF-FILES: Clock is not set or synchronized, retaining old versionStamps CNF files updating complete Router(config-telephony)# create cnf-files Router(config-telephony)# ephone 3 Router(config-ephone)# reset Locale on a Non-default Locale Index The following example is the output from the user-locale command if you configure a user-defined locale as an alternate locale for a particularSCCPphone (ephone 1) in Cisco Unified CME. The user-locale-tag argument is required only when using multiple locales. In this configuration, the locale is user-defined Finnish (U2) on user-locale index 2. Router(config-telephony)# user-locale 2 U2 load CME-locale-fi_FI-7.0.1.1.tar Updating CNF files LOCALE INSTALLER MESSAGE: VER:1 LOCALE INSTALLER MESSAGE: Langcode:fi LOCALE INSTALLER MESSAGE: Language:Finnish LOCALE INSTALLER MESSAGE: Filename: 7905-dictionary.xml LOCALE INSTALLER MESSAGE: Filename: 7905-kate.xml LOCALE INSTALLER MESSAGE: Filename: 7920-dictionary.xml LOCALE INSTALLER MESSAGE: Filename: 7960-dictionary.xml LOCALE INSTALLER MESSAGE: Filename: 7960-font.xml LOCALE INSTALLER MESSAGE: Filename: 7960-kate.xml LOCALE INSTALLER MESSAGE: Filename: 7960-tones.xml LOCALE INSTALLER MESSAGE: Filename: mk-sccp.jar LOCALE INSTALLER MESSAGE: Filename: tc-sccp.jar LOCALE INSTALLER MESSAGE: Filename: td-sccp.jar LOCALE INSTALLER MESSAGE: Filename: tags_file LOCALE INSTALLER MESSAGE: Filename: utf8_tags_file LOCALE INSTALLER MESSAGE: Filename: g3-tones.xml LOCALE INSTALLER MESSAGE: Filename: SCCP-dictionary.utf-8.xml LOCALE INSTALLER MESSAGE: Filename: SCCP-dictionary.xml LOCALE INSTALLER MESSAGE: Filename: ipc-sccp.jar LOCALE INSTALLER MESSAGE: Filename: gp-sccp.jar LOCALE INSTALLER MESSAGE: New Locale configured Processing file:flash:/its/user_define_2_tags_file Processing file:flash:/its/user_define_2_utf8_tags_file CNF-FILES: Clock is not set or synchronized, retaining old versionStamps CNF files updating complete Router(config-telephony)# ephone-template 1 Router(config-ephone-template)# user-locale 2 Router(config-ephone-template)# ephone 1 Router(config-ephone)# ephone-template 1 The ephone template tag has been changed under this ephone, please restart or reset ephone to take effect. Router(config-ephone)# telephony-service Cisco Unified Communications Manager Express System Administrator Guide 441 Localization Support Locale on a Non-default Locale Index Router(config-telephony)# create cnf-files Router(config-telephony)# ephone 1 Router(config-ephone)# reset Examples for Configuring Multiple User and Network Locales on SIP Phones The following example sets the default locale of 0 to Germany, which defines Germany as the default user and network locale. Germany is used for all phones unless you apply a different locale to individual phones using ephone templates. voice register global user-locale 0 DE network-locale 0 DE After using the previous commandsto define Germany asthe default user and network locale, use the following commands to return the default value of 0 to US: voice register global no user-locale 0 DE no network-locale 0 DE Another way to define Germany as the default user and network locale is to use the following commands: voice register global user-locale DE network-locale DE After using the previous commands, use the following commands to return the default to US: voice register global no user-locale DE no network-locale DE SIP: Alternative Locales The following example defines three alternative locales: JP(Japan),FR (France), and ES(Spain). The default is US for all phones that do not have an alternative applied using ephone templates. In this example, ephone 11 uses JP for its locales, ephone 12 uses FR, ephone 13 uses ES, and ephone 14 uses the default, US. voice register global create profile user-locale 1 JP user-locale 2 FR user-locale 3 ES network-locale 1 JP network-locale 2 FR network-locale 3 ES create profile voice register template 1 user-locale 1 network-locale 1 voice register template 2 user-locale 2 network-locale 2 voice register pool 1 number 1 dn 1 template 1 user-locale 3 network-locale 3 voice register pool 2 number 2 dn 2 template 2 Cisco Unified Communications Manager Express System Administrator Guide 442 Localization Support Examples for Configuring Multiple User and Network Locales on SIP Phones voice register pool 6 number 3 dn 3 template 3 Example for Configuring Locale Installer on SIP Phones The following example shows how the locale installer only requires you to copy the locale file using the copy command in privileged EXEC configuration mode to configure a locale on a Cisco Unified SIP IP phone. The example also shows that the locale file has been copied in the /its directory. Router# copy tftp://100.1.1.1/CME-locale-de_DE-German-8.6.3.0.tar flash:/its Destination filename [/its/CME-locale-de_DE-German-8.6.3.0.tar]? Router# configure terminal Enter configuration commands, one per line. End with CNTL/Z. Router(config)# voice register global Router(config-register-global)# user-locale DE load CME-locale-de_DE-German-8.6.3.0.tar LOCALE INSTALLER MESSAGE (SIP):Loading Locale Package... LOCALE INSTALLER MESSAGE: VER:3 LOCALE INSTALLER MESSAGE: Langcode:de_DE LOCALE INSTALLER MESSAGE: Language:German LOCALE INSTALLER MESSAGE: Filename: g3-tones.xml LOCALE INSTALLER MESSAGE: Filename: tags_file LOCALE INSTALLER MESSAGE: Filename: utf8_tags_file LOCALE INSTALLER MESSAGE: Filename: gd-sip.jar LOCALE INSTALLER MESSAGE: Filename: gh-sip.jar LOCALE INSTALLER MESSAGE: Filename: g4-tones.xml LOCALE INSTALLER MESSAGE: New Locale configured Router(config-register-global)# Where to Go Next Ephone Templates For more information about ephone templates, see Templates, on page 1427. Feature Information for Localization Support The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Table 32: Feature Information for Localization Support Feature Name Cisco Unified CME Version Feature Information Cisco Unified CME 10.5 provides support for additional languages. Localization Enhancements for 10.5 Cisco Unified SIP IP Phones Cisco Unified Communications Manager Express System Administrator Guide 443 Localization Support Example for Configuring Locale Installer on SIP Phones Feature Name Cisco Unified CME Version Feature Information Provides the following enhanced localization support for Cisco Unified SIP IP phones: • Localization support for Cisco Unified 6941 and 6945 SIP IP Phones. • Locale installer that supports a single procedure for all Cisco UnifiedSIPIPphones. Localization Enhancements for 9.0 Cisco Unified SIP IP Phones Addslocalization support for Cisco Unified 3905 SIP and Cisco Unified 6945, 8941, and 8945 SCCP IP Phones. Localization Enhancement 8.8 Adds localization support for SIP IP Phones. Usability Enhancement 8.6 • Locale installer that supports a single procedure for all SCCP IP phones. • Parses firmware-load text files and automatically creates the required TFTP aliases for localization. • Backward compatibility with the configuration method in Cisco Unified CME 7.0 and earlier versions. Cisco Unified CME Usability 7.0(1) Enhancement Multiple user and network locales were introduced. Multiple Locales 4.0 User-defined locales were introduced. User-Defined Locales 4.0 Cisco Unified Communications Manager Express System Administrator Guide 444 Localization Support Feature Information for Localization Support CHAPTER 12 Dial Plans This chapter describes features that enable Cisco Unified Communications Manager Express (Cisco Unified CME) to expand or manipulate internal extension numbersso that they conform to numbering plans used by external systems. • Information About Dial Plans, page 445 • Configure Dial Plans, page 451 • Configuration Examples for Dial Plan Features, page 469 • Feature Information for Dial Plan Features, page 471 Information About Dial Plans Phone Number Plan If you install a Cisco Unified CME system to replace an older telephony system that had an established telephone number plan, you can retain the old number plan. Cisco Unified CME supports flexible extension number lengths and can provide automatic conversion between extension dialing and E.164 public telephone number dialing. When a router receives a voice call, it selects an outbound dial peer by comparing the called number (the full E.164 telephone number) in the call information with the number configured as the destination pattern for the POTS dial peer. The router then strips out the left-justified numbers corresponding to the destination pattern matching the called number. If you have configured a prefix, the prefix will be put in front of the remaining numbers, creating a dial string, which the router will then dial. If all numbers in the destination pattern are stripped-out, the user will receive (depending on the attached equipment) a dial tone. A successful Cisco Unified CME system requires a telephone numbering plan that supports future expansion. The numbering plan also must not overlap or conflict with other numbers that are on the same VoIP network or are part of a centralized voice mail system. Cisco Unified CME supports shared lines and multiple lines configured with the same extension number. This means that you can set up several phones to share an extension number to provide coverage for that number. You can also assign several line buttons on a single phone to the same extension number to create a small hunt group. Cisco Unified Communications Manager Express System Administrator Guide 445 If you are configuring more than one Cisco Unified CME site, you need to decide how calls between the sites will be handled. Calls between Cisco Unified CME phones can be routed either through the PSTN or over VoIP. If you are routing calls over VoIP, you must decide among the following three choices: • You can route calls using a global pool of fixed-length extension numbers. For example, all sites have unique extension numbers in the range 5000 to 5999, and routing is managed by a gatekeeper. If you select this method, assign a subrange of extension numbers to each site so that duplicate number assignment does not result. You will have to keep careful records of which Cisco Unified CME system is assigned which number range. • You can route calls using a local extension number plus a special prefix for each Cisco Unified CME site. This choice allows you to use the same extension numbers at more than one site. • You can use an E.164 PSTN phone number to route calls over VoIP between Cisco Unified CME sites. In this case, intersite callers use the PSTN area code and local prefix to route calls between Cisco Unified CME systems. If you choose to have a gatekeeper route calls among multiple Cisco Unified CME systems, you may face additional restrictions on the extension number formatsthat you use.For example, you might be able to register onlyPSTN-formatted numbers with the gatekeeper. The gatekeeper might not allow the registration of duplicate telephone numbersin different Cisco Unified CME systems, but you might be able to overcome thislimitation. Cisco Unified CME allows the selective registration of either 2- to 5-digit extension numbers or 7- to 10-digit PSTN numbers, so registering only PSTN numbers might prevent the gatekeeper from sensing duplicate extensions. Mapping of public telephone numbers to internal extension numbers is not restricted to simple truncation of the digit string. Digit substitutions can be made by defining dial plan patterns to be matched. For information about dial plans,see DialPlanPatterns, on page 446. More sophisticated number manipulations can be managed with voice translation rules and voice translation profiles, which are described in the Voice Translation Rules and Profiles section. In addition, your selection of a numbering scheme for phones that can be directly dialed from the PSTN is limited by your need to use the range of extensions that are assigned to you by the telephone company that provides your connection to the PSTN. For example, if your telephone company assigns you a range from 408 555-0100 to 408 555-0199, you may assign extension numbers only in the range 100 to 199 if those extensions are going to have Direct Inward Dialing (DID) access.For more information about DID,see Direct Inward Dialing Trunk Lines, on page 447. Dial Plan Patterns A dial plan pattern enables abbreviated extensions to be expanded into fully qualified E.164 numbers. Use dial plan patterns when configuring a network with multiple Cisco Unified CMEsto ensure that the appropriate calling number, extension or E.164 number, is provided to the target Cisco Unified CME, and appears on the phone display of the called phone. In networks that have a single router, you do not need to use dial plan patterns. When you define a directory number for anSCCPphone, the Cisco Unified CME system automatically creates a POTS dial peer with the ephone-dn endpoint as a destination. For SIP phones connected directly into Cisco Unified CME, the dial peer is automatically created when the phone registers. By default, Cisco Unified CME creates a single POTS dial peer for each directory number. Cisco Unified Communications Manager Express System Administrator Guide 446 Dial Plans Dial Plan Patterns For example, when the ephone-dn with the number 1001 was defined, the following POTS dial peer was automatically created for it: dial-peer voice 20001 pots destination-pattern 1001 voice-port 50/0/2 A dial plan pattern builds additional dial peers for the expanded numbers it creates. If a dialplan pattern is configured and it matches against a directory number, twoPOTSdial peers are created, one for the abbreviated number and one for the complete E.164 direct-dial telephone number. For example, if you then define a dial plan pattern that 1001 will match, such as 40855500.., a second dial peer is created so that calls to both the 0001 and 4085550001 numbers are completed. In this example, the additional dial peer that is automatically created looks like the following: dial-peer voice 20002 pots destination-pattern 40855510001 voice-port 50/0/2 In networks with multiple routers, you may need to use dial plan patterns to expand extensions to E.164 numbers because local extension numbering schemes can overlap each other. Networks with multiple routers have authorities such as gatekeepers that route calls through the network. These authorities require E.164 numbers so that all numbers in the network are unique. Define dial plan patterns to expand extension numbers into unique E.164 numbers for registering with a gatekeeper. For more information on E.164 numbers, see E .164 Enhancements, on page 448. If multiple dial plan patterns are defined, the system matches extension numbers against the patterns in sequential order, starting with the lowest numbered dial plan pattern tag first. Once a pattern matches an extension number, the pattern is used to generate an expanded number. If additional patterns subsequently match the extension number, they are not used. Direct Inward Dialing Trunk Lines Direct Inward Dialing (DID), is a one-way incoming trunking mechanism, that allows an external caller to directly reach a specific extension without the call being served by an attendant or other intervention. It is a service offered in which the last few (typically three or four) digits dialed by the caller are forwarded to the called party on a special DID trunk. For example, all the phone numbers from 555-0000 to 555-0999 could be assigned to a company with 20 DID trunks. When a caller dials any number in this range, the call is forwarded on any available trunk. If the caller dialed 555-0234, then the digits 2, 3, and 4 are forwarded. These DID trunks could be terminated on a PBX, so that the extension 234 gets the call without operator assistance. This makes it look as though 555-0234 and the other 999 lines all have direct outside lines, while only requiring 20 trunks to service the 1,000 telephone extensions. Using DID, a company can offer its customers individual phone numbers for each person or workstation within the company without requiring a physical line into the PBX for each possible connection. Compared to regular PBX service, DID saves the cost of a switchboard operator. Calls go through faster, and callers feel they are calling a person rather than a company. Dial plan patterns are required to enable calls to DID numbers. When the PSTN connects a DID call for “4085550234” to the Cisco Unified CME system, it also forwardsthe extension digits“234” to allow the system to route the call. Cisco Unified Communications Manager Express System Administrator Guide 447 Dial Plans Direct Inward Dialing Trunk Lines Voice Translation Rules and Profiles Translation rules manipulate dialed numbers to conform to internal or external numbering schemes. Voice translation profiles allow you to group translation rules together and apply them to the following types of numbers: • Called numbers (DNIS) • Calling numbers (ANI) • Redirected called numbers • Redirected target numbers—These are transfer-to numbers and call-forwarding final destination numbers. Supported by SIP phones in Cisco Unified CME 4.1 and later versions. After you define a set of translation rules and assign them to a translation profile, you can apply the rules to incoming and outgoing call legs to and from the Cisco Unified CME router based on the directory number. Translation rules can perform regular expression matches and replace substrings. A translation rule replaces a substring of the input number if the number matches the match pattern, number plan, and type present in the rule. For configuration information, see Define Voice Translation Rules in Cisco CME 3.2 and Later Versions, on page 454. For examples of voice translation rules and profiles, see the Voice Translation Rules technical note and the Number Translation using Voice Translation Profiles technical note. Secondary Dial Tone A secondary dial tone is available for Cisco Unified IP phones connected to Cisco Unified CME. From Cisco Unified CME Release 11.6 onwards, secondary dial tone is supported on both SIP phones and SCCP phones. The secondary dial tone is generated when a phone user dials a predefinedPSTN access prefix and terminates when additional digits are dialed. An example is when a secondary dial tone is heard after a PSTN access prefix, such as the number 9, is dialed to reach an outside line. For SIP phones, a dialplan file is downloaded when the phone restarts. This dialplan file will have the dialplan pattern configured. Based on this dialplan pattern, phone would collect the digits or play secondary dial tone if there is a comma (,) in the pattern. The call is placed from the phone, when there is matching pattern in the dialplan file. Also note that when this feature is enabled, KPML digit collection is disabled on SIP phones. For configuration information,see ActivateSecondary Dial ToneForSCCPPhones, on page 463 and Activate Secondary Dial Tone for SIP Phones, on page 464. E .164 Enhancements Cisco Unified CME 8.5 allows you to present a phone number in + E.164 telephone numbering format. E.164 is an International Telecommunication Union (ITU-T) recommendation that defines the international public telecommunication numbering plan used in the PSTN and other data networks. E.164 defines the format of telephone numbers. A leading + E.164 telephone number can have a maximum of 15 digits and is usually written with a ‘+’ prefix defining the international access code. To dial such numbers from a normal fixed line phone, the appropriate international call prefix must be used. Cisco Unified Communications Manager Express System Administrator Guide 448 Dial Plans Voice Translation Rules and Profiles The leading +E.164 number is unique number specified to a phone or a device. Callers from around the world dial the leading + E.164 phone number to reach a phone or a device without the need to know local or international prefix. The leading + E.164 feature also reduces the overall telephony configuration process by eliminating the need to further translate the telephone numbers. Phone Registration with Leading + E164 Number In Cisco Unified CME, phones register using the leading ‘+’ dialing plan in two ways. Phones can either register with the extension number or with leading + E.164 number. When phones are registered with extension number, the phones will have a dial peer association with the extension number. The dialplan-pattern command is enhanced to allow you to configure leading + phone numbers on the dialplan pattern. Once dialplan-pattern is configured, there could be an E.164 number dialpeer associated with the same phone. For example, phones registered with extension number 1111 can also be reached by dialing +13332221111. This phone registration method is beneficial in two ways, that is, locally, phones are able to reach each other by just dialing the extension numbers and, remotely, phones can dial abbreviated numbers which are translated as an E.164 number at the outgoing dial-peer. See Example 1, on page 449 for more information. There are instances where phone is registered with Unified CME using the extension number. If the user hasto reach the phone using the full +E.164 number, a dial peer needsto be configured for the full number. Thisis applicable only when the extension-length isspecified to have the same length as extension number. Note When phones are registered with a leading + E.164 number, there is only one leading + E.164 number associated with the phone. Thedemote option in thedialplan-patterncommand allows the phone to have two dialpeers associated with the same phone. For more information on configuring the dialplan-patterns, see Configure Dial Plans, on page 451. For example, a phone registered with + E.164 phone number +12223331111 will have two dialpeers associated with the same phone that is, +122233331111 and 1111. See Example 2 , on page 450. Example 1 In the following example, phones are registered with extension number 1111 but they can be reached by either dialing the 4-digit extension number, or a leading + E.164 number (+122233331111). When the dial-peer pattern is configured, phones can also be reached by dialing its + E.164 number. The phone can be reached by dialing either the 4-digit extension number or the + E.164 number. ! ephone-dn 1 number 1111 ! ephone 1 button 1:1 ! telephony-service dialplan-pattern 1 +1222333.... extension-length 4 ! voice register dn 1 number 1235 ! voice register pool 1 number 1 dn 1 ! voice register global Cisco Unified Communications Manager Express System Administrator Guide 449 Dial Plans E .164 Enhancements dialplan-pattern 1 +1222333.... extension-length 4 Example 2 In the following example, phones are registered with leading + E.164 number (+122233331111) and the phones can be reached by dialing either the 4-digit extension number or the + E.164 number. In this example, phone can be reached by dialing 1111 or the +E.164 number. ! ephone-dn 1 number +12223331111 ! ephone 1 button 1:1 ! telephony-service dialplan-pattern 1 +1222333.... extension-length 4 demote ! voice register dn 1 number +12223331235 ! voice register pool 1 number 1 dn 1 ! voice register global dialplan-pattern 1 +1222333.... extension-length 4 demote Because the legacy phone does not have a ‘+’ button, you can configure dialplan-pattern or translation profile. Note Example 3 In the following example, phones are registered with leading + E.164 number (+12223331111) for SCCP phone and +12223331235 for SIP phone) and the phones can be reached by dialing either the 6-digit number or the + E.164 number. The phone number +12223331234 can be reached by dialing either the 6-digit demoted number or the + E.164 number. ! ephone-dn 1 number +12223331111 ! ephone 1 button 1:1 ! telephony-service dialplan-pattern 1 +1222333.... extension-length 6 demote ! voice register dn 1 number +12223331235 ! voice register pool 1 Cisco Unified Communications Manager Express System Administrator Guide 450 Dial Plans E .164 Enhancements number 1 dn 1 ! voice register global dialplan-pattern 1 +1222333.... extension-length 6 demote After the CLI for demote is configured to extension-length 6, you can dial 331235 for SIP phone, and 331111 for SCCP phone. Callback and Calling Number Display In earlier versions of Cisco Unified CME and Cisco Unified SRST, the calling number (number from an incoming call ringing on your phone) was used for both callback (number displayed under Missed Calls in your local phone directory number) and calling numbers. The + E.164 feature in Cisco Unified CME 8.5, allows you to display both calling number and callback numbers in appropriate format so that you are not required to edit the phone numbers before placing a call. The calling number is displayed on the phone when you configure the translation-profile outgoing command in ephone-dn or voice register dn mode. The translate callback-number configuration in voice translation-profile allows you to translate the callback number and display it in E.164 format. The translate callback number configuration is only applicable for outgoing calls onSIPandSCCPIPphones. When translate callbacknumber is configured, the extra callback field is displayed and if the number matches the translation rule, it is translated. For more information see Define Translation Rules for Callback-Number on SIP Phones, on page 466. Similarly, in Cisco Unified SRST 8.5, you can configure translate calling under voice translation-profile mode to display the calling number. You can configure translation-profile outgoing in call-manager-fallback mode or voice register pool to display the callback number. You can use translate called command in translation-profile and call-manager-fallback orvoice register pool will try to match the called number to do the translation. See Enabling Translation Profiles for more information. The leading ‘+’ in the E.164 number is stripped from the called and calling numbers if the called endpoint or gateway,such as H323 or QSIG gateway, does notsupport the leading ‘+’sign in the E.164 number translation. You can strip the leading ‘+’ sign from the number you are calling or a called number using the translation-profile incoming or translation-profile outgoing commands. Configure Dial Plans Configure SCCP Dial Plan Patterns Tip In networks that have a single router, you do not need to define dial plan patterns. SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. dialplan-pattern tag pattern extension-length length [extension-pattern epattern] [no-reg] 5. end Cisco Unified Communications Manager Express System Administrator Guide 451 Dial Plans Configure Dial Plans DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 3 Maps a digit pattern for an abbreviated extension-number prefix to the full E.164 telephone number pattern. dialplan-pattern tag pattern extension-length length [extension-pattern epattern] [no-reg] Example: Router(config-telephony)# dialplan-pattern 1 4085550100 extension-length 3 extension-pattern 4.. Step 4 This example maps all extension numbers 4xx to the PSTN number 40855501xx, so that extension 412 corresponds to 4085550112. Note Exits configuration mode and enters privileged EXEC mode. end Example: Router(config-telephony)# end Step 5 Configure SIP Dial Plan Patterns To create and apply a pattern for expanding individual abbreviated SIP extensions into fully qualified E.164 numbers, follow the steps in this section. dial plan pattern expansion affects calling numbers and for call forward using B2BUA, redirecting, including originating and last reroute, numbers for SIP extensions in Cisco Unified CME. Before You Begin Cisco Unified CME 4.0 or a later version. Cisco Unified Communications Manager Express System Administrator Guide 452 Dial Plans Configure SIP Dial Plan Patterns SUMMARY STEPS 1. enable 2. configure terminal 3. voice register global 4. dialplan-pattern tag pattern extension-length extension-length [extension-pattern extension-pattern | no-reg] 5. call-forward system redirecting-expanded 6. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register global configuration mode to set parameters for all supported SIP phones in Cisco Unified CME. voice register global Example: Router(config)# voice register global Step 3 Defines pattern that is used to expand abbreviated extension numbers of SIP calling numbers in Cisco Unified CME into fully qualified E.164 numbers. dialplan-pattern tag pattern extension-length extension-length [extension-patternextension-pattern | no-reg] Example: Router(config-register-global)# dialplan-pattern 1 4085550... extension-length 5 Step 4 Applies dial plan pattern expansion globally to redirecting, including originating and last reroute, numbers for SIP call-forward system redirecting-expanded Example: Router(config-register-global)# call-forward system redirecting-expanded Step 5 extensions in Cisco Unified CME for call forward using B2BUA. end Exits configuration mode and enters privileged EXEC mode. Example: Router(config-register-global)# end Step 6 Cisco Unified Communications Manager Express System Administrator Guide 453 Dial Plans Configure SIP Dial Plan Patterns Verify Dial Plan Patterns SUMMARY STEPS 1. show telephony-service 2. SCCP: show telephony-service dial-peer or SIP: show dial-peer summary DETAILED STEPS Step 1 show telephony-service Use this command to verify dial plan patterns in the configuration. Example: The following example maps the extension pattern 4.. to the last three digits of the dial plan pattern 4085550155: telephony-service dialplan-pattern 1 4085550155 extension-length 3 extension-pattern 4.. Step 2 SCCP: show telephony-service dial-peer or SIP: show dial-peer summary Use the command to display dial peers that are automatically created by the dialplan-pattern command. Use this command display the configuration for all VoIP and POTS dial peers configured for a router, including dial peers created by using the dialplan-expansion (voice register) command. Example: The following example is output from the show dial-peer summary command displaying information for four dial peers, one each for extensions 60001 and 60002 and because the dialplan-expansion command is configured to expand 6.... to 4085555...., one each for 4085550001 and 4085550002. The latter two dial peers will not appear in the running configuration. Router# show dial-peer summary AD PRE PASS OUT TAG TYPE MIN OPER PREFIX DEST-PATTERN FER THRU SESS-TARGET STATT 20010 pots up up 60002$ 0 0 20011 pots up up 60001$ 0 9 20012 pots up up 5105555001$ 0 9 20013 pots up up 5105555002$ 0 0 Define Voice Translation Rules in Cisco CME 3.2 and Later Versions To configure translation rules for voice calls in Cisco CME 3.1 and earlier versions, see Cisco IOS Voice, Video, and FAX Configuration Guide. Note Before You Begin • SCCP support—Cisco CME 3.2 or a later version. Cisco Unified Communications Manager Express System Administrator Guide 454 Dial Plans Verify Dial Plan Patterns • SIP support—Cisco Unified CME 4.1 or a later version. • To define up to 100 translation rules per translation rule table—Cisco Unified CME 8.6 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. voice translation-rule number 4. rule precedence /match-pattern/ /replace-pattern/ 5. exit 6. voice translation-profile name 7. translate {called | calling| redirect-called | redirect-target} translation-rule-number 8. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Defines a translation rule for voice calls and enters voice translation-rule configuration mode. voice translation-rule number Example: Router(config)# voice translation-rule 1 Step 3 • number—Number that identifies the translation rule. Range: 1 to 2147483647. rule precedence /match-pattern/ Defines a translation rule. /replace-pattern/ Step 4 • precedence—Priority of the translation rule. Range: 1 to 100. Example: Router(cfg-translation-rule)# rule 1 /^9/ // Range limited to 15 maximum rules in CME 8.5 and earlier versions. Note • match-pattern—Stream Editor (SED) expression used to match incoming call information. The slash (/) is a delimiter in the pattern. • replace-pattern—SED expression used to replace the match pattern in the call information. The slash (/) is a delimiter in the pattern. Cisco Unified Communications Manager Express System Administrator Guide 455 Dial Plans Define Voice Translation Rules in Cisco CME 3.2 and Later Versions Command or Action Purpose exit Exits voice translation-rule configuration mode. Example: Router(cfg-translation-rule)# exit Step 5 Step 6 voice translation-profile name Defines a translation profile for voice calls. Example: Router(config)# voice translation-profile name1 • name—Name of the translation profile. Maximum length of the voice translation profile name is 31 alphanumeric characters. translate {called | calling| redirect-called Associates a translation rule with a voice translation profile. | redirect-target} translation-rule-number Step 7 • called—Associates the translation rule with called numbers. Example: Router(cfg-translation-profile)# translate called 1 • calling—Associates the translation rule with calling numbers. • redirect-called—Associates the translation rule with redirected called numbers. • redirect-target—Associates the translation rule with transfer-to numbers and call-forwarding final destination numbers. This keyword is supported by SIP phones in Cisco Unified CME 4.1 and later versions. • translation-rule-number—Reference number of the translation rule configured in Step 3, on page 455. Range: 1 to 2147483647. end Returns to privileged EXEC mode. Example: Router(cfg-translation-profile)# end Step 8 What to Do Next • To apply voice translation profiles to SCCP phones connected to Cisco Unified CME 3.2 or a later version, see Apply Voice Translation Rules on SCCP Phones in Cisco Unified CME 3.2 and Later Versions, on page 457. • To apply voice translation profiles toSIPphones connected to Cisco Unified CME 4.1 or a later version, see Apply Voice Translation Rules on SIP Phones in Cisco Unified CME 4.1 and Later, on page 459. • To apply voice translation profiles to SIP phones connected to Cisco CME 3.4 or Cisco Unified CME 4.0(x), see Apply Voice Translation Rules on SIP Phones Before Cisco Unified CME 4.1, on page 460. Cisco Unified Communications Manager Express System Administrator Guide 456 Dial Plans Define Voice Translation Rules in Cisco CME 3.2 and Later Versions Apply Voice Translation Rules on SCCP Phones in Cisco Unified CME 3.2 and Later Versions To apply a voice translation profile to incoming or outgoing calls to or from a directory number on a SCCP phone, perform the following steps. Before You Begin • Cisco CME 3.2 or a later version. • Voice translation profile containing voice translation rules to be applied must be already configured. For configuration information,see Define Voice Translation Rulesin Cisco CME 3.2 and Later Versions, on page 454. SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-dn tag 4. translation-profile {incoming | outgoing} name 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters ephone-dn configuration mode to create an extension (ephone-dn) for a Cisco Unified IPphone line, an intercom line, a paging line, a voice-mail port, or a message-waiting indicator (MWI). ephone-dn tag Example: Router(config)# ephone-dn 1 Step 3 • tag—Unique sequence number that identifies this ephone-dn during configuration tasks. Range is 1 to the maximum number of ephone-dns allowed on the router platform. See the CLI help for the maximum value for this argument. Assigns a translation profile for incoming or outgoing call legs to or from Cisco Unified IP phones. translation-profile {incoming | outgoing} name Step 4 Cisco Unified Communications Manager Express System Administrator Guide 457 Dial Plans Apply Voice Translation Rules on SCCP Phones in Cisco Unified CME 3.2 and Later Versions Command or Action Purpose Example: Router(config-ephone-dn)# translation-profile outgoing name1 • You can also use an ephone-dn template to apply this command to one or more directory numbers. If you use an ephone-dn template to apply a command and you use the same command in ephone-dn configuration mode for the same directory number, the value that you set in ephone-dn configuration mode has priority. end Returns to privileged EXEC mode. Example: Router(config-ephone-dn)# end Step 5 What to Do Next If you are done modifying parameters for phones in Cisco Unified CME, generate a new configuration file and restart the phones. See Generate Configuration Files for Phones, on page 388. Apply Translation Rules on SCCP Phones Before Cisco Unified CME 3.2 To apply a translation rule to an individual directory number in Cisco CME 3.1 and earlier versions, perform the following steps. Before You Begin Translation rule to be applied must be already configured by using the translation-rule and rule commands. For configuration information, see Cisco IOS Voice, Video, and FAX Configuration Guide. SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-dn tag 4. translate {called | calling} translation-rule-tag 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. Cisco Unified Communications Manager Express System Administrator Guide 458 Dial Plans Apply Translation Rules on SCCP Phones Before Cisco Unified CME 3.2 Command or Action Purpose configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters ephone-dn configuration mode to create directory number for a Cisco Unified IP phone line, an intercom line, a paging line, a voice-mail port, or a message-waiting indicator (MWI). ephone-dn tag Example: Router(config)# ephone-dn 1 Step 3 translate {called | calling} Specifies rule to be applied to the directory number being configured. translation-rule-tag Step 4 • translation-rule-tag—Reference number of previously configured translation rule. Range: 1 to 2147483647. Example: Router(config-ephone-dn)# translate called 1 • You can use an ephone-dn template to apply this command to one or more directory numbers. If you use an ephone-dn template to apply a command to a directory number and you also use the same command in ephone-dn configuration mode for the same directory number, the value that you set in ephone-dn configuration mode has priority. end Exits configuration mode and enters privileged EXEC mode. Example: Router(cfg-translation-profile)# end Step 5 What to Do Next If you are done modifying parameters for phones in Cisco Unified CME, generate a new configuration file and restart the phones. See Generate Configuration Files for Phones, on page 388. Apply Voice Translation Rules on SIP Phones in Cisco Unified CME 4.1 and Later To apply a voice translation profile to incoming calls to a directory number on a SIP phone, perform the following steps. Before You Begin • Cisco Unified CME 4.1 or a later version. • Voice translation profile containing voice translation rules to be applied must be already configured. For configuration information,see Define Voice Translation Rulesin Cisco CME 3.2 and Later Versions, on page 454. Cisco Unified Communications Manager Express System Administrator Guide 459 Dial Plans Apply Voice Translation Rules on SIP Phones in Cisco Unified CME 4.1 and Later SUMMARY STEPS 1. enable 2. configure terminal 3. voice register dn dn-tag 4. translation-profile incoming name 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register dn configuration mode to define a directory number for a SIP phone, intercom line, voice port, or a message-waiting indicator (MWI). voice register dn dn-tag Example: Router(config)# voice register dn 1 Step 3 Assigns a translation profile for incoming call legs to this directory number. translation-profile incoming name Example: Router(config-register-dn)# translation-profile incoming name1 Step 4 end Returns to privileged EXEC mode. Example: Router(config-register-dn)# end Step 5 What to Do Next If you are done modifying parameters for phones in Cisco Unified CME, generate a new configuration file and restart the phones. See Generate Configuration Profiles for SIP Phones, on page 391. Apply Voice Translation Rules on SIP Phones Before Cisco Unified CME 4.1 To apply an already-configured voice translation rule to modify the number dialed by extensions on a SIP phone, perform the following steps. Cisco Unified Communications Manager Express System Administrator Guide 460 Dial Plans Apply Voice Translation Rules on SIP Phones Before Cisco Unified CME 4.1 Before You Begin • Cisco CME 3.4 or a later version. • Voice translation rule to be applied must be already configured. For configuration information, see Define Voice Translation Rules in Cisco CME 3.2 and Later Versions, on page 454. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register pool pool-tag 4. translate-outgoing {called | calling} rule-tag 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register pool configuration mode to set phone-specific parameters for SIP phones. voice register pool pool-tag Example: Router(config)# voice register pool 3 Step 3 Specifies an already configured voice translation rule to be applied to SIP phone being configured. translate-outgoing {called | calling} rule-tag Example: Router(config-register-pool)# translate-outgoing called 1 Step 4 Exits configuration mode and enters privileged EXEC mode. end Example: Router(config-register-global)# end Step 5 Cisco Unified Communications Manager Express System Administrator Guide 461 Dial Plans Apply Voice Translation Rules on SIP Phones Before Cisco Unified CME 4.1 What to Do Next If you are done modifying parameters for phones in Cisco Unified CME, generate a new configuration file and restart the phones. See Generate Configuration Profiles for SIP Phones, on page 391. Verify Voice Translation Rules and Profiles To verify voice translation profiles, and rules, perform the following steps. SUMMARY STEPS 1. show voice translation-profile [name] 2. show voice translation-rule [number] 3. test voice translation-rule number DETAILED STEPS Step 1 show voice translation-profile [name] This command displays the configuration of one or all translation profiles. Example: Router# show voice translation-profile profile-8415 Translation Profile: profile-8415 Rule for Calling number: 4 Rule for Called number: 1 Rule for Redirect number: 5 Rule for Redirect-target number: 2 Step 2 show voice translation-rule [number] This command displays the configuration of one or all translation rules. Example: Router# show voice translation-rule 6 Translation-rule tag: 6 Rule 1: Match pattern: 65088801.. Replace pattern: 6508880101 Match type: none Replace type: none Match plan: none Replace plan: none Step 3 test voice translation-rule number This command enables you to test your translation rules. Example: Router(config)# voice translation-rule 5 Router(cfg-translation-rule)# rule 1 /201/ /102/ Router(cfg-translation-rule)# exit Router(config)# exit Cisco Unified Communications Manager Express System Administrator Guide 462 Dial Plans Verify Voice Translation Rules and Profiles Router# test voice translation-rule 5 2015550101 Matched with rule 5 Original number:2015550101 Translated number:1025550101 Original number type: none Translated number type: none Original number plan: none Translated number plan: none Activate Secondary Dial Tone For SCCP Phones To activate a secondary dial tone after a phone user dials the specified number, perform the following steps. Before You Begin • Cisco CME 3.0 or a later version. • PSTN access prefix must be configured for outbound dial peer. SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. secondary-dialtone digit-string 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 3 Step 4 secondary-dialtone digit-string Activates a secondary dial tone when digit-string is dialed. Cisco Unified Communications Manager Express System Administrator Guide 463 Dial Plans Activate Secondary Dial Tone For SCCP Phones Command or Action Purpose Example: Router(config-telephony)# secondary-dialtone 9 • digit-string—String of up to 32 digits that, when dialed, activates a secondary dial tone. Typically, the digit-string is a predefined PSTN access prefix. end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 5 Activate Secondary Dial Tone for SIP Phones To activate a secondary dial tone after a phone user dials the specified number, perform the following steps. Before You Begin • Cisco Unified CME 11.6 or later for SIP phones. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register dialplan tag 4. type 7940-7960-others 5. pattern tag string 6. voice register pool tag 7. dialplan tag 8. voice register global 9. create profile 10. voice register pool tag 11. reset 12. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. Cisco Unified Communications Manager Express System Administrator Guide 464 Dial Plans Activate Secondary Dial Tone for SIP Phones Command or Action Purpose configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 voice register dialplan tag Enters voice register dialplan configuration mode. Example: Router(config)# voice register dialplan 1 • tag—Range for dialplan tag is 1 to 24. type 7940-7960-others Specifies the phone type assigned. Example: Router(config-register-dialplan)# type 7940-7960-others Step 4 Specifiesthe pattern to be matched while dialing from phone. Range is 1 to 24. pattern tag string Example: Router(config-register-dialplan)# pattern 1 30, Step 5 • tag—Range for pattern tag is 1 to 24. • string—It is the pattern to be matched while dialing from phone. This string is represented as WORD and the value of this string can be a combination of [0-9.*#,]. Defines the voice register pool tag, and enters the voice register pool configuration mode. voice register pool tag Example: Router(config-register-dialplan)# voice register pool 1 Step 6 dialplan tag Specifies the dialplan to be attached to the pool. Example: Router(config-register-pool)# dialplan 1 Step 7 voice register global Enters voice register global configuration mode. Example: Router(config-register-pool)# voice register global Step 8 create profile Creates the XML configuration files for the phone. Example: Router(config-register-global)# create profile Step 9 Cisco Unified Communications Manager Express System Administrator Guide 465 Dial Plans Activate Secondary Dial Tone for SIP Phones Command or Action Purpose Defines the voice register pool tag, and enters the voice register pool configuration mode. voice register pool tag Example: Router(config-register-global)# voice register pool 1 Step 10 reset Resets the phone for the phone configurations to be applied. Example: Router(config-register-pool)# reset Step 11 end Returns to privileged EXEC mode. Example: Router(config-register-pool)# end Step 12 Define Translation Rules for Callback-Number on SIP Phones Before You Begin • To define up to 100 translation rules per translation rule table—Cisco Unified CME 8.6 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. voice translation-rule number 4. rule precedence | match-pattern | replace-pattern| 5. exit 6. voice translation-profile name 7. translate {callback-number | called| calling | redirect-called| redirect-target} translation-rule-number 8. exit 9. voice register pool phone-tag 10. number tag dn dn-tag 11. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Cisco Unified Communications Manager Express System Administrator Guide 466 Dial Plans Define Translation Rules for Callback-Number on SIP Phones Command or Action Purpose Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Defines a translation rule for voice calls and enters voice translation-rule configuration mode. voice translation-rule number Example: Router(config)# voice translation-rule 10 Step 3 • number—Number that identifies the translation rule. Range: 1 to 2147483647. rule precedence | match-pattern | Defines a translation rule. replace-pattern| Step 4 • precedence—Priority of the translation rule. Range: 1 to 100. Example: Router(cfg-translation-rule)# rule 1 /^9/ // Range limited to 15 maximum rules in CME 8.5 and earlier versions. Note • match-pattern—Stream Editor (SED) expression used to match incoming call information. The slash (/) is a delimiter in the pattern. • replace-pattern—SED expression used to replace the match pattern in the call information. The slash (/) is a delimiter in the pattern. exit Exits voice translation-rule configuration mode. Example: Router(cfg-translation-rule)# exit Step 5 Step 6 voice translation-profile name Defines a translation profile for voice calls. Example: Router(config)# voice translation-profile eastern • name—Name of the translation profile. Maximum length of the voice translation profile name is 31 alphanumeric characters. translate {callback-number | called| calling Associates a translation rule with a voice translation profile. | redirect-called | redirect-target} translation-rule-number Step 7 • callback-number—Associates the translation rule with the callback-number. Example: Router(cfg-translation-profile)# translate callback-number 10 • called—Associates the translation rule with called numbers. • calling—Associates the translation rule with calling numbers. • redirect-called—Associates the translation rule with redirected called numbers. Cisco Unified Communications Manager Express System Administrator Guide 467 Dial Plans Define Translation Rules for Callback-Number on SIP Phones Command or Action Purpose • redirect-target—Associates the translation rule with transfer-to numbers and call-forwarding final destination numbers. This keyword is supported by SIP phones in Cisco Unified CME 4.1 and later versions. • translation-rule-number—Reference number of the translation rule configured in Step 3, on page 467. Range: 1 to 2147483647 exit Exits voice translation-profile configuration mode. Example: Router(cfg-translation-profile))# exit Step 8 Enters voice register pool configuration mode to set phone-specific parameters for a SIP phone. voice register pool phone-tag Example: Router(config)# voice register pool 3 Step 9 Step 10 number tag dn dn-tag Associates a directory number with the SIP phone being configured. Example: Router(config-register-pool)# number 1 dn 17 • dn dn-tag—identifies the directory number for this SIP phone as defined by the voice register dn command. end Returns to privileged EXEC mode. Example: Router(config-translation-profile)# end Step 11 The following examples show translation rules defined for callback-number: ! ! voice service voip ip address trusted list ipv4 20.20.20.1 media flow-around allow-connections sip to sip ! ! voice translation-rule 10 ! ! voice translation-profile eastcoast ! voice translation-profile eastern translate callback-number 10 ! What to Do Next • To apply voice translation profiles toSIPphones connected to Cisco Unified CME 4.1 or a later version, see Apply Voice Translation Rules on SIP Phones in Cisco Unified CME 4.1 and Later, on page 459. Cisco Unified Communications Manager Express System Administrator Guide 468 Dial Plans Define Translation Rules for Callback-Number on SIP Phones Configuration Examples for Dial Plan Features Example for Configuring Secondary Dial Tone on SCCP Phones telephony-service fxo hook-flash load 7910 P00403020214 load 7960-7940 P00305000600 load 7914 S00103020002 load 7905 CP7905040000SCCP040701A load 7912 CP7912040000SCCP040701A max-ephones 100 max-dn 500 ip source-address 10.153.233.41 port 2000 max-redirect 20 no service directed-pickup timeouts ringing 10 system message XYZ Company voicemail 7189 max-conferences 8 gain -6 moh music-on-hold.au web admin system name admin1 password admin1 dn-webedit time-webedit ! ! ! secondary-dialtone 9 Example for Configuring Secondary Dial Tone on SIP Phones A secondary dial tone is played on the phone when comma (',') is found in the pattern. In this example, secondary dial tone is played after the digit 50. voice register dialplan 1 type 7940-7960-others pattern 1 50, voice register pool 1 busy-trigger-per-button 2 id mac 0C11.6780.52A3 type 7841 number 1 dn 1 dialplan 1 dtmf-relay rtp-nte username cisco1 password cisco codec g711ulaw no vad provision-tag 1 Example for Configuring Voice Translation Rules In the following configuration examples, if a user on Cisco Unified CME 1 dials 94155550100, the call matches on dial peer 9415 and uses translation profile profile-9415. The called number is translated from 94155550100 to 4155550100, as specified by the translate called command using translation rule 1. Cisco Unified Communications Manager Express System Administrator Guide 469 Dial Plans Configuration Examples for Dial Plan Features If a user on Cisco Unified CME 1 calls a phone on Cisco Unified CME 2 by dialing 5105550120, and the call forward number is 94155550100, Cisco Unified CME 1 attempts to forward the call to 94155550100. A 302 message is then sent to Cisco Unified CME 1 with the “Contact:” field translated to 4155550100. When the 302 reaches Cisco Unified CME 1, it matches the To: field in the 302 message (5105550120) with dial peer 510. It does incoming translation from 4155550100 to 84155550100, and an INVITE with 84155550100 is sent, which matches dial-peer 8415. Figure 14: Translation Rules in SIP Call Transfer Cisco Unified CME 1 with 408555.... dialplan-pattern Cisco Unified CME 2 with 510555.... dialplan-pattern dial-peer voice 8415 voip translation-profile outgoing profile-8415 destination-pattern 8415555.... session protocol sipv2 session target ipv4:10.4.187.177 codec g711ulaw dial-peer voice 510 voip translation-profile incoming profile-510 destination-pattern 510555.... session protocol sipv2 session target ipv4:10.4.187.188 codec g711ulaw voice translation-profile profile-8415 translate called 1 translate redirect-target 2 voice translation-profile profile-510 translate called 3 voice translation-rule 1 rule 1 /^9415/ /415/ voice translation-rule 2 rule 2 /^415/ /9415/ voice translation-rule 3 rule 1 /^8415/ /415/ dial-peer voice 9415 voip translation-profile outgoing profile-9415 destination-pattern 9415555.... session protocol sipv2 session target ipv4:10.4.187.177 codec g711ulaw voice translation-profile profile-9415 translate called 1 translate redirect-target 1 voice translation-rule 1 rule 1 /^9415/ /415/ Cisco Unified Communications Manager Express System Administrator Guide 470 Dial Plans Example for Configuring Voice Translation Rules Feature Information for Dial Plan Features The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Table 33: Feature Information for Dialing Plan Features Feature Name Cisco Unified CME Versions Feature Information Added support for dial plan pattern expansion for call forward and call transfer when the forward or transfer-to target is an individual abbreviated SIP extension or an extension that appear on a SIP phone. Dial Plan Pattern 4.0 Strips leading digit pattern from extension number when expanding an extension to an E.164 telephone number. The length of the extension pattern must equal the value configured for the extension-length argument. 2.1 Adds a prefix to extensions to transform them into E.164 numbers. 1.0 Added support for E.164 enhancements. E.164 Enhancements 8.5 Support for Secondary Dial Tone on SIP phones. Secondary Dial Tone 11.6 Support for secondary dial tone after dialing specified number string. 3.0 Cisco Unified Communications Manager Express System Administrator Guide 471 Dial Plans Feature Information for Dial Plan Features Feature Name Cisco Unified CME Versions Feature Information Added support for an increased number of translation rules per translaiton table. Old value is 15 maximum, new value is 100 maximum. Voice Translation Rules 8.6 Added support for voice translation profiles for incoming call legs to a directory number on a SIP phone. 4.1 Added support for voice translation rules to modify the number dialed by extensions on a SIP phone. 3.4 Adds, removes, or transforms digits for calls going to or originating from specified ephone-dns. 3.2 Cisco Unified Communications Manager Express System Administrator Guide 472 Dial Plans Feature Information for Dial Plan Features CHAPTER 13 Transcoding Resources This chapter describesthe transcoding support available in Cisco Unified Communications Manager Express (Cisco Unified CME). Note • To configure a DSP farm profile for multi-party ad hoc and meet-me conferencing in Cisco Unified CME 4.1 and later versions, see Meet-Me Conferencing in Cisco Unified CME 4.1 and Later versions, on page 1373 and Meet-Me Conferencing in Cisco Unified CME 11.7 and Later Versions, on page 1374. • To configure DSP farms for meet-me conferencing in Cisco CME 3.2 to Cisco Unified CME 4.0. see Meet-Me Conferencing in Cisco CME 3.2 to Cisco Unified CME 4.0, on page 1375. • Prerequisites for Configuring Transcoding Resources, page 473 • Restrictions for Configuring Transcoding Resources, page 474 • Information About Transcoding Resources, page 474 • Configure Transcoding Resources, page 479 • Configuration Examples for Transcoding Resources, page 508 • Where to go Next, page 510 • Feature Information for Transcoding Resources, page 510 Prerequisites for Configuring Transcoding Resources • Cisco Unified CME 3.2 or a later version. • Cisco Unified CME 11.6 or later versions for LTI-based transcoding, supported on Cisco 4000 Series Integrated Services Router (ISR). Cisco Unified Communications Manager Express System Administrator Guide 473 Restrictions for Configuring Transcoding Resources • Before Cisco CME 3.2, only G.729 is supported for two-party voice calls. • In Cisco CME 3.2 to Cisco Unified CME 4.0, transcoding between G.711 and G.729 does not support the following: ◦Meet-me conferencing ◦Multiple-party ad-hoc conferencing ◦Transcoding security • For Cisco Unified CME Release 11.6, hardware conferencing is notsupported with LTI-based transcoding on Cisco 4000 Series Integrated Services Router (ISR). • In Unified CME 11.6, SCCP based transcoding is not supported. Information About Transcoding Resources Transcoding Support Transcoding compresses and decompresses voice streams to match endpoint-device capabilities. Transcoding is required when an incoming voice stream is digitized and compressed (by means of a codec) to save bandwidth, and the local device does not support that type of compression. Cisco Unified CME 3.2 and later versions support transcoding between G.711 and G.729 codecs for the following features: • Ad hoc conferencing—One or more remote conferencing parties uses G.729. • Call transfer and forward—One leg of a Voice over IP (VoIP)-to-VoIP hairpin call uses G.711 and the other leg uses G.729. A hairpin call is an incoming call that is transferred or forwarded over the same interface from which it arrived. • Cisco Unity Express or Cisco Unity Express Virtual—An H.323 or SIP call using G.729 is forwarded to Cisco Unity Express or Cisco Unity Express Virtual. Cisco Unity Express or Cisco Unity Express Virtual supports only G.711, so G.729 must be transcoded. From Cisco Unified CME Release 11.6 onwards, SIP calls coming to Cisco Unity Express or Cisco Unity Express Virtual is supported on Cisco 4000 Series ISR routers using the LTI transcoding infrastructure.For more information on configuring LTI transcoding on Cisco Unified CME,see Configure LTI-based Transcoding, on page 506. • Music on hold (MOH)—The phone receiving MOH is part of a system that uses G.729, G.722, or internet Low Bitrate Codec (iLBC). When the G.711 MOH is transcoded into G.729, it results in a poorer quality sound due to the lower compression of G.729. From Cisco Unified CME Release 11.7 onwards, Music on Hold is supported on Cisco 4000 Series ISR routers using the LTI transcoding infrastructure. For more information on configuring LTI transcoding on Cisco Unified CME, see Configure LTI-based Transcoding, on page 506. Cisco Unified Communications Manager Express System Administrator Guide 474 Transcoding Resources Restrictions for Configuring Transcoding Resources Each of the preceding call situations is illustrated in Figure 15: Three-Way Conferencing, Call Transfer and Forward, Cisco Unity Express, and MOH Between G.711 and G.729, on page 475. Figure 15: Three-Way Conferencing, Call Transfer and Forward, Cisco Unity Express, and MOH Between G.711 and G.729 Transcoding is facilitated through DSPs, which are located in network modules. All network modules have single in-line memory module (SIMM) sockets or packet voice/data modules (PVDM) slots that each hold a Packet Voice DSP Module (PVDM). Each PVDM holds DSPs. A router can have multiple network modules. Cisco Unified CME routers and external voice routers on the same LAN must be configured with digitalsignal processors (DSPs) that support transcoding. DSPs reside either directly on a voice network module, such as the NM-HD-2VE, on PVDM2s that are installed in a voice network module, such as the NM-HDV2, or on PVDM2s that are installed directly onto the motherboard, such as on the Cisco 2800 and 3800 series voice gateway routers. • DSPs on the NM-HDV, NM-HDV2, NM-HD-1V, NM-HD-2V, and NM-HD-2VE can be configured for transcoding. • PVDM2-xx on the Cisco 2800 series and the Cisco 3800 series motherboards can also be configured for transcoding. Transcoding of G.729 calls to G.711 allows G.729 calls to participate in existing G.711 software-based, three-party conferencing, thus eliminating the need to divide DSPs between transcoding and conferencing. Cisco Unified Communications Manager Express System Administrator Guide 475 Transcoding Resources Transcoding Support Figure 16: NM-HDV Supports up toFivePVDMs, on page 476 shows an NM-HDV with fiveSIMM sockets or PVDM slots that each hold a 12-Channel PVDM (PVDM-12). Each PVDM-12 holds three TI 549 DSPs. Each DSP supports four channels. Figure 16: NM-HDV Supports up to Five PVDMs Cisco Unified Communications Manager Express System Administrator Guide 476 Transcoding Resources Transcoding Support Use DSP resources to provide voice termination of the digital voice trunk group or resources for a DSP farm. DSP resources available for transcoding and not used for voice termination are referred to as a DSP farm. Figure 17: DSP Farm, on page 477 shows a DSP farm managed by Cisco Unified CME. Figure 17: DSP Farm Local Transcoding Interface (LTI) Based Transcoding From Cisco Unified CME Release 11.6 onwards, Local Transcoding Interface (LTI) based transcoding is supported on Cisco 4000 series ISR. LTI includes an internal API that accesses digital signal processor (DSP) resources. This API does not require the use of Skinny Client Control Protocol (SCCP) based configuration for transcoding to work. Cisco Unified Communications Manager Express System Administrator Guide 477 Transcoding Resources Transcoding Support LTI-based transcoding is an alternative to SCCP-based transcoding. The LTI-based transcoding configures transcoding functionality only on the specific Unified CME router. Unlike theSCCP-based transcoding, other Unified CME routers cannot leverage the transcoding capabilities configured on a specific Unified CME router. That is, transcoding resources (DSPFARM) are required to be co-located with Unified CME router for LTI-based configuration to work. When both LTI-based and SCCP-based transcoding are configured, LTI takes precedence. With LTI-based transcoding, internal APIs are used to access DSPresourcesfor transcoding. The TCPsockets are not opened and no registration is used. Also, you need to configure only the DSPFARM profile configuration. Voice Class Codec (VCC) is supported with LTI-based Transcoding on Cisco 4000 Series ISR, and is an optional configuration. A VCC defines the codec preference order. When a voice class codec is applied to a dial peer, the preference order defined in the voice class codec is followed. LTI infrastructure supports the features SIP-to-SIP line to trunk transcoding, DTMF Interworking (with in-band on the trunk and rtp-nte on the line), and mid-call transcoder invocation and deletion with call transfer. Features such as Shared Line, Call Park, Call Pickup, iDivert, and so on are not supported with LTI-based transcoding. Transcoding When a Remote Phone Uses G.729r8 A situation in which transcoding resources may be used is when you use the codec command to select the G.729r8 codec to help save network bandwidth for a remote IP phone. If a conference is initiated, all phones in the conference switch to G.711 mu-law. To allow the phone to retain its G.729r8 codec setting when joined to a conference, you can use the codec g729r8 dspfarm-assist command to specify that this phone’s calls should use the resources of a DSP farm for transcoding. For example, there are two remote phones (A and B) and a local phone (C) that initiates a conference with them. Both A and B are configured to use the G.729r8 codec with the assistance of the DSP-farm transcoder. In the conference, the call leg from C to the conference usesthe G.711 mu-law codec, and the call legsfrom A and B to the Cisco Unified CME router use the G.729r8 codec. Consider your options carefully when deciding to use the codec g729r8dspfarm-assist command. The benefit isthat it allows callsto use the G.729r8 codec on the call leg between the IPphone and the Cisco Unified CME router, which saves network bandwidth. The disadvantage is that for situations requiring G.711 codecs, such as conferencing and Cisco Unity Express, DSP resources that are possibly scarce are used to transcode the call, and delay is introduced while voice is shuttled to and from the DSP. In addition, the overuse of this feature can mask configuration errors in the codec selection mechanisms involving dial peers and codec lists. Therefore, we recommend using the codec g729r8 dspfarm-assist command sparingly and only when absolutely required for bandwidth savings or when you know the phone will be participating very little, if at all, in calls that require a G.711 codec. Because of how Cisco Unified CME uses voice channels withSkinny Client ControlProtocol (SCCP) endpoints, you must configure at least two available transcoding sessions when establishing a call that requirestranscoding configured with the codec g729r8 dspfarm-assist command. Only one session is used after the voice path is established with transcoding. However, during theSCCP manipulations, a temporary session may be allocated. If this temporary session cannot be allocated, the transcoding request is not honored, and the call continues with the G.711 codec. If the codec g729r8 dspfarm-assist command is configured for a phone and a DSP resource is not available when needed for transcoding, a phone registered to the local Cisco Unified CME router will use G.711 instead of G.729r8. This is not true for nonSCCP call legs; if DSP resources are not available for the transcoding required for a conference, for example, the conference is not created. Cisco Unified Communications Manager Express System Administrator Guide 478 Transcoding Resources Transcoding When a Remote Phone Uses G.729r8 Secure DSP Farm Transcoding Cisco Unified CME usesthe secure transcoding DSPfarm capability only in the case described in Transcoding When a RemotePhone Uses G.729r8, on page 478. If a call using the codec g729r8dspfarm-assist command is secure, Cisco Unified CME looks for a secure transcoding resource. If it cannot find one, transcoding is not done. If the call is not secure, Cisco Unified CME looks for a nonsecure transcoding resource. If it cannot find one, Cisco Unified CME looks for a secure transcoding resource. Even if Cisco Unified CME uses a secure transcoding resource, the call is not secure, and a more expensive secure DSP Farm resource is not needed for a nonsecure call because Cisco Unified CME cannot find a less expensive nonsecure transcoder. Configure Transcoding Resources This section contains the following tasks: Determine DSP Resource Requirements for Transcoding To determine if that there are enough DSPs available on your router for transcoding services, perform the following steps. Step 1 Use the show voice dsp command to display current status of digital signal processor (DSP) voice channels. Step 2 Use the show sdspfarm sessions command to display the number of transcoder sessions that are active. Step 3 Use the show sdspfarm units command to display the number of DSP farms that are configured. Provision Network Modules or PVDMs for Transcoding DSPs can reside directly on any one of the following: • A voice network module, such as the NM-HD-2VE, • PVDM2sthat are installed in a voice network module,such asthe NM-HDV2. A single network module can hold up to five PVDMs. • PVDM2s that are installed directly onto the motherboard, such as on the Cisco 2800 and 3800 series voice gateway routers. You must determine the number ofPVDM2s or network modulesthat are required to support your conferencing and transcoding services and install the modules on your router. SUMMARY STEPS 1 Determine performance requirements. 2 Determine the number of DSPs that are required. 3 Determine the number of DSPs that are supportable Cisco Unified Communications Manager Express System Administrator Guide 479 Transcoding Resources Secure DSP Farm Transcoding 4 Verify your solution. 5 Install hardware. DETAILED STEPS Step 1 Determine the number of transcoding sessions that your router must support. Step 2 Determine the number of DSPsthat are required to support transcoding sessions.See Table 5 and Table 6 in the “Allocation of DSP Resources” section of the “Configuring Enhanced Conferencing and Transcoding for Voice Gateway Routers” chapter of the Cisco Unified Communications Manager and Cisco IOS Interoperability Guide. If voice termination is also required, determine the additional number of DSPs required. For example: 16 transcoding sessions (30-ms packetization) and 4 G.711 voice calls require two DSPs. Step 3 Determine the maximum number of NMs or NM farms that your router can support by using Table 4 in the “Allocation of DSP Resources” section of the “Configuring Enhanced Conferencing and Transcoding for Voice Gateway Routers” chapter of the Cisco Unified Communications Manager and Cisco IOS Interoperability Guide. Step 4 Ensure that your requirements fall within router capabilities, taking into account whether your router supports multiple NMs or NM farms. If necessary, reassess performance requirement. Step 5 Install PVDMs, NMs, and NM farms as needed. See the Connecting Voice Network Modules chapter in the Cisco Network Modules Hardware Installation Guide. What to Do Next Perform one of the following options, depending on the type of network module to be configured: • To set up DSP farms on NM-HDs and NM-HDV2s, see Configure DSP Farms for NM-HDs and NM-HDV2s, on page 481. • To set up DSP farms for NM-HDVs, see Configure DSP Farms for NM-HDVs, on page 485. Cisco Unified Communications Manager Express System Administrator Guide 480 Transcoding Resources Provision Network Modules or PVDMs for Transcoding Configure DSP Farms for NM-HDs and NM-HDV2s SUMMARY STEPS 1. enable 2. configure terminal 3. voice-card slot 4. dsp services dspfarm 5. exit 6. sccp local interface-type interface-number 7. sccp ccm ip-address identifier identifier-number 8. sccp 9. sccp ccm group group-number 10. bind interface interface-type interface-number 11. associate ccm identifier-number priority priority-number 12. associate profile profile identifier register device-name 13. keepalive retries number 14. switchover method [graceful | immediate] 15. switchback method{graceful | guardtimeout-guard-value | immediate |uptime uptime-timeout-value} 16. switchback interval seconds 17. exit 18. dspfarm profile profile-identifier transcode [security] 19. trustpoint trustpoint-label 20. codec codec-type 21. maximum sessions number 22. associate application sccp 23. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Cisco Unified Communications Manager Express System Administrator Guide 481 Transcoding Resources Configure DSP Farms for NM-HDs and NM-HDV2s Command or Action Purpose Enters voice-card configuration mode for the network module on which you want to enable DSP-farm services. voice-card slot Example: Router(config)# voice-card 1 Step 3 dsp services dspfarm Enables DSP-farm services for the voice card. Example: Router(config-voicecard)# dsp services dspfarm Step 4 exit Exits voice-card configuration mode. Example: Router(config-voicecard)# exit Step 5 Selects the local interface that the SCCP applications (transcoding and conferencing) should use to register with Cisco Unified CME. sccp local interface-type interface-number Example: Router(config)# sccp local FastEthernet 0/0 Step 6 • interface-type—Interface type that the SCCP application uses to register with Cisco Unified CME. The type can be an interface address or a virtual-interface address such as Ethernet. • interface-number—Interface number that theSCCPapplication uses to register with Cisco Unified CME. Step 7 sccpccm ip-addressidentifier identifier-number Specifies the Cisco Unified CME address. Example: Router(config)# sccp ccm 10.10.10.1 identifier 1 • ip-address—IP address of the Cisco Unified CME router. • identifier identifier-number—Number that identifies the Cisco Unified CME router. • Repeat this step to specify the address of a secondary Cisco Unified CME router. Enables SCCP and its associated transcoding and conferencing applications. sccp Example: Router(config)# sccp Step 8 Creates a Cisco Unified CME group and enters SCCP configuration mode for Cisco Unified CME. sccp ccm group group-number Example: Router(config)# sccp ccm group 1 Step 9 • group-number—Number that identifies the Cisco Unified CME group. A Cisco Unified CME group is a naming device under which data for the DSP farms is declared. Only one group is required. Note Cisco Unified Communications Manager Express System Administrator Guide 482 Transcoding Resources Configure DSP Farms for NM-HDs and NM-HDV2s Command or Action Purpose (Optional) Binds an interface to a Cisco Unified CME group so that the selected interface is used for all calls that belong to the profiles that are associated to this Cisco Unified CME group. bind interface interface-type interface-number Example: Router(config-sccp-ccm)# bind interface FastEthernet 0/0 Step 10 • This command is optional, but we recommend it if you have more than one profile or if you are on differentsubnets, to ensure that the correct interface is selected. Associates a Cisco Unified CME router with a group and establishes its priority within the group. associate ccm identifier-number priority priority-number Step 11 Example: Router(config-sccp-ccm)# associate ccm 1 priority 1 • identifier-number—Number that identifies the Cisco Unified CME router. See the sccp ccm command in Step 7, on page 482. • priority—The priority of the Cisco Unified CME router in the Cisco Unified CME group. Only one Cisco Unified CME group is possible. Default: 1. associate profile profile identifier register Associates a DSP farm profile with a Cisco Unified CME group. device-name Step 12 • profile-identifier—Number that identifies the DSPfarm profile. Example: Router(config-sccp-ccm)# associate profile 1 register mtp000a8eaca80 • device-name—MAC address with the “mtp” prefix added, where the MAC addressisthe burnt-in address of the physical interface that is used to register as the SCCP device. Sets the number of keepalive retries from SCCP to Cisco Unified CME. keepalive retries number Example: Router(config-sccp-ccm)# keepalive retries 5 Step 13 • number—Number of keepalive attempts. Range: 1 to 32. Default: 3. Sets the switchover method that the SCCP client uses when its communication link to the active Cisco Unified CME system goes down. switchover method [graceful | immediate] Example: Router(config-sccp-ccm)# switchover method immediate Step 14 • graceful—Switchover happens only after all the active sessions have been terminated gracefully. • immediate—Switches over to any one of the secondary Cisco Unified CME systems immediately. Sets the switch back method that the SCCP client uses when the primary or higher priority Cisco Unified CME becomes available again. switch back method {graceful | guard timeout-guard-value | immediate | uptime uptime-timeout-value} Step 15 Example: Router(config-sccp-ccm)# switchback method immediate • graceful—Switchback happens only after all the active sessions have been terminated gracefully. Cisco Unified Communications Manager Express System Administrator Guide 483 Transcoding Resources Configure DSP Farms for NM-HDs and NM-HDV2s Command or Action Purpose • guard timeout-guard-value—Switchback happens either when the active sessions have been terminated gracefully or when the guard timer expires, whichever happens first. Timeout value is in seconds. Range: 60 to 172800. Default: 7200. • immediate—Switches back to the higher order Cisco Unified CME immediately when the timer expires, whether there is an active connection or not. • uptime uptime-timeout-value—Initiates the uptime timer when the higher-order Cisco Unified CME system comes alive. Timeout value isin seconds. Range: 60 to 172800. Default: 7200. Sets the amount of time that the DSP farm waits before polling the primary Cisco Unified CME system when the current Cisco Unified CME switchback connection fails. switchback interval seconds Example: Router(config-sccp-ccm)# switchback interval 5 Step 16 • seconds—Timer value, in seconds. Range: 1 to 3600. Default: 60. exit Exits SCCP configuration mode. Example: Router(config-sccp-ccm)# exit Step 17 Enters DSP farm profile configuration mode and defines a profile for DSP farm services. dspfarm profile profile-identifier transcode [security] Step 18 Example: Router(config)# dspfarm profile 1 transcode security • profile-identifier—Number that uniquely identifies a profile. Range: 1 to 65535. • transcode—Enables profile for transcoding. • security—Enables secure DSP farm services. This keyword is supported in Cisco Unified CME 4.2 and later versions. trustpoint trustpoint-label (Optional) Associates a trustpoint with a DSP farm profile. Example: Router(config-dspfarm-profile)# trustpoint dspfarm Step 19 Step 20 codec codec-type Specifies the codecs supported by a DSP farm profile. Example: Router(config-dspfarm-profile)# codec g711ulaw • codec-type—Specifies the preferred codec. Type ? for a list of supported codecs. • Repeat this step for each supported codec. Cisco Unified Communications Manager Express System Administrator Guide 484 Transcoding Resources Configure DSP Farms for NM-HDs and NM-HDV2s Command or Action Purpose Specifies the maximum number of sessions that are supported by the profile. maximum sessions number Example: Router(config-dspfarm-profile)# maximum sessions 5 Step 21 • number—Number of sessions supported by the profile. Range: 0 to X. Default: 0. • The X value is determined at run time depending on the number of resources available with the resource provider. associate application sccp Associates SCCP with the DSP farm profile. Example: Router(config-dspfarm-profile)# associate application sccp Step 22 end Returns to privileged EXEC mode. Example: Router(config-dspfarm-profile)# end Step 23 What to Do Next • To register the DSP Farm to Cisco Unified CME in secure mode, see Register the DSP Farm with Cisco Unified CME 4.2 or a Later Version in Secure Mode, on page 496. Configure DSP Farms for NM-HDVs SUMMARY STEPS 1. enable 2. configure terminal 3. voice-card slot 4. dsp services dspfarm 5. exit 6. sccp local interface-type interface-number 7. sccp ccm ip-address priority priority-number 8. sccp 9. dsp farm transcoder maximum sessions number 10. dspfarm 11. end Cisco Unified Communications Manager Express System Administrator Guide 485 Transcoding Resources Configure DSP Farms for NM-HDVs DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice-card configuration mode and identifies the slot in the chassis in which the NM-HDV or NM-HDV farm is located. voice-card slot Example: Router(config)# voice-card 1 Step 3 dsp services dspfarm Enables DSP-farm services on the NM-HDV or NM-HDV farm. Example: Router(config-voicecard)# dsp services dspfarm Step 4 exit Returns to global configuration mode. Example: Router(config-voicecard)# exit Step 5 Selects the local interface that the SCCP applications (transcoding and conferencing) should use to register with Cisco Unified CME. sccp local interface-type interface-number Example: Router(config)# sccp local FastEthernet 0/0 Step 6 • interface-type—Interface type that the SCCP application uses to register with Cisco Unified CME. The type can be an interface address or a virtual-interface addresssuch as Ethernet. • interface-number—Interface number that theSCCPapplication uses to register with Cisco Unified CME. Step 7 sccp ccm ip-address priority priority-number Specifies the Cisco Unified CME address. Example: Router(config)# sccp ccm 10.10.10.1 priority 1 • ip-address—IP address of the Cisco Unified CME router. • priority priority—Priority of the Cisco Unified CME router relative to other connected routers. Range: 1 (highest) to 4 (lowest). Enables SCCP and its associated transcoding and conferencing applications. sccp Example: Router(config)# sccp Step 8 Cisco Unified Communications Manager Express System Administrator Guide 486 Transcoding Resources Configure DSP Farms for NM-HDVs Command or Action Purpose Specifies the maximum number of transcoding sessions to be supported by the DSPfarm. A DSPcan support up to four transcoding sessions. dsp farm transcoder maximum sessions number Example: Router(config)# dspfarm transcoder maximum sessions 12 Step 9 When you assign this value, take into account the number of DSPs allocated for conferencing services. Note dspfarm Enables the DSP farm. Example: Router(config)# dspfarm Step 10 end Returns to privileged EXEC mode. Example: Router(config)# end Step 11 Configure the Cisco Unified CME Router to Act as the DSP Farm Host Determine the Maximum Number of Transcoder Sessions To determine the maximum number of transcoder sessions that can occur at one time perform the following steps. Step 1 Use the dspfarm transcoder maximum sessions command to set the maximum number of transcoder sessions you have configured. Step 2 Use the show sdspfarm sessions command to display the number of transcoder sessions that are active. Step 3 Use the show sdspfarm units command to display the number of DSP farms that are configured. Step 4 Obtain the maximum number of transcoder sessions by multiplying the number of transcoder sessions from Step 2 (configured in Step 1 using the dspfarm transcoder maximum sessions command) by the number of DSP farms from Step 3. Set the Cisco Unified CME Router to Receive IP Phone Messages Note You can unregister all active calls’ transcoding streams with the sdspfarm unregister force command. Cisco Unified Communications Manager Express System Administrator Guide 487 Transcoding Resources Configure the Cisco Unified CME Router to Act as the DSP Farm Host Before You Begin Identify the MAC address of theSCCPclient interface.For example, if you have the following configuration: interface FastEthernet 0/0 ip address 10.5.49.160 255.255.0.0 . . . sccp local FastEthernet 0/0 sccp The show interface FastEthernet 0/0 command will yield a MAC address. In the following example, the MAC address of the Fast Ethernet interface is 000a.8aea.ca80: Router# show interface FastEthernet 0/0 . . . FastEthernet0/0 is up, line protocol is up Hardware is AmdFE, address is 000a.8aea.ca80 (bia 000a.8aea.ca80) SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. ip source-address ip-address [port port] [any-match | strict-match] 5. sdspfarm units number 6. sdspfarm transcode sessions number 7. sdspfarm tag number device-name 8. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 3 Enables a router to receive messages from Cisco Unified IP phones through the router's IP addresses and ports. ip source-address ip-address [port port] [any-match | strict-match] Step 4 Cisco Unified Communications Manager Express System Administrator Guide 488 Transcoding Resources Configure the Cisco Unified CME Router to Act as the DSP Farm Host Command or Action Purpose Example: Router(config-telephony)# ip source address 10.10.10.1 port 3000 • address—Range: 0 to 5. Default: 0. • port port—(Optional) TCP/IP port used for SCCP. Default: 2000. • any-match—(Optional) Disables strict IP address checking for registration. This is the default. • strict-match—(Optional) Requires strict IP address checking for registration. Specifies the maximum number of DSP farms that are allowed to be registered to the SCCP router. sdspfarm units number Example: Router(config-telephony)# sdspfarm units 4 Step 5 • number—Range: 0 to 5. Default: 0. Specifiesthe maximum number of transcodersessionsfor G.729 allowed by the Cisco Unified CME router. sdspfarm transcode sessions number Example: Router(config-telephony)# sdspfarm transcode sessions 40 Step 6 • One transcodersession consists of two transcoding streams between callers using transcode. Use the maximum number of transcoding sessions and conference calls that you want your router to support at one time. • number—See Determine the Maximum Number of Transcoder Sessions, on page 487. Range: 0 to 128. Default: 0. Permits a DSP farm unit to be registered to Cisco Unified CME and associates it with an SCCP client interface's MAC address. sdspfarm tag number device-name Example: Router(config-telephony)# sdspfarm tag 1 mtp000a8eaca80 Step 7 • Required only if you blocked automatic registration by using the auto-reg-ephone command. or Router(config-telephony)# sdspfarm tag 1 MTP000a8eaca80 • number—The tag number. Range: 1 to 5. • device-name—MAC address of theSCCPclient interface with the "MTP" prefix added. end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 8 Configure the Cisco Unified CME Router to Host a Secure DSP Farm You must configure the Media Encryption Secure Real-Time Transport Protocol (SRTP) feature in the Cisco Unified CME 4.2 and later versions, making it a secure Cisco Unified CME, before it can host a secure Cisco Unified Communications Manager Express System Administrator Guide 489 Transcoding Resources Configure the Cisco Unified CME Router to Act as the DSP Farm Host DSP farm. For information on configuring a secure Cisco Unified CME, see Configure Security, on page 597. Modify DSP Farms for NM-HDVs After Upgrading Cisco IOS Software To ensure continued support for existing DSP farms for NM-HDVs configured after upgrading the Cisco IOS software on your Cisco router, perform the following steps. Perform thistask if previously-configured DSPfarmsfor NM-HDVsfail to register to Cisco Unified CME after you upgrade the Cisco IOS software release. Note Before You Begin Confirm that device name for a dspfarm tag in telephony-service configuration is lower case by using the show-running configuration command. Example: Router#show-running configuration Building configuration... . . . ! telephony-service max-ephones 2 max-dn 20 ip source-address 142.103.66.254 port 2000 auto assign 1 to 2 system message Your current options sdspfarm units 2 sdspfarm transcode sessions 16 sdspfarm tag 1 mtp00164767cc20 !<===Device name is MAC address with lower-case “mtp” prefix . . . SUMMARY STEPS 1. enable 2. configure terminal 3. no sdspfarm tag number 4. sdspfarm tag number device-name 5. dspfarm 6. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Cisco Unified Communications Manager Express System Administrator Guide 490 Transcoding Resources Modify DSP Farms for NM-HDVs After Upgrading Cisco IOS Software Command or Action Purpose Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 no sdspfarm tag number Disables the DSP farm. Example: Router(config)# no sdspfarm tag 1 Step 3 Permits a digital-signal-processor (DSP) farm to be to registered to Cisco Unified CME and associates it with a SCCP client interface's MAC address. sdspfarm tag number device-name Example: Router(config)# sdspfarm tag 1 MTP00164767cc20 Step 4 • Required only if you blocked automatic registration by using the auto-reg-ephone command. • device-name—MAC address of the SCCP client interface with the "MTP" prefix added. dspfarm Enables the DSP farm. Example: Router(config)# dspfarm Step 5 end Returns to privileged EXEC mode. Example: Router(config)# end Step 6 Modify the Number of Transcoding Sessions for NM-HDVs SUMMARY STEPS 1. enable 2. configure terminal 3. no dspfarm 4. dspfarm transcoder maximum sessions number 5. dspfarm 6. end Cisco Unified Communications Manager Express System Administrator Guide 491 Transcoding Resources Modify the Number of Transcoding Sessions for NM-HDVs DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 no dspfarm Disables the DSP farm. Example: Router(config)# no dspfarm Step 3 Specifiesthe maximum number of transcoding sessions to be supported by the DSP farm. dspfarm transcoder maximum sessions number Example: Router(config)# dspfarm transcoder maximum sessions 12 Step 4 dspfarm Enables the DSP farm. Example: Router(config)# dspfarm Step 5 end Returns to privileged EXEC mode. Example: Router(config)# end Step 6 Tune DSP-Farm Performance on an NM-HDV SUMMARY STEPS 1. enable 2. configure terminal 3. sccp ip precedence value 4. dspfarm rtp timeout seconds 5. dspfarm connection interval seconds 6. end Cisco Unified Communications Manager Express System Administrator Guide 492 Transcoding Resources Tune DSP-Farm Performance on an NM-HDV DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 (Optional)Setsthe IPprecedence value to increase the priority of voice packets over connections controlled by SCCP. sccp ip precedence value Example: Router(config)# sccp ip precedence 5 Step 3 (Optional) Configuresthe Real-Time TransportProtocol (RTP) timeout interval if the error condition "RTPport unreachable" occurs. dspfarm rtp timeout seconds Example: Router(config)# dspfarm rtp timeout 60 Step 4 (Optional)Specifies how long to monitor RTPinactivity before deleting an RTP stream. dspfarm connection interval seconds Example: Router(config)# dspfarm connection interval 60 Step 5 end Returns to privileged EXEC mode. Example: Router(config)# end Step 6 Verify DSP Farm Operation To verify that the DSP farm is registered and running, perform the following steps in any order. Step 1 Use the show sccp[statistics| connections] command to display theSCCPconfiguration information and currentstatus. Example: Router# show sccp statistics SCCP Application Service(s) Statistics: Profile ID:1, Service Type:Transcoding TCP packets rx 7, tx 7 Unsupported pkts rx 1, Unrecognized pkts rx 0 Cisco Unified Communications Manager Express System Administrator Guide 493 Transcoding Resources Verify DSP Farm Operation Register tx 1, successful 1, rejected 0, failed 0 KeepAlive tx 0, successful 0, failed 0 OpenReceiveChannel rx 2, successful 2, failed 0 CloseReceiveChannel rx 0, successful 0, failed 0 StartMediaTransmission rx 2, successful 2, failed 0 StopMediaTransmission rx 0, successful 0, failed 0 Reset rx 0, successful 0, failed 0 MediaStreamingFailure rx 0 Switchover 0, Switchback 0 Use the show sccp connections command to display information about the connections controlled by the SCCP transcoding and conferencing applications. In the following example, the secure value of the stype field indicates that the connection is encrypted: Router# show sccp connections sess_id conn_id stype mode codec ripaddr rport sport 16777222 16777409 secure-xcode sendrecv g729b 10.3.56.120 16772 19534 16777222 16777393 secure-xcode sendrecv g711u 10.3.56.50 17030 18464 Total number of active session(s) 1, and connection(s) 2 Step 2 Use the show sdspfarm units command to display the configured and registered DSP farms. Example: Router# show sdspfarm units mtp-1 Device:MTP003080218a31 TCP socket:[2] REGISTERED actual_stream:8 max_stream 8 IP:10.10.10.3 11470 MTP YOKO keepalive 1 Supported codec:G711Ulaw G711Alaw G729a G729ab max-mtps:1, max-streams:40, alloc-streams:8, act-streams:2 Step 3 Use the show sdspfarm sessions command to display the transcoding streams. Example: Router# show sdspfarm sessions Stream-ID:1 mtp:1 10.10.10.3 18404 Local:2000 START usage:Ip-Ip codec:G711Ulaw64k duration:20 vad:0 peer Stream-ID:2 Stream-ID:2 mtp:1 10.10.10.3 17502 Local:2000 START usage:Ip-Ip codec:G729AnnexA duration:20 vad:0 peer Stream-ID:1 Stream-ID:3 mtp:1 0.0.0.0 0 Local:0 IDLE usage: codec:G711Ulaw64k duration:20 vad:0 peer Stream-ID:0 Stream-ID:4 mtp:1 0.0.0.0 0 Local:0 IDLE usage: codec:G711Ulaw64k duration:20 vad:0 peer Stream-ID:0 Stream-ID:5 mtp:1 0.0.0.0 0 Local:0 IDLE usage: codec:G711Ulaw64k duration:20 vad:0 peer Stream-ID:0 Stream-ID:6 mtp:1 0.0.0.0 0 Local:0 IDLE usage: codec:G711Ulaw64k duration:20 vad:0 peer Stream-ID:0 Stream-ID:7 mtp:1 0.0.0.0 0 Local:0 IDLE usage: Cisco Unified Communications Manager Express System Administrator Guide 494 Transcoding Resources Verify DSP Farm Operation codec:G711Ulaw64k duration:20 vad:0 peer Stream-ID:0 Stream-ID:8 mtp:1 0.0.0.0 0 Local:0 IDLE usage: codec:G711Ulaw64k duration:20 vad:0 peer Stream-ID:0 Step 4 Use the show sdspfarm sessions summary command to display a summary view the transcoding streams. Example: Router# show sdspfarm sessions summary max-mtps:2, max-streams:240, alloc-streams:40, act-streams:2 ID MTP State CallID confID Usage Codec/Duration ==== ===== ====== =========== ====== ============================= ============== 1 2 IDLE -1 0 G711Ulaw64k /20ms 2 2 IDLE -1 0 G711Ulaw64k /20ms 3 2 START -1 3 MoH (DN=3 , CH=1) FE=TRUE G729 /20ms 4 2 START -1 3 MoH (DN=3 , CH=1) FE=FALSE G711Ulaw64k /20ms 5 2 IDLE -1 0 G711Ulaw64k /20ms 6 2 IDLE -1 0 G711Ulaw64k /20ms 7 2 IDLE -1 0 G711Ulaw64k /20ms 8 2 IDLE -1 0 G711Ulaw64k /20ms 9 2 IDLE -1 0 G711Ulaw64k /20ms 10 2 IDLE -1 0 G711Ulaw64k /20ms 11 2 IDLE -1 0 G711Ulaw64k /20ms 12 2 IDLE -1 0 G711Ulaw64k /20ms 13 2 IDLE -1 0 G711Ulaw64k /20ms 14 2 IDLE -1 0 G711Ulaw64k /20ms 15 2 IDLE -1 0 G711Ulaw64k /20ms 16 2 IDLE -1 0 G711Ulaw64k /20ms 17 2 IDLE -1 0 G711Ulaw64k /20ms 18 2 IDLE -1 0 G711Ulaw64k /20ms 19 2 IDLE -1 0 G711Ulaw64k /20ms 20 2 IDLE -1 0 G711Ulaw64k /20ms 21 2 IDLE -1 0 G711Ulaw64k /20ms 22 2 IDLE -1 0 G711Ulaw64k /20ms 23 2 IDLE -1 0 G711Ulaw64k /20ms 24 2 IDLE -1 0 G711Ulaw64k /20ms 25 2 IDLE -1 0 G711Ulaw64k /20ms 26 2 IDLE -1 0 G711Ulaw64k /20ms 27 2 IDLE -1 0 G711Ulaw64k /20ms 28 2 IDLE -1 0 G711Ulaw64k /20ms 29 2 IDLE -1 0 G711Ulaw64k /20ms 30 2 IDLE -1 0 G711Ulaw64k /20ms 31 2 IDLE -1 0 G711Ulaw64k /20ms 32 2 IDLE -1 0 G711Ulaw64k /20ms 33 2 IDLE -1 0 G711Ulaw64k /20ms 34 2 IDLE -1 0 G711Ulaw64k /20ms 35 2 IDLE -1 0 G711Ulaw64k /20ms 36 2 IDLE -1 0 G711Ulaw64k /20ms Step 5 Use the show sdspfarm sessions active command to display the transcoding streams for all active sessions. Example: Router# show sdspfarm sessions active Stream-ID:1 mtp:1 10.10.10.3 18404 Local:2000 START usage:Ip-Ip codec:G711Ulaw64k duration:20 vad:0 peer Stream-ID:2 Stream-ID:2 mtp:1 10.10.10.3 17502 Local:2000 START usage:Ip-Ip codec:G729AnnexA duration:20 vad:0 peer Stream-ID:1 Step 6 Use the show sccp connections details command to display the SCCP connections details such as call-leg details. Cisco Unified Communications Manager Express System Administrator Guide 495 Transcoding Resources Verify DSP Farm Operation Example: Router# show sccp connections details bridge-info(bid, cid) - Normal bridge information(Bridge id, Calleg id) mmbridge-info(bid, cid) - Mixed mode bridge information(Bridge id, Calleg id) sess_id conn_id call-id codec pkt-period type bridge-info(bid, cid) mmbridge-info(bid, cid) 1 - 14 N/A N/A transmsp All RTPSPI Callegs N/A 1 2 15 g729a 20 rtpspi (4,14) N/A 1 1 13 g711u 20 rtpspi (3,14) N/A Total number of active session(s) 1, connection(s) 2, and callegs 3 Step 7 Use the debug sccp {all | errors | events | packets | parser} command to set debugging levels for SCCP and its applications. Step 8 Use the debug dspfarm {all | errors | events | packets} command to set debugging levels for DSP-farm service. Step 9 Use the debug ephone mtp command to enable Message Transfer Part (MTP) debugging. Use this debug command with the debug ephone mtp, debug ephone register, debug ephone state, and debug ephone pak commands. Register the DSP Farm with Cisco Unified CME 4.2 or a Later Version in Secure Mode The DSP farm can reside on the same router with the Cisco Unified CME or on a different router. Some of the steps in the following tasks are optional depending the location of the DSP farm. Obtain Digital Certificate from a CA Server The CA server can be the same router as the DSP farm. The DSP farm router can be configured as a CA server. The configuration steps below show how to configure a CA server on the DSP farm router. Additional configurations are required for configuring CA server on an external Cisco router or using a different CA server by itself. Configure a CA Server Skip this procedure if the DSP farm resides on the same router as the Cisco Unified CME. Proceed to the Create a Trustpoint, on page 499 section. Note The CA server automatically creates a trustpoint where the certificates are stored. The automatically created trustpoint stores the CA root certificate. Cisco Unified Communications Manager Express System Administrator Guide 496 Transcoding Resources Register the DSP Farm with Cisco Unified CME 4.2 or a Later Version in Secure Mode Before You Begin • Cisco Unified CME 4.2 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. crypto pki server label 4. database level complete 5. grant auto 6. database url root-url 7. no shutdown 8. exit 9. crypto pki trustpoint label 10. revocation-check crl 11. rsakeypair key-label DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Defines a label for the certificate server and enters certificate-server configuration mode. crypto pki server label Example: Router(config)# crypto pki server dspcert Step 3 • label—Name for CA certificate server. (Optional) Controls the type of data stored in the certificate enrollment database. The default if this command is not used is minimal. database level complete Example: Router(cs-server)# database level complete Step 4 • complete—In addition to the information given in the minimal and names levels, each issued certificate is written to the database. The complete keyword produces a large amount of information; so specify an external TFTP server in which to store the data using of the database url command. Note Cisco Unified Communications Manager Express System Administrator Guide 497 Transcoding Resources Register the DSP Farm with Cisco Unified CME 4.2 or a Later Version in Secure Mode Command or Action Purpose (Optional) Allows an automatic certificate to be issued to any requester. The recommended method and default if this command is not used is manual enrollment. grant auto Example: Router(cs-server)# grant auto Step 5 Use this command only during enrollment when testing and building simple networks. A security best practice is to disable this functionality using the no grant auto command after configuration so that certificates cannot be continually granted. Tip (Optional) Specifies the location where all database entries for the certificate server are to be written out. If this command is not specified, all database entries are written to NVRAM. database url root-url Example: Router(cs-server)# database url nvram: Step 6 • root-url—Location where database entries will be written out. The URL can be any URL that is supported by the Cisco IOS file system. If the CA is going to issue a large number of certificates, select an appropriate storage location like flash or other storage device to store the certificates. Note When the storage location chosen is flash and the file system type on this device is Class B (LEFS), make sure to check free space on the device periodically and use the squeeze command to free the space used up by deleted files. This process may take several minutes and should be done during scheduled maintenance periods or off-peak hours. Note Step 7 no shutdown (Optional) Enables the CA. Example: Router(cs-server)# no shutdown You should use this command only after you have completely configured the CA. Note exit Exits certificate-server configuration mode. Example: Router(cs-server)# exit Step 8 Step 9 crypto pki trustpoint label (Optional) Declares a trustpoint and enters ca-trustpoint configuration mode. Example: Router(config)# crypto pki trustpoint dspcert • label—Name for the trustpoint. Use this command and the enrollment url command if this CA is local to the Cisco Unified CME router. These commands are not needed for a CA running on an external router. The label has to be the same as the label in Step 3. Note (Optional) Checks the revocation status of a certificate and specifies one or more methods to check the status. If a second and third method are specified, each revocation-check crl Example: Router(ca-trustpoint)# revocation-check crl Step 10 method is used only if the previous method returns an error,such as a server being down. • crl—Certificate checking is performed by a certificate revocation list (CRL). This is the default behavior. Cisco Unified Communications Manager Express System Administrator Guide 498 Transcoding Resources Register the DSP Farm with Cisco Unified CME 4.2 or a Later Version in Secure Mode Command or Action Purpose Step 11 rsakeypair key-label (Optional) Specifies an RSA key pair to use with a certificate. Example: Router(ca-trustpoint)# rsakeypair caserver • key-label—Name of the key pair, which is generated during enrollment if it does not already exist or if the auto-enroll regenerate command is used. Multiple trustpoints can share the same key. Note Create a Trustpoint The trustpoint stores the digital certificate for the DSP farm. To create a trustpoint, perform the following procedure: Before You Begin • Cisco Unified CME 4.2 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. crypto pki trustpoint label 4. enrollment url ca-url 5. serial-number none 6. fqdn none 7. ip-address none 8. subject-name [x.500-name] 9. revocation-check none 10. rsakeypair key-label DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Cisco Unified Communications Manager Express System Administrator Guide 499 Transcoding Resources Register the DSP Farm with Cisco Unified CME 4.2 or a Later Version in Secure Mode Command or Action Purpose Declares the trustpoint that your RA mode certificate server should use and enters CA-trustpoint configuration mode. crypto pki trustpoint label Example: Router(config)# crypto pki trustpoint dspcert Step 3 • label—Name for the trustpoint and RA. Specifies the enrollment URL of the issuing CA certificate server (root certificate server). enrollment url ca-url Example: Router(ca-trustpoint)# enrollment url http://10.3.105.40:80 Step 4 • ca-url—URL of the router on which the root CA is installed. Specifies whether the router serial number should be included in the certificate request. serial-number none Example: Router(ca-trustpoint)# serial-number none Step 5 • none—Specifies that a serial number will not be included in the certificate request. Specifies a fully qualified domain name (FQDN) that will be included as "unstructuredName" in the certificate request. fqdn none Example: Router(ca-trustpoint)# fqdn none Step 6 • none—RouterFQDN will not be included in the certificate request. Specifies a dotted IP address or an interface that will be included as "unstructuredAddress" in the certificate request. ip-address none Example: Router(ca-trustpoint)# ip-address none Step 7 • none—Specifies that an IP address is not to be included in the certificate request. Step 8 subject-name [x.500-name] Specifies the subject name in the certificate request. Example: Router(ca-trustpoint)# subject-name cn=vg224, ou=ABU, o=Cisco Systems Inc. The example shows how to format the certificate subject name to be similar to that of an IP phones. Note (Optional) Checks the revocation status of a certificate and specifies one or more methods to check the status. If a second and third method are revocation-check none Example: Router(ca-trustpoint)# revocation-check none Step 9 specified, each method is used only if the previous method returns an error, such as a server being down. • none—Certificate checking is not required. Step 10 rsakeypair key-label (Optional) Specifies an RSA key pair to use with a certificate. Example: Router(ca-trustpoint)# rsakeypair dspcert • key-label—Name of the key pair, which is generated during enrollment if it does not already exist or if the auto-enroll regenerate command is used. Multiple trustpoints can share the same key. The key-label is the same as the label in Step 3. Note Cisco Unified Communications Manager Express System Administrator Guide 500 Transcoding Resources Register the DSP Farm with Cisco Unified CME 4.2 or a Later Version in Secure Mode Command or Action Purpose Authenticate and Enroll a Certificate with the CA Server Before You Begin • Cisco Unified CME 4.2 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. crypto pki authenticate trustpoint-label 4. crypto pki enroll trustpoint-label DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Retrievesthe CA certificate and authenticatesit. Checksthe certificate fingerprint if prompted. crypto pki authenticate trustpoint-label Example: Router(config)# crypto pki authenticate dspcert Step 3 • trustpoint-label—Trustpoint label. The trustpoint-label is the trustpoint label specified in the Create a Trustpoint, on page 499 section. Note Step 4 crypto pki enroll trustpoint-label Enrolls with the CA and obtains the certificate for this trustpoint. Example: Router(config)# crypto pki enroll dspcert • trustpoint-label—Trustpoint label. The trustpoint-label is the trustpoint label specified in the Create a Trustpoint, on page 499 section. Note Cisco Unified Communications Manager Express System Administrator Guide 501 Transcoding Resources Register the DSP Farm with Cisco Unified CME 4.2 or a Later Version in Secure Mode Copy the CA Root Certificate of the DSP Farm Router to the Cisco Unified CME Router The DSP farm router and Cisco Unified CME router exchanges certificates during the registration process. These certificates are digitally signed by the CA server of the respective router. For the routers to accept each others digital certificate, they should have the CA root certificate of each other. Manually copy the CA root certificate of the DSP farm and Cisco Unified CME router to each other. Before You Begin • Cisco Unified CME 4.2 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. crypto pki trustpoint label 4. enrollment terminal 5. crypto pki export trustpoint pem terminal 6. crypto pki authenticate trustpoint-label 7. You will be prompted to enter the CA certificate. Cut and paste the base 64 encoded certificate at the command line, then press Enter, and type "quit". The router prompts you to accept the certificate. Enter "yes" to accept the certificate. DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Declares the trustpoint that your RA mode certificate server should use and enters CA-trustpoint configuration mode. crypto pki trustpoint label Example: Router(config)# crypto pki trustpoint dspcert Step 3 • label—Name for the trustpoint and RA. The label isthe trustpoint labelspecified in the Create a Trustpoint, on page 499 section. Note enrollment terminal Specifies manual cut-and-paste certificate enrollment. Example: Router(ca-trustpoint)# enrollment terminal Step 4 Cisco Unified Communications Manager Express System Administrator Guide 502 Transcoding Resources Register the DSP Farm with Cisco Unified CME 4.2 or a Later Version in Secure Mode Command or Action Purpose Exports certificates and RSA keys that are associated with a trustpoint in a privacy-enhanced mail (PEM)-formatted file. crypto pki export trustpoint pem terminal Example: Router(ca-trustpoint)# crypto pki export dspcert pem terminal Step 5 Retrieves the CA certificate and authenticates it. Checks the certificate fingerprint if prompted. crypto pki authenticate trustpoint-label Example: Router(config)# crypto pki authenticate vg224 Step 6 • trustpoint-label—Trustpoint label. This command is optional if the CA certificate is already loaded into the configuration. Note Completes the copying of the CA root certificate of the DSP farm router to the Cisco Unified CME router. You will be prompted to enter the CA certificate. Cut and paste the base 64 encoded certificate at the command line, then press Enter, and type "quit". The Step 7 router prompts you to accept the certificate. Enter "yes" to accept the certificate. Copy CA Root Certificate of the Cisco Unified CME Router to the DSP Farm Router Repeat the steps in the Copy the CA Root Certificate of the DSP Farm Router to the Cisco Unified CME Router, on page 502 section in the opposite direction, that is, from Cisco Unified CME router to the DSPfarm router. Prerequisites • Cisco Unified CME 4.2 or a later version. Configure Cisco Unified CME to Allow the DSP Farm to Register Before You Begin • Cisco Unified CME 4.2 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. sdspfarm units number 5. sdspfarm transcode sessions number 6. sdspfarm tag number device-name 7. exit Cisco Unified Communications Manager Express System Administrator Guide 503 Transcoding Resources Register the DSP Farm with Cisco Unified CME 4.2 or a Later Version in Secure Mode DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 3 Specifies the maximum number of digital-signal-processor (DSP) farms that are allowed to be registered to the Skinny Client Control Protocol (SCCP) server. sdspfarm units number Example: Router(config-telephony)# sdspfarm units 1 Step 4 Specifiesthe maximum number of transcoding sessions allowed per Cisco Unified CME router. sdspfarm transcode sessions number Example: Router(config-telephony)# sdspfarm transcode sessions 30 Step 5 • number—Declares the number of DSP farm sessions. Valid values are numbers from 1 to 128. Permits a DSPfarm to register to Cisco Unified CME and associates it with a SCCP client interfaces MAC address. sdspfarm tag number device-name Example: Router(config-telephony)# sdspfarm tag 1 vg224 Step 6 The device-name in this step must be the same as the device-name in the associate profile command in Step 17 of the Configure DSP Farms for NM-HDs and NM-HDV2s, on page 481 section. Note exit Exits telephony-service configuration mode. Example: Router(config-telephony)# exit Step 7 Verify DSP Farm Registration with Cisco Unified CME Use the show sdspfarm units command to verify that the DSP farm is registering with Cisco Unified CME. Use the show voice dsp group slot command to show the status of secure conferencing. Prerequisites Cisco Unified Communications Manager Express System Administrator Guide 504 Transcoding Resources Register the DSP Farm with Cisco Unified CME 4.2 or a Later Version in Secure Mode • Cisco Unified CME 4.2 or a later version. show sdspfarm units Router# show sdspfarm units mtp-2 Device:choc2851SecCFB1 TCP socket:[1] REGISTERED actual_stream:8 max_stream 8 IP:10.1.0.20 37043 MTP YOKO keepalive 17391 Supported codec: G711Ulaw G711Alaw G729 G729a G729ab GSM FR max-mtps:2, max-streams:60, alloc-streams:18, act-streams:0 show voice dsp Router# show voice dsp group slot 1 dsp 13: State: UP, firmware: 4.4.706 Max signal/voice channel: 16/16 Max credits: 240 Group: FLEX_GROUP_VOICE, complexity: FLEX Shared credits: 180, reserved credits: 0 Signaling channels allocated: 2 Voice channels allocated: 0 Credits used: 0 Group: FLEX_GROUP_XCODE, complexity: SECURE MEDIUM Shared credits: 0, reserved credits: 60 Transcoding channels allocated: 0 Credits used: 0 dsp 14: State: UP, firmware: 1.0.6 Max signal/voice channel: 16/16 Max credits: 240 Group: FLEX_GROUP_CONF, complexity: SECURE CONFERENCE Shared credits: 0, reserved credits: 240 Conference session: 1 Credits used: 0 Cisco Unified Communications Manager Express System Administrator Guide 505 Transcoding Resources Register the DSP Farm with Cisco Unified CME 4.2 or a Later Version in Secure Mode Configure LTI-based Transcoding SUMMARY STEPS 1. enable 2. configure terminal 3. voice-card slot 4. dsp services dspfarm 5. exit 6. dspfarm profile profile-identifier transcode [universal] 7. codec codec-type 8. maximum sessions number 9. associate application CUBE 10. no shutdown 11. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice-card configuration mode for the network module on which you want to enable DSP-farm services. voice-card slot Example: Router(config)# voice-card 1 Step 3 dsp services dspfarm Enables DSP-farm services for the voice card. Example: Router(config-voicecard)# dsp services dspfarm Step 4 exit Exits voice-card configuration mode. Example: Router(config-voicecard)# exit Step 5 Cisco Unified Communications Manager Express System Administrator Guide 506 Transcoding Resources Configure LTI-based Transcoding Command or Action Purpose Enters DSP farm profile configuration mode and defines a profile for DSP farm services. dspfarm profile profile-identifier transcode [universal] Step 6 Example: Router(config)# dspfarm profile 1 transcode universal • profile-identifier—Number that uniquely identifies a profile. Range: 1 to 65535. • transcode—Enables profile for transcoding. • universal—Enables transcoding support between all codecs for DSP farm services. Without universal, transcoding is always from g711ulaw to any other codec. This keyword is supported in Cisco Unified CME 11.6 and later versions for Cisco 4000 Series ISR. Step 7 codec codec-type Specifies the codecs supported by a DSP farm profile. Example: Router(config-dspfarm-profile)# codec g711ulaw • codec-type—Specifies the preferred codec. Type ? for a list of supported codecs. • Repeat this step for each supported codec. Specifies the maximum number of sessions that are supported by the profile. maximum sessions number Example: Router(config-dspfarm-profile)# maximum sessions 5 Step 8 • number—Number of sessions supported by the profile. If the variable is not configured or if the DSP resources are not available, the value is set to 0. • The X value is determined at run time depending on the number of resources available with the resource provider. associate application CUBE Associates CUBE with the DSP farm profile. Example: Router(config-dspfarm-profile)# associate application CUBE Step 9 no shutdown Enables the DSP farm profile. Example: Router(config-dspfarm-profile)# no shutdown Step 10 end Returns to privileged EXEC mode. Example: Router(config-dspfarm-profile)# end Step 11 Cisco Unified Communications Manager Express System Administrator Guide 507 Transcoding Resources Configure LTI-based Transcoding What to Do Next You can use the command show dspfarm profile profile-number to verify the configured DSP farm profiles. Use the command to verify if the profile statusis UP, and the application statusis ASSOCIATED. Note Configuration Examples for Transcoding Resources Example for Setting up DSP Farms for NM-HDVs The following example sets up a DSP farm of 4 DSPs to handle up to 16 sessions (4 sessions per DSP) on a router with an IP address of 10.5.49.160 and a priority of 1 among other servers. voice-card 1 dsp services dspfarm exit sccp local FastEthernet 0/0 sccp sccp ccm 10.5.49.160 priority 1 dspfarm transcoder maximum sessions 16 dspfarm telephony-service ip source-address 10.5.49.200 port 2000 sdspfarm units 4 sdspfarm transcode sessions 40 sdspfarm tag 1 mtp000a8eaca80 sdspfarm tag 2 mtp123445672012 Example for Setting Up DSP Farms for NM-HDs and NM-HDV2s The following example sets up six transcoding sessions on a router with one DSP farm, an IP address of 10.5.49.160, and a priority of 1 among servers. voice-card 1 dsp services dspfarm sccp local FastEthernet 0/1 sccp sccp ccm 10.5.49.160 identifier 1 sccp ccm group 123 associate ccm 1 priority associate profile 1 register mtp123456792012 keepalive retries 5 switchover method immediate switchback method immediate switchback interval 5 dspfarm profile 1 transcode codec g711ulaw codec g711alaw codec g729ar8 codec g729abr8 maximum sessions 6 associate application sccp telephony-service Cisco Unified Communications Manager Express System Administrator Guide 508 Transcoding Resources Configuration Examples for Transcoding Resources ip source-address 10.5.49.200 port 2000 sdspfarm units 1 sdspfarm transcode sessions 40 sdspfarm tag 1 mtp000a8eaca80 sdspfarm tag 2 mtp123445672012 Example for Configuring Cisco Unified CME Router as the DSP Farm Host The following example configures Cisco Unified CME router address 10.100.10.11 port 2000 to be the farm host using the DSPfarm at mtp000a8eaca80 to allow for a maximum of 1 DSPfarm and 16 transcodersessions. telephony-service ip source address 10.100.10.11 port 2000 sdspfarm units 1 sdspfarm transcode sessions 16 sdspfarm tag 1 mtp000a8eaca80 Example for Configuring LTI-based Transcoding The following example configures Cisco Unified CME router for LTI-based transcoding. voice-card 0 dsp services dspfarm !--- Dspfarm profile configuration with associate !--- application CUBE for LTI transcoding. dspfarm profile 1 transcode universal codec g729ar8 codec g729br8 codec g711alaw codec g711ulaw codec g729r8 maximum sessions 12 associate application CUBE !--- Only dspfarm profile configurations are needed for !--- LTI-based transcoding. All the SCCP-based transcoding !--- features will be supported with LTI-based transcoding. Example for Configuring Voice Class Codec The following example configures voice class codec under a dial peer on Unified CME. voice class codec 10 codec preference 1 g711alaw codec preference 2 g711ulaw bytes 80 codec preference 3 g723ar53 codec preference 4 g723ar63 bytes 144 codec preference 5 g723r53 codec preference 6 g723r63 bytes 120 codec preference 7 g726r16 codec preference 8 g726r24 codec preference 9 g726r32 bytes 80 codec preference 10 g728 codec preference 11 g729br8 codec preference 12 g729r8 bytes 50 dial-peer voice 100 voip voice-class codec 10 Cisco Unified Communications Manager Express System Administrator Guide 509 Transcoding Resources Example for Configuring Cisco Unified CME Router as the DSP Farm Host You can also configure voice class codec under a voice register pool on Unified CME. voice register pool 1 id mac 0030.94C2.A22A preference 5 cor incoming call91 1 91011 translate-outgoing called 1 proxy 192.0.2.0 preference 1 monitor probe icmp-ping alias 1 94... to 91011 preference 8 voice-class codec 10 Where to go Next Music on Hold Music on hold can require transcoding resources. See Music on Hold, on page 829. Teleworker Remote Phones Transcoding has benefits and disadvantages for remote teleworker phones. See the discussion in Configuring Phones to Make Basic Calls, on page 223. Feature Information for Transcoding Resources The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Table 34: Feature Information for Transcoding Resources Feature Name Cisco Unified CME Version Feature Information Support for LTI-based Transcoding on Cisco 4000 Series ISR. LTI-based Transcoding 11.6 Secure transcoding for calls using the codec g729r8 dspfarm-assist command was introduced. Secure Transcoding 4.2 Transcoding between G.711 and G.729 was introduced. Transcoding Support 3.2 Cisco Unified Communications Manager Express System Administrator Guide 510 Transcoding Resources Where to go Next CHAPTER 14 Toll Fraud Prevention • Prerequisites for Configuring Toll Fraud Prevention, page 511 • Information About Toll Fraud Prevention, page 511 • Configure Toll Fraud Prevention, page 513 • Feature Information for Toll Fraud Prevention, page 521 Prerequisites for Configuring Toll Fraud Prevention • Cisco Unified CME 8.1 or a later version. • Cisco IOS Release 15.1(2)T. Information About Toll Fraud Prevention Cisco Unified CME 8.1 enhances the Toll Fraud Prevention feature to secure the Cisco Unified CME system against potential toll fraud exploitation by unauthorized users. The following are the enhancements to Toll Fraud Prevention in Cisco Unified CME: IP Address Trusted Authentication IP address trusted authentication process blocks unauthorized calls and helps secure the Cisco Unified CME system against potential toll fraud exploitation by unauthorized users. In Cisco Unified CME, IP address trusted authentication is enabled by default. When IP address trusted authenticate is enabled, Cisco Unified CME accepts incoming VoIP (SIP/H.323) calls only if the remote IP address of an incoming VoIP call is successfully validated from the system IP address trusted list. If the IP address trusted authentication fails, an incoming VoIP call is then disconnected by the application with a user- defined cause code and a new application internal error code 31 message (TOLL_FRAUD_CALL_BLOCK) is logged. For configuration information, see Configure IP Address Trusted Authentication for Incoming VoIP Calls, on page 513. Cisco Unified CME maintains an IP address trusted list to validate the remote IP addresses of incoming VOIP calls. Cisco Unified CME saves an IPv4 session target of VoIP dial-peer to add the trusted IP addresses Cisco Unified Communications Manager Express System Administrator Guide 511 to IP address trusted list automatically.The IPv4 session target is identified as a trusted IP address only if the status of VoIP dial-peer in operation is “UP”. Up to 10050 IPv4 addresses can be defined in the trusted IP address list. No duplicate IP addresses are allowed in the trusted IP address list. You can manually add up to 100 trusted IP addresses for incoming VOIP calls. For more information on manually adding trusted IP addresses, see Add Valid IP Addresses For Incoming VoIP Calls, on page 515. A call detail record (CDR) history record is generated when the call is blocked as a result of IPaddress trusted authentication failure. A new voice Internal Error Code (IEC) is saved to the CDR history record. The voice IEC error messages are logged to syslog if “voice iec syslog” option is enabled. The following is an IEC toll fraud call rejected syslog display: *Aug 14 19:54:32.507: %VOICE_IEC-3-GW: Application Framework Core: Internal Error (Toll fraud call rejected): IEC=1.1.228.3.31.0 on callID 3 GUID=AE5066C5883E11DE8026A96657501A09 The IP address trusted list authentication must be suspended when Cisco Unified CME is defined with “gateway” and a VoIP dial-peer with “session-target ras” is in operational UP status. The incoming VOIP call routing is then controlled by the gatekeeper. Table 35: Administration and Operation States of IP Address Trusted Authentication, on page 512 shows administration state and operational state in different trigger conditions. Table 35: Administration and Operation States of IP Address Trusted Authentication Trigger Condition Administration State Operation State When ip address trusted Down Down authenticate is enabled. When “gateway” is defined and a Up Down VoIP dial-peer with “ras” as a session target isin “UP” operational state When ip address trusted Up Up authenticate is enabled and either “gateway” is not defined or no voip dial-peer with “ras” as session target is in “UP” operational state We recommend enabling SIP authentication before enabling Out-of-dialog REFER (OOD-R) to avoid any potential toll fraud threats. Note Direct Inward Dial for Incoming ISDN Calls In Cisco Unified CME 8.1 and later versions the direct-inward-dial isdn feature in enabled to prevent the toll fraud for incoming ISDN calls. The called number of an incoming ISDN enbloc dialing call is used to match the outbound dial-peers even if thedirect-inward-dial option is disabled from a selected inbound plain old telephone service (POTS) dial-peer. If no outbound dial-peer is selected for the outgoing call set up, the Cisco Unified Communications Manager Express System Administrator Guide 512 Toll Fraud Prevention Direct Inward Dial for Incoming ISDN Calls incoming ISDN call is disconnected with cause-code “unassigned-number (1)”.For configuration information, see Configure Direct Inward Dial for Incoming ISDN Calls, on page 517. Disconnect ISDN Calls With No Matching Dial-peer Cisco Unified CME 8.1 and later versions disconnect unauthorized ISDN calls when no matching inbound voice dial-peer is selected. Cisco Unified CME and voice gateways use the dial-peer no-match disconnect-cause command to disconnect an incoming ISDN call when no inbound dial-peer is selected to avoid default POTS dial-peer behavior including two-stage dialing service to handle the incoming ISDN call. Block Two-stage Dialing Service on Analog and Digital FXO Ports Cisco Unified CME 8.1 and later versions block the two-stage dialing service which is initiated when an Analog or Digital FXO port goes offhook and the private line automatic ringdown (PLAR) connection is not setup from the voice-port. As a result, no outbound dial-peer is selected for an incoming analog or digital FXO call and no dialed digits are collected from an FXO call. Cisco Unified CME and voice gateways disconnect theFXO call with cause-code “unassigned-number (1)”. Cisco Unified CME usestheno secondary dialtone command by default from FXO voice-port to block the two-stage dialing service on Analog or digital FXO ports. For more information on blocking two-stage dialing service on Analog and Digital FXO port, see Block Secondary Dial tone on Analog and Digital FXO Ports, on page 518. Configure Toll Fraud Prevention Configure IP Address Trusted Authentication for Incoming VoIP Calls Restriction • IP address trusted authentication is skipped if an incoming SIP call is originated from a SIP phone. • IP address trusted authentication is skipped if an incoming call is an IPv6 call. • For an incoming VoIP call, IP trusted authentication must be invoked when the IP address trusted authentication is in “UP” operational state. Before You Begin • Cisco Unified CME 8.1 or a later version. Cisco Unified Communications Manager Express System Administrator Guide 513 Toll Fraud Prevention Disconnect ISDN Calls With No Matching Dial-peer SUMMARY STEPS 1. enable 2. configure terminal 3. voice service voip 4. ip address trusted authenticate 5. ip-address trusted call-block cause code 6. end 7. show ip address trusted list DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 voice service voip Enters voice service voip configuration mode. Example: Router(config)# voice service voip Step 3 Enables IP address authentication on incoming H.323 or SIP trunk calls for toll fraud prevention support. ip address trusted authenticate Example: Router(conf-voi-serv)# ip address trusted authenticate Step 4 IP address trusted list authenticate is enabled by default. Use the “no ip address trusted list authenticate” command to disable the IP address trusted list authentication. Issues a cause-code when the incoming call is rejected to the IP address trusted authentication. ip-address trusted call-block cause code Example: Router(conf-voi-serv)#ip address trusted call-block cause call-reject Step 5 If the IP address trusted authentication fails, a call-reject (21) cause-code is issued to disconnect the incoming VoIP call. Note end Returns to privileged EXEC mode. Example: Router()# end Step 6 Cisco Unified Communications Manager Express System Administrator Guide 514 Toll Fraud Prevention Configure IP Address Trusted Authentication for Incoming VoIP Calls Command or Action Purpose Verifies a list of valid IP addresses for incoming H.323 or SIP trunk calls, Call Block cause for rejected incoming calls. show ip address trusted list Example: Router# #show ip address trusted list IP Address Trusted Authentication Step 7 Administration State: UP Operation State: UP IP Address Trusted Call Block Cause: call-reject (21) Router #show ip address trusted list IP Address Trusted Authentication Administration State: UP Operation State: UP IP Address Trusted Call Block Cause: call-reject (21) VoIP Dial-peer IPv4 Session Targets: Peer Tag Oper State Session Target -------- ---------- -------------- 11 DOWN ipv4:1.3.45.1 1 UP ipv4:1.3.45.1 IP Address Trusted List: ipv4 172.19.245.1 ipv4 172.19.247.1 ipv4 172.19.243.1 ipv4 171.19.245.1 ipv4 172.19.245.0 255.255.255.0'' Add Valid IP Addresses For Incoming VoIP Calls Before You Begin • Cisco Unified CME 8.1 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. voice service voip 4. ip address trusted list 5. ipv4 { []} 6. end 7. show ip address trusted list Cisco Unified Communications Manager Express System Administrator Guide 515 Toll Fraud Prevention Add Valid IP Addresses For Incoming VoIP Calls DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 voice service voip Enters voice service voip configuration mode. Example: Router(config)# voice service voip Step 3 Enters ip address trusted list mode and allows to manually add additional valid IP addresses. ip address trusted list Example: Router(conf-voi-serv)# ip address trusted list Router(cfg-iptrust-list)# Step 4 Allows you to add up to 100 IPv4 addresses in ip address trusted list. Duplicate IP addresses are not allowed in the ip address trusted list. ipv4 { []} Example: Router(config)#voice service voip Step 5 • (Optional) network mask— allowsto define a subnet IP address. Router(conf-voi-serv)#ip taddress trusted list Router(cfg-iptrust-list)#ipv4 172.19.245.1 Router(cfg-iptrust-list)#ipv4 172.19.243.1 end Returns to privileged EXEC mode. Example: Router(config-register-pool)# end Step 6 Displays a list of valid IP addresses for incoming H.323 or SIP trunk calls. show ip address trusted list Example: Router# show shared-line Step 7 The following example shows 4 IP addresses configured as trusted IP addresses: Router#show ip address trusted list IP Address Trusted Authentication Administration State: UP Operation State: UP Cisco Unified Communications Manager Express System Administrator Guide 516 Toll Fraud Prevention Add Valid IP Addresses For Incoming VoIP Calls IP Address Trusted Call Block Cause: call-reject (21) VoIP Dial-peer IPv4 Session Targets: Peer Tag Oper State Session Target -------- ---------- -------------- 11 DOWN ipv4:1.3.45.1 1 UP ipv4:1.3.45.1 IP Address Trusted List: ipv4 172.19.245.1 ipv4 172.19.247.1 ipv4 172.19.243.1 ipv4 171.19.245.1 ipv4 171.19.10.1 Configure Direct Inward Dial for Incoming ISDN Calls Before You Begin • Direct-inward-dial isdn is not supported for incoming ISDN overlap dialing call. SUMMARY STEPS 1. enable 2. configure terminal 3. voice service pots 4. direct-inward-dial isdn 5. exit DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice service configuration mode with voice telephone-service encapsulation type (pots). voice service pots Example: Router(config)# voice service pots Router(conf-voi-serv)# Step 3 Cisco Unified Communications Manager Express System Administrator Guide 517 Toll Fraud Prevention Configure Direct Inward Dial for Incoming ISDN Calls Command or Action Purpose Enables direct-inward-dial (DID) for incoming ISDN number. The incoming ISDN (enbloc dialing) call is treated as if the digits direct-inward-dial isdn Example: Router(conf-voi-serv)#direct-inward-dial isdn Step 4 were received from the DID trunk. The called number is used to select the outgoing dial peer. No dial tone is presented to the caller. exit Exits voice service pots configuration mode. Example: Router(conf-voi-serv)# exit Step 5 ! voice service voip ip address trusted list ipv4 172.19.245.1 ipv4 172.19.247.1 ipv4 172.19.243.1 ipv4 171.19.245.1 ipv4 171.19.10.1 allow-connections h323 to h323 allow-connections h323 to sip allow-connections sip to h323 allow-connections sip to sip supplementary-service media-renegotiate sip registrar server expires max 120 min 120 ! ! dial-peer voice 1 voip destination-pattern 5511... session protocol sipv2 session target ipv4:1.3.45.1 incoming called-number 5522... direct-inward-dial dtmf-relay sip-notify codec g711ulaw ! dial-peer voice 100 pots destination-pattern 91... incoming called-number 2... forward-digits 4 ! Block Secondary Dial tone on Analog and Digital FXO Ports SUMMARY STEPS 1. enable 2. configure terminal 3. voice-port 4. no secondary dialtone 5. end 6. show run Cisco Unified Communications Manager Express System Administrator Guide 518 Toll Fraud Prevention Block Secondary Dial tone on Analog and Digital FXO Ports DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 voice-port Enters voice-port configuration mode. Example: Router(config)#voice-p 2/0/0 • Type your Analog or Digital FXO port number. Blocks the secondary dialtone on Analog and Digital FXO port. no secondary dialtone Example: Router((config-voiceport)# no secondary dialtone Step 4 end Returns to privileged EXEC mode. Example: Router(conf-voiceport)# exit Step 5 Verifies that the secondary dial tone is disabled on the specific voice-port. show run Example: Router# show run | sec voice-port 2/0/0 Step 6 Router# conf t Router(config)#voice-p 2/0/0 Router(config-voiceport)# no secondary dialtone ! end Router# show run | sec voice-port 2/0/0 Foreign Exchange Office 2/0/0 Slot is 2, Sub-unit is 0, Port is 0 Type of VoicePort is FXO Operation State is DORMANT Administrative State is UP ... Secondary dialtone is disabled Cisco Unified Communications Manager Express System Administrator Guide 519 Toll Fraud Prevention Block Secondary Dial tone on Analog and Digital FXO Ports Troubleshooting Tips for Toll Fraud Prevention When incoming VOIPcall is rejected by IPaddress trusted authentication, a specific internal error code (IEC) 1.1.228.3.31.0 is saved to the call history record. You can monitor the failed or rejected calls using the IEC support. Follow these steps to monitor any rejected calls: Step 1 Use the show voice iec description command to find the text description of an IEC code. Example: Router# show voice iec description 1.1.228.3.31.0 IEC Version: 1 Entity: 1 (Gateway) Category: 228 (User is denied access to this service) Subsystem: 3 (Application Framework Core) Error: 31 (Toll fraud call rejected) Diagnostic Code: 0 Step 2 View the IEC statistics information using the Enable iec statistics command. The example below shows that 2 calls were rejected due to toll fraud call reject error code. Example: Router# Enable iec statistics Router(config)#voice statistics type iec Router#show voice statistics iec since-reboot Internal Error Code counters ---------------------------- Counters since reboot: SUBSYSTEM Application Framework Core [subsystem code 3] [errcode 31] Toll fraud call rejected Step 3 Use the enable IEC syslog command to verify the syslog message logged when a call with IEC error is released. Example: Router# Enable iec syslog Router (config)#voice iec syslog Feb 11 01:42:57.371: %VOICE_IEC-3-GW: Application Framework Core: Internal Error (Toll fraud call rejected): IEC=1.1.228.3.31.0 on callID 288 GUID=DB3F10AC619711DCA7618593A790099E Step 4 Verify the source address of an incoming VOIP call using the show call history voice last command. Example: Router# show call history voice last 1 GENERIC: SetupTime=3306550 ms Index=6 ... InternalErrorCode=1.1.228.3.31.0 ... RemoteMediaIPAddress=1.5.14.13 ... Step 5 IEC is saved to VSA of Radius Accounting Stop records. Monitor the rejected calls using the external RADIUS server. Cisco Unified Communications Manager Express System Administrator Guide 520 Toll Fraud Prevention Troubleshooting Tips for Toll Fraud Prevention Example: Feb 11 01:44:06.527: RADIUS: Cisco AVpair [1] 36 “internal-error-code=1.1.228.3.31.0” Step 6 Retrieve the IEC details from cCallHistoryIec MIB object. More information on IEC is available at: Cisco IOS Voice Troubleshooting and Monitoring Guide Example: getmany 1.5.14.10 cCallHistoryIec cCallHistoryIec.6.1 = 1.1.228.3.31.0 >getmany 172.19.156.132 cCallHistory cCallHistorySetupTime.6 = 815385 cCallHistoryPeerAddress.6 = 1300 cCallHistoryPeerSubAddress.6 = cCallHistoryPeerId.6 = 8000 cCallHistoryPeerIfIndex.6 = 76 cCallHistoryLogicalIfIndex.6 = 0 cCallHistoryDisconnectCause.6 = 15 cCallHistoryDisconnectText.6 = call rejected (21) cCallHistoryConnectTime.6 = 0 cCallHistoryDisconnectTime.6 = 815387 cCallHistoryCallOrigin.6 = answer(2) cCallHistoryChargedUnits.6 = 0 cCallHistoryInfoType.6 = speech(2) cCallHistoryTransmitPackets.6 = 0 cCallHistoryTransmitBytes.6 = 0 cCallHistoryReceivePackets.6 = 0 cCallHistoryReceiveBytes.6 = 0 cCallHistoryReleaseSrc.6 = internalCallControlApp(7) cCallHistoryIec.6.1 = 1.1.228.3.31.0 >getone 172.19.156.132 cvVoIPCallHistoryRemMediaIPAddr.6 cvVoIPCallHistoryRemMediaIPAddr.6 = 1.5.14.13 Feature Information for Toll Fraud Prevention The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Table 36: Feature Information for Toll Fraud Prevention Feature Name Cisco Unified CME Version Feature Information Introduced support for Toll Fraud Prevention feature. Toll Fraud Prevention in 8.1 Cisco Unified CME Cisco Unified Communications Manager Express System Administrator Guide 521 Toll Fraud Prevention Feature Information for Toll Fraud Prevention Cisco Unified Communications Manager Express System Administrator Guide 522 Toll Fraud Prevention Feature Information for Toll Fraud Prevention CHAPTER 15 Graphical User Interface This chapter describesthe Cisco Unified Communications Manager Express(Cisco Unified CME) graphical user interface (GUI) and explains how to set it up accountsforsystem administrators, customer administrators, and phone users. • Prerequisites for Enabling the GUI, page 523 • Restrictions for Enabling the GUI, page 523 • Information About Enabling the GUI, page 524 • Enable the GUI, page 525 • Configuration Examples for Enabling the GUI, page 534 • Feature Information for Enabling the GUI, page 536 Prerequisites for Enabling the GUI • GUI files must be copied into flash memory on the router.For more information,see Install and Upgrade Cisco Unified CME Software, on page 101. • To use a phone user account in the Cisco Unified CME GUI to configure speed dials on a phone that is enabled for Extension Mobility, Cisco Unified CME GUI 4.2.1 or a later version must be installed on the Cisco router. Restrictions for Enabling the GUI • Unified CME GUI does not support configuration, administration, or customer facing features for SIP Phones. Unified CME GUI files are version-specific; GUI filesfor one version of Unified CME are not compatible with any other version of Unified CME. If you are downgrading or upgrading your Unified CME version, you must downgrade or upgrade your GUI files. • The user name parameter of any authentication credential must be unique. Do not use the same value for a user name when you configure any two or more authentication credentials in Unified CME, such Cisco Unified Communications Manager Express System Administrator Guide 523 as the username for any Unified CME GUI account and the user name in a logout or user profile for Extension Mobility. • Extension Mobility optionsin Cisco Unified CME GUI 4.2.1 and later versions cannot be accessed from the System Administrator or Customer Administrator login screens. • To access the GUI, you must use Microsoft Internet Explorer 5.5 or a later version. Other browsers are not supported. • If you use an XML configuration file to create a customer administrator login, the XML file can have a maximum size of 4000 bytes. • The password of the system administrator cannot be changed through the GUI. Only the password of a customer administrator or a phone user can be changed through the GUI. • If more than 100 phones are configured, choosing to display all phones results in a long delay before results appear. Information About Enabling the GUI Cisco Unified CME GUI Support The Cisco Unified CME GUI provides a web-based interface to manage most system-level and phone-based features. In particular, the GUI facilitatesthe routine additions and changes associated with employee turnover, allowing these changes to be performed by nontechnical staff. The GUI provides three levels of access to support the following user classes: • System administrator—Able to configure all system-level and phone-based features. This person is familiar with Cisco IOS software and VoIP network configuration. • Customer administrator—Able to perform routine phone additions and changes without having access to system-level features. This person does not have to be familiar with Cisco IOS software. • Phone user—Able to program a small set of features on his or her own phone and search the Cisco Unified CME directory. In Cisco Unified CME GUI 4.2.1 and later versions, phone users can use the GUI to set up personal speed dials for an Extension Mobility phone. The same credential for logging into an Extension Mobility phone can be used to log into the Cisco Unified CME GUI. The user name parameter of any authentication credential must be unique. Do not use the same value for a user name when you configure any two or more authentication credentials in Cisco Unified CME, such as the username for any Cisco United CME GUI account and the user name in a logout or user profile for Extension Mobility. The Cisco Unified CME GUI uses HTTPto transfer information from the router to thePC of an administrator or phone user. The router must be configured as an HTTPserver, and an initial system administrator username and password must be defined from the router command-line interface (CLI). Additional accountsfor customer administrators and phone users can be added from the Cisco Unified CME router using Cisco IOS software commands or from a PC using GUI screens. Cisco Unified CME provides support for eXtensible Markup Language (XML) cascading style sheets (files with a .css suffix) that can be used to customize the browser GUI display. Cisco Unified Communications Manager Express System Administrator Guide 524 Graphical User Interface Information About Enabling the GUI AAA Authentication The GUIsupports authentication, authorization, and accounting (AAA) authentication forsystem administrators through a remote server when this capability is enabled with the ip http authentication command. If authentication through the server fails, the local router is searched. Using the iphttpauthenticationcommand prevents unauthorized usersfrom accessing the Cisco Unified CME router. If this command is not used, the enable password for the router is the only requirement to authenticate user accessto the GUI. Instead, we recommend you use the local or TACACSauthentication options, configured as part of a global AAA framework. By explicitly using the ip http authentication command, you designate alternative authentication methods, such as by a local login account or by the method that is specified in the AAA configuration on the Cisco Unified CME router. If you select the AAA authentication method, you must also define an authentication method in your AAA configuration. For information on configuring AAA authentication, see "Configuring Authentication” chapter of Cisco IOS Security Configuration Guide. Enable the GUI Enable the HTTP Server To enable the HTTP server, and specify the path to files for the GUI and a method of user authentication for security, perform the following steps. The HTTP server on a router is disabled by default. SUMMARY STEPS 1. enable 2. configure terminal 3. ip http server 4. ip http path flash: 5. ip http authentication {aaa | enable | local | tacacs} 6. exit DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Cisco Unified Communications Manager Express System Administrator Guide 525 Graphical User Interface AAA Authentication Command or Action Purpose ip http server Enables the HTTP server on the Cisco Unified CME router. Example: Router(config)# ip http server Step 3 Sets the location of the HTML files used by the HTTP web server to flash memory on the router. ip http path flash: Example: Step 4 Router(config)# ip http path flash: Specifies the method of authentication for the HTTP server. Default is the enable keyword. ip http authentication {aaa | enable | local | tacacs} Step 5 Example: • aaa—Indicates that the authentication method used for the AAA login service should be used for authentication. The AAA login Router(config)# ip http authentication aaa service method is specified by the aaa authentication login command. • enable—Uses the enable password. This is the default if this command is not used. • local—Uses login username, password, and privilege level access combination specified in the local system configuration (by the username command). • tacacs—Uses TACACS (or XTACACS) server. exit Returns to privileged EXEC mode. Example: Router(config)# exit Step 6 Enable GUI Access for the System Administrator To define an initial username and password for a system administrator to access the GUI and enable the GUI to be used to set the time and to add directory listings, perform the following steps. Cisco Unified Communications Manager Express System Administrator Guide 526 Graphical User Interface Enable GUI Access for the System Administrator SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. web admin system name username {password string | secret {0 | 5} string} 5. dn-webedit 6. time-webedit 7. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 3 web admin system name username Defines username and password for a system administrator. {password string | secret {0 | 5} string} Step 4 • name username—Unique alphanumeric string to identify a user for this authentication credential only. Default is Admin. Example: Router(config-telephony)# web admin system name pwa3 secret 0 wp78pw • password string—String to verify system administrator’s identity. Default is empty string. • secret {0 | 5} string—Digitspecifiesstate of encryption of the string that follows: ◦0—Password that follows is not encrypted. ◦5—Password that follows is encrypted using Message Digest 5 (MD5). The secret 5 keyword pair is used in the output of show commands when encrypted passwords are displayed. It indicates that the password that follows is encrypted. Note Cisco Unified Communications Manager Express System Administrator Guide 527 Graphical User Interface Enable GUI Access for the System Administrator Command or Action Purpose (Optional) Enables the ability to add directory numbers through the web interface. dn-webedit Example: Router(config-telephony)# dn-webedit Step 5 The no form of this command disables the ability to create IP phone extension telephone numbers. That ability could disrupt the network wide management of telephone numbers. If this command is not used, the ability to create directory numbers is disabled by default. (Optional) Enables the ability to set the phone time for the Cisco Unified CME system through the web interface. time-webedit Example: Router(config-telephony)# time-webedit Step 6 We do not recommend this method for setting network time. The router should be set up to automatically synchronize its router clock from a network-based clock source using Network Time Protocol (NTP). In the rare case that a network NTPclock source is not available, use the time-webedit command to allow manual setting and resetting of the router clock through the GUI. Note end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 7 Access the Cisco Unified CME GUI To accessthe Cisco Unified CME router through the GUI to make configuration changes, perform the following steps. In Cisco Unified CME GUI 4.2.1 and later versions, phone users can use the GUI to set up personal speed dialsfor an Extension Mobility phone. The same credential for logging on to an Extension Mobility phone can be used to log into the Cisco Unified CME GUI. Note Cisco Unified Communications Manager Express System Administrator Guide 528 Graphical User Interface Access the Cisco Unified CME GUI Restriction • The Cisco Unified CME GUI requires Microsoft Internet Explorer 5.5 or a later version. Other browsers are not supported. • Extension Mobility options in Cisco Unified CME GUI 4.2.1 and later versions cannot be accessed from the System Administrator or Customer Administrator login screens. Step 1 Go to the following URL: http://router_ipaddress/ccme.html where router_ipaddress is the IP address of your Cisco Unified CME router. For example, if the IP address of your Cisco Unified CME router is 10.10.10.176, enter the following: http://10.10.10.176/ccme.html Enter your username and password at the login screen. The Cisco Unified CME system evaluates your privilege level and presents the appropriate window. Note that users with Cisco IOS software privilege level 15 also have system-administrator-level privileges in the Cisco Unified CME GUI after being authenticated locally or remotely through AAA. The ip http authentication command that is configured on the Cisco Unified CME router determines where authentication occurs. Step 2 After you login and are authenticated, the system displays one of the following home pages, based on your user level: • System administrator home page. • Customer administratorsees a reduced version of the options available on the system administrator page, according to the XML configuration file that the system administrator created. • Phone user home page. After you log in successfully, access online help from the Help menu. Create a Customized XML File for Customer Administrator GUI The XML configuration file specifies the parameters and features that are available to customer administrators and the parameters and features that are restricted. The file follows a template named xml.template, which conformsto the Cisco XML Document Type Definition (DTD), as documented in the Cisco IPPhoneServices Application Development Notes. This template is one of the first Cisco Unified CME files that is downloaded during installation. Cisco Unified Communications Manager Express System Administrator Guide 529 Graphical User Interface Create a Customized XML File for Customer Administrator GUI To edit and load the XML configuration file, perform the following steps. Step 1 Copy the XML template and open it in any text editor (see Example for Configuring XML ConfigurationFile Template, on page 534 ). Name the file something that is meaningful to you and use “xml” as its suffix. For example, you could name the file "custadm.xml". Step 2 Edit the XML template. Within the template, each line that starts with a title enclosed in angle brackets describes an XML object and matches an entity name in the Cisco CME GUI. For example, “” refers to the Add Extension capability, and “” refersto the Type field on the Add Extension window.For each object in the template, you have a choice of actions. Your choices appear within brackets; for example, “[Hide | Show]” indicates that you have a choice between whether this object is hidden or visible when a customer administrator logs in to the GUI. Delete the action that you do not want and the vertical bar and brackets around the actions. Example: For example, to hide the Sequence Number field, change the following text in the template file: [Hide | Show] to the following text in your configuration file: Hide Edit every line in the template until you have changed each choice in brackets to a single action and you have removed the vertical bars and brackets. A sample XML file is shown in the Example for Configuring XML Configuration File, on page 535. Step 3 Copy the file to a TFTP or FTP server that can be accessed by the Cisco Unified CME router. Step 4 Copy your file to flash memory on the Cisco Unified CME router. Example: Router# copy tftp flash Step 5 Load the XML file from router flash memory. Example: Router(config)# telephony-service Router(config-telephony)# web customize load filename Router(config-telephony)# exit GUI Access for Customer Administrators Prerequisites for Enabling GUI Access to Customer Administrators • Enable a system administrator account for GUI access. See Enable GUI Access for the System Administrator, on page 526. Cisco Unified Communications Manager Express System Administrator Guide 530 Graphical User Interface GUI Access for Customer Administrators • Create the XML configuration file for the customer administrator GUI. See Create a Customized XML File for Customer Administrator GUI, on page 529. • Reload the XML file using the webcustomize loadcommand if you have made changesto the customer administrator GUI. Define a Customer Administrator Account Using GUI Step 1 From the Configure System Parameters menu, choose Administrator’s Login Account. Step 2 Complete the Admin User Name (username) and Admin User Type (Customer) fields. The username must be a unique alphanumeric string to identify a user for this authentication credential only. Step 3 Complete the New Password field for the user that you are defining as a customer administrator. Type the password again to confirm it. Step 4 Click Change for your changes to become effective. Define a Customer Administrator Account Using Cisco IOS Software Commands To allow the system administrator to create a customer administrator account by using the Cisco IOSsoftware command line interface, perform the following steps. SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. web admin customer name username password string 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Cisco Unified Communications Manager Express System Administrator Guide 531 Graphical User Interface GUI Access for Customer Administrators Command or Action Purpose telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 3 web admin customer name username password Defines a username and password for a customer administrator. string Step 4 • name username—Unique alphanumeric string to identify a user for this authentication credential only. Default is Customer. Example: Router(config-telephony)# web admin customer name user44 password pw10293847 • passwordstring—String to verify customer administrator identity. end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 5 GUI Access for Phone Users Prerequisites for Enabling GUI Access for Phone Users • Enable a system administrator account for GUI access. See Enable GUI Access for the System Administrator, on page 526. Define a Phone User Account Using GUI To create a phone user account by using the Cisco Unified CME GUI, perform the following steps. Step 1 From the Configure Phones menu, choose Add Phone to add GUI access for a user with a new phone or Change Phone to add GUI access for a user with an existing phone. The Add Phone screen or the Change Phone screen appears. Step 2 Enter a username and password in the Login Account area of the screen. The username must be a unique alphanumeric string to identify a user for this authentication credential only. If you are adding a new phone, complete the other fields as appropriate. Step 3 Click Change for your edits to become effective. Cisco Unified Communications Manager Express System Administrator Guide 532 Graphical User Interface GUI Access for Phone Users Define a Phone User Account Using Cisco IOS Software Commands To use commands in the ephone configuration mode to create credentials for phone users to log into the Cisco Unified CME GUI, perform the following steps for each phone user/phone combination. You can also create phone user credentials for accessing the Cisco Unified CME GUI by using the user command in the voice user-profile configuration mode and the voice logout-profile mode.For configuration information, see Extension Mobility, on page 725. Note SUMMARY STEPS 1. enable 2. configure terminal 3. ephone phone-tag 4. username username password password 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 ephone phone-tag Enters ephone configuration mode. Example: Router(config)# ephone 2 Step 3 Step 4 username username password password Assigns a phone user login account name and password. Example: Router(config-ephone)# username prx password pk59wq • This allows the phone user to log in to the Cisco Unified CME GUI to change a limited number of personal settings. • username—Unique alphanumeric string to identify a user for this authentication credential only. Cisco Unified Communications Manager Express System Administrator Guide 533 Graphical User Interface GUI Access for Phone Users Command or Action Purpose end Returns to privileged EXEC mode. Example: Router(config-ephone)# end Step 5 Troubleshooting the GUI If you are having trouble starting the Cisco Unified CME GUI, try the following actions: Step 1 Verify you are using Microsoft Internet Explorer 5.5 or a later version. No other browser is supported. Step 2 Clear your browser cache or history. Step 3 Verify that the GUI files in router flash memory are the correct version for the version of Cisco Unified CME that you have. Compare the filenames in flash memory with the list in the Cisco Unified CME software archive that you downloaded. Compare the sizes of files in flash memory with the sizes of the files in the tar archive for the Cisco Unified CME GUI to ensure that you have the most recent files installed in flash memory. If necessary, download the latest version from the Software Download website at http://www.cisco.com/cgi-bin/tablebuild.pl/ip-iostsp. Configuration Examples for Enabling the GUI Example for Configuring HTTP Server and System Administrator Account The following example sets up the HTTP server and creates a system administrator account for pwa3, a customer administrator account for user44, and a user account for prx. ip http server ip http path flash: ip http authentication aaa telephony-service web admin system name pwa3 secret 0 wp78pw web admin customer name user44 password pw10293847 dn-webedit time-webedit ephone 25 username prx password pswd Example for Configuring XML Configuration File Template Cisco Unified Communications Manager Express System Administrator Guide 534 Graphical User Interface Troubleshooting the GUI [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [Hide | Show] [No | Yes] [No | Yes] [No | Yes] [1-6] Example for Configuring XML Configuration File sample.xml Hide Hide Hide Hide Cisco Unified Communications Manager Express System Administrator Guide 535 Graphical User Interface Example for Configuring XML Configuration File Hide Hide Hide Hide Hide Hide Show Hide Hide Hide Hide Hide Hide Show Hide Hide Hide Hide Hide Hide Hide Hide Hide Hide Hide Hide Hide Hide No No 4 Feature Information for Enabling the GUI The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Cisco Unified Communications Manager Express System Administrator Guide 536 Graphical User Interface Feature Information for Enabling the GUI Table 37: Feature Information for Enabling the GUI Feature Name Cisco Unified CME Version Feature Information Allows a phone user to use a name and password from an Extension Mobility profile to log into the Cisco Unified CME GUI for configuring personal speed dials on an Extension Mobility phone. Support for Extension Mobility 4.2(1) Phone Usersin Cisco Unified CME GUI The Cisco Unified CME GUI was introduced. Cisco Unified CME GUI 2.0 Cisco Unified Communications Manager Express System Administrator Guide 537 Graphical User Interface Feature Information for Enabling the GUI Cisco Unified Communications Manager Express System Administrator Guide 538 Graphical User Interface Feature Information for Enabling the GUI CHAPTER 16 Voice Mail Integration This chapter describes how to integrate your voice-mailsystem with Cisco Unified Communications Manager Express (Cisco Unified CME). • Prerequisites for Voice Mail Integration, page 539 • Information About Voice-Mail Integration, page 540 • Configure Voice-Mail Integration, page 546 • Configuration Examples for Voice-Mail Integration, page 576 • Feature Information for Voice-Mail Integration, page 579 Prerequisites for Voice Mail Integration • Calls can be successfully completed between phones on the same Cisco Unified CME router. • If your voice-mail system is something other than Cisco Unity Express, such as Cisco Unity, voice mail must be installed and configured on your network. • If your voice-mail system is Cisco Unity Express: When you order Cisco Unity Express, Cisco Unity Express software and the purchased license are installed on the module at the factory. Spare modules also ship with the software and license installed. If you are adding Cisco Unity Express to an existing Cisco router, you will be required to install hardware and software components. Note ◦Interface module for Cisco Unity Express is installed. For information about the AIM-CUE or NM-CUE, access documentslocated at http://www.cisco.com/en/US/products/hw/modules/ps2797/ prod_installation_guides_list.html. ◦The recommended Cisco IOSrelease and feature set plus the necessary Cisco Unified CME phone firmware and GUI files to support Cisco Unity Express are installed on the Cisco Unified CME router. If the GUI files are not installed, see Install Cisco Unified CME Software. Cisco Unified Communications Manager Express System Administrator Guide 539 To determine whether the Cisco IOS software release and Cisco Unified CME software version are compatible with the Cisco Unity Express version, Cisco router model, and Cisco Unity Express hardware that you are using, see Cisco Unity Express Compatibility Matrix. To verify installed Cisco Unity Express software version, enter the Cisco Unity Express command environment and use the show software version user EXEC command. For information about the command environment,see the appropriate Cisco Unity Express CLI Administrator Guide at http:/ /www.cisco.com/en/US/docs/voice_ip_comm/unity_exp/roadmap/cuedocs.html. ◦The proper license for Cisco Unified CME, not Cisco Unified Communications Manager, is installed. To verify installed license, enter the Cisco Unity Express command environment and use the show software license user EXEC command. For information about the command environment, see the appropriate Cisco Unity Express CLI Administrator Guide at http:// www.cisco.com/en/US/docs/voice_ip_comm/unity_exp/roadmap/cuedocs.html. This is an example of the Cisco Unified CME license: se-10-0-0-0> show software licenses Core: - application mode: CCME - total usable system ports: 8 Voicemail/Auto Attendant: - max system mailbox capacity time: 6000 - max general delivery mailboxes: 15 - max personal mailboxes: 50 Languages: - max installed languages: 1 - max enabled languages: 1 ◦Voicemail and Auto Attendant (AA) applications are configured. For configuration information, see “Configuring the System Using the Initialization Wizard” in the appropriate Cisco Unity Express GUI Administrator Guide at http://www.cisco.com/en/US/docs/voice_ip_comm/unity_exp/roadmap/ cuedocs.html. Information About Voice-Mail Integration Cisco Unity Connection Integration Cisco Unity Connection transparently integrates messaging and voice recognition components with your data network to provide continuous global access to calls and messages. These advanced, convergence-based communication services help you use voice commands to place calls or listen to messages in “hands-free” mode and check voice messages from your desktop, either integrated into an e-mail inbox or from a Web browser. Cisco Unity Connection also features robust automated-attendant functions that include intelligent routing and easily customizable call-screening and message-notification options. For instructions on how to integrate Cisco Unified CME with Cisco Unity Connection,see Cisco CallManager Express 3.x Integration Guide for Cisco Unity Connection 1.1. Cisco Unified Communications Manager Express System Administrator Guide 540 Voice Mail Integration Information About Voice-Mail Integration Cisco Unity Express Integration Cisco Unity Express offers easy, one-touch access to messages and commonly used voice-mail features that enable usersto reply, forward, and save messages. To improve message management, users can create alternate greetings, access envelope information, and mark or play messages based on privacy or urgency.For instructions on how to configure Cisco Unity Express, see the administrator guides for Cisco Unity Express. For configuration information, see Enable DTMF Integration Using SIP NOTIFY. Note Cisco Unified CME and Cisco Unity Express must both be configured before they can be integrated. Cisco Unity Integration Cisco Unity is a Microsoft Windows-based communications solution that brings you voice mail and unified messaging and integrates them with the desktop applications you use daily. Cisco Unity gives you the ability to access all of your messages, voice, fax, and e-mail, by using your desktop PC, a touchtone phone, or the Internet. The Cisco Unity voice mail system supports voice-mail integration with Cisco Unified CME. This integration requiresthat you configure the Cisco Unified CME router and Cisco Unity software to get voice-mail service. For configuration instructions, see Enable DTMF Integration Using RFC 2833. DTMF Integration for Legacy Voice-Mail Applications For dual-tone multifrequency (DTMF) integrations, information on how to route incoming or forwarded calls is sent by a telephone system in the form of DTMF digits. The DTMF digits are sent in a pattern that is based on the integration file in the voice-mail system connected to the Cisco Unified CME router. These patterns are required for DTMF integration of Cisco Unified CME with most voice-mail systems. Voice-mail systems are designed to respond to DTMF after the system answers the incoming calls. After configuring the DTMF integration patterns on the Cisco Unified CME router, you set up the integration files on the third-party legacy voice-mailsystem by following the instructionsin the documentsthat accompany the voice-mail system. You must design the DTMF integration patterns appropriately so that the voice-mail system and the Cisco Unified CME router work with each other. For configuration information, see Enable DTMF Integration for Analog Voice-Mail Applications. Mailbox Selection Policy Typically a voice-mail system uses the number that a caller has dialed to determine the mailbox to which a call should be sent. However, if a call has been diverted several times before reaching the voice-mail system, the mailbox that is selected might vary for different types of voice-mail systems. For example, Cisco Unity Express uses the last number to which the call was diverted before it was sent to voice mail as the mailbox number. Cisco Unity and some legacy PBX systems use the originally called number as the mailbox number. Cisco Unified Communications Manager Express System Administrator Guide 541 Voice Mail Integration Cisco Unity Express Integration The MailboxSelectionPolicy feature allows you to provision the following optionsfrom the Cisco Unified CME configuration. • For Cisco Unity Express, you can select the originally dialed number. • For PBX voice-mail systems, you can select the last number to which the call was diverted before it was sent to voice mail. This option is configured on the outgoing dial peer for the voice-mail system's pilot number. • For Cisco Unity voice mail, you can select the last number to which the call was diverted before it was sent to voice mail. This option is configured on the ephone-dn that is associated with the voice-mail pilot number. To enable Mailbox Selection Policy, see Set a Mailbox Selection Policy for Cisco Unity Express or a PBX Voice-Mail Number or Set a Mailbox Selection Policy for Cisco Unity. RFC 2833 DTMF MTP Pass through In Cisco Unified CME 4.1, the RFC 2833 Dual-Tone Multifrequency (DTMF) Media Termination Point (MTP) Passthrough feature provides the capability to pass DTMF tones transparently between SIP endpoints that require transcoding or Resource Reservation Protocol (RSVP) agents. This feature supports DTMF Relay across SIP WAN devices that support RFC 2833, such as Cisco Unity and SIP trunks. Devices registered to a Cisco Unified CME SIP back-to-back user agent (B2BUA) can exchange RFC 2833 DTMF MTP with other devices that are not registered with the Cisco Unified CME SIP B2BUA, or with devices that are registered in one of the following: • Local or remote Cisco Unified CME • Cisco Unified Communications Manager • Third party proxy By default, the RFC 2833 DTMF MTP Passthrough feature uses payload type 101 on MTP, and MTP accepts all the other dynamic payload types if it is indicated by Cisco Unified CME. For configuration information, see Enable DTMF Integration Using RFC 2833. MWI Line Selection Message waiting indicator (MWI) line selection allows you to choose the phone line that is monitored for voice-mail messages and that lights an indicator when messages are present. Before Cisco Unified CME 4.0, the MWI lamp on a phone running SCCP could be associated only with the primary line of the phone. In Cisco Unified CME 4.0 and later versions, you can designate a phone line other than the primary line to be associated with the MWI lamp. Lines other than the one associated with the MWI lamp display an envelope icon when a message is waiting. A logical phone “line” is not the same as a phone button. A button with one or more directory numbers is considered one line. A button with no directory number assigned does not count as a line. In Cisco Unified CME 4.0 and later versions, aSIPdirectory number that is used for call forward all, presence BLF status, and MWI features must be configured by using the dn keyword in the number command; direct line numbers are not supported. Cisco Unified Communications Manager Express System Administrator Guide 542 Voice Mail Integration RFC 2833 DTMF MTP Pass through For configuration information, see Configure a Voice Mailbox Pilot Number on a SCCP Phone or Configure a Directory Number for MWI NOTIFY. AMWI The AMWI (Audible Message Line Indicator) feature provides a special stutter dial tone to indicate message waiting. This is an accessibility feature for vision-impaired phone users. The stutter dial tone is defined as 10 ms ON, 100 ms OFF, repeat 10 times, then steady on. In Cisco Unified CME 4.0(3), you can configure the AMWI feature on the Cisco Unified IP Phone 7911 and Cisco Unified IP Phone 7931G to receive audible, visual, or audible and visual MWI notification from an external voice-messaging system. AMWI cannot be enabled unlessthenumber command is already configured for the IP phone to be configured. Cisco Unified CME applies the following logic based on the capabilities of the IP phone and how MWI is configured: • If the phone supports (visual) MWI and MWI is configured for the phone, activate the Message Waiting light. • If the phone supports (visual) MWI only, activate the Message Waiting light regardless of the configuration. • If the phone supports AMWI and AMWI is configured for the phone, send the stutter dial tone to the phone when it goes off-hook. • If the phone supports AMWI only and AMWI is configured, send the stutter dial tone to the phone when it goes off-hook regardless of the configuration. If a phone supports (visual) MWI and AMWI and both options are configured for the phone, activate the Message Waiting light and send the stutter dial tone to the phone when it goes off-hook. For configuration information, see Configure a SCCP Phone for MWI Outcall. SIP MWI Prefix Specification Central voice-messaging servers that provide mailboxes for several Cisco Unified CME sites may use site codes or prefixes to distinguish among similarly numbered ranges of extensions at different sites. In Cisco Unified CME 4.0 and later versions, you can specify that your Cisco Unified CME system should accept unsolicited SIP Notify messages for MWI that include a prefix string as a site identifier. For example, an MWI message might indicate that the central mailbox number 555-0123 has a voice message. In this example, the digits 555 are set as the prefix string or site identifier using the mwi prefix command. The local Cisco Unified CME system is able to convert 555-0123 to 0123 and deliver the MWI to the correct phone. Without this prefix string manipulation, the system would reject an MWI for 555-0123 as not matching the local Cisco Unified CME extension 0123. To enable SIP MWI Prefix Specification, see Enable SIP MWI Prefix Specification. SIP MWI - QSIG Translation In Cisco Unified CME 4.1 and later, the SIP MWI - QSIG Translation feature extends MWI functionality for SIP MWI and QSIG MWI interoperation to enable sending and receiving MWI over QSIG to a PBX. Cisco Unified Communications Manager Express System Administrator Guide 543 Voice Mail Integration AMWI When the SIP Unsolicited NOTIFY is received from voice mail, the Cisco router translates this event to activate QSIG MWI to thePBX, viaPSTN. ThePBX willswitch on, or off, the MWI lamp on the corresponding IPphone. Thisfeature supports only Unsolicited NOTIFY.Subscribe NOTIFY is notsupported by thisfeature. In Figure 18: SIP MWI to ISDN QSIG When Voice Mail and Cisco Router are On the Same LAN, on page 544, the Cisco router receives the SIP Unsolicited NOTIFY, performs the protocol translation, and initiates the QSIG MWI call to the PBX, where it is routed to the appropriate phone. Figure 18: SIP MWI to ISDN QSIG When Voice Mail and Cisco Router are On the Same LAN It makes no difference if the SIP Unsolicited NOTIFY is received via LAN or WAN if the PBX is connected to the Cisco router, and not to the remote voice-mail server. In Figure 19: SIP MWI to ISDN QSIG When PBX is Connected to a Remote Cisco Router, on page 544, a voice mail server and Cisco Unified CME are connected to the same LAN and a remote Cisco Unified CME is connected across the WAN. In this scenario, the protocol translation is performed at the remote Cisco router and the QSIG MWI message is sent to the PBX. Figure 19: SIP MWI to ISDN QSIG When PBX is Connected to a Remote Cisco Router VMWI There are two types of visual message waiting indicator (VMWI) features: Frequency-shift Keying (FSK) and DC voltage. The message-waiting lamp can be enabled to flash on an analog phone that requires an FSK Cisco Unified Communications Manager Express System Administrator Guide 544 Voice Mail Integration VMWI message to activate a visual indicator. The DC Voltage VMWI feature is used to flash the message-waiting lamp on an analog phone which requires DC voltage instead of an FSK message. For all other applications, such as MGCP, FSK VMWI is used even if the voice gateway is configured for DC voltage VMWI. The configuration for DC voltage VMWI issupported only forForeign ExchangeStation (FXS) ports on the Cisco VG224 analog voice gateway with analog device version V1.3 and V2.1. The Cisco VG224 can only support 12 Ringer Equivalency Number (REN) for ringing 24 onboard analog FXS voice ports. To support ringing and DC Voltage VMWI for 24 analog voice ports, stagger-ringing logic is used to maximize the limited REN resource. When a system runs out of REN because too many voice ports are being rung, the MWI lamp temporarily turns off to free up REN to ring the voice ports. DC voltage VMWI is also temporarily turned off any time the port's operational state is no longer idle and onhook, such as when one of the following events occur: • Incoming call on voice port • Phone goes off hook • The voice port is shut down or busied out Once the operational state of the port changes to idle and onhook again, the MWI lamp resumes flashing until the application receives a requests to clear it; for example, if there are no more waiting messages. For configuration information, see Transfer to Voice Mail. Transfer to Voice Mail The Transfer to Voice Mail feature allows a phone user to transfer a caller directly to a voice-mail extension. The user pressesthe TrnsfVM softkey to place the call on hold, entersthe extension number, and then commits the transfer by pressing the TrnsfVM softkey again. The caller hears the complete voice mail greeting. This feature is supported using the TrnsfVM softkey or feature access code (FAC). For example, a receptionist might screen calls for five managers. If a call comes in for a manager who is not available, the receptionist can transfer the caller to the manager's voice-mail extension by using the TrnsfVM softkey and the caller hears the personal greeting of the individual manager. For configuration information, see Transfer to Voice Mail. Live Record The Live Record feature enablesIPphone usersin a Cisco Unified CME system to record a phone conversation if Cisco Unity Expressisthe voice mailsystem. An audible notification, either by announcement or by periodic beep, alerts participants that the conversation is being recorded. The playing of the announcement or beep is under the control of Cisco Unity Express. Live Record is supported for two-party calls and ad hoc conferences. In normal record mode, the conversation is recorded after the LiveRcd softkey is pressed. This puts the other party on-hold and initiates a call to Cisco Unity Express at the configured live-record number. To stop the recording session, the phone user presses the LiveRcd softkey again, which toggles between on and off. The Live-Record number is configured globally and must match the number configured in Cisco Unity Express. You can control the availability of the feature on individual phones by modifying the display of the LiveRcd softkey using an ephone template. This feature must be enabled on both Cisco Unified CME and Cisco Unity Express. Cisco Unified Communications Manager Express System Administrator Guide 545 Voice Mail Integration Transfer to Voice Mail To enable Live Record in Cisco Unified CME, see Configure Live Record on SCCP Phones. Cisco Unity Express AXL Enhancement In Cisco Unified CME 7.0(1) and later versions, the Cisco Unity Express AXL enhancement in Cisco Unified CME provides better administrative integration between Cisco Unified CME and Cisco Unity Express by automatically synchronizing passwords. No configuration is required to enable this feature. Configure Voice-Mail Integration Configure a Voice Mailbox Pilot Number on a SCCP Phone To configure the telephone number that isspeed-dialed when the Message button on aSCCPphone is pressed, perform the following steps. Note The same telephone number is configured for voice messaging for allSCCPphonesin Cisco Unified CME. Before You Begin • Voicemail phone number must be a valid number; directory number and number for voicemail phone number must be configured. SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. voicemail phone-number 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. Cisco Unified Communications Manager Express System Administrator Guide 546 Voice Mail Integration Cisco Unity Express AXL Enhancement Command or Action Purpose configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register global configuration mode to set parameters for all supported phones in Cisco Unified CME. telephony-service Example: Router(config)# telephony-service Step 3 Defines the telephone number that is speed-dialed when the Messages button on a Cisco Unified IP phone is pressed. voicemail phone-number Example: Router(config-telephony)# voice mail 0123 Step 4 • phone-number—Same phone number is configured for voice messaging for all SCCP phones in a Cisco Unified CME. end Exits to privileged EXEC mode. Example: Router(config-telephony)# end Step 5 What to Do Next • (Cisco Unified CME 4.0 or a later version only) To set up a mailbox selection policy, see Configure a Mailbox Selection Policy on SCCP Phone. • To set up DTMFintegration patternsfor connecting to analog voice-mail applications,see Enable DTMF Integration for Analog Voice-Mail Applications. • To connect to a remote SIP-based IVR or Cisco Unity, or to connect to a remote SIP-PSTN that goes through the PSTN to a voice-mail or IVR application, see Enable DTMF Integration Using RFC 2833. • To connect to a Cisco Unity Express system, configure a nonstandard SIP NOTIFY format. See Enable DTMF Integration Using SIP NOTIFY. Configure a Mailbox Selection Policy on SCCP Phone Perform one of the following tasks, depending on which voice-mail application is used: • Set a Mailbox Selection Policy for Cisco Unity Express or a PBX Voice-Mail Number • Set a Mailbox Selection Policy for Cisco Unity Cisco Unified Communications Manager Express System Administrator Guide 547 Voice Mail Integration Configure a Mailbox Selection Policy on SCCP Phone Set a Mailbox Selection Policy for Cisco Unity Express or a PBX Voice-Mail Number To set a policy for selecting a mailbox for calls from a Cisco Unified CME system that are diverted before being sent to a Cisco Unity Express or PBX voice-mail pilot number, perform the following steps. Restriction In the following scenarios, the mailbox selection policy can fail to work properly: • The last redirecting endpoint is not hosted on Cisco Unified CME. This may rarely occur with a PBX. • A call is forwarded across several SIP trunks. Multiple SIP Diversion Headers (stacking hierarchy) are not supported in Cisco IOS software. • A call is forwarded across non-Cisco voice gateways that do not support the optional H450.3 originalCalledNr field. Before You Begin Cisco Unified CME 4.0 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. dial-peer voice tag voip or dial-peer voice tag pots 4. mailbox-selection [last-redirect-num | orig-called-num] 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 dial-peer voice tag voip or dial-peer voice Enters dial-peer configuration mode. tag pots Step 3 • tag—identifies the dial peer. Valid entries are 1 to 2147483647. Example: Router(config)# dial-peer voice 7000 voip Use this command on the outbound dial peer associated with the pilot number of the voice-mail system. For systems using Cisco Unity Express, this is a VoIPdial peer.For systems using PBX-based voice mail, this is a POTS dial peer. Note Cisco Unified Communications Manager Express System Administrator Guide 548 Voice Mail Integration Configure a Mailbox Selection Policy on SCCP Phone Command or Action Purpose or Router(config)# dial-peer voice 35 pots Sets a policy for selecting a mailbox for calls that are diverted before being sent to a voice-mail line. mailbox-selection [last-redirect-num | orig-called-num] Step 4 Example: Router(config-dial-peer)# mailbox-selection orig-called-num • last-redirect-num—(PBX voice mail only) The mailbox number to which the call will be sent is the last number to divert the call (the number that sends the call to the voice-mail pilot number). • orig-called-num—(Cisco Unity Express only) The mailbox number to which the call will be sent is the number that was originally dialed before the call was diverted. end Returns to privileged EXEC mode. Example: Router(config-ephone-dn)# end Step 5 What to Do Next • To use voice mail on a SIP network that connects to a Cisco Unity Express system, configure a nonstandard SIP NOTIFY format. See Enable DTMF Integration Using SIP NOTIFY. Set a Mailbox Selection Policy for Cisco Unity To set a policy for selecting a mailbox for calls that are diverted before being sent to a Cisco Unity voice-mail pilot number, perform the following steps. Restriction This feature might not work properly in certain network topologies, including when: • The last redirecting endpoint is not hosted on Cisco Unified CME. This may rarely occur with a PBX. • A call is forwarded across several SIP trunks. Multiple SIP Diversion Headers (stacking hierarchy) are not supported in Cisco IOS software. • A call is forwarded across other voice gateways that do not support the optional H450.3 originalCalledNr field. Before You Begin • Cisco Unified CME 4.0 or a later version. • Directory number to be configured is associated with a voice mailbox. Cisco Unified Communications Manager Express System Administrator Guide 549 Voice Mail Integration Configure a Mailbox Selection Policy on SCCP Phone SUMMARY STEPS 1. enable 2. configure terminal 3. exit 4. ephone-dn dn-tag 5. mailbox-selection [last-redirect-num] 6. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 exit Exits dial-peer configuration mode. Example: Router(config-dial-peer)# exit Step 3 ephone-dn dn-tag Enters ephone-dn configuration mode. Example: Router(config)# ephone-dn 752 Step 4 Sets a policy for selecting a mailbox for calls that are diverted before being sent to a Cisco Unity voice-mail pilot number. mailbox-selection [last-redirect-num] Example: Router(config-ephone-dn)# mailbox-selection last-redirect-num Step 5 end Returns to privileged EXEC mode. Example: Router(config-ephone-dn)# end Step 6 Cisco Unified Communications Manager Express System Administrator Guide 550 Voice Mail Integration Configure a Mailbox Selection Policy on SCCP Phone What to Do Next • To use a remoteSIP-based IVR or Cisco Unity, or to connect Cisco Unified CME to a remoteSIP-PSTN that goes through the PSTN to a voice-mail or IVR application, see Enable DTMF Integration Using RFC 2833. Transfer to Voice Mail To enable a phone user to transfer a call to voice mail by using the TrnsfVM softkey or a FAC, perform the following steps. The TrnsfVM softkey is not supported on the Cisco Unified IP Phone 7905, 7912, or 7921, or analog phones connected to the Cisco VG224 or Cisco ATA. These phones support the trnsfvm FAC. Restriction Before You Begin • Cisco Unified CME 4.3 or a later version. • Cisco Unity Express 3.0 or a later version, installed and configured. • For information about standard and custom FACs, see Feature Access Codes. SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-template template-tag 4. softkeys connected {[Acct] [ConfList] [Confrn] [Endcall] [Flash] [HLog] [Hold] [Join] [LiveRcd] [Park] [RmLstC] [Select] [TrnsfVM] [Trnsfer]} 5. exit 6. ephone phone-tag 7. ephone-template template-tag 8. exit 9. telephony-service 10. voicemail phone-number 11. fac {standard | custom trnsfvm custom-fac} 12. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Cisco Unified Communications Manager Express System Administrator Guide 551 Voice Mail Integration Transfer to Voice Mail Command or Action Purpose Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters ephone-template configuration mode to create an ephone template. ephone-template template-tag Example: Router(config)# ephone-template 5 Step 3 • template-tag—Unique identifier for the ephone template. Range: 1 to 20. (Optional) Modifies the order and type of softkeys that display on an IP phone during the connected call state. softkeys connected{[Acct] [ConfList] [Confrn] [Endcall] [Flash] [HLog] [Hold] [Join] Step 4 [LiveRcd] [Park] [RmLstC] [Select] [TrnsfVM] [Trnsfer]} • You can enter any of the keywords in any order. Example: Router(config-ephone-template)# softkeys connected TrnsfVM Park Acct ConfList Confrn Endcall Trnsfer Hold • Default is all softkeys are displayed in alphabetical order. • Any softkey that is not explicitly defined is disabled. exit Exits ephone-template configuration mode. Example: Router(config-ephone-template)# exit Step 5 Step 6 ephone phone-tag Enters ephone configuration mode. Example: Router(config)# ephone 12 • phone-tag—Unique number that identifiesthis ephone during configuration tasks. Step 7 ephone-template template-tag Applies the ephone template to the phone. Example: Router(config-ephone)# ephone-template 5 • template-tag—Unique identifier of the ephone template that you created in Step 3, on page 552. exit Exits ephone configuration mode. Example: Router(config-ephone)# exit Step 8 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 9 Cisco Unified Communications Manager Express System Administrator Guide 552 Voice Mail Integration Transfer to Voice Mail Command or Action Purpose Defines the telephone number that is speed-dialed when the Messages button on a Cisco Unified IP phone is pressed. voicemail phone-number Example: Router(config-telephony)# voicemail 8900 Step 10 • phone-number—Same phone number is configured for voice messaging for all SCCP phones in a Cisco Unified CME. Step 11 fac {standard | custom trnsfvm custom-fac} Enables standard FACs or creates a custom FAC or alias. Example: Router(config-telephony)# fac custom trnsfvm #22 • standard—Enables standard FACs for all phones. Standard FAC for transfer to voice mail is *6. • custom—Creates a custom FAC for a FAC type. • custom-fac—User-defined code to be dialed using the keypad on an IP or analog phone. Custom FAC can be up to 256 characters long and contain numbers 0 to 9 and * and #. end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 12 The following example shows a configuration where the display order of the TrnsfVM softkey is modified for the connected call state in ephone template 5 and assigned to ephone 12. A custom FAC for transfer to voice mail is set to #22. telephony-service max-ephones 100 max-dn 240 timeouts transfer-recall 60 voicemail 8900 max-conferences 8 gain -6 transfer-system full-consult fac custom trnsfvm #22 ! ! ephone-template 5 softkeys connected TrnsfVM Park Acct ConfList Confrn Endcall Trnsfer Hold max-calls-per-button 3 busy-trigger-per-button 2 ! ! ephone 12 ephone-template 5 mac-address 000F.9054.31BD type 7960 button 1:10 2:7 What to Do Next • If you are finished modifying parametersfor phonesin Cisco Unified CME, generate a new configuration file and restart the phones. See Generate Configuration Files for SCCP Phones. • For information on how phone users transfer a call to voice mail, see Cisco Unified IP Phone documentation for Cisco Unified CME. Cisco Unified Communications Manager Express System Administrator Guide 553 Voice Mail Integration Transfer to Voice Mail Configure Live Record on SCCP Phones To configure the Live Record feature so that a phone user can record a conversation by pressing the LiveRcd softkey, perform the followings steps. Restriction • Only one live record session is allowed for each conference. • Only the conference creator can initiate a live record session. In an ad hoc conference, participants who are not the conference creator cannot start a live record session. In a two-party call, the party who starts the live record session is the conference creator. Note For legal disclaimer information about this feature, see copyright information section. Before You Begin • Cisco Unified CME 4.3 or a later version. • Cisco Unity Express 3.0 or a later version, installed and configured. For information on configuring Live Record in Cisco Unity Express, see Configure Live Record in the Cisco Unity Express Voice-Mail and Auto-Attendant CLI Administrator Guide for 3.0 and Later Versions. • Ad hoc hardware conference resource is configured and ready to use. See Configure Conferencing. • If phone user wantsto view the live record session, include ConfListsoftkey using the softkeys connected command. Cisco Unified Communications Manager Express System Administrator Guide 554 Voice Mail Integration Configure Live Record on SCCP Phones SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. live record number 5. voicemail number 6. exit 7. ephone-dn dn-tag 8. number number [secondary number] [no-reg [both | primary]] 9. call-forward all target-number 10. exit 11. ephone-template template-tag 12. softkeys connected {[Acct] [ConfList] [Confrn] [Endcall] [Flash] [HLog] [Hold] [Join] [LiveRcd] [Park] [RmLstC] [Select] [TrnsfVM] [Trnsfer]} 13. exit 14. ephone phone-tag 15. ephone-template template-tag 16. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 3 Defines the extension number that is dialed when the LiveRcd softkey is pressed on an SCCP IP phone. live record number Example: Router(config-telephony)# live record 8900 Step 4 Cisco Unified Communications Manager Express System Administrator Guide 555 Voice Mail Integration Configure Live Record on SCCP Phones Command or Action Purpose Defines the extension number that is speed-dialed when the Messages button is pressed on an IP phone. voicemail number Example: Router(config-telephony)# voicemail 8000 Step 5 • Number—Cisco Unity Express voice-mail pilot number. exit Exits telephony-service configuration mode. Example: Router(config-telephony)# exit Step 6 Creates a directory number that forwards all calls to the Cisco Unity Express voice-mail pilot number. ephone-dn dn-tag Example: Router(config)# ephone-dn 10 Step 7 number number[secondary number] [no-reg [both Assigns an extension number to this directory number. | primary]] Step 8 • Number—Must match the Live Record pilot-number configured in Step 4, on page 555. Example: Router(config-ephone-dn)# number 8900 Forwards all calls to this extension to the specified voice-mail number. call-forward all target-number Example: Router(config-ephone-dn)# call-forward all 8000 Step 9 • target-number—Phone number to which calls are forwarded. Must match the voice-mail pilot number configured in Step 5, on page 556. Phone users can activate and cancel the call-forward-all state from the phone using the CFwdAll softkey or a FAC. Note exit Exits ephone-dn configuration mode. Example: Router(config-ephone-dn)# exit Step 10 Enters ephone-template configuration mode to create an ephone template. ephone-template template-tag Example: Router(config)# ephone-template 5 Step 11 • template-tag—Unique identifier for the ephone template. Range: 1 to 20. Modifies the order and type of softkeys that display on an IP phone during the connected call state. softkeys connected {[Acct] [ConfList] [Confrn] [Endcall] [Flash] [HLog] [Hold] [Join] [LiveRcd] [Park] [RmLstC] [Select] [TrnsfVM] [Trnsfer]} Step 12 Example: Router(config-ephone-template)# softkeys connected LiveRcd Confrn Hold Park Trnsfer TrnsfVM Cisco Unified Communications Manager Express System Administrator Guide 556 Voice Mail Integration Configure Live Record on SCCP Phones Command or Action Purpose exit Exits ephone-template configuration mode. Example: Router(config-ephone-template)# exit Step 13 Step 14 ephone phone-tag Enters ephone configuration mode. Example: Router(config)# ephone 12 • phone-tag—Unique number that identifies this ephone during configuration tasks. Step 15 ephone-template template-tag Applies the ephone template to the phone. Example: Router(config-ephone)# ephone-template 5 • template-tag—Unique identifier of the ephone template that you created in Step 11, on page 556. end Exits to privileged EXEC mode. Example: Router(config-ephone)# end Step 16 The following example shows Live Record is enabled at the system-level for extension 8900. All incoming calls to extension 8900 are forwarded to the voice-mail pilot number 8000 when the LiveRcd softkey is pressed, as configured under ephone-dn 10. Ephone template 5 modifies the display order of the LiveRcd softkey on IP phones. telephony-service privacy-on-hold max-ephones 100 max-dn 240 timeouts transfer-recall 60 live-record 8900 voicemail 8000 max-conferences 8 gain -6 transfer-system full-consult fac standard ! ! ephone-template 5 softkeys remote-in-use CBarge Newcall softkeys hold Resume Newcall Join softkeys connected LiveRcd Confrn Hold Park Trnsfer TrnsfVM max-calls-per-button 3 busy-trigger-per-button 2 ! ! ephone-dn 10 number 8900 call-forward all 8000 Configure a Voice Mailbox Pilot Number on a SIP Phone To configure the telephone number that is speed-dialed when the Message button on a SIP phone is pressed, follow the steps in this section. Cisco Unified Communications Manager Express System Administrator Guide 557 Voice Mail Integration Configure a Voice Mailbox Pilot Number on a SIP Phone The same telephone number is configured for voice messaging for all SIP phones in Cisco Unified CME. The call forward b2bua command enables call forwarding and designates that calls that are forwarded to a busy or no-answer extension be sent to a voicemail box. Note Before You Begin • Directory number and number for voicemail phone number must be configured. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register global 4. voicemail phone-number 5. exit 6. voice register dn dn-tag 7. call-forward b2bua busy directory-number 8. call-forward b2bua mailbox directory-number 9. call-forward b2bua noan directory-number timeout seconds 10. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register global configuration mode to set parameters for all supported SIP phones in Cisco Unified CME. voice register global Example: Router(config)# voice register global Step 3 Defines the telephone number that is speed-dialed when the Messages button on a Cisco Unified IP phone is pressed. voicemail phone-number Example: Router(config-register-global)# voice mail 1111 Step 4 • phone-number—Same phone number is configured for voice messaging for all SIP phones in a Cisco Unified CME. Cisco Unified Communications Manager Express System Administrator Guide 558 Voice Mail Integration Configure a Voice Mailbox Pilot Number on a SIP Phone Command or Action Purpose exit Exits voice register global configuration mode. Example: Router(config-register-global)# exit Step 5 Enters voice register dn mode to define a directory number for a SIP phone, intercom line, voice port, or an MWI. voice register dn dn-tag Example: Router(config)# voice register dn 2 Step 6 Enables call forwarding for a SIP back-to-back user agent so that incoming calls to an extension that is busy will be forwarded to the designated directory number. call-forward b2bua busy directory-number Example: Router(config-register-dn)# call-forward b2bua busy 1000 Step 7 Designates the voice mailbox to use at the end of a chain of call forwards. call-forward b2bua mailbox directory-number Example: Router(config-register-dn)# call-forward b2bua mailbox 2200 Step 8 • Incoming calls have been forwarded to a busy or no-answer extension will be forwarded to the directory-numberspecified. Enables call forwarding for a SIP back-to-back user agent so that incoming calls to an extension that does not answer will be forwarded to the designated directory number. call-forward b2bua noan directory-number timeout seconds Example: Router(config-register-dn)# call-forward b2bua noan 2201 timeout 15 Step 9 • seconds—Number of seconds that a call can ring with no answer before the call is forwarded to another extension. Range: 3 to 60000. Default: 20. end Exits to privileged EXEC mode. Example: Router(config-register-dn)# end Step 10 What to Do Next • To set up DTMFintegration patternsfor connecting to analog voice-mail applications,see Enable DTMF Integration for Analog Voice-Mail Applications. • To use a remote SIP-based IVR or Cisco Unity, or to connect to a remote SIP-PSTN that goes through the PSTN to a voice-mail or IVR application, see Enable DTMF Integration Using RFC 2833. • To connect to a Cisco Unity Express system, configure a nonstandard SIP NOTIFY format, see Enable DTMF Integration Using SIP NOTIFY. Cisco Unified Communications Manager Express System Administrator Guide 559 Voice Mail Integration Configure a Voice Mailbox Pilot Number on a SIP Phone Enable DTMF Integration Perform one of the following tasks, depending on which DTMF-relay method is required: • Enable DTMF Integration for Analog Voice-Mail Applications—To set up DTMF integration patterns for connecting to analog voice-mail applications. • Enable DTMF Integration Using RFC 2833—To connect to a remote SIP-based IVR or voice-mail application such as Cisco Unity or whenSIPis used to connect Cisco Unified CME to a remoteSIP-PSTN voice gateway that goes through the PSTN to a voice-mail or IVR application. • Enable DTMF Integration Using SIP NOTIFY—To configure a SIP dial peer to point to Cisco Unity Express. Enable DTMF Integration for Analog Voice-Mail Applications To set up DTMF integration patterns for analog voice-mail applications, perform the following steps. You can configure multiple tags and tokens for each pattern, depending on the voice-mail system and type of access. Note SUMMARY STEPS 1. enable 2. configure terminal 3. vm-integration 4. pattern direct tag1 {CGN | CDN | FDN} [tag2 {CGN | CDN | FDN}] [tag3 {CGN | CDN | FDN}] [last-tag] 5. pattern ext-to-ext busy tag1 {CGN |CDN | FDN} [tag2 {CGN | CDN |FDN}] [tag3 {CGN | CDN | FDN}] [last-tag] 6. pattern ext-to-ext no-answer tag1 {CGN | CDN | FDN} [tag2 {CGN |CDN | FDN}] [tag3 {CGN | CDN |FDN}] [last-tag] 7. pattern trunk-to-ext busy tag1 {CGN |CDN | FDN} [tag2 {CGN | CDN |FDN}] [tag3 {CGN | CDN | FDN}] [last-tag] 8. pattern trunk-to-ext no-answer tag1 {CGN | CDN | FDN} [tag2 {CGN |CDN | FDN}] [tag3 {CGN |CDN | FDN}] [last-tag] 9. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Cisco Unified Communications Manager Express System Administrator Guide 560 Voice Mail Integration Enable DTMF Integration Command or Action Purpose Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice-mail integration configuration mode and enables voice-mail integration with DTMFand an analog voice-mailsystem. vm-integration Example: Router(config) vm-integration Step 3 Configuresthe DTMFdigit pattern forwarding necessary to activate the voice-mail system when the user presses the messages button on the phone. pattern direct tag1 {CGN | CDN | FDN} [tag2 {CGN | CDN | FDN}] [tag3 {CGN | CDN | FDN}] [last-tag] Step 4 Example: Router(config-vm-integration) pattern direct 2 CGN * • The tag attribute is an alphanumeric string fewer than four DTMF digits in length. The alphanumeric string consists of a combination of four letters (A, B, C, and D), two symbols (* and #), and ten digits (0 to 9). The tag numbers match the numbers defined in the voice-mail system’s integration file, immediately preceding either the number of the calling party, the number of the called party, or a forwarding number. • The keywords, CGN, CDN, and FDN, configure the type of call information sent to the voice-mailsystem,such as calling number (CGN), called number (CDN), or forwarding number (FDN). Configuresthe DTMFdigit pattern forwarding necessary to activate the voice-mail system when an internal extension attempts to connect to a busy extension and the call is forwarded to voice mail. pattern ext-to-ext busy tag1 {CGN |CDN | FDN} [tag2 {CGN | CDN |FDN}] [tag3 {CGN | CDN | FDN}] [last-tag] Example: Router(config-vm-integration) pattern ext-to-ext busy 7 FDN * CGN * Step 5 Configuresthe DTMFdigit pattern forwarding necessary to activate the voice-mail system when an internal extension fails to connect to an extension and the call is forwarded to voice mail. pattern ext-to-ext no-answer tag1 {CGN | CDN | FDN} [tag2 {CGN |CDN | FDN}] [tag3 {CGN | CDN |FDN}] [last-tag] Example: Router(config-vm-integration) pattern ext-to-ext no-answer 5 FDN * CGN * Step 6 Cisco Unified Communications Manager Express System Administrator Guide 561 Voice Mail Integration Enable DTMF Integration Command or Action Purpose Configuresthe DTMFdigit pattern forwarding necessary to activate the voice-mail system when an external trunk call reaches a busy extension and the call is forwarded to voice mail. pattern trunk-to-ext busy tag1 {CGN |CDN | FDN} [tag2 {CGN | CDN |FDN}] [tag3 {CGN | CDN | FDN}] [last-tag] Example: Router(config-vm-integration) pattern trunk-to-ext busy 6 FDN * CGN * Step 7 Configuresthe DTMFdigit pattern forwarding necessary to activate the voice-mail system when an external trunk call reaches an unanswered extension and the call is forwarded to voice mail. patterntrunk-to-extno-answer tag1 {CGN | CDN | FDN} [tag2 {CGN |CDN | FDN}] [tag3 {CGN |CDN | FDN}] [last-tag] Example: Router(config-vm-integration)# pattern trunk-to-ext no-answer 4 FDN * CGN * Step 8 end Exits configuration mode and enters privileged EXEC mode. Example: Router(config-vm-integration)# exit Step 9 What to Do Next After configuring DTMF relay, you are ready to configure Message Waiting Indicator (MWI) notification for either the MWI outcall, unsolicited notify, or subscribe/notify mechanism. See Configure a SCCP Phone for MWI Outcall. Enable DTMF Integration Using RFC 2833 To configure a SIP dial peer to point to Cisco Unity and enable SIP dual-tone multifrequency (DTMF) relay using RFC 2833, use the commands in this section on both the originating and terminating gateways. This DTMF relay method is required in the following situations: • When SIP is used to connect Cisco Unified CME to a remote SIP-based IVR or voice-mail application such as Cisco Unity. • WhenSIPis used to connect Cisco Unified CME to a remoteSIP-PSTN voice gateway that goesthrough the PSTN to a voice-mail or IVR application. If the T.38Fax Relay feature is also configured on thisIPnetwork, we recommend that you either configure the voice gateways to use a payload type other than PT96 or PT97 for fax relay negotiation, or depending on whether the SIP endpoints support different payload types, configure Cisco Unified CME to use a payload type other than PT96 or PT97 for DTMF. Note Cisco Unified Communications Manager Express System Administrator Guide 562 Voice Mail Integration Enable DTMF Integration Before You Begin • Configure the codec or voice-class codec command for transcoding between G.711 and G.729. SUMMARY STEPS 1. enable 2. configure terminal 3. dial-peer voice tag voip 4. description string 5. destination-pattern string 6. session protocol sipv2 7. session target {dns:address | ipv4:destination-address} 8. dtmf-relay rtp-nte 9. dtmf-interworking rtp-nte 10. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters dial-peer configuration mode to define a VoIP dial peer for the voice-mail system. dial-peer voice tag voip Example: Router (config)# dial-peer voice 123 voip Step 3 • tag—Defines the dial peer being configured. Range is 1 to 2147483647. (Optional) Associates a description with the dial peer being configured. Enter a string of up to 64 characters. description string Example: Router (config-voice-dial-peer)# description CU pilot Step 4 Step 5 destination-pattern string Specifiesthe pattern of the numbersthat the user must dial to place a call. Example: Router (config-voice-dial-peer)# destination-pattern 20 • string—Prefix or full E.164 number. Cisco Unified Communications Manager Express System Administrator Guide 563 Voice Mail Integration Enable DTMF Integration Command or Action Purpose Specifies that Internet Engineering Task Force (IETF) Session Initiation Protocol (SIP) is protocol to be used for calls between local and remote routers using the packet network. session protocol sipv2 Example: Router (config-voice-dial-peer)# session protocol sipv2 Step 6 Designates a network-specific address to receive calls from the dial peer being configured. session target {dns:address | ipv4:destination-address} Step 7 Example: Router (config-voice-dial-peer)# session target ipv4:10.8.17.42 • dns:address—Specifies the DNSaddress of the voice-mail system. • ipv4:destination- address—Specifies the IP address of the voice-mail system. Step 8 dtmf-relay rtp-nte Sets DTMF relay method for the voice dial peer being configured. Example: Router (config-voice-dial-peer)# dtmf-relay rtp-nte • rtp-nte— Provides conversion from the out-of-band SCCP indication to the SIP standard for DTMF relay (RFC 2833). Forwards DTMF tones by using Real-Time Transport Protocol (RTP) with the Named Telephone Event (NTE) payload type. • This command can also be configured in voice-register-pool configuration mode. For individual phones, the phone-level configuration for this command overrides the system-level configuration for this command. The need to use out-of-band conversion is limited to SCCP phones. SIP phones natively support in-band. Note (Optional) Enables a delay between the dtmf-digit begin and dtmf-digit end events in the RFC 2833 packets. dtmf-interworking rtp-nte Example: Router (config-voice-dial-peer)# dtmf-interworking rtp-nte Step 9 • This command is supported in Cisco IOS Release 12.4(15)XZ and later releases and in Cisco Unified CME 4.3 and later versions. • This command can also be configured in voice-service configuration mode. end Exits to privileged EXEC mode. Example: Router(config-voice-dial-peer)# end Step 10 What to Do Next After configuring DTMF relay, you are ready to configure Message Waiting Indicator (MWI) notification for either the MWI outcall, unsolicited notify, or subscribe/notify mechanism. See Configure a SCCP Phone for MWI Outcall. Cisco Unified Communications Manager Express System Administrator Guide 564 Voice Mail Integration Enable DTMF Integration Enable DTMF Integration Using SIP NOTIFY To configure aSIPdial peer to point to Cisco Unity Express and enableSIPdual-tone multi-frequency (DTMF) relay using SIP NOTIFY format, follow the steps in this task. SUMMARY STEPS 1. enable 2. configure terminal 3. dial-peer voice tag voip 4. description string 5. destination-pattern string 6. b2bua 7. session protocol sipv2 8. session target {dns:address | ipv4:destination-address} 9. dtmf-relay sip-notify 10. codec g711ulaw 11. no vad 12. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal# Step 2 Enters dial-peer configuration mode to define a VoIP dial peer for the voice-mail system. dial-peer voice tag voip Example: Router (config)# dial-peer voice 2 voip Step 3 • tag—Defines the dial peer being configured. Range is 1 to 2147483647. (Optional) Associates a description with the dial peer being configured. Enter a string of up to 64 characters. description string Example: Router (config-voice-dial-peer)# description cue pilot Step 4 Cisco Unified Communications Manager Express System Administrator Guide 565 Voice Mail Integration Enable DTMF Integration Command or Action Purpose Specifies the pattern of the numbers that the user must dial to place a call. destination-pattern string Example: Router (config-voice-dial-peer)# destination-pattern 20 Step 5 • string—Prefix or full E.164 number. (Optional) Includesthe Cisco Unified CME address as part of contact in 3XX response to point to Cisco Unity Express and enables SIP-to-SCCP call forward. b2bua Example: Router (config-voice-dial-peer)# b2bua Step 6 Specifies that Internet Engineering Task Force (IETF) Session InitiationProtocol (SIP) is protocol to be used for calls between local and remote routers using the packet network. session protocol sipv2 Example: Router (config-voice-dial-peer)# session protocol sipv2 Step 7 Designates a network-specific address to receive calls from the dial peer being configured. session target {dns:address | ipv4:destination-address} Step 8 Example: Router (config-voice-dial-peer)# session target ipv4:10.5.49.80 • dns:address—Specifies the DNS address of the voice-mail system. • ipv4:destination- address—Specifies the IP address of the voice-mail system. Step 9 dtmf-relay sip-notify Setsthe DTMFrelay method for the voice dial peer being configured. Example: Router (config-voice-dial-peer)# dtmf-relay sip-notify • sip-notify— Forwards DTMF tones using SIP NOTIFY messages. • This command can also be configured in voice-register-pool configuration mode. For individual phones, the phone-level configuration for this command overrides the system-level configuration for this command. Specifies the voice coder rate of speech for a dial peer being configured. codec g711ulaw Example: Router (config-voice-dial-peer)# codec g711ulaw Step 10 Disables voice activity detection (VAD) for the calls using the dial peer being configured. no vad Example: Router (config-voice-dial-peer)# no vad Step 11 end Exits to privileged EXEC mode. Example: Router(config-voice-dial-peer)# end Step 12 Cisco Unified Communications Manager Express System Administrator Guide 566 Voice Mail Integration Enable DTMF Integration What to Do Next After configuring DTMF relay, you are ready to configure Message Waiting Indicator (MWI). See Configure a SCCP Phone for MWI Outcall. Configure a SCCP Phone for MWI Outcall To designate a phone line or directory number on an individual SCCP phone to be monitored for voice-mail messages, or to enable audible MWI, perform the following steps. Restriction • Audible MWI is supported only in Cisco Unified CME 4.0(2) and later versions. • Audible MWI issupported only on Cisco Unified IPPhone 7931G and Cisco Unified IPPhone 7911. Before You Begin • Directory number and number for MWI line must be configured. SUMMARY STEPS 1. enable 2. configure terminal 3. ephone phone-tag 4. mwi-line line-number 5. exit 6. ephone-dn dn-tag 7. mwi {off | on | on-off} 8. mwi-type {visual | audio | both} 9. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Cisco Unified Communications Manager Express System Administrator Guide 567 Voice Mail Integration Configure a SCCP Phone for MWI Outcall Command or Action Purpose ephone phone-tag Enters ephone configuration mode. Example: Router(config)# ephone 36 Step 3 Step 4 mwi-line line-number (Optional) Selects a phone line to receive MWI treatment. Example: Router(config-ephone)# mwi-line 3 • line-number—Number of phone line to receive MWI notification. Range: 1 to 34. Default: 1. exit Exits ephone configuration mode. Example: Router(config-ephone)# exit Step 5 ephone-dn dn-tag Enters ephone-dn configuration mode. Example: Router(config)# ephone-dn 11 Step 6 (Optional) Enables a specific directory number to receive MWI notification from an external voice-messaging system. mwi {off | on | on-off} Example: Router(config-ephone-dn)# mwi on-off Step 7 This command can also be configured in ephone-dn-template configuration mode. The value that you set in ephone-dn configuration mode has priority over the value set in ephone-dn-template mode. Note Step 8 mwi-type {visual | audio | both} (Optional) Specifies which type of MWI notification to be received. Example: Router(config-ephone-dn)# mwi-type audible This command is supported only on the Cisco Unified IP Phone 7931G and Cisco Unified IP Phone 7911. Note This command can also be configured in ephone-dn-template configuration mode. The value that you set in ephone-dn configuration mode has priority over the value set in ephone-dn-template mode.For configuration information,see Create an Ephone-dn Template. Note end Returns to privileged EXEC mode. Example: Router(config-ephone-dn)# end Step 9 Enable MWI at the System-Level on SIP Phones To enable a message waiting indicator (MWI) at a system-level, perform the following steps. Cisco Unified Communications Manager Express System Administrator Guide 568 Voice Mail Integration Enable MWI at the System-Level on SIP Phones Before You Begin • Cisco CME 3.4 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register global 4. mwi reg-e164 5. mwi stutter 6. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register global configuration mode to set parameters for all supported SIP phones in Cisco Unified CME. voice register global Example: Router(config)# voice register global Step 3 Registers full E.164 number to the MWI server in Cisco Unified CME and enables MWI. mwi reg-e164 Example: Router(config-register-global)# mwi reg-e164 Step 4 Enables Cisco Unified CME router at the central site to relay MWI notification to remote SIP phones. mwi stutter Example: Router(config-register-global)# mwi stutter Step 5 end Exits to privileged EXEC mode. Example: Router(config-register-global)# end Step 6 Cisco Unified Communications Manager Express System Administrator Guide 569 Voice Mail Integration Enable MWI at the System-Level on SIP Phones Configure a Directory Number for MWI on SIP Phones Perform one of the following tasks, depending on whether you want to configure MWI outcall or MWI notify (unsolicited notify or subscribe/notify) for SIP endpoints in Cisco Unified CME. • Define Pilot Call Back Number for MWI Outcall • Configure a Directory Number for MWI NOTIFY Define Pilot Call Back Number for MWI Outcall To designate a phone line on an individual SIP directory number to be monitored for voice-mail messages, perform the following steps. Restriction • For Cisco Unified CME 4.1 and later versions, the Call Forward All, Presence, and MWI features require thatSIPphones must be configured with a directory number by using thenumber command with the dn keyword; direct line numbers are not supported. Before You Begin • Cisco CME 3.4 or a later version. • Directory number and number for receiving MWI must be configured. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register dn dn-tag 4. mwi 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Cisco Unified Communications Manager Express System Administrator Guide 570 Voice Mail Integration Configure a Directory Number for MWI on SIP Phones Command or Action Purpose Enters voice register dn configuration mode to define a directory number for a SIP phone, intercom line, voice port, or an MWI. voice register dn dn-tag Example: Router(config)# voice register dn 1 Step 3 Enables a specific directory number to receive MWI notification. mwi Example: Router(config-register-dn)# mwi Step 4 end Exits to privileged EXEC mode. Example: Router(config-ephone-dn)# end Step 5 Configure a Directory Number for MWI NOTIFY To identify the MWI server and specify a directory number for receiving MWI Subscribe/NOTIFY or MWI Unsolicited NOTIFY, follow the steps in this section. Note We recommend using the Subscribe/NOTIFY method instead of an Unsolicited NOTIFY when possible. Restriction • For Cisco Unified CME 4.1 and later versions, the Call Forward All, Presence, and MWI features require thatSIPphones must be configured with a directory number by using thenumber command with the dn keyword; direct line numbers are not supported. • The SIP MWI - QSIG Translation feature in Cisco Unified CME 4.1 does not support Subscribe NOTIFY. • Cisco Unified IP Phone 7960, 7940, 7905, and 7911 support only Unsolicited NOTIFY for MWI. Before You Begin • Cisco CME 3.4 or a later version. • For Cisco Unified CME 4.0 and later, QSIQ supplementary services must be configured on the Cisco router. For information, see Enable H.450.7 and QSIG Supplementary Services at System-Level, on page 1202 or Enable H.450.7 and QSIG Supplementary Services on a Dial Peer, on page 1204. • Directory number and number for receiving MWI must be configured. Cisco Unified Communications Manager Express System Administrator Guide 571 Voice Mail Integration Configure a Directory Number for MWI on SIP Phones SUMMARY STEPS 1. enable 2. configure terminal 3. sip-ua 4. mwi-server {ipv4:destination-address |dns:host-name} [unsolicited] 5. exit 6. voice register dn dn-tag 7. mwi 8. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters Session Initiation Protocol (SIP) user agent (ua) configuration mode for configuring the user agent. sip-ua Example: Router(config)# sip-ua Step 3 mwi-server {ipv4:destination-address Specifies voice-mail server settings on a voice gateway or UA. |dns:host-name} [unsolicited] Step 4 The sip-server and mwi expires commands under the telephony-service configuration mode have been migrated to mwi-server to support DNSformat of the SIP server. Note Example: Router(config-sip-ua)# mwi-server ipv4:1.5.49.200 or Router(config-sip-ua)# mwi-server dns:server.yourcompany.com unsolicited Exits to the next highest mode in the configuration mode hierarchy. exit Example: Router(config-sip-ua)# exit Step 5 Enters voice register dn configuration mode to define a directory number for a SIP phone, intercom line, voice port, or an MWI. voice register dn dn-tag Example: Router(config)# voice register dn 1 Step 6 Cisco Unified Communications Manager Express System Administrator Guide 572 Voice Mail Integration Configure a Directory Number for MWI on SIP Phones Command or Action Purpose Enables a specific directory number to receive MWI notification. mwi Example: Router(config-register-dn)# mwi Step 7 end Exits to privileged EXEC mode. Example: Router(config-register-dn)# end Step 8 Enable SIP MWI Prefix Specification To accept unsolicited SIP Notify messages for MWI that include a prefix string as a site identifier, perform the following steps. Before You Begin • Cisco Unified CME 4.0 or a later version. • Directory number for receiving MWI Unsolicited NOTIFY must be configured. For information, see Configure a Directory Number for MWI NOTIFY. SUMMARY STEPS 1. enable 2. telephony-service 3. mwi prefix prefix-string 4. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 2 Cisco Unified Communications Manager Express System Administrator Guide 573 Voice Mail Integration Enable SIP MWI Prefix Specification Command or Action Purpose Specifies a string of digits that, if present before a known Cisco Unified CME extension number, are recognized as a prefix. mwi prefix prefix-string Example: Router(config-telephony)# mwi prefix 555 Step 3 • prefix-string—Digit string. The maximum prefix length is 32 digits. end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 4 Configure VMWI on SIP Phones To enable a VMWI, perform the following steps. Before You Begin • Cisco IOS Release 12.4(6)T or a later version SUMMARY STEPS 1. enable 2. configure terminal 3. voice-port port 4. mwi 5. vmwi dc-voltage or vmwi fsk 6. exit 7. sip-ua 8. mwi-server {ipv4:destination-address | dns:host-name} [unsolicited] 9. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. Cisco Unified Communications Manager Express System Administrator Guide 574 Voice Mail Integration Configure VMWI on SIP Phones Command or Action Purpose configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 voice-port port Enters voice-port configuration mode. Example: Router(config)# voice-port 2/0 • port—Syntax is platform-dependent. Type ? to determine. mwi Enables MWI for a specified voice port. Example: Router(config-voiceport)# mwi Step 4 (Optional) Enables DC voltage or FSK VMWI on a Cisco VG224 onboard analog FXS voice port. vmwi dc-voltage or vmwi fsk Example: Router(config-voiceport)# vmwi dc-voltage Step 5 You do not need to perform this step for the Cisco VG202 and Cisco VG204. They support FSK only. VMWI is configured automatically when MWI is configured on the voice port. This step is required for the VG224. If an FSK phone is connected to the voice port, use the fskkeyword. If a DC voltage phone is connected to the voice port, use the dc-voltage keyword. exit Exits to the next highest mode in the configuration mode hierarchy. Example: Router(config-sip-ua)# exit Step 6 Enters Session Initiation Protocol user agent configuration mode for configuring the user agent. sip-ua Example: Router(config)# sip-ua Step 7 Specifies voice-mail server settings on a voice gateway or user agent (ua). mwi-server {ipv4:destination-address | dns:host-name} [unsolicited] Step 8 Example: Router(config-sip-ua)# mwi-server ipv4:1.5.49.200 The sip-server and mwi expires commands under the telephony-service configuration mode have been migrated to mwi-server to support DNS format of the Session Initiation Protocol (SIP) server. Note or Router(config-sip-ua)# mwi-server dns:server.yourcompany.com unsolicited Exits voice-port configuration mode and returns to privileged EXEC mode. end Example: Router(config-voiceport)# end Step 9 Cisco Unified Communications Manager Express System Administrator Guide 575 Voice Mail Integration Configure VMWI on SIP Phones Verify Voice-Mail Integration • Press the Messages button on a local phone in Cisco Unified CME and listen for the voice mail greeting. • Dial an unattended local phone and listen for the voice mail greeting. • Leave a test message. • Go to the phone that you called. Verify that the [Message] indicator is lit. • Press the Messages button on this phone and retrieve the voice mail message. Configuration Examples for Voice-Mail Integration Example for Setting up a Mailbox Selection Policy for SCCP Phones The following example sets a policy to select the mailbox of the originally called number when a call is diverted to a Cisco Unity Express or PBX voice-mail system with the pilot number 7000. dial-peer voice 7000 voip destination-pattern 7000 session target ipv4:10.3.34.211 codec g711ulaw no vad mailbox-selection orig-called-num The following example sets a policy to select the mailbox of the last number that the call was diverted to before being diverted to a Cisco Unity voice-mail system with the pilot number 8000. ephone-dn 825 number 8000 mailbox-selection last-redirect-num Example for Configuring Voice Mailbox for SIP Phones The following example shows how to configure the call forward b2bua mailbox for SIP endpoints: voice register global voicemail 1234 ! voice register dn 2 number 2200 call-forward b2bua all 1000 call-forward b2bua mailbox 2200 call-forward b2bua noan 2201 timeout 15 mwi Cisco Unified Communications Manager Express System Administrator Guide 576 Voice Mail Integration Verify Voice-Mail Integration Example for Configuring DTMF Integration Using RFC 2833 The following example shows the configuration for DTMF Relay using RFC 2833: dial-peer voice 1 voip destination-pattern 4… session target ipv4:10.8.17.42 session protocol sipv2 dtmf-relay sip-notify rtp-nte Example for Configuring DTMF Integration Using SIP Notify The following example shows the configuration for DTMF using SIP Notify: dial-peer voice 1 voip destination-pattern 4… session target ipv4:10.5.49.80 session protocol sipv2 dtmf-relay sip-notify b2bua Example for Configuring DTMF Integration for Legacy Voice-Mail Applications The following example sets up DTMF integration for an analog voice-mail system. vm-integration pattern direct 2 CGN * pattern ext-to-ext busy 7 FDN * CGN * pattern ext-to-ext no-answer 5 FDN * CGN * pattern trunk-to-ext busy 6 FDN * CGN * pattern trunk-to-ext no-answer 4 FDN * CGN * Example for Enabling SCCP Phone Line for MWI The following example enables MWI on ephone 18 for line 2 (button 2), which has overlaid ephone-dns. Only a message waiting for the first ephone-dn (2021) on this line will activate the MWI lamp. Button 4 is unused. The line numbers in this example are as follows: • Line 1—Button 1—Extension 2020 • Line 2—Button 2—Extension 2021, 2022, 2023, 2024 • Line 3—Button 3—Extension 2021, 2022, 2023, 2024 (rollover line) • Button 4—Unused • Line 4—Button 5—Extension 2025 ephone-dn 20 number 2020 ephone-dn 21 number 2021 ephone-dn 22 number 2022 ephone-dn 23 number 2023 Cisco Unified Communications Manager Express System Administrator Guide 577 Voice Mail Integration Example for Configuring DTMF Integration Using RFC 2833 ephone-dn 24 number 2024 ephone-dn 25 number 2025 ephone 18 button 1:20 2o21,22,23,24,25 3x2 5:26 mwi-line 2 The following example enables MWI on ephone 17 for line 3 (extension 609). In this example, the button numbers do not match the line numbers because buttons 2 and 4 are not used. The line numbersin this example are as follows: • Line 1—Button 1—Extension 607 • Button 2—Unused • Line 2—Button 3—Extension 608 • Button 4—Unused • Line 3—Button 5—Extension 609 ephone-dn 17 number 607 ephone-dn 18 number 608 ephone-dn 19 number 609 ephone 25 button 1:17 3:18 5:19 mwi-line 3 Example for Configuring SIP MWI Prefix Specification The following example identifies the SIP server for MWI notification at the IP address 172.16.14.22. It states that the Cisco Unified CME system will accept unsolicited SIP Notify messages for known mailbox numbers using the prefix 555. sip-ua mwi-server 172.16.14.22 unsolicited telephony-service mwi prefix 555 Example for Configuring SIP Directory Number for MWI Outcall The following example shows an MWI callback pilot number: voice register dn number 9000…. mwi Cisco Unified Communications Manager Express System Administrator Guide 578 Voice Mail Integration Example for Configuring SIP MWI Prefix Specification Example for Configuring SIP Directory Number for MWI Unsolicited Notify The following example shows how to specify voice-mail server settings on a UA. The example includes the unsolicited keyword, enabling the voice-mailserver to send aSIPnotification message to the UA if the mailbox status changes and specifiesthat voice dn 1, number 1234 on theSIPphone in Cisco Unified CME will receive the MWI notification: sip-ua mwi-server dns:server.yourcompany.com expires 60 port 5060 transport udp unsolicited voice register dn 1 number 1234 mwi Example for Configuring SIP Directory Number for MWI Subscribe/NOTIFY The following example shows how to define an MWIserver and specify that directory number 1, number 1234 on a SIP phone in Cisco Unified CME is to receive the MWI notification: sip-ua mwi-server ipv4:1.5.49.200 voice register dn 1 number 1234 mwi Feature Information for Voice-Mail Integration The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required Table 38: Feature Information for Voice-Mail Integration Feature Name Cisco Unified CME Version Feature Information Provides support for selecting audible, visual, or audible and visual Message Waiting Indicator (MWI) on supported Cisco Unified IP phones. Audible MWI 4.0(2) Cisco Unified CME and Cisco Unity Express passwords are automatically synchronized. No configuration is required for this feature. Cisco Unity Express AXL 7.0(1) Enhancement Cisco Unified Communications Manager Express System Administrator Guide 579 Voice Mail Integration Example for Configuring SIP Directory Number for MWI Unsolicited Notify Feature Name Cisco Unified CME Version Feature Information Added support for voice messaging systems connected via a SIP trunk or SIP user agent. The standard Subscribe/NOTIFY method is preferred over an Unsolicited NOTIFY. DTMF Integration 3.4 DTMF integration patterns were introduced. 2.0 Enables IP phone users in a Cisco Unified CME system to record a phone conversation if Cisco Unity Express is the voice mail system. Live Record 4.3 Mailbox selection policy was introduced. Mailbox Selection Policy 4.0 MWI line selection of a phone line other than the primary line on a SCCP phone was introduced. MWI 4.0 Voice messaging systems (including Cisco Unity) connected via a SIP trunk or SIP user agent can pass a Message Waiting Indicator (MWI) that will be received and understood by a SIP phone directly connected to Cisco Unified CME. 3.4 SIP MWI prefix specification was introduced. SIP MWI Prefix Specification 4.0 Extends message waiting indicator (MWI) functionality for SIP MWI and QSIG MWI interoperation to enable sending and receiving of MWI over QSIG to PBX. SIP MWI - QSIG Translation 4.1 Enables a phone user to transfer a caller directly to a voice-mail extension. Transfer to Voice Mail 4.3 Cisco Unified Communications Manager Express System Administrator Guide 580 Voice Mail Integration Feature Information for Voice-Mail Integration CHAPTER 17 Security This chapter describesthe phone authentication support in Cisco Unified Communications Manager Express (Cisco Unified CME), Hypertext Transfer Protocol Secure (HTTPS) provisioning for Cisco Unified IP Phones, and the Media Encryption (SRTP) on Cisco Unified CME feature that provides the following secure voice call capabilities: • Secure call controlsignaling and media streamsin Cisco Unified CME networks usingSecure Real-Time Transport Protocol (SRTP) and H.323 protocols. • Secure supplementary services for Cisco Unified CME networks using H.323 trunks. • Secure Cisco VG224 Analog Phone Gateway endpoints. • Prerequisites for Security, page 581 • Restrictions for Security, page 582 • Information About Security, page 582 • Configure Security, page 597 • Configuration Examples for Security, page 643 • Where to Go Next, page 656 • Feature Information for Security, page 656 Prerequisites for Security • Cisco Unified CME 4.0 or a later version for Phone Authentication. • Cisco Unified CME 4.2 or a later version for Media Encryption (SRTP) on Cisco Unified CME. • Cisco IOS feature set Advanced Enterprise Services (adventerprisek9) or Advanced IP Services (advipservicesk9) on supported platforms. • Firmware 9.0(4) or a later version must be installed on the IP phone for HTTPS provisioning. • System clock must be set by using one of the following methods: Cisco Unified Communications Manager Express System Administrator Guide 581 ◦Configure Network Time Protocol (NTP). For configuration information, see Enable Network Time Protocol, on page 133. ◦Manually set the software clock using the clockset command.For information about this command, see Cisco IOS Network Management Command Reference. Restrictions for Security Phone Authentication • Cisco Unified CME phone authentication is notsupported on the Cisco IAD 2400 series or the Cisco 1700 series. Media Encryption • Secure three-way software conferencing is notsupported. A secure call beginning withSRTP will always fall back to nonsecure Real-Time Transport Protocol (RTP) when it is joined to a conference. • If a party drops from a three-party conference, the call between the remaining two parties returns to secure if the two parties are SRTP-capable local Skinny Client Control Protocol (SCCP) endpoints to a single Cisco Unified CME and the conference creator is one of the remaining parties. If either of the two remaining parties are only RTP-capable, the call remains nonsecure. If the two remaining parties are connected through FXS, PSTN, or VoIP, the call remains nonsecure. • Calls to Cisco Unity Express are not secure. • Music on Hold (MOH) is not secure. • Video calls are not secure. • Modem relay and T.3 fax relay calls are not secure. • Media flow-around is not supported for call transfer and call forward. • Conversion between inband tone and RFC 2833 DTMF is not supported. RFC 2833 DTMF handling is supported when encryption keys are sent to secure DSP Farm devices but is not supported for codec passthrough. • Secure Cisco Unified CME supports SIP trunks and H.323 trunks. • Secure calls are supported in the default session application only. Information About Security Phone Authentication Overview Phone authentication is a security infrastructure for providing secure SCCP signaling between Cisco Unified CME and IP phones. The goal of Cisco Unified CME phone authentication is to create a secure environment for a Cisco Unified CME IP telephony system. Cisco Unified Communications Manager Express System Administrator Guide 582 Security Restrictions for Security Phone authentication addresses the following security needs: • Establishing the identity of each endpoint in the system • Authenticating devices • Providing signaling-session privacy • Providing protection for configuration files Cisco Unified CME phone authentication implements authentication and encryption to prevent identity theft of the phone or Cisco Unified CME system, data tampering, call-signaling tampering, or media-stream tampering. To prevent these threats, the Cisco Unified IP telephony network establishes and maintains authenticated communication streams, digitally signs files before they are transferred to phones, and encrypts call signaling between Cisco Unified IP phones. Cisco Unified CME phone authentication depends on the following processes: • Phone Authentication, on page 583 • File Authentication, on page 583 • Signaling Authentication, on page 583 Phone Authentication The phone authentication process occurs between the Cisco Unified CME router and a supported device when each entity accepts the certificate of the other entity; only then does a secure connection between the entities occur. Phone authentication relies on the creation of a Certificate Trust List (CTL) file, which is a list of known, trusted certificates and tokens.Phones communicate with Cisco Unified CME using a Transport Layer Security (TLS) session connection, which requires that the following criteria be met: • A certificate must exist on the phone. • A phone configuration file must exist on the phone, and the Cisco Unified CME entry and certificate must exist in the file. File Authentication The file authentication process validates digitally signed files that a phone downloads from a Trivial File Transfer Protocol (TFTP) server—for example, configuration files, ring list files, locale files, and CTL files. When the phone receives these types of files from the TFTP server, the phone validates the file signatures to verify that file tampering did not occur after the files were created. Signaling Authentication The signaling authentication process, also known as signaling integrity, uses the TLS protocol to validate that signaling packets have not been tampered with during transmission. Signaling authentication relies on the creation of the CTL file. Cisco Unified Communications Manager Express System Administrator Guide 583 Security Phone Authentication Overview Public Key Infrastructure Cisco Unified CME phone authentication uses the public-key-infrastructure (PKI) capabilities in Cisco IOS software for certificate-based authentication of IP phones. PKI provides customers with a scalable, secure mechanism for distributing, managing, and revoking encryption and identity information in a secure data network. Every entity (a person or a device) participating in the secure communication is enrolled in the PKI using a process in which the entity generates a Rivest-Shamir-Adleman (RSA) key pair (one private key and one public key) and has its identity validated by a trusted entity (also known as a certification authority [CA] or trustpoint). After each entity enrollsin aPKI, every peer (also known as an end host) in aPKI is granted a digital certificate that has been issued by a CA. When peers must negotiate a secure communication session, they exchange digital certificates. Based on the information in the certificate, a peer can validate the identity of another peer and establish an encrypted session with the public keys contained in the certificate. Phone Authentication Components A variety of components work together to ensure secure communications in a Cisco Unified CME system. Table 39: Cisco Unified CME Phone Authentication Components , on page 584 describes the Cisco Unified CME phone authentication components. Table 39: Cisco Unified CME Phone Authentication Components Component Definition An electronic document that binds a user's or device's name to its public key. Certificates are commonly used to validate digital signatures. Certificates are needed for authentication during secure communication. An entity obtains a certificate by enrolling with the CA. certificate An assurance from an entity that the transaction it accompanies is authentic. The entity’s private key is used to sign transactions and the corresponding public key is used for decryption. signature Cisco Unified Communications Manager Express System Administrator Guide 584 Security Public Key Infrastructure Component Definition RSA is a public key cryptographic system developed by Ron Rivest, Adi Shamir, and Leonard Adleman. An RSA key pair consists of a public key and a private key. The public key is included in a certificate so that peers can use it to encrypt data that is sent to the router. The private key is kept on the router and used both to decrypt the data sent by peers and to digitally sign transactions when negotiating with peers. You can configure multiple RSA key pairs to match policy requirements, such as key length, key lifetime, and type of keys, for different certificate authorities or for different certificates. RSA key pair A certificate server generates and issues certificates on receipt of legitimate requests. A trustpoint with the same name as the certificate server stores the certificates. Each trustpoint has one certificate plus a copy of the CA certificate. certificate server trustpoint The root certificate server. It is responsible for managing certificate requests and issuing certificates to participating network devices. Thisservice provides centralized key management for participating devices and is explicitly trusted by the receiver to validate identities and to create digital certificates. The CA can be a Cisco IOS CA on the Cisco Unified CME router, a Cisco IOS CA on another router, or a third-party CA. certification authority (CA) Records or verifies some or all of the data required for the CA to issue certificates. It is required when the CA is a third-party CA or Cisco IOS CA is not on the Cisco Unified CME router. registration authority (RA) Cisco Unified Communications Manager Express System Administrator Guide 585 Security Phone Authentication Components Component Definition A mandatory structure that contains the public key information (server identities) of all the servers with which the IP phone needs to interact (for example, the Cisco Unified CME server, TFTP server, and CAPFserver). The CTL file is digitally signed by the SAST. After you configure the CTL client, it createsthe CTL file and makesit available in the TFTPdirectory. The CTL file is signed using the SAST certificate’s corresponding private key. An IP phone is then able to download this CTL file from the TFTP directory. The filename format for each phone’s CTL file is CTLSEP.tlv. When the CTL client isrun on a router in the network that is not a Cisco Unified CME router, you must configure a CTL provider on each Cisco Unified CME router in the network. Similarly, if a CTL client is running on one of two Cisco Unified CME routers in a network, a CTL provider must be configured on the other Cisco Unified CME router. The CTL protocol transfers information to and from the CTL provider that allows the second Cisco Unified CME router to be trusted by phones and vice versa. certificate trust list (CTL) file CTL client CTL provider File that contains certificate expiration dates and used to determine whether a certificate that is presented is valid or revoked. certificate revocation list (CRL) Part of the CTL client that is responsible for signing the CTL file. The Cisco Unified CME certificate and its associated key pair are used for theSAST function. There are actually two SAST records pertaining to two different certificates in the CTL file for security reasons. They are known as SAST1 and SAST2. If one of the certificates is lost or compromised, then the CTL client regenerates the CTL file using the other certificate. When a phone downloads the new CTL file, it verifies with only one of the two original public keysthat wasinstalled earlier. This mechanism isto prevent IPphonesfrom accepting CTL filesfrom unknown sources. system administrator security token (SAST) Cisco Unified Communications Manager Express System Administrator Guide 586 Security Phone Authentication Components Component Definition Entity that issues certificates (LSCs) to phones that request them. The CAPF is a proxy for the phones, which are unable to directly communicate with the CA. The CAPF can also perform the following certificate-management tasks: • Upgrade existing locally significant certificates on the phones. • Retrieve phone certificates for viewing and troubleshooting. • Delete LSCs on the phone. certificate authority proxy function (CAPF) Phones need certificates to engage in secure communications. Many phones come from the factory with MICs, but MICs may expire or become lost or compromised.Some phones do not come with MICs. LSCs are certificates that are issued locally to the phones using the CAPF server. manufacture-installed certificate (MIC) locally significant certificate (LSC) IETF standard (RFC 2246) protocol, based on Netscape Secure Socket Layer (SSL) protocol. TLS sessions are established using a handshake protocol to provide privacy and data integrity. The TLS record layer fragments and defragments, compresses and decompresses, and performs encryption and decryption of application data and other TLS information, including handshake messages. transport Layer Security (TLS) protocol Cisco Unified Communications Manager Express System Administrator Guide 587 Security Phone Authentication Components Figure 20: Cisco Unified CME Phone Authentication, on page 588 shows the components in a Cisco Unified CME phone authentication environment. Figure 20: Cisco Unified CME Phone Authentication Phone Authentication Process The following is a high-level summary of the phone-authentication process. To enable Cisco Unified CME phone authentication: 1 Certificates are issued. The CA issues certificates to Cisco Unified CME, SAST, CAPF, and TFTP functions. 2 The CTL file is created, signed and published. Cisco Unified Communications Manager Express System Administrator Guide 588 Security Phone Authentication Process a The CTL file is created by the CTL client, which is configuration driven. Its goal is to create a CTLfile.tlv for each phone and deposit it in the TFTP directory. To complete its task, the CTL client needsthe certificates and public key information of the CAPFserver, Cisco Unified CME server, TFTP server, and SASTs. b The CTL file issigned by theSAST credentials. There are twoSAST records pertaining to two different certificates in the CTL file for security reasons. If one of the certificates is lost or compromised, then the CTL client regenerates the CTL file using the other certificate. When a phone downloads the new CTL file, it verifies the download with only one of the two original public keys that was installed earlier. This mechanism prevents IP phones from accepting CTL files from unknown sources. c The CTL file is published on the TFTP server. Because an external TFTP server is not supported in secure mode, the configuration files are generated by the Cisco Unified CME system itself and are digitally signed by the TFTP server’s credentials. The TFTP server credentials can be the same as the Cisco Unified CME credentials. If desired, a separate certificate can be generated for the TFTPfunction if the appropriate trustpoint is configured under the CTL-client interface. 3 The telephony service module signs phone configuration files and each phone requests its file. 4 When an IP phone boots up, it requests the CTL file (CTLfile.tlv) from the TFTP server and downloads its digitally signed configuration file, which has the filename format of SEP.cnf.xml.sgn. 5 The phone then reads the CAPF configuration status from the configuration file. If a certificate operation is needed, the phone initiates a TLSsession with the CAPFserver on TCPport 3804 and begins the CAPF protocol dialogue. The certificate operation can be an upgrade, delete, or fetch operation. If an upgrade operation is needed, the CAPF server makes a request on behalf of the phone for a certificate from the CA. The CAPF server uses the CAPF protocol to obtain the information it needs from the phone, such as the public key and phone ID. After the phone successfully receives a certificate from the server, the phone stores it in its flash memory. 6 With the certificate in its flash, the phone initiates a TLS connection with the secure Cisco Unified CME server on a well-known TCP port (2443) if the device security mode settings in the .cnf.xml file are set to authenticated or encrypted. This TLS session is mutually authenticated by both parties. The IP phone knows the Cisco Unified CME server’s certificate from the CTL file, which it initially downloaded from the TFTPserver. The phone’s LSC is a trusted party for the Cisco Unified CME server because the issuing CA certificate is present in the router. Startup Messages If the certificate server is part of your startup configuration, you may see the following messages during the boot procedure: % Failed to find Certificate Server's trustpoint at startup % Failed to find Certificate Server's cert. These messages are informational messages that show a temporary inability to configure the certificate server because the startup configuration has not been fully parsed yet. The messages are useful for debugging if the startup configuration has been corrupted. Cisco Unified Communications Manager Express System Administrator Guide 589 Security Startup Messages Configuration File Maintenance In a secure environment,several types of configuration files must be digitally signed before they can be hosted and used. The filenames of all signed files have a .sgn suffix. The Cisco Unified CME telephony service module creates phone configuration files (.cnf.xml suffix) and hosts them on a Cisco IOS TFTP server. These files are signed by the TFTP server’s credentials. In addition to the phone configuration files, other Cisco Unified CME configuration files such as the network and user-locale files must be signed. These files are internally generated by Cisco Unified CME, and the signed versions are automatically created in the current code path whenever the unsigned versions are updated or created. Other configuration files that are not generated by Cisco Unified CME, such as ringlist.xml, distinctiveringlist.xml, audio files, and so forth, are often used for Cisco Unified CME features.Signed versions of these configuration files are not automatically created. Whenever a new configuration file that has not been generated by Cisco Unified CME is imported into Cisco Unified CME, use the load-cfg-file command, which does all of the following: • Hosts the unsigned version of the file on the TFTP server. • Creates a signed version of the file. • Hosts the signed version of the file on the TFTP server. You can also use the load-cfg-file command instead of the tftp-server command when only the unsigned version of a file needs to be hosted on the TFTP server. CTL File Maintenance The CTL file contains the SAST records and other records. (A maximum of two SAST records may exist.) The CTL file is digitally signed by one of the SAST credentials that are listed in the CTL file before the CTL file is downloaded by the phone and saved in its flash. After receiving the CTL file, a phone trusts a newer or changed CTL file only if it is signed by one of the SAST credentials that is present in the original CTL file. For this reason, you should take care to regenerate the CTL file only with one of the originalSAST credentials. If both SAST credentials are compromised and a CTL file must be generated with a new credential, you must reset the phone to its factory defaults. CTL Client and Provider The CTL client generates the CTL file. The CTL client must be provided with the names of the trustpoints it needs for the CTL file. It can run on the same router as Cisco Unified CME or on another, standalone router. When the CTL client runs on a standalone router (not a Cisco Unified CME router), you must configure a CTL provider on each Cisco Unified CME router. The CTL provider securely communicates the credentials of the Cisco Unified CME server functions to the CTL client that is running on another router. When the CTL client is running on either a primary or secondary Cisco Unified CME router, you must configure a CTL provider on each Cisco Unified CME router on which the CTL client is not running. The CTL protocol is used to communicate between the CTL client and a CTL provider. Using the CTL protocol ensures that the credentials of all Cisco Unified CME routers are present in the CTL file and that all Cisco Unified Communications Manager Express System Administrator Guide 590 Security Configuration File Maintenance Cisco Unified CME routers have access to the phone certificates that were issued by the CA. Both elements are prerequisites to secure communications. To enable CTL clients and providers, see Configure the CTL Client, on page 607 and Configure the CTL Provider, on page 619. Manually Importing MIC Root Certificate When a phone uses a MIC for authentication during the TLS handshake with the CAPF server, the CAPF server must have a copy of the MIC to verify it. Different certificates are used for different types of IPphones. A phone uses a MIC for authentication when it has a MIC but no LSC.For example, you have a Cisco Unified IP Phone 7970 that has a MIC by default but no LSC. When you schedule a certificate upgrade with the authentication mode set to MIC for this phone, the phone presents its MIC to the Cisco Unified CME CAPF server for authentication. The CAPFserver must have a copy of the MIC'sroot certificate to verify the phone's MIC. Without this copy, the CAPF upgrade operation fails. To ensure that the CAPF server has copies of the MICs it needs, you must manually import certificates to the CAPFserver. The number of certificatesthat you must import depends on your network configuration. Manual enrollment refers to copy-and-paste or TFTP transfer methods. To manually import the MIC root certificate, see Manually Import the MIC Root Certificate, on page 626. Feature Design of Media Encryption Companion voice security Cisco IOSfeatures provide an overall architecture forsecure end-to-end IPtelephony calls on supported network devices that enable the following: • SRTP-capable Cisco Unified CME networks with secure interoperability • Secure Cisco IP phone calls • Secure Cisco VG224 Analog Phone Gateway endpoints • Secure supplementary services These features are implemented using media and signaling authentication and encryption in Cisco IOS H.323 networks. H.323, the ITU-T standard that describes packet-based video, audio, and data conferencing, refers to a set of other standards, including H.450, to describe its actual protocols. H.323 allows dissimilar communication devices to communicate with each other by using a standard communication protocol and defines a common set of codecs, call setup and negotiating procedures, and basic data transport methods. H.450, a component of the H.323 standard, defines signaling and procedures that are used to provide telephony-like supplementary services. H.450 messages are used in H.323 networks to implement secure supplementary service support and also empty capability set (ECS) messaging for media capability negotiation. Secure Cisco Unified CME The secure Cisco Unified CME solution includes secure-capable voice ports, SCCP endpoints, and a secure H.323 trunk between Cisco Unified CME and Cisco Unified Communications Manager for audio media. SIP Cisco Unified Communications Manager Express System Administrator Guide 591 Security Manually Importing MIC Root Certificate trunks are not supported. Figure 21: Secure Cisco Unified CME System, on page 592 shows the components of a secure Cisco Unified CME system. Figure 21: Secure Cisco Unified CME System Secure Cisco Unified CME implements call control signaling using Transport Layer Security (TLS) or IPsec (IPSecurity) for the secure channel and usesSRTPfor media encryption.Secure Cisco Unified CME manages the SRTP keys to endpoints and gateways. The Media Encryption (SRTP) on Cisco Unified CME feature supports the following features: • SCCP endpoints. • Secure voice callsin a mixed shared line environment that allows both RTP- andSRTP-capable endpoints; shared line media security depends on the endpoint configuration. • Secure supplementary services using H.450 including: ◦Call forward ◦Call transfer ◦Call hold and resume ◦Call park and call pickup ◦Nonsecure software conference SRTP conference calls over H.323 may experience a zero- to two-second noise interval when the call is joined to the conference. Note • Secure calls in a non-H.450 environment. Cisco Unified Communications Manager Express System Administrator Guide 592 Security Secure Cisco Unified CME • Secure Cisco Unified CME interaction with secure Cisco Unity. • Secure Cisco Unified CME interaction with Cisco Unity Express (interaction is supported and calls are downgraded to nonsecure mode). • Secure transcoding for remote phones with DSP Farm transcoding configured. These features are discussed in the following sections. Secure Supplementary Services The Media Encryption (SRTP) feature supports secure supplementary services in both H.450 and non-H.450 Cisco Unified CME networks. A secure Cisco Unified CME network should be either H.450 or non-H.450, not a hybrid. Secure SIP Trunk Support on Cisco Unified CME Prior to Cisco Unified CME Relese 10 release, supplementary services were not supported on the secure SIP trunk of the secure SCCP Cisco Unified CME. This feature supports the following supplementary services in the secure SRTP and SRTP fallback modes on the SIP trunk of the SCCP Cisco Unified CME: • Basic secure calls • Call hold and resume • Call transfer (blind and consult) • Call forward (CFA,CFB,CFNA) • DTMF support • Call park and pickup • Voice mail systems using CUE (works only with SRTP fallback mode) To enable the supplementary services, use the existing “supplementary-service media-renegotiate” command as shown in the following example: (config)# voice service voip (conf-voi-serv)# no ip address trusted authenticate (conf-voi-serv)# srtp (conf-voi-serv)# allow-connections sip to sip (conf-voi-serv)# no supplementary-service sip refer (conf-voi-serv)# supplementary-service media-renegotiate In the SRTP mode, nonsecure media (RTP) format is not allowed across the secure SIP trunk. For Music On Hold, Tone On Hold, and Ring Back Tone, the tone is not played acrosstheSIPtrunk. InSRTPfallback mode, media across the secure SIP trunk is switched over to RTP if the remote end is nonsecure or while playing the MMusic On Hold, Tone On Hold, and Ring Back Tone. Note Cisco Unified Communications Manager Express System Administrator Guide 593 Security Secure Supplementary Services Restriction • Secure SIP trunk is supported only on SCCP Cisco Unified CME and not on SIP Cisco Unified CME. Secure SIP lines are not supported on the Cisco Unified CME mode. • Xcoder support is not available for playing secure tones (Music On Hold, Tone On Hold, and Ring Back Tone). • Tones are not played in the SRTP mode because these tones are available only in non-secure (RTP) format. • We recommend that you configure no supplementary-service sip refer command for SCCP Cisco Unfied CME for the supplementary services. Secure Cisco Unified CME in an H.450 Environment Signaling and media encryption among secure endpoints is supported, enabling supplementary services such as call transfer (H.450.2) and call forward (H.450.3) between secure endpoints. Call park and pick up use H.450 messages. Secure Cisco Unified CME is H.450-enabled by default; however, secure music on hold (MOH) and secure conferences (three-way calling) are not supported. For example, when supplementary services are initiated as shown in Figure 22: Music on Hold in an H.450 Environment, on page 594, ECS and Terminal Capabilities Set (TCS) are used to negotiate the initially secure call between A and B down to RTP so A can hear MOH. When B resumes the call to A, the call goes back to SRTP. Similarly, when a transfer is initiated, the party being transferred is put on hold and the call is negotiated down to RTP. When the call is transferred, it goes back to SRTP if the other end is SRTP capable. Figure 22: Music on Hold in an H.450 Environment Secure Cisco Unified CME in a Non H.450 Environment Security for supplementary services requires midcall key negotiation or midcall media renegotiation. In an H.323 network where there are no H.450 messages, media renegotiation is implemented using ECS for scenarios such as mismatched codecs and secure calls. If you disable H.450 on the router globally, the configuration is applied to RTPandSRTPcalls. The signaling path is hairpin on XOR for Cisco Unified CME and Cisco Unified Communications Manager. For example, in Figure 23: Transfer in a Non-H.450 Environment, on page 595, the signaling path goes from A through B (the supplementary services initiator) to C. When deploying voice security in this scenario, consider that the media security keys will pass through Cisco Unified Communications Manager Express System Administrator Guide 594 Security Secure SIP Trunk Support on Cisco Unified CME XOR, that is, through B, the endpoint that issued the transfer request. To avoid the man-in-the-middle attack, the XOR must be a trusted entity. Figure 23: Transfer in a Non-H.450 Environment The media path is optional. The default media path for Cisco Unified CME is hairpin. However, whenever possible media flow around can be configured on Cisco Unified CME. When configuring media flow through, which is the default, remember that chaining multiple XOR gateways in the media path introduces more delay and thus reduces voice quality. Router resources and voice quality limit the number of XOR gateways that can be chained. The requirement is platform dependent and may vary between signaling and media. The practical chaining level is three. A transcoder is inserted when there is a codec mismatch and ECS and TCS negotiation fails. For example, if Phone A and Phone B are SRTP capable, but Phone A uses the G.711 codec and Phone B uses the G.729 codec, a transcoder is inserted if Phone B has one. However, the call is negotiated down to RTP to fulfill the codec requirement so the call is not secure. Secure Transcoding for Remote Phones with DSP Farm Transcoding Configured Transcoding is supported for remote phones that have the dspfarm-assist keyword of the codec command configured. A remote phone is a phone that is registered to a Cisco Unified CME and is residing on a remote location across the WAN. To save bandwidth across the WAN connection, calls to such a phone can be made to use the G.729r8 codec by configuring the codec g729r8 dspfarm assist command for the ephone. The g729r8 keyword forces calls to such a phone to use the G.729 codec. The dspfarm-assist keyword enables using available DSP resources if an H.323 call to the phone needs to be transcoded. Transcoding is enabled only if an H.323 call with a different codec from the remote phone tries to make a call to the remote phone. If a local phone on the same Cisco Unified CME as the remote phone makes a call to the remote phone, the local phone is forced to change its codec to G.729 instead of using transcoding. Note Secure transcoding for point-to-point SRTP calls can only occur when both the SCCP phone that is to be serviced by Cisco Unified CME transcoding and its peer in the call are SRTP capable and have successfully negotiated the SRTP keys. Secure transcoding for point-to-point SRTP calls cannot occur when only one of the peers in the call is SRTP capable. If Cisco Unified CME transcoding is to be performed on a secure call, the Media Encryption (SRTP) on Cisco Unified CME feature allows Cisco Unified CME to provide the DSP Farm with the encryption keys for the secure call as additional parameters so that Cisco Unified CME transcoding can be performed successfully. Without the encryption keys, the DSP Farm would not be able to read the encrypted voice data to transcode it. Cisco Unified Communications Manager Express System Administrator Guide 595 Security Secure Transcoding for Remote Phones with DSP Farm Transcoding Configured Note The secure transcoding described here does not apply to IP-IP gateway transcoding. Cisco Unified CME transcoding is different from IP-to-IP gateway transcoding because it is invoked for an SCCP endpoint only, instead of for bridging VoIP call legs. Cisco Unified CME transcoding and IP-to-IP gateway transcoding are mutually exclusive, that is, only one type of transcoding can be invoked for a call. If no DSP Farm capable of SRTP transcoding is available, Cisco Unified CME secure transcoding is not performed and the call goes through using G.711. For configuration information, see Register the DSP Farm with Cisco Unified CME 4.2 or a Later Version in Secure Mode, on page 496. Secure Cisco Unified CME with Cisco Unity Express Cisco Unity Express does not support secure signaling and media encryption. Secure Cisco Unified CME interoperates with Cisco Unity Express but calls between Cisco Unified CME and Cisco Unity Express are not secure. In a typical Cisco Unity Express deployment with Cisco Unified CME in a secure H.323 network, Session Initiation Protocol (SIP) is used for signaling and the media path is G.711 with RTP. For Call Forward No Answer (CFNA) and Call Forward All (CFA), before the media path is established, signaling messages are sent to negotiate an RTP media path. If codec negotiation fails, a transcoder is inserted. The Media Encryption (SRTP) on Cisco Unified CME feature’s H.323 service provider interface (SPI) supports fast start calls. In general, callstransferred or forwarded back to Cisco Unified CME from Cisco Unity Expressfall into existing call flows and are treated as regular SIP and RTP calls. The Media Encryption (SRTP) on Cisco Unified CME feature supports blind transfer back to Cisco Unified CME only. When midcall media renegotiation is configured, the secure capability for the endpoint is renegotiated regardless of which transfer mechanism, H.450.2 or Empty Capability Set (ECS), is used. Secure Cisco Unified CME with Cisco Unity The Media Encryption (SRTP) on Cisco Unified CME feature supports Cisco Unity 4.2 or a later version and Cisco Unity Connection 1.1 or a later version using SCCP. Secure Cisco Unity for Cisco Unified CME acts like a secure SCCP phone. Some provisioning is required before secure signaling can be established. Cisco Unity receives Cisco Unified CME device certificates from the Certificate Trust List (CTL) and Cisco Unity certificates are inserted into Cisco Unified CME manually. Cisco Unity with SIP is not supported. The certificate for the Cisco Unity Connection is in the Cisco Unity administration web application under the “port group settings.” HTTPS Provisioning For Cisco Unified IP Phones This section contains the following topics: • HTTPS support for an External Server, on page 597 • HTTPS Support in Cisco Unified CME, on page 597 Cisco Unified Communications Manager Express System Administrator Guide 596 Security Secure Cisco Unified CME with Cisco Unity Express HTTPS support for an External Server There is an increasing need to securely access web content on Cisco Unified IP phones using HTTPS. The X.509 certificate of a third-party web server must be stored in the IP phone’s CTL file to authenticate the web server but the server command used to enter trustpoint information cannot be used to import the certificate to the CTL file. Because the server command requires the private key from the third-party web server for certificate chain validation and you cannot obtain that private key from the web server, the import certificate command is added to save the trusted certificate in the CTL file. For information on how to import a trusted certificate to an IP phone’s CTL file for HTTPS provisioning, see HTTPS Provisioning for Cisco Unified IP Phones, on page 637. For information on phone authentication support in Cisco Unified CME,seePhone Authentication Overview, on page 582. HTTPS Support in Cisco Unified CME Cisco Unified IP phones use HTTP for some of the services offered by Cisco Unified CME. These services, which include local-directory lookup on Cisco Unified CME, My Phone Apps, and Extension Mobility, are invoked by pressing the “Services” button on the phones. With Hypertext Transfer Protocol Secure (HTTPS) support in Cisco Unified CME 9.5 and later versions, these services can be invoked using an HTTPS connection from the phones to Cisco Unified CME. Ensure that the configured phone is provisioned for HTTPS-based servicesthat run on Cisco Unified CME before configuring HTTPS globally or locally. Please refer to the appropriate phone administrator guide to know if your Cisco Unified IP phone supports HTTPS access. HTTP services continue to run for other phones that do not support HTTPS. Note For information on provisioning Cisco Unified IP phones for secure access to web content using HTTPS, see HTTPS Provisioning for Cisco Unified IP Phones, on page 637. For configuration examples, see Example for Configuring HTTPS Support for Cisco Unified CME, on page 655. Configure Security Configure the Cisco IOS Certification Authority To configure a Cisco IOS Certification Authority (CA) on a local or external router, perform the following steps. Note If you use a third-party CA, follow the provider’s instructions instead of performing these steps. Cisco Unified Communications Manager Express System Administrator Guide 597 Security Configure Security SUMMARY STEPS 1. enable 2. configure terminal 3. ip http server 4. crypto pki server label 5. database level {minimal | names | complete} 6. database url root-url 7. lifetime certificate time 8. issuer-name CN=label 9. exit 10. crypto pki trustpoint label 11. enrollment url ca-url 12. exit 13. crypto pki server label 14. grant auto 15. no shutdown 16. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enablesthe Cisco web-browser user interface on the local Cisco Unified CME router. ip http server Example: Router(config)# ip http server Step 3 Defines a label for the Cisco IOS CA and enters certificate-server configuration mode. crypto pki server label Example: Router(config)# crypto pki server sanjose1 Step 4 (Optional) Controls the type of data stored in the certificate enrollment database. database level {minimal | names | complete} Step 5 Cisco Unified Communications Manager Express System Administrator Guide 598 Security Configure the Cisco IOS Certification Authority Command or Action Purpose Example: Router(config-cs-server)# database level complete • minimal—Enough information is stored only to continue issuing new certificates without conflict. This is the default value. • names—In addition to the minimal information given, the serial number and subject name of each certificate are also provided. • complete—In addition to the information given in the minimal and names levels, each issued certificate is written to the database. If you use this keyword, you must also specify an external TFTP server in which to store the data by using the database url command. (Optional) Specifies the location, other than NVRAM, where all database entries for the certificate server are to be written out. database url root-url Example: Router(config-cs-server)# database url nvram: Step 6 • Required if you configured the complete keyword with the database level command in the previous step. • root-url—URL that issupported by the Cisco IOSfile system and where database entries are to be written out. If the CA is going to issue a large number of certificates, select an appropriate storage location like flash or other storage device to store the certificates. • When the storage location chosen is flash and the file system type on this device is Class B (LEFS), make sure to check free space on the device periodically and use the squeeze command to free the space used up by deleted files. This process may take several minutes and should be done during scheduled maintenance periods or off-peak hours. (Optional) Specifies the lifetime, in days, of certificates issued by this Cisco IOS CA. lifetime certificate time Example: Router(config-cs-server) lifetime certificate 888 Step 7 • time—Number of days until a certificate expires. Range is 1 to 1825 days. Default is 365. The maximum certificate lifetime is 1 month less than the lifetime of the CA certificate. • Configure this command before the Cisco IOS CA is enabled by using the no shutdown command. (Optional) Specifies a distinguished name (DN) as issuer name for the Cisco IOS CA. issuer-name CN=label Example: Router(config-cs-server)# issuer-name CN=sanjose1 Step 8 • Default is already-configured label for the Cisco IOS CA. See Step 4, on page 598. exit Exits certificate-server configuration mode. Example: Router(config-cs-server)# exit Step 9 Step 10 crypto pki trustpoint label (Optional) Declares a trustpoint and enters ca-trustpoint configuration mode. Cisco Unified Communications Manager Express System Administrator Guide 599 Security Configure the Cisco IOS Certification Authority Command or Action Purpose Example: Router(config)# crypto pki trustpoint sanjose1 • For local CA only. This command is not required for Cisco IOS CA on an external router. • If you must use a specific RSA key for the Cisco IOS CA, use this command to create your own trustpoint by using the same label to be used with the cryptopkiserver command. If the routersees a configured trustpoint with the same label as the crypto pki server, it uses this trustpoint and does not automatically create a trustpoint. Step 11 enrollment url ca-url Specifies the enrollment URL of the issuing Cisco IOS CA. Example: Router(config-ca-trustpoint)# enrollment url http://ca-server.company.com • For local Cisco IOS CA only. This command is not required for Cisco IOS CA on an external router. • ca-url—URL of the router on which the Cisco IOS CA is installed. exit Exits ca-trustpoint configuration mode. Example: Router(config-ca-trustpoint)# exit Step 12 Step 13 crypto pki server label Enters certificate-server configuration mode. Example: Router(config)# crypto pki server sanjose1 • label—Name of the Cisco IOS CA being configured. Step 14 grant auto (Optional) Allows certificates to be issued automatically to any requester. Example: Router(config-cs-server)# grant auto • Default and recommended method is manual enrollment. • Use this command only when testing and building simple networks. Use the no grant auto command after configuration is complete to prevent certificates from being automatically granted. Step 15 no shutdown (Optional) Enables the Cisco IOS CA. Example: Router(config-cs-server)# no shutdown • Use this command only after you are finished configuring the Cisco IOS CA. end Returns to privileged EXEC mode. Example: Router(config-cs-server)# end Step 16 Cisco Unified Communications Manager Express System Administrator Guide 600 Security Configure the Cisco IOS Certification Authority The following partial output from the show running-config command shows the configuration for a Cisco IOS CA named sanjose1 running on the local Cisco Unified CME router: ip http server crypto pki server sanjose1 database level complete database url nvram: crypto pki trustpoint sanjose1 enrollment url http://ca-server.company.com crypto pki server authority1 no grant auto no shutdown Obtain Certificates for Server Functions The CA issues certificates for the following server functions: • Cisco Unified CME—Requires a certificate for TLS sessions with phones. • TFTP—Requires a key pair and certificate for signing configuration files. • HTTPS—Requires a key pair and certificate for signing configuration files. • CAPF—Requires a certificate for TLS sessions with phones. • SAST—Required for signing the CTL file. We recommend creating two SAST certificates, one for primary use and one for backup. To obtain a certificate for a server function, perform the following steps for each server function. You can configure a different trustpoint for each server function or you can configure the same trustpoint for more than one server function as shown in Configuration Examples for Security, on page 643 at the end of this module. Note SUMMARY STEPS 1. enable 2. configure terminal 3. crypto pki trustpoint trustpoint-label 4. enrollment url url 5. revocation-check method1 [method2 [method3]] 6. rsakeypair key-label [key-size [encryption-key-size]] 7. exit 8. crypto pki authenticate trustpoint-label 9. crypto pki enroll trustpoint-label 10. exit Cisco Unified Communications Manager Express System Administrator Guide 601 Security Obtain Certificates for Server Functions DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Declares the trustpoint that the CA should use and enters ca-trustpoint configuration mode. crypto pki trustpoint trustpoint-label Example: Router(config)# crypto pki trustpoint capf Step 3 • trustpoint-label—Label for server function being configured. Step 4 enrollment url url Specifies the enrollment URL of the issuing CA. Example: Router(config-ca-trustpoint)# enrollment url http://ca-server.company.com • url—URL of the router on which the issuing CA is installed. (Optional)Specifiesthe method to be used to check the revocation status of a certificate. revocation-check method1 [method2 [method3]] Step 5 Example: Router(config-ca-trustpoint)# revocation-check none • method—If a second and third method are specified, each subsequent method is used only if the previous method returns an error, such as a server being down. • crl—Certificate checking is performed by a certificate revocation list (CRL). This is the default behavior. • none—Certificate checking is not required. • ocsp—Certificate checking is performed by an Online Certificate Status Protocol (OCSP) server. rsakeypair key-label [key-size (Optional) Specifies a key pair to use with a certificate. [encryption-key-size]] Step 6 • key-label—Name of the key pair, which is generated during enrollment if it does not already exist or if the auto-enroll regenerate command is configured. Example: Router(config-ca-trustpoint)# rsakeypair capf 1024 1024 • key-size—Size of the desired RSA key. If notspecified, the existing key size is used. • encryption-key-size—Size of the second key, which is used to request separate encryption, signature keys, and certificates. • Multiple trustpoints can share the same key. Cisco Unified Communications Manager Express System Administrator Guide 602 Security Obtain Certificates for Server Functions Command or Action Purpose exit Exits ca-trustpoint configuration mode. Example: Router(config-ca-trustpoint)# exit Step 7 Retrieves the CA certificate, authenticates it, and checks the certificate fingerprint if prompted. crypto pki authenticate trustpoint-label Example: Router(config)# crypto pki authenticate capf Step 8 • This command is optional if the CA certificate is already loaded into the configuration • trustpoint-label—Already-configured label for server function being configured. Step 9 crypto pki enroll trustpoint-label Enrolls with the CA and obtains the certificate for this trustpoint. Example: crypto pki enroll trustpoint-label • trustpoint-label—Already-configured label for server function being configured. Router(config)# crypto pki enroll capf exit Returns to privileged EXEC mode. Example: Router(config)# exit Step 10 The following partial output from the show running-config command show how to obtain certificates for a variety of server functions: Obtaining a certificate for the CAPF server function !configuring a trust point crypto pki trustpoint capf-server enrollment url http://192.168.1.1:80 revocation-check none !authenticate w/ the CA and download its certificate crypto pki authenticate capf-server ! enroll with the CA and obtain this trustpoint's certificate crypto pki enroll capf-server Obtaining a certificate for the Cisco Unified CME server function crypto pki trustpoint cme-server enrollment url http://192.168.1.1:80 revocation-check none crypto pki authenticate cme-server crypto pki enroll cme-server Cisco Unified Communications Manager Express System Administrator Guide 603 Security Obtain Certificates for Server Functions Obtaining a certificate for the TFTP server function crypto pki trustpoint tftp-server enrollment url http://192.168.1.1:80 revocation-check none crypto pki authenticate tftp-server crypto pki enroll tftp-server Obtaining a certificate for the first SAST server function (sast1) crypto pki trustpoint sast1 enrollment url http://192.168.1.1:80 revocation-check none crypto pki authenticate sast1 crypto pki enroll sast1 Obtaining a certificate for the second SAST server function (sast2) crypto pki trustpoint sast2 enrollment url http://192.168.1.1:80 revocation-check none crypto pki authenticate sast2 crypto pki enroll sast2 Configure Telephony-Service Security Parameters To configure security parameters for telephony service, perform the following steps. SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. secure-signaling trustpoint label 5. tftp-server-credentials trustpoint label 6. device-security-mode {authenticated | none | encrypted} 7. cnf-file perphone 8. load-cfg-file file-url alias file-alias [sign] [create] 9. server-security-mode {erase | non-secure | secure} 10. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Cisco Unified Communications Manager Express System Administrator Guide 604 Security Configure Telephony-Service Security Parameters Command or Action Purpose Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 3 Step 4 secure-signaling trustpoint label Configures trustpoint to be used for secure signalling. Example: Router(config-telephony)# secure-signaling trustpoint cme-sccp • label—Name of a configured PKI trustpoint with a valid certificate to be used for TLS handshakes with IP phones on TCP port 2443. Configures the TFTP server credentials (trustpoint) to be used for signing the configuration files. tftp-server-credentials trustpoint label Example: Router(config-telephony)# tftp-server-credentials trustpoint cme-tftp Step 5 • label—Name of a configured PKI trustpoint with a valid certificate to be used to sign the phone configuration files. This can be the CAPF trustpoint that was used in the previous step or any trustpoint with a valid certificate device-security-mode {authenticated | Enables security mode for endpoints. none | encrypted} Step 6 • authenticated—Instructs device to establish a TLS connection with no encryption. There is no Secure Real-Time Transport Protocol (SRTP) in the media path. Example: Router(config-telephony)# device-security-mode authenticated • none—SCCP signaling is not secure. This is the default. • encrypted—Instructs device to establish an encrypted TLSconnection to secure media path using SRTP. • This command can also be configured in ephone configuration mode. The value set in ephone configuration mode has priority over the value set in telephony-service configuration mode. Specifies that the system generate a separate XML configuration file for each IP phone. cnf-file perphone Example: Router(config-telephony)# cnf-file perphone Step 7 • Separate configuration files for each endpoint are required for security. Cisco Unified Communications Manager Express System Administrator Guide 605 Security Configure Telephony-Service Security Parameters Command or Action Purpose (Optional) Signs configuration files that are not created by Cisco Unified CME. Also loads the signed and unsigned versions of a file on the TFTP server. load-cfg-file file-url alias file-alias [sign] [create] Example: Router(config-telephony)# load-cfg-file slot0:Ringlist.xml alias Ringlist.xml sign create Step 8 • file-url—Complete path of a configuration file in a local directory. • aliasfile-alias—Alias name of the file to be served on the TFTPserver. • sign—(Optional) The file needs to be digitally signed and served on the TFTP server. • create—(Optional) Creates the signed file in the local directory. • The first time that you use this command for each file, use the create and sign keywords. The create keyword is not maintained in the running configuration to prevent signed files from being recreated during every reload. • To serve an already-signed file on the TFTP server, use this command without the create and sign keywords. server-security-mode {erase |non-secure (Optional) Changes the security mode of the server. | secure} Step 9 • erase—Deletes the CTL file. Example: Router(config-telephony)# server-security-mode non-secure • non-secure—Nonsecure mode. • secure—Secure mode. • This command has no impact until the CTL file is initially generated by the CTL client. When the CTL file is generated, the CTL client automatically sets server security mode to secure. end Returns to privileged EXEC mode. Example: Router(config-ephone)# end Step 10 Verify Telephony-Service Security Parameters Step 1 show telephony-service security-info Use this command to display the security-related information that is configured in telephony-service configuration mode. Example: Router# show telephony-service security-info Cisco Unified Communications Manager Express System Administrator Guide 606 Security Configure Telephony-Service Security Parameters Skinny Server Trustpoint for TLS: cme-sccp TFTP Credentials Trustpoint: cme-tftp Server Security Mode: Secure Global Device Security Mode: Authenticated Step 2 show running-config Use this command to display the running configuration to verify telephony and per-phone security configuration. Example: Router# show running-config telephony-service secure-signaling trustpoint cme-sccp server-security-mode secure device-security-mode authenticated tftp-server-credentials trustpoint cme-tftp . . . Configure the CTL Client Perform one of the following tasks, depending upon your network configuration: • Configure the CTL Client on a Cisco Unified CME Router, on page 607 • Configure the CTL Client on a Router That is Not a Cisco Unified CME Router, on page 610 Configure the CTL Client on a Cisco Unified CME Router To configure a CTL client for creating a list of known, trusted certificates and tokens on a local Cisco Unified CME router, perform the following steps. If you have primary and secondary Cisco Unified CME routers, you can configure the CTL client on either one of them. Note Cisco Unified Communications Manager Express System Administrator Guide 607 Security Configure the CTL Client SUMMARY STEPS 1. enable 2. configure terminal 3. ctl-client 4. sast1 trustpoint label 5. sast2 trustpoint label 6. server {capf | cme| cme-tftp | tftp} ip-address trustpoint trustpoint-label 7. server cme ip-address username name-string password {0 | 1} password-string 8. regenerate 9. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 ctl-client Enters CTL-client configuration mode. Example: Router(config)# ctl-client Step 3 Step 4 sast1 trustpoint label Configures credentials for the primary SAST. Example: Router(config-ctl-client)# sast1 trustpoint sast1tp • label- Name of SAST1 trustpoint. SAST1 and SAST2 certificates must be different from each other. The CTL file is always signed by SAST1. The SAST2 credentials are included in the CTL file so that if the SAST1 certificate is compromised, the file can be signed by SAST2 to prevent phones from being reset to the factory default. Note Step 5 sast2 trustpoint label Configures credentials for the secondary SAST. Example: Router(config-ctl-client)# sast2 trustpoint • label - name of SAST2 trustpoint. SAST1 and SAST2 certificates must be different from each other. The CTL file is always signed by SAST1. The SAST2 credentials are included in the CTL file so that if the SAST1 certificate is compromised, the file can be signed by SAST2 to prevent phones from being reset to the factory default. Note Cisco Unified Communications Manager Express System Administrator Guide 608 Security Configure the CTL Client Command or Action Purpose Configures a trustpoint for each server function that is running locally on the Cisco Unified CME router. server {capf | cme| cme-tftp | tftp} ip-address trustpoint trustpoint-label Step 6 Example: Router(config-ctl-client)# server capf 10.2.2.2 trustpoint capftp • ip-address - IP address of the Cisco Unified CME router. If there are multiple network interfaces, use the interface addressin the local LAN to which the phones are connected. • trustpoint trustpoint-label- Name of the PKI trustpoint for the server function being configured. • Repeat this command for server each function that is running locally on the Cisco Unified CME router. (Optional) Provides information for another Cisco Unified CME router (primary or secondary) in the network. server cme ip-address username name-string password {0 | 1} password-string Step 7 • ip-address- IP address of the othe Cisco Unified CME router. Example: Router(config-ctl-client)# server cme 10.2.2.2 username user3 password 0 38h2KL • username name-string- Username that is configured on the CTL provider. • password- Defines the way that you want the password to appear in show command output and not to the way that you enter the password. ◦0- Not encrypted. ◦1- Encrypted using Message Digest 5 (MD5). • password-string- Administrative password of the CTL provider running on the remote Cisco Unified CME router. Creates a new CTLFile.tlv after you make changes to the CTL client configuration. regenerate Example: Router(config-ctl-client)# regenerate Step 8 end Returns to privileged EXEC mode. Example: Router(config-ctl-client)# end Step 9 Examples The following sample output from the show ctl-client command displays the trustpoints in the system: Router# show ctl-client CTL Client Information ----------------------------- SAST 1 Certificate Trustpoint: cmeserver SAST 1 Certificate Trustpoint: sast2 Cisco Unified Communications Manager Express System Administrator Guide 609 Security Configure the CTL Client List of Trusted Servers in the CTL CME 10.1.1.1 cmeserver TFTP 10.1.1.1 cmeserver CAPF 10.1.1.1 cmeserver What to Do Next You are finished configuring the CTL client. See Configure the CAPF Server, on page 612. Configure the CTL Client on a Router That is Not a Cisco Unified CME Router To configure a CTL client on a stand-alone router that is not a Cisco Unified CME router, perform the following steps. SUMMARY STEPS 1. enable 2. configure terminal 3. ctl-client 4. sast1 trustpoint label 5. sast2 trustpoint label 6. server cme ip-address username name-string password {0 | 1} password-string 7. regenerate 8. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 ctl-client Enters ctl-client configuration mode. Example: Router(config)# ctl-client Step 3 Step 4 sast1 trustpoint label Configures credentials for the primary SAST. Example: Router(config-ctl-client)# sast1 trustpoint sast1tp • label—Name of SAST1 trustpoint. Cisco Unified Communications Manager Express System Administrator Guide 610 Security Configure the CTL Client Command or Action Purpose SAST1 andSAST2 certificates must be different from each other but either of them may use the same certificate asthe Cisco Unified CME router to conserve memory. The CTL file is alwayssigned bySAST1. The SAST2 credentials are included in the CTL file so that if the SAST1 certificate is compromised, the file can be signed by SAST2 to prevent phones from being reset to the factory default. Note Step 5 sast2 trustpoint label Configures credentials for the secondary SAST. Example: Router(config-ctl-client)# sast2 trustpoint • label—name of SAST2 trustpoint. SAST1 andSAST2 certificates must be different from each other but either of them may use the same certificate asthe Cisco Unified CME router to conserve memory. The CTL file is alwayssigned bySAST1. The SAST2 credentials are included in the CTL file so that if the SAST1 certificate is compromised, the file can be signed by SAST2 to prevent phones from being reset to the factory default. Note (Optional) Provides information about another Cisco Unified CME router (primary or secondary) in the network, if one exists. server cme ip-address username name-string password {0 | 1} password-string Step 6 • ip-address—IP address of the other Cisco Unified CME router. Example: Router(config-ctl-client)# server cme 10.2.2.2 username user3 password 0 38h2KL • username name-string—Username that is configured on the CTL provider. • password—Encryption status of the password string. ◦0—Not encrypted. ◦1—Encrypted using Message Digest 5 (MD5). This option refers to the way that you want the password to appear in show command output and not to the way that you enter the password in this command. Note • password-string—Administrative password of the CTL provider running on the remote Cisco Unified CME router. Creates a new CTLFile.tlv after you make changes to the CTL client configuration. regenerate Example: Router(config-ctl-client)# regenerate Step 7 end Returns to privileged EXEC mode. Example: Router(config-ctl-client)# end Step 8 Cisco Unified Communications Manager Express System Administrator Guide 611 Security Configure the CTL Client Examples The following sample output from the show ctl-client command displays the trustpoints in the system: Router# show ctl-client CTL Client Information ----------------------------- SAST 1 Certificate Trustpoint: cmeserver SAST 1 Certificate Trustpoint: sast2 List of Trusted Servers in the CTL CME 10.1.1.1 cmeserver TFTP 10.1.1.1 cmeserver CAPF 10.1.1.1 cmeserver Configure the CAPF Server A certificate must be obtained for the CAPFserverso that it can establish a TLSsession with the phone during certificate operation. The CAPF server can install, fetch, or delete locally significant certificates (LSCs) on security-enabled phones. To enable the CAPFserver on the Cisco Unified CME router, perform the following steps. When you use the CAPF server to install phone certificates, arrange to do so during a scheduled period of maintenance. Generating many certificates at the same time may cause call-processing interruptions. Tip SUMMARY STEPS 1. enable 2. configure terminal 3. capf-server 4. trustpoint-label label 5. cert-enroll-trustpoint label password {0 |1} password-string 6. source-addr ip-address 7. auth-mode {auth-string | LSC | MIC | none | null-string} 8. auth-string {delete | generate} {all | ephone-tag} [digit-string] 9. phone-key-size {512 | 1024 | 2048} 10. port tcp-port 11. keygen-retry number 12. keygen-timeout minutes 13. cert-oper {delete all | fetch all | upgrade all} 14. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Cisco Unified Communications Manager Express System Administrator Guide 612 Security Configure the CAPF Server Command or Action Purpose Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 capf-server Enters capf-server configuration mode. Example: Router(config)# capf-server Step 3 Step 4 trustpoint-label label Specifies the label for the trustpoint. Example: Router(config-capf-server)# trustpoint-label tp1 • label—Name of trustpoint whose certificate is to be used for TLS connection between the CAPF server and the phone. Enrolls the CAPF with the CA (or RA, if the CA is not local to the Cisco Unified CME router). cert-enroll-trustpoint labelpassword{0 |1} password-string Step 5 Example: Router(config-capf-server)# cert-enroll-trustpoint ra1 password 0 x8oWiet • label—PKI trustpoint label for CA and RA that was previously configured by using the crypto pki trustpoint command in global configuration mode. • password—Encryption status of the password string. • password-string—Password to use for certificate enrollment. This password isthe revocation password that issent along with the certificate request to the CA. source-addr ip-address Defines the IP address of the CAPF server on the Cisco Unified CME router. Example: Router(config-capf-server)# source addr 10.10.10.1 Step 6 Specifies the type of authentication mode for CAPF sessions to verify endpoints that request certificates. auth-mode {auth-string | LSC | MIC | none | null-string} Step 7 Example: Router(config-capf-server)# auth-mode auth-string • auth-string—The phone user enters a special authentication string at the phone. The string is provided to the user by the system administrator and is configured using the auth-string generate command. • LSC—The phone provides its LSC for authentication, if one exists. • MIC—The phone provides its MIC for authentication, if one exists. If this option is chosen, the MIC s issuer certificate must be imported into a PKI trustpoint. Cisco Unified Communications Manager Express System Administrator Guide 613 Security Configure the CAPF Server Command or Action Purpose • none—No certificate upgrade is initiated. This is the default. • null-string—No authentication. (Optional) Creates or removes authentication strings for one or all secure phones. auth-string {delete | generate} {all | ephone-tag} [digit-string] Step 8 Example: Router(config-capf-server)# auth-string generate all • Use this command if the auth-string keyword is specified in the previous step. Strings become part of the ephone configuration. • delete—Remove authentication stringsfor the specified secure devices. • generate—Create authentication stringsfor the specified secure devices. • all—All phones. • ephone-tag—identifier for the ephone to receive the authentication string. • digit-string—Digits that phone user must dial for CAPFauthentication. Length of string is 4 to 10 digits that can be pressed on the keypad. If this value is not specified, a random string is generated for each phone. • You can also define an authentication string for an individual SCCP IP phone by using the capf-auth-str command in ephone configuration mode. (Optional) Specifies the size of the RSA key pair that is generated on the phone for the phone s certificate, in bits. phone-key-size {512 | 1024 | 2048} Example: Router(config-capf-server)# phone-key-size 2048 Step 9 • 512—512. • 1024—1024. This is the default. • 2048—2048. (Optional) Defines the TCP port number on which the CAPF server listens for socket connections from the phones. port tcp-port Example: Router(config-capf-server)# port 3804 Step 10 • tcp-port—TCP port number. Range is 2000 to 9999. Default is 3804. (Optional)Specifiesthe number of timesthat the serversends a key generation request. keygen-retry number Example: Router(config-capf-server)# keygen-retry 5 Step 11 • number—Number of retries. Range is 0 to 100. Default is 3. (Optional) Specifies the amount of time that the server waits for a key generation response from the phone. keygen-timeout minutes Example: Router(config-capf-server)# keygen-timeout 45 Step 12 • minutes—Number of minutes before the generation process times out. Range is 1 to 120. Default is 30. Cisco Unified Communications Manager Express System Administrator Guide 614 Security Configure the CAPF Server Command or Action Purpose (Optional) Initiates the indicated certificate operation on all configured endpoints in the system. cert-oper {delete all | fetchall |upgrade all} Step 13 Example: Router(config-capf-server)# cert-oper upgrade all • delete all—Remove all phone certificates. • fetch all—Retrieve all phone certificates for troubleshooting. • upgrade all—Upgrade all phone certificates. • This command can also be configured in ephone configuration mode to initiate certificate operations on individual phones. This command in ephone configuration mode has priority over this command in CAPF-server configuration mode. end Returns to privileged EXEC mode. Example: Router(config-capf-server)# end Step 14 Verify the CAPF Server Use the show capf-server summary command to display CAPF-server configuration information. Router# show capf-server summary CAPF Server Configuration Details Trustpoint for TLS With Phone: tp1 Trustpoint for CA operation: ra1 Source Address: 10.10.10.1 Listening Port: 3804 Phone Key Size: 1024 Phone KeyGen Retries: 3 Phone KeyGen Timeout: 30 minutes Configure Ephone Security Parameters To configure security parameters for individual phones, perform the following steps for each phone. Before You Begin • Phones to be configured for security must be configured for basic calling in Cisco Unified CME. For configuration information, see Configure Phones to Make Basic Call, on page 315. Cisco Unified Communications Manager Express System Administrator Guide 615 Security Configure Ephone Security Parameters SUMMARY STEPS 1. enable 2. configure terminal 3. ephone phone-tag 4. capf-ip-in-cnf 5. device-security-mode {authenticated | none | encrypted } 6. codec {g711ulaw | g722r64 | g729r8 [dspfarm-assist]} 7. capf-auth-str digit-string 8. cert-oper {delete | fetch | upgrade} auth-mode {auth-string | LSC | MIC | null-string} 9. reset 10. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 ephone phone-tag Enters ephone configuration mode. Example: Router(config)# ephone 24 • phone-tag—Unique identifier of phone to be configured. (Optional) Enables the CAPF Server IP Address to be added to the CNF file for an SCCP phone. Upon successful registration, the SCCP phone downloads the LSC capf-ip-in-cnf Example: Router(config-ephone)# capf-ip-in-cnf Step 4 from the CAPFserver. This CLI command is optional and required only if the phone has to register, download, and authenticate with the LSC. device-security-mode (Optional) Enables security mode for an individual SCCP IP phone. {authenticated | none | encrypted } Step 5 • authenticated—Instructs device to establish a TLS connection with no encryption. There is no Secure Real-Time Transport Protocol (SRTP) in the media path. Example: Router(config-ephone)# device-security-mode authenticated • none—SCCP signaling is not secure. This is the default. • encrypted—Instructs device to establish an encrypted TLS connection to secure media path using SRTP. Cisco Unified Communications Manager Express System Administrator Guide 616 Security Configure Ephone Security Parameters Command or Action Purpose • This command can also be configured in telephony-service configuration mode. The value set in ephone configuration mode has priority over the value set in telephony-service configuration mode. (Optional) Sets the security mode for SCCP signaling for a phone communicating with the Cisco Unified CME router. codec {g711ulaw | g722r64 | g729r8 [dspfarm-assist]} Step 6 Example: Router(config-ephone)# codec g711ulaw dspfarm-assist • dspfarm-assist—Required for secure transcoding with Cisco Unified CME. Causes the system to attempt to use DSP Farm resources for transcoding the segment between the phone and the Cisco Unified CME router if G.711 is negotiated for the call. This keyword is ignored if the SCCP endpoint type is ATA, VG224, or VG248. (Optional) Defines a string to use as a personal identification number (PIN) for CAPF authentication. capf-auth-str digit-string Example: Router(config-ephone)# capf-auth-str 2734 Step 7 For instructions on how to enter the string on a phone, see Enter the Authentication String on the Phone, on page 625. Note • digit-string—Digits that the phone user must dial for CAPF authentication. The length of string is 4 to 10 digits. • This command can also be configured in telephony-service configuration mode. The value set in ephone configuration mode has priority over the value set in telephony-service configuration mode. • You can also define a PIN for CAPF authentication by using theauth-string command in CAPF-server configuration mode. (Optional) Initiates the indicated certificate operation on the ephone being configured. cert-oper {delete | fetch|upgrade} auth-mode {auth-string | LSC | MIC | null-string} Step 8 • delete—Removes the phone certificate. Example: Router(config-ephone)# cert-oper upgrade auth-mode auth-string • fetch—Retrieves the phone certificate for troubleshooting. • upgrade—Upgrades the phone certificate. • auth-mode—Type of authentication to use during CAPF sessions to verify endpoints that request certificates. • auth-string—Authentication string to be entered on the phone by the phone user. Use the capf-auth-str command to configure the auth-string. For configuration information, see Enter the Authentication String on the Phone, on page 625. • LSC—Phone provides its phone certificate for authentication. Precedence is given to an LSC if one exists. • MIC—Phone provides its phone certificate for authentication. Precedence is given to an MIC if one exists. MIC s issuer certificate must be imported into a PKI trustpoint. For information, see Manually Import the MIC Root Certificate, on page 626. Cisco Unified Communications Manager Express System Administrator Guide 617 Security Configure Ephone Security Parameters Command or Action Purpose • null-string—No authentication. • This command can also be configured in CAPF-server configuration mode to initiate certificate operations at a global level. This command in ephone configuration mode has priority over this command in CAPF-server configuration mode. • You can also use the auth-mode command in CAPF-server configuration mode to configure authentication at a global level. reset Performs a complete reboot of the phone. Example: Router(config-ephone)# reset Step 9 end Returns to privileged EXEC mode. Example: Router(config-ephone)# end Step 10 Verify Ephone Security Parameters Use the show capf-server auth-string command to display configured authentication strings (PINs) that users enter at the phone to establish CAPF authentication. Example: Router# show capf-server auth-string Authentication Strings for configured Ephones Mac-Addr Auth-String -------- ----------- 000CCE3A817C 2734 001121116BDD 922 000D299D50DF 9182 000ED7B10DAC 3114 000F90485077 3328> 0013C352E7F1 0678 What to Do Next • When you have more than one Cisco Unified CME router in your network, you must configure a CTL provider on each Cisco Unified CME router that is not running the CTL client. To configure a CTL provider on each Cisco Unified CME router on which the CTL client is not running, see Configure the CTL Provider, on page 619. Cisco Unified Communications Manager Express System Administrator Guide 618 Security Configure Ephone Security Parameters • If the CA is a third-party CA or if the Cisco IOS CA is on a Cisco IOS router external to the Cisco Unified CME router, you must configure an RA to issue certificates to phones. For information, see Configure the Registration Authority, on page 621. • If the specified authentication mode for the CAPF session is authentication-string, you must enter an authentication string on each phone that is receiving an updated LSC. For information, see Enter the Authentication String on the Phone, on page 625. • If the specified authentication mode for the CAPF session is MIC, the MIC’s issuer certificate must be imported into aPKI trustpoint.For information,see Manually Import the MIC Root Certificate, on page 626. • To configure Media Encryption, see Configure Media Encryption (SRTP) in Cisco Unified CME, on page 629. Configure the CTL Provider When you have more than one Cisco Unified CME router in your network, you must configure a CTL provider on each Cisco Unified CME router that is not running the CTL client. To configure a CTL provider on each Cisco Unified CME router on which the CTL client is not running, perform the following steps. SUMMARY STEPS 1. enable 2. configure terminal 3. credentials 4. ip source-address [ip-address [port [port-number]]] 5. trustpoint trustpoint-label 6. ctl-service admin username secret {0 | 1 } password- string 7. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 credentials Enters credentials-interface mode to configure a CTL provider. Example: Router(config)# credentials Step 3 Cisco Unified Communications Manager Express System Administrator Guide 619 Security Configure the CTL Provider Command or Action Purpose identifies the local router on which this CTL provider is being configured. ip source-address [ip-address [port [port-number]]] Step 4 Example: Router(config-credentials)# ip source-address 172.19.245.1 port 2444 • ip-address—Typically one of the addresses of the Ethernet port of the router. • port port-number—TCP port for credentials service communication. Default is 2444 and we recommend that you use the default value. Step 5 trustpoint trustpoint-label Configures the trustpoint. Example: Router(config-credentials)# trustpoint ctlpv • trustpoint-label—Name of CTL provider trustpoint to be used for TLS sessions with the CTL client. Specifies a username and password to authenticate the CTL client when it connects to retrieve the credentials during the CTL protocol. ctl-service admin username secret {0 | 1 } password- string Step 6 Example: Router(config-credentials)# ctl-service admin user4 secret 0 c89L8o • username—Name that will be used to authenticate the client. • secret—Character string for login authentication and whether the string should be encrypted when it is stored in the running configuration. ◦0—Not encrypted. ◦1—Encrypted using Message Digest 5 (MD5). • password-string—Character string for login authentication. end Returns to privileged EXEC mode. Example: Router(config-credentials)# end Step 7 Verify the CTL Provider Use the show credentials command to display credentials settings. Example: Router# show credentials Credentials IP: 172.19.245.1 Cisco Unified Communications Manager Express System Administrator Guide 620 Security Configure the CTL Provider Credentials PORT: 2444 Trustpoint: ctlpv What to Do Next • If the CA is a third-party CA or if the Cisco IOS CA is on a Cisco IOS router external to the Cisco Unified CME router, you must configure an RA to issue certificates to phones. For information, see Configure the Registration Authority, on page 621. • If the specified authentication mode for the CAPF session is authentication-string, you must enter an authentication string on each phone that is receiving an updated LSC. For information, see Enter the Authentication String on the Phone, on page 625. • If the specified authentication mode for the CAPF session is MIC, the MIC’s issuer certificate must be imported into aPKI trustpoint.For information,see Manually Import the MIC Root Certificate, on page 626. • To configure Media Encryption, see Configure Media Encryption (SRTP) in Cisco Unified CME, on page 629. Configure the Registration Authority A registration authority (RA) is the authority charged with recording or verifying some or all of the data required for the CA to issue certificates. In many cases the CA undertakes all of the RA functions itself, but where a CA operates over a wide geographical area or when there is security concern over exposing the CA at the edge of the network, it may be advisable to delegate some of the tasksto an RA and let the CA concentrate on its primary tasks of signing certificates. You can configure a CA to run in RA mode. When the RA receives a manual orSimple Certificate Enrollment Protocol (SCEP) enrollment request, the administrator can either reject or grant it on the basis of local policy. If the request is granted, it is forwarded to the issuing CA, and the CA automatically generates the certificate and returns it to the RA. The client can later retrieve the granted certificate from the RA. To configure an RA, perform the following steps on the Cisco Unified CME router. Cisco Unified Communications Manager Express System Administrator Guide 621 Security Configure the Registration Authority SUMMARY STEPS 1. enable 2. configure terminal 3. crypto pki trustpoint label 4. enrollment url ca-url 5. revocation-check method1 [method2 [method3]] 6. serial-number [none] 7. rsakeypair key-label [key-size [encryption-key-size]] 8. exit 9. crypto pki server label 10. mode ra 11. lifetime certificate time 12. grant auto 13. no shutdown 14. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Declares the trustpoint that your RA mode certificate server should use and enters CA-trustpoint configuration mode. crypto pki trustpoint label Example: Router(config)# crypto pki trustpoint ra12 Step 3 • label—Name for the trustpoint and RA. This label is also required for the cert-enroll-trustpoint command when you set up the CA proxy. See Configure the CAPF Server, on page 612. Tip Step 4 enrollment url ca-url Specifies the enrollment URL of the issuing CA (root CA). Example: Router(config-ca-trustpoint)# enrollment url http://ca-server.company.com • ca-url—URL of the router on which the root CA has been installed. (Optional) Checks the revocation status of a certificate and specifies one or more methods to check the status. If a second and third method are specified, revocation-check method1 [method2 [method3]] Step 5 Cisco Unified Communications Manager Express System Administrator Guide 622 Security Configure the Registration Authority Command or Action Purpose each method is used only if the previous method returns an error, such as a server being down. Example: Router(config-ca-trustpoint)# revocation-check none Valid values for methodn are as follows: • crl—Certificate checking is performed by a certificate revocation list (CRL). This is the default behavior. • none—Certificate checking is not required. • ocsp—Certificate checking is performed by an Online CertificateStatus Protocol (OCSP) server. (Optional) Specifies whether the router serial number should be included in the certificate request. When this command is not used, you are prompted for the serial number during certificate enrollment. serial-number [none] Example: Router(config-ca-trustpoint)# serial-number Step 6 • none—(Optional) A serial number is not included in the certificate request. rsakeypair key-label [key-size (Optional) Specifies an RSA key pair to use with a certificate. [encryption-key-size]] Step 7 • key-label—Name of the key pair, which is generated during enrollment if it does not already exist or if the auto-enroll regenerate command is used. Example: Router(config-ca-trustpoint)# rsakeypair exampleCAkeys 1024 1024 • key-size—(Optional) Size of the desired RSA key. If not specified, the existing key size is used. • encryption-key-size—(Optional) Size of the second key, which is used to request separate encryption, signature keys, and certificates. • Multiple trustpoints can share the same key. exit Exits ca-trustpoint configuration mode. Example: Router(config-ca-trustpoint)# exit Step 8 Defines a label for the certificate server and enters certificate-server configuration mode. crypto pki server label Example: Router(config)# crypto pki server ra12 Step 9 • label—Name for the trustpoint and RA. Use the same label that you previously created as a trustpoint and RA in Step 3, on page 622. mode ra Places the PKI server into certificate-server mode for the RA. Example: Router(config-cs-server)# mode ra Step 10 Step 11 lifetime certificate time (Optional) Specifies the lifetime, in days, of a certificate. Cisco Unified Communications Manager Express System Administrator Guide 623 Security Configure the Registration Authority Command or Action Purpose Example: Router(config-cs-server)# lifetime certificate 1800 • time—Number of days until the certificate expires. Range is 1 to 1825. Default is 365. The maximum certificate lifetime is 1 month less than the lifetime of the CA certificate. • This command must be used before the server is enabled with the no shutdown command. Step 12 grant auto Allows a certificate to be issued automatically to any requester. Example: Router(config-cs-server)# grant auto • Configure this command only during enrollment when testing and building simple networks. • As a security best practice, use the no grant auto command to disable this functionality after configuration so that certificates are not continually granted. Step 13 no shutdown (Optional) Enables the certificate server. Example: Router(config-cs-server)# no shutdown • When prompted, provide input regarding acceptance of the CA certificate, the router certificate, the challenge password, and a password for protecting the private key. • Use this command only after you have completely configured your certificate server. end Returns to privileged EXEC mode. Example: Router(config-cs-server)# end Step 14 What to Do Next • When you have more than one Cisco Unified CME router in your network, you must configure a CTL provider on each Cisco Unified CME router that is not running the CTL client. To configure a CTL provider on each Cisco Unified CME router on which the CTL client is not running, see Configure the CTL Provider, on page 619. • If the specified authentication mode for the CAPF session is authentication-string, you must enter an authentication string on each phone that is receiving an updated LSC. For information, see Enter the Authentication String on the Phone, on page 625. • If the specified authentication mode for the CAPF session is MIC, the MIC s issuer certificate must be imported into aPKI trustpoint.For information,see Manually Import the MIC Root Certificate, on page 626. • To configure Media Encryption, see Configure Media Encryption (SRTP) in Cisco Unified CME, on page 629. Cisco Unified Communications Manager Express System Administrator Guide 624 Security Configure the Registration Authority Enter the Authentication String on the Phone This procedure is required only for the one-time installation of an LSC on a phone and only if you configured the authentication mode for the CAPF session as authentication-string. The authentication string must be communicated to the phone user so that it can be entered on the phone before the LSC is installed. Note You can list authentication strings for phones by using the show capf-server auth-string command. Restriction • Authentication string applies for one-time use only. Before You Begin • Signed image exists on the IP phone; see the Cisco Unified IP phone administration documentation that supports your phone model. • IP phone is registered in Cisco Unified CME. • CAPF certificate exists in the CTL file. For information, see Configure the CTL Client, on page 607. • Authentication string to be entered is configured using auth-string command in CAPF-server configuration mode or the capf-auth-str command in ephone configuration mode. For information, see Configure Telephony-Service Security Parameters, on page 604. • The device-security-mode command is configured using the none keyword. For information, see Configure Telephony-Service Security Parameters, on page 604. Step 1 Press the Settings button. On the Cisco Unified IP Phone 7921, press Down Arrow to access the Settings menu. Step 2 If the configuration is locked, press **# (asterisk, asterisk, pound sign) to unlock it. Step 3 Scroll down the Settings menu. Highlight Security Configuration and press the Select softkey. Step 4 Scroll down the Security Configuration menu. Highlight LSC and press the Update softkey. On the Cisco Unified IP Phone 7921, press **# to unlock the Security Configuration menu. Step 5 When prompted for the authentication string, enter the string provided by the system administrator and press theSubmit softkey. The phone installs, updates, deletes, or fetches the certificate, depending on the CAPF configuration. You can monitor the progress of the certificate operation by viewing the messages that display on the phone. After you press Submit, the message “Pending” appears under the LSC option. The phone generates the public and private key pair and displays the information on the phone. When the phone successfully completes the process, the phone displays a successful message. If the phone displays a failure message, you entered the wrong authentication string or did not enable the phone for upgrade. You can stop the process by choosing Stop at any time. Cisco Unified Communications Manager Express System Administrator Guide 625 Security Enter the Authentication String on the Phone Step 6 Verify that the certificate was installed on the phone. From the Settings menu on the phone screen, choose Model Information and then press the Select softkey to display the Model Information. Step 7 Press the navigation button to scroll to LSC. The value for this item indicates whether LSC is Installed or Not Installed. What to Do Next • When you have more than one Cisco Unified CME router in your network, you must configure a CTL provider on each Cisco Unified CME router that is not running the CTL client. To configure a CTL provider on each Cisco Unified CME router on which the CTL client is not running, see Configure the CTL Provider, on page 619. • If the CA is a third-party CA or if the Cisco IOS CA is on a Cisco IOS router external to the Cisco Unified CME router, you must configure an RA to issue certificates to phones. For information, see Configure the Registration Authority, on page 621 . • If the specified authentication mode for the CAPF session is MIC, the MIC’s issuer certificate must be imported into aPKI trustpoint.For information,see Manually Import the MIC Root Certificate, on page 626. • To configure Media Encryption, see Configure Media Encryption (SRTP) in Cisco Unified CME, on page 629. Manually Import the MIC Root Certificate The MIC root certificate must be present in the Cisco Unified CME router to allow Cisco Unified CME to authenticate the MIC that is presented to it. To manually import the MIC root certificate on the Cisco Unified CME router, perform the following steps for each type of phone that requires a MIC for authentication. Before You Begin One of the following must be true before you perform this task: • The device-security-mode command is configured using the none keyword. For information, see Configure Telephony-Service Security Parameters, on page 604. • MIC is the specified authentication mode for phone authentication during a CAPF session. • A phone’s MIC, rather than an LSC, is used to establish the TLS session for SCCP signaling. Cisco Unified Communications Manager Express System Administrator Guide 626 Security Manually Import the MIC Root Certificate SUMMARY STEPS 1. enable 2. configure terminal 3. crypto pki trustpoint name 4. revocation-check none 5. enrollment terminal 6. exit 7. crypto pki authenticate name 8. Download the four MIC root certificate files. Cut and paste the appropriate text for each certificate. Accept the certificates. 9. exit DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Declares the CA that your router should use and enters ca-trustpoint configuration mode. crypto pki trustpoint name Example: Router(config)# crypto pki trustpoint sanjose1 Step 3 • name—Already-configured label for the CA. Specifiesthat revocation check is not performed and the certificate is always accepted. revocation-check none Example: Router(ca-trustpoint)# revocation-check none Step 4 enrollment terminal Specifies manual (copy-and-paste) certificate enrollment. Example: Router(ca-trustpoint)# enrollment terminal Step 5 exit Exits ca-trustpoint configuration mode. Example: Router(ca-trustpoint)# exit Step 6 Cisco Unified Communications Manager Express System Administrator Guide 627 Security Manually Import the MIC Root Certificate Command or Action Purpose Step 7 crypto pki authenticate name Authenticates the CA by getting the certificate from the CA. Example: Router(config)# crypto pki authenticate sanjose1 • name- Already-configured label for the CA. Download the four MIC root certificate files. Cut and paste the appropriate text for each certificate. Accept the certificates. Step 8 1 Click on the link to the certificate: The certificates are available at the following links: • CAP-RTP-001: http://www.cisco.com/security/pki/certs/ CAP-RTP-001.cer • CAP-RTP-002: http://www.cisco.com/security/pki/certs/ CAP-RTP-002.cer • CMCA: http://www.cisco.com/security/pki/certs/cmca.cer • CiscoRootCA2048: http://www.cisco.com/security/pki/certs/ crca2048.cer 2 When the Downloading Certificate dialog window opens, select the option to view the certificate. Do not install the certificate. 3 Select the Detail tab on top. 4 Click Export on the bottom and save the certificate into a file. 5 Open the file with WordPad. 6 Cut and paste the text between -----BEGIN CERTIFICATE----- and -----END CERTIFICATE----- into the IOS console. 7 When prompted, press Enter and type quit. After pasting the certificate, press Enter and type quit on a line by itself. 8 Enter y to accept the certificate. The system respondsto the pasted certificate text by providing the MD5 and SHA1 fingerprints, and asks whether you accept the certificate. Enter y to accept the certificate or n to reject it. 9 Repeat steps a. through h. for each certificate. exit Returns to privileged EXEC mode. Example: Router(config)# exit Step 9 Cisco Unified Communications Manager Express System Administrator Guide 628 Security Manually Import the MIC Root Certificate What to Do Next • When you have more than one Cisco Unified CME router in your network, you must configure a CTL provider on each Cisco Unified CME router that is not running the CTL client. To configure a CTL provider on each Cisco Unified CME router on which the CTL client is not running, see Configure the CTL Provider, on page 619. • If the CA is a third-party CA or if the Cisco IOS CA is on a Cisco IOS router external to the Cisco Unified CME router, you must configure an RA to issue certificates to phones. For information, see Configure the Registration Authority, on page 621. • If the specified authentication mode for the CAPF session is authentication-string, you must enter an authentication string on each phone that is receiving an updated LSC. For information, see Enter the Authentication String on the Phone, on page 625. • To configure Media Encryption, see Configure Media Encryption (SRTP) in Cisco Unified CME, on page 629. Configure Media Encryption (SRTP) in Cisco Unified CME To configure the network forsecure calls between Cisco Unified CME systems across an H.323 trunk, perform the following steps on the Cisco Unified CME router. Restriction • Secure three-way software conferencing is notsupported. A secure call beginning withSRTPalways falls back to nonsecure Real-Time Transport Protocol (RTP) when it is joined to a conference. • If a party drops from a three-party conference, the call between the remaining two parties returns to secure if the two parties are SRTP-capable local Skinny Client Control Protocol (SCCP) endpoints to a single Cisco Unified CME and the conference creator is one of the remaining parties. If either of the two remaining parties are only RTP-capable, the call remains nonsecure. If the two remaining parties are connected through FXS, PSTN, or VoIP, the call remains nonsecure. • Calls to Cisco Unity Express are not secure. • Music on Hold (MOH) is not secure. • Video calls are not secure. • Modem relay and T.3 fax relay calls are not secure. • Media flow-around is not supported for call transfer and call forward. • Conversion between inband tone and RFC 2833 DTMFis notsupported. RFC 2833 DTMFhandling is supported when encryption keys are sent to secure DSP Farm devices but is not supported for codec passthrough. • Secure Cisco Unified CME does not support SIP trunks; only H.323 trunks are supported. • Media Encryption (SRTP) supports secure supplementary services in both H.450 and non-H.450 Cisco Unified CME networks. A secure Cisco Unified CME network should be either H.450 or non-H.450, not a hybrid. • Secure calls are supported in the default session application only. Cisco Unified Communications Manager Express System Administrator Guide 629 Security Configure Media Encryption (SRTP) in Cisco Unified CME Before You Begin • Cisco Unified CME 4.2 or a later version. • To make secure H.323 calls, telephony-service security parameters must be configured. See Configure Telephony-Service Security Parameters, on page 604. • Compatible Cisco IOS Release on the Cisco VG224 Analog Phone Gateway. For information, see Cisco Unified CME and Cisco IOS Release Compatibility Matrix. SUMMARY STEPS 1. enable 2. configure terminal 3. voice service voip 4. supplementary-service media-renegotiate 5. srtp fallback 6. h323 7. emptycapability 8. exit DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 voice service voip Enters voice-service configuration mode. Example: Router(config)# voice service voip • The voip keyword specifies VoIP encapsulation. supplementary-service media-renegotiate Enables midcall renegotiation of SRTP cryptographic keys. Example: Router(conf-voi-serv)# supplementary-service media-renegotiate Step 4 Globally enables secure calls using SRTP for media encryption and authentication and enables SRTP-to-RTP fallback to support supplementary services such as ringback tone and MOH. srtp fallback Example: Router(conf-voi-serv)# srtp fallback Step 5 Cisco Unified Communications Manager Express System Administrator Guide 630 Security Configure Media Encryption (SRTP) in Cisco Unified CME Command or Action Purpose • Skip this step if you are going to configure fallback on individual dial peers. • This command can also be configured in dial-peer configuration mode. This command in dial-peer configuration command takes precedence over this command in voice service voip configuration mode. h323 Enters H.323 voice-service configuration mode. Example: Router(conf-voi-serv)# h323 Step 6 Eliminates the need for identical codec capabilities for all dial peers in the rotary group. emptycapability Example: Router(conf-serv-h323)# emptycapability Step 7 exit Exits H.323 voice-service configuration mode. Example: Router(conf-serv-h323)# exit Step 8 What to Do Next You have completed the required task for configuring Media Encryption (SRTP) on Cisco Unified CME. Configuring Cisco Unified CME SRTP Fallback for H.323 Dial Peers. You can now perform the following optional tasks: • Configure Cisco Unified CME SRTP Fallback for H.323 Dial Peers, on page 631(Optional) • Configure Cisco Unity for Secure Cisco Unified CME Operation, on page 633(Optional) Configure Cisco Unified CME SRTP Fallback for H.323 Dial Peers To configure SRTP fallback for an individual dial peer, perform the following steps on the Cisco Unified CME router. Cisco Unified Communications Manager Express System Administrator Guide 631 Security Configure Cisco Unified CME SRTP Fallback for H.323 Dial Peers SUMMARY STEPS 1. enable 2. configure terminal 3. voice class codec tag 4. codec preference value codec-type 5. exit 6. dial-peer voice tag voip 7. srtp fallback 8. voice-class codec tag 9. exit DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice-class configuration mode and assigns an identification tag number for a codec voice class. voice class codec tag Example: Router(config)# voice class codec 1 Step 3 Step 4 codec preference value codec-type Specifies a list of preferred codecs to use on a dial peer. Example: Router(config-voice-class)# codec preference 1 g711alaw • Repeat this step to build a list of preferred codecs. • Use the same preference order for the codec list on both Cisco Unified CMEs on either side of the H.323 trunk. exit Exits voice-class configuration mode. Example: Router(config-voice-class)# exit Step 5 dial-peer voice tag voip Enters dial peer voice configuration mode. Example: Router(config)# dial-peer voice 101 voip Step 6 Cisco Unified Communications Manager Express System Administrator Guide 632 Security Configure Cisco Unified CME SRTP Fallback for H.323 Dial Peers Command or Action Purpose Enables secure calls that use SRTP for media encryption and authentication and specifies fallback capability. srtp fallback Example: Router(config-dial-peer)# srtp fallback Step 7 • Using the no srtp command disables SRTP and causes the dial peer to fall back to RTP mode. • fallback—Enables fallback to nonsecure mode (RTP) on an individual dial peer. The no srtp fallback command disables fallback and SRTP. • This command can also be configured in voice service voip configuration mode. This command in dial-peer configuration command takes precedence over this command in voice service voip configuration mode. Assigns a previously configured codec selection preference list (codec voice class) to a Voice over IP (VoIP) dial peer. voice-class codec tag Example: Router(config-dial-peer)# voice-class codec 1 Step 8 • The tag argument in this step is the same as the tag in Step 3. exit Exits dial-peer voice configuration mode. Example: Router(config-dial-peer)# exit Step 9 Configure Cisco Unity for Secure Cisco Unified CME Operation This section contains the following tasks: • Prerequisites for Configuring Cisco Unity for Secure Cisco Unified CME Operation, on page 633 • Configure Integration Between Cisco Unified CME and Cisco Unity, on page 634 • Import the Cisco Unity Root Certificate to Cisco Unified CME, on page 634 • Configure Cisco Unity Ports for Secure Registration, on page 636 • Verify that Cisco Unity are Registering Securely, on page 636 Prerequisites for Configuring Cisco Unity for Secure Cisco Unified CME Operation • Cisco Unity 4.2 or later version. Cisco Unified Communications Manager Express System Administrator Guide 633 Security Configure Cisco Unity for Secure Cisco Unified CME Operation Configure Integration Between Cisco Unified CME and Cisco Unity To change the settingsfor the integration between Cisco Unified CME and Cisco Unity, perform the following steps on the Cisco Unity server: Step 1 If Cisco Unity Telephony Integration Manager (UTIM) is not yet open on the Cisco Unity server, choosePrograms > Cisco Unity > Manage Integrations from the Windows Start menu. The UTIM window appears. Step 2 In the left pane, double-click Cisco Unity Server. The existing integrations appear. Step 3 Click Cisco Unified Communications Manager integration. Step 4 In the right pane, click the cluster for the integration. Step 5 Click the Servers tab. Step 6 In the Cisco Unified Communications Manager Cluster Security Mode field, click the applicable setting. Step 7 If you clicked Non-secure, click Save and skip the remaining steps in this procedure. If you clicked Authenticated or Encrypted, the Security tab and the Add TFTP Server dialog box appear. In the IP Address or Host Name field of the Add TFTP Server dialog box, enter the IP address (or DNS name) of the primary TFTP server for the Cisco Unified Communications Manager cluster and click OK. Step 8 If there are more TFTP servers that Cisco Unity will use to download the Cisco Unified Communications Manager certificates, click Add. The Add TFTP Server dialog box appears. Step 9 In the IP Address or Host Name field, enter the IP address (or DNS name) of the secondary TFTP server for the Cisco Unified Communications Manager cluster and click OK. Step 10 Click Save. Cisco Unity creates the voice messaging port device certificates, exports the Cisco Unity server root certificate, and displays the Export Cisco Unity Root Certificate dialog box. Step 11 Note the filename of the exported Cisco Unity server root certificate and click OK. Step 12 On the Cisco Unity server, navigate to the CommServer\SkinnyCerts directory. Step 13 Locate the Cisco Unity server root certificate file that you exported in Step 11. Step 14 Right-click the file and click Rename. Step 15 Change the file extension from .0 to .pem. For example, change the filename “12345.0” to “12345.pem” for the exported Cisco Unity server root certificate file. Step 16 Copy this file to a PC from which you can access the Cisco Unified CME router. Import the Cisco Unity Root Certificate to Cisco Unified CME To import the Cisco Unity root certificate to Cisco Unified CME, perform the following steps on the Cisco Unified CME router: Cisco Unified Communications Manager Express System Administrator Guide 634 Security Configure Cisco Unity for Secure Cisco Unified CME Operation SUMMARY STEPS 1. enable 2. configure terminal 3. crypto pki trustpoint name 4. revocation-check none 5. enrollment terminal 6. exit 7. crypto pki authenticate trustpoint-label 8. Open the root certificate file that you copied from the Cisco Unity Server in Step 16, on page 634. 9. You will be prompted to enter the CA certificate. Cut and paste the entire contents of the base 64 encoded certificate between BEGIN CERTIFICATE and END CERTIFICATE at the command line. Press Enter and type quit. The router prompts you to accept the certificate. Enter yes to accept the certificate. DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Declares the trustpoint that your RA mode certificate servershould use and enters ca-trustpoint configuration mode. crypto pki trustpoint name Example: Router(config)# crypto pki trustpoint PEM Step 3 • label—Name for the trustpoint and RA. (Optional) Specifies that certificate checking is not required. revocation-check none Example: Router(ca-trustpoint)# revocation-check none Step 4 enrollment terminal Specifies manual cut-and-paste certificate enrollment. Example: Router(ca-trustpoint)# enrollment terminal Step 5 exit Exits ca-trustpoint configuration mode. Example: Router(ca-trustpoint)# exit Step 6 Cisco Unified Communications Manager Express System Administrator Guide 635 Security Configure Cisco Unity for Secure Cisco Unified CME Operation Command or Action Purpose Retrievesthe CA certificate and authenticatesit. Checks the certificate fingerprint when prompted. crypto pki authenticate trustpoint-label Example: Router(config)# crypto pki authenticate pem Step 7 • trustpoint-label—Already-configured name for the trustpoint and RA. See Step 3, on page 635. Open the root certificate file that you copied from the Cisco Unity Server in Step 16, on page 634. Step 8 Completesthe copying of the Cisco Unity root certificate to the Cisco Unified CME router. You will be prompted to enter the CA certificate. Cut and paste the entire contents of the base 64 encoded certificate between BEGIN CERTIFICATE and END CERTIFICATE Step 9 at the command line. Press Enter and type quit. The router prompts you to accept the certificate. Enter yes to accept the certificate. Configure Cisco Unity Ports for Secure Registration To configure Cisco Unity ports for registration in secure mode, perform the following steps: Step 1 Choose the Cisco voice-mail port that you want to update. Step 2 From the Device Security Mode drop-down list, choose Encrypted. Step 3 Click Update. Verify that Cisco Unity are Registering Securely Use the show sccp connections command to verify that Cisco Unity ports are registered securely with Cisco Unified CME. In the following example, the secure value of the type field shows that the connections are secure. Router# show sccp connections sess_id conn_id stype mode codec ripaddr rport sport 16777222 16777409 secure-xcode sendrecv g729b 10.3.56.120 16772 19534 16777222 16777393 secure-xcode sendrecv g711u 10.3.56.50 17030 18464 Total number of active session(s) 1, and connection(s) 2 Cisco Unified Communications Manager Express System Administrator Guide 636 Security Configure Cisco Unity for Secure Cisco Unified CME Operation HTTPS Provisioning for Cisco Unified IP Phones To provision a Cisco Unified IP phone for secure access to web content using HTTPS, perform the following steps: Before You Begin • Firmware 9.0 (4) or a later version must be installed on the IP phone to prevent an infinite registration loop. • Certificate file to be imported from flash memory to the IP phone must be in privacy-enhanced mail format. Cisco Unified Communications Manager Express System Administrator Guide 637 Security HTTPS Provisioning for Cisco Unified IP Phones SUMMARY STEPS 1. enable 2. configure terminal 3. ip http server 4. crypto pki server cs-label 5. database level {minimum | names |complete} 6. database url root url 7. grant auto 8. exit 9. crypto pki trustpoint name 10. enrollment url url 11. exit 12. crypto pki server cs-label 13. no shutdown 14. exit 15. crypto pki trustpoint name 16. enrollment url url 17. revocation-check method1 [method2[method3]] 18. rsakeypair key-label 19. exit 20. crypto pki authenticate name 21. crypto pki enroll name 22. crypto pki trustpoint name 23. enrollment url url 24. revocation-check method1 [method2[method3]] 25. rsakeypair key-label 26. exit 27. crypto pki authenticate name 28. crypto pki enroll name 29. ctl-client 30. sastl trustpoint label 31. sast2 trustpoint label 32. import certificate tag description flash: cert_name 33. server application server address trustpoint label 34. regenerate 35. end Cisco Unified Communications Manager Express System Administrator Guide 638 Security HTTPS Provisioning for Cisco Unified IP Phones DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 ip http server Enables the HTTP server on the Cisco Unified CME router. Example: Router(config)# ip http server Step 3 Enables a Cisco IOS certificate server and enters certificate server configuration mode. crypto pki server cs-label Example: Router(config)# crypto pki server IOS-CA Step 4 • cs-label—Name of the certificate server. The certificate server name should not exceed 13 characters. Note Controls what type of data is stored in the certificate enrollment database. database level {minimum |names|complete} Example: Router(cs-server)# database level complete Step 5 • complete—Each issued certificate is written to the database. If this keyword is used, you should enable the database url command. Specifiesthe location where database entriesfor the certificate server will be stored or published. database url root url Example: Router(cs-server)# database url flash: Step 6 • root url—Location where database entries will be written. (Optional) Allows an automatic certificate to be issued to any requester. The recommended method and default if this command is not used is manual enrollment. grant auto Example: Router(cs-server)# grant auto Step 7 exit Exits certificate server configuration mode. Example: Router(cs-server)# exit Step 8 Step 9 crypto pki trustpoint name Declares a trustpoint and enters ca-trustpoint configuration mode. Cisco Unified Communications Manager Express System Administrator Guide 639 Security HTTPS Provisioning for Cisco Unified IP Phones Command or Action Purpose Example: Router(config)# crypto pki trustpoint IOS-CA • name—Name for the trustpoint. Step 10 enrollment url url Specifies the enrollment parameters of a certification authority. Example: Router(ca-trustpoint)# enrollment url http://10.1.1.1:80 • url—Specifies the URL of the file system where your router should send certificate requests. exit Exits ca-trustpoint configuration mode. Example: Router(ca-trustpoint)# exit Step 11 Enables a Cisco IOS certificate server and enters certificate server configuration mode. crypto pki server cs-label Example: Router(config)# crypto pki server IOS-CA Step 12 • cs-label—Name of the certificate server. The certificate server name should not exceed 13 characters. Note no shutdown Enables the Cisco IOS Certification Authority. Example: Router(cs-server)# no shutdown Step 13 exit Exits certificate server configuration mode. Example: Router(cs-server)# exit Step 14 Step 15 crypto pki trustpoint name Declares a trustpoint and enters ca-trustpoint configuration mode. Example: Router(config)# crypto pki trustpoint primary-cme • name—Name for the trustpoint. Step 16 enrollment url url Specifies the enrollment parameters of the certification authority. Example: Router(ca-trustpoint)# enrollment url http://10.1.1.1:80 • url—Specifies the URL of the file system where your router should send certificate requests. Step 17 revocation-check method1 [method2[method3]] Checks the revocation status of a certificate. Example: Router(ca-trustpoint)# revocation-check none • none—Certificate checking is not required. Step 18 rsakeypair key-label Specifies which RSA key pair to associate with the certificate. Cisco Unified Communications Manager Express System Administrator Guide 640 Security HTTPS Provisioning for Cisco Unified IP Phones Command or Action Purpose Example: Router(ca-trustpoint)# rsakeypair primary-cme • key-label—Name of the key pair, which is generated during enrollment if it does not already exist or if the auto-enroll regenerate command is configured. exit Exits ca-trustpoint configuration mode. Example: Router(ca-trustpoint)# exit Step 19 Authenticates the certification authority by getting the authority's certificate. crypto pki authenticate name Example: Router(config)# crypto pki authenticate primary-cme Step 20 • name—Name of the certification authority. Step 21 crypto pki enroll name Obtains the certificates for the router from the certificate authority. Example: Router(config)# crypto pki enroll primary-cme • name—Name of the certification authority. Use the same name as when you declared the certification authority using the crypto pki trustpoint command. Step 22 crypto pki trustpoint name Declares a trustpoint and enters ca-trustpoint configuration mode. Example: Router(config)# crypto pki trustpoint sast-secondary • name—Name for the trustpoint. Step 23 enrollment url url Specifies the enrollment parameters of a certification authority. Example: Router(ca-trustpoint)# enrollment url http://10.1.1.1:80 • url—Specifies the URL of the file system where your router should send certificate requests. Step 24 revocation-check method1 [method2[method3]] Checks the revocation status of a certificate. Example: Router(ca-trustpoint)# revocation-check none • none—Certificate checking is not required. Step 25 rsakeypair key-label Specifies which RSA key pair to associate with the certificate. Example: Router(ca-trustpoint)# rsakeypair sast-secondary • key-label—Name of the key pair, which is generated during enrollment if it does not already exist or if the auto-enroll regenerate command is configured. exit Exits ca-trustpoint configuration mode. Example: Router(ca-trustpoint)# exit Step 26 Cisco Unified Communications Manager Express System Administrator Guide 641 Security HTTPS Provisioning for Cisco Unified IP Phones Command or Action Purpose Authenticates the certification authority by getting the authority's certificate. crypto pki authenticate name Example: Router(config)# crypto pki authenticate sast-secondary Step 27 • name—Name of the certification authority. Step 28 crypto pki enroll name Obtains the certificates for the router from the certificate authority. Example: Router(config)# crypto pki enroll sast-secondary • name—Name of the certification authority. Use the same name as when you declared the certification authority using the crypto pki trustpoint command. Enters CTL-client configuration mode to set parametersfor the CTL client. ctl-client Example: Router(config)# ctl-client Step 29 Step 30 sastl trustpoint label Configures the credentials for the primary SAST. Example: Router(config-ctl-client)# sast1 trustpoint first-sast • label—Name of SAST1 trustpoint. SAST1 andSAST2 certificates must be different from each other. The CTL file is alwayssigned bySAST1. TheSAST2 credentials are included in the CTL file so that if theSAST1 certificate is compromised, the file can be signed bySAST2 to prevent phones from being reset to the factory default. Note Step 31 sast2 trustpoint label Configures the credentials for the secondary SAST. Example: Router(config-ctl-client)# sast2 trustpoint second-sast • label—Name of SAST2 trustpoint. SAST1 andSAST2 certificates must be different from each other. The CTL file is alwayssigned bySAST1. TheSAST2 credentials are included in the CTL file so that if theSAST1 certificate is compromised, the file can be signed bySAST2 to prevent phones from being reset to the factory default. Note Imports a trusted certificate in PEM format from flash memory to the CTL file of an IP phone. import certificate tag description flash: cert_name Step 32 Example: Router(config-ctl-client)# import certificate 5 FlashCert flash:flash_cert.cer This step is required to provision HTTPS service running on external server. Note • tag—identifier for the trusted certificate. • description—Descriptive name of the trusted certificate. • flash:cert_cert—Specifiesthe filename of the trusted certificate stored in flash memory. server application server address trustpoint Configures the server application and the credentials for the SAST. label Step 33 Cisco Unified Communications Manager Express System Administrator Guide 642 Security HTTPS Provisioning for Cisco Unified IP Phones Command or Action Purpose Example: Router(config-ctl-client)# server application 10.1.2.3 trustpoint first-sast Creates a new CTLFile.tlv after you make changes to the CTL client configuration. regenerate Example: Router(config-ctl-client)# regenerate Step 34 end Exits to privileged EXEC mode. Example: Router(config-ctl-client)# end Step 35 Configuration Examples for Security Example for Configuring Cisco IOS CA crypto pki server iosca grant auto database url flash: ! crypto pki trustpoint iosca revocation-check none rsakeypair iosca ! crypto pki certificate chain iosca certificate ca 01 308201F9 30820162 ... Example for Manually Importing MIC Root Certificate on the Cisco Unified CME Router The following example shows three certificates imported to the router (7970, 7960, PEM): Router(config)# crypto pki trustpoint 7970 Router(ca-trustpoint)# revocation-check none Router(ca-trustpoint)# enrollment terminal Router(ca-trustpoint)# exit Router(config)# crypto pki authenticate 7970 Enter the base 64 encoded CA certificate. End with a blank line or the word "quit" on a line by itself MIIDqDCCApCgAwIBAgIQNT+yS9cPFKNGwfOprHJWdTANBgkqhkiG9w0BAQUFADAu MRYwFAYDVQQKEw1DaXNjbyBTeXN0ZW1zMRQwEgYDVQQDEwtDQVAtUlRQLTAwMjAe Cisco Unified Communications Manager Express System Administrator Guide 643 Security Configuration Examples for Security Fw0wMzEwMTAyMDE4NDlaFw0yMzEwMTAyMDI3MzdaMC4xFjAUBgNVBAoTDUNpc2Nv IFN5c3RlbXMxFDASBgNVBAMTC0NBUC1SVFAtMDAyMIIBIDANBgkqhkiG9w0BAQEF AAOCAQ0AMIIBCAKCAQEAxCZlBK19w/2NZVVvpjCPrpW1cCY7V1q9lhzI85RZZdnQ 2M4CufgIzNa3zYxGJIAYeFfcRECnMB3f5A+x7xNiEuzE87UPvK+7S80uWCY0Uhtl AVVf5NQgZ3YDNoNXg5MmONb8lT86F55EZyVac0XGne77TSIbidejrTgYQXGP2MJx Qhg+ZQlGFDRzbHfM84Duv2Msez+l+SqmqO80kIckqE9Nr3/XCSj1hXZNNVg8D+mv Hth2P6KZqAKXAAStGRLSZX3jNbS8tveJ3Gi5+sj9+F6KKK2PD0iDwHcRKkcUHb7g lI++U/5nswjUDIAph715Ds2rn9ehkMGipGLF8kpuCwIBA6OBwzCBwDALBgNVHQ8E BAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUUpIr4ojuLgmKTn5wLFal mrTUm5YwbwYDVR0fBGgwZjBkoGKgYIYtaHR0cDovL2NhcC1ydHAtMDAyL0NlcnRF bnJvbGwvQ0FQLVJUUC0wMDIuY3Jshi9maWxlOi8vXFxjYXAtcnRwLTAwMlxDZXJ0 RW5yb2xsXENBUC1SVFAtMDAyLmNybDAQBgkrBgEEAYI3FQEEAwIBADANBgkqhkiG 9w0BAQUFAAOCAQEAVoOM78TaOtHqj7sVL/5u5VChlyvU168f0piJLNWip2vDRihm E+DlXdwMS5JaqUtuaSd/m/xzxpcRJm4ZRRwPq6VeaiiQGkjFuZEe5jSKiSAK7eHg tup4HP/ZfKSwPA40DlsGSYsKNMm3OmVOCQUMH02lPkS/eEQ9sIw6QS7uuHN4y4CJ NPnRbpFRLw06hnStCZHtGpKEHnY213QOy3h/EWhbnp0MZ+hdr20FujSI6G1+L39l aRjeD708f2fYoz9wnEpZbtn2Kzse3uhU1Ygq1D1x9yuPq388C18HWdmCj4OVTXux V6Y47H1yv/GJM8FvdgvKlExbGTFnlHpPiaG9tQ== quit Certificate has the following attributes: Fingerprint MD5: F7E150EA 5E6E3AC5 615FC696 66415C9F Fingerprint SHA1: 1BE2B503 DC72EE28 0C0F6B18 798236D8 D3B18BE6 % Do you accept this certificate? [yes/no]: y Trustpoint CA certificate accepted. % Certificate successfully imported Router(config)# crypto pki trustpoint 7960 Router(ca-trustpoint)# revocation-check none Router(ca-trustpoint)# enrollment terminal Router(ca-trustpoint)# exit Router(config)# crypto pki authenticate 7960 Enter the base 64 encoded CA certificate. End with a blank line or the word "quit" on a line by itself MIICKDCCAZGgAwIBAgIC8wEwDQYJKoZIhvcNAQEFBQAwQDELMAkGA1UEBhMCVVMx GjAYBgNVBAoTEUNpc2NvIFN5c3RlbXMgSW5jMRUwEwYDVQQDEwxDQVBGLTdEN0Qw QzAwHhcNMDQwNzE1MjIzODMyWhcNMTkwNzEyMjIzODMxWjBAMQswCQYDVQQGEwJV UzEaMBgGA1UEChMRQ2lzY28gU3lzdGVtcyBJbmMxFTATBgNVBAMTDENBUEYtN0Q3 RDBDMDCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA0hvMOZZ9ENYWme11YGY1 it2rvE3Nk/eqhnv8P9eqB1iqt+fFBeAG0WZ5bO5FetdU+BCmPnddvAeSpsfr3Z+h x+r58fOEIBRHQLgnDZ+nwYH39uwXcRWWqWwlW147YHjV7M5c/R8T6daCx4B5NBo6 kdQdQNOrV3IP7kQaCShdM/kCAwEAAaMxMC8wDgYDVR0PAQH/BAQDAgKEMB0GA1Ud JQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDBTANBgkqhkiG9w0BAQUFAAOBgQCaNi6x sL6M5NlDezpSBO3QmUVyXMfrONV2ysrSwcXzHu0gJ9MSJ8TwiQmVaJ47hSTlF5a8 YVYJ0idifXbXRo+/EEO7kkmFE8MZta5rM7UWj8bAeR42iqA3RzQaDwuJgNWT9Fhh GgfuNAlo5h1AikxsvxivmDlLdZyCMoqJJd7B2Q== quit Certificate has the following attributes: Fingerprint MD5: 4B9636DF 0F3BA6B7 5F54BE72 24762DBC Fingerprint SHA1: A9917775 F86BB37A 5C130ED2 3E528BB8 286E8C2D % Do you accept this certificate? [yes/no]: y Trustpoint CA certificate accepted. % Certificate successfully imported Router(config)# crypto pki trustpoint PEM Router(ca-trustpoint)# revocation-check none Router(ca-trustpoint)# enrollment terminal Router(ca-trustpoint)# exit Router(config)# crypto pki authenticate PEM Enter the base 64 encoded CA certificate. End with a blank line or the word "quit" on a line by itself MIIDqDCCApCgAwIBAgIQdhL5YBU9b59OQiAgMrcjVjANBgkqhkiG9w0BAQUFADAu MRYwFAYDVQQKEw1DaXNjbyBTeXN0ZW1zMRQwEgYDVQQDEwtDQVAtUlRQLTAwMTAe Fw0wMzAyMDYyMzI3MTNaFw0yMzAyMDYyMzM2MzRaMC4xFjAUBgNVBAoTDUNpc2Nv IFN5c3RlbXMxFDASBgNVBAMTC0NBUC1SVFAtMDAxMIIBIDANBgkqhkiG9w0BAQEF AAOCAQ0AMIIBCAKCAQEArFW77Rjem4cJ/7yPLVCauDohwZZ/3qf0sJaWlLeAzBlq Rj2lFlSij0ddkDtfEEo9VKmBOJsvx6xJlWJiuBwUMDhTRbsuJz+npkaGBXPOXJmN > Cisco Unified Communications Manager Express System Administrator Guide 644 Security Example for Manually Importing MIC Root Certificate on the Cisco Unified CME Router Vd54qlpc/hQDfWlbrIFkCcYhHws7vwnPsLuy1Kw2L2cP0UXxYghSsx8H4vGqdPFQ NnYy7aKJ43SvDFt4zn37n8jrvlRuz0x3mdbcBEdHbA825Yo7a8sk12tshMJ/YdMm vny0pmDNZXmeHjqEgVO3UFUn6GVCO+K1y1dUU1qpYJNYtqLkqj7wgccGjsHdHr3a U+bw1uLgSGsQnxMWeMaWo8+6hMxwlANPweufgZMaywIBA6OBwzCBwDALBgNVHQ8E BAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQU6Rexgscfz6ypG270qSac cK4FoJowbwYDVR0fBGgwZjBkoGKgYIYtaHR0cDovL2NhcC1ydHAtMDAxL0NlcnRF bnJvbGwvQ0FQLVJUUC0wMDEuY3Jshi9maWxlOi8vXFxjYXAtcnRwLTAwMVxDZXJ0 RW5yb2xsXENBUC1SVFAtMDAxLmNybDAQBgkrBgEEAYI3FQEEAwIBADANBgkqhkiG 9w0BAQUFAAOCAQEAq2T96/YMMtw2Dw4QX+F1+g1XSrUCrNyjx7vtFaRDHyB+kobw dwkpohfkzfTyYpJELzV1r+kMRoyuZ7oIqqccEroMDnnmeApc+BRGbDJqS1Zzk4OA c6Ea7fm53nQRlcSPmUVLjDBzKYDNbnEjizptaIC5fgB/S9S6C1q0YpTZFn5tjUjy WXzeYSXPrcxb0UH7IQJ1ogpONAAUKLoPaZU7tVDSH3hD4+VjmLyysaLUhksGFrrN phzZrsVVilK17qpqCPllKLGAS4fSbkruq3r/6S/SpXS6/gAoljBKixP7ZW2PxgCU 1aU9cURLPO95NDOFN3jBk3Sips7cVidcogowPQ== quit Certificate has the following attributes: Fingerprint MD5: 233C8E33 8632EA4E 76D79FEB FFB061C6 Fingerprint SHA1: F7B40B94 5831D2AB 447AB8F2 25990732 227631BE % Do you accept this certificate? [yes/no]: y Trustpoint CA certificate accepted. % Certificate successfully imported Use the show crypto pki trustpoint status command to show that enrollment has succeeded and that five CA certificates have been granted. The five certificates include the three certificates just entered, the CA server certificate, and the router certificate. Router# show crypto pki trustpoint status Trustpoint 7970: Issuing CA certificate configured: Subject Name: cn=CAP-RTP-002,o=Cisco Systems Fingerprint MD5: F7E150EA 5E6E3AC5 615FC696 66415C9F Fingerprint SHA1: 1BE2B503 DC72EE28 0C0F6B18 798236D8 D3B18BE6 State: Keys generated ............. Yes (General Purpose) Issuing CA authenticated ....... Yes Certificate request(s) ..... None Trustpoint 7960: Issuing CA certificate configured: Subject Name: cn=CAPF-508A3754,o=Cisco Systems Inc,c=US Fingerprint MD5: 6BAE18C2 0BCE391E DAE2FE4C 5810F576 Fingerprint SHA1: B7735A2E 3A5C274F C311D7F1 3BE89942 355102DE State: Keys generated ............. Yes (General Purpose) Issuing CA authenticated ....... Yes Certificate request(s) ..... None Trustpoint PEM: Issuing CA certificate configured: Subject Name: cn=CAP-RTP-001,o=Cisco Systems Fingerprint MD5: 233C8E33 8632EA4E 76D79FEB FFB061C6 Fingerprint SHA1: F7B40B94 5831D2AB 447AB8F2 25990732 227631BE State: Keys generated ............. Yes (General Purpose) Issuing CA authenticated ....... Yes Certificate request(s) ..... None Trustpoint srstcaserver: Issuing CA certificate configured: Subject Name: cn=srstcaserver Fingerprint MD5: 6AF5B084 79C93F2B 76CC8FE6 8781AF5E Fingerprint SHA1: 47D30503 38FF1524 711448B4 9763FAF6 3A8E7DCF State: Keys generated ............. Yes (General Purpose) Issuing CA authenticated ....... Yes Certificate request(s) ..... None Trustpoint srstca: Cisco Unified Communications Manager Express System Administrator Guide 645 Security Example for Manually Importing MIC Root Certificate on the Cisco Unified CME Router Issuing CA certificate configured: Subject Name: cn=srstcaserver Fingerprint MD5: 6AF5B084 79C93F2B 76CC8FE6 8781AF5E Fingerprint SHA1: 47D30503 38FF1524 711448B4 9763FAF6 3A8E7DCF Router General Purpose certificate configured: Subject Name: serialNumber=F3246544+hostname=c2611XM-sSRST.cisco.com Fingerprint: 35471295 1C907EC1 45B347BC 7A9C4B86 State: Keys generated ............. Yes (General Purpose) Issuing CA authenticated ....... Yes Certificate request(s) ..... Yes Example for Configuring Telephony-Service Security Parameters The following example shows Cisco Unified CME security parameters: telephony-service device-security-mode authenticated secure-signaling trustpoint cme-sccp tftp-server-credentials trustpoint cme-tftp load-cfg-file slot0:Ringlist.xml alias Ringlist.xml sign create ephone 24 device-security-mode authenticated capf-auth-str 2734 cert-oper upgrade auth-mode auth-string Example for Configuring CTL Client Running on Cisco Unified CME Router ctl-client server capf 10.1.1.1 trustpoint cmeserver server cme 10.1.1.1 trustpoint cmeserver server tftp 10.1.1.1 trustpoint cmeserver sast1 trustpoint cmeserver sast2 trustpoint sast2 CTL Client Running on Another Router: Example ctl-client server cme 10.1.1.100 trustpoint cmeserver server cme 10.1.1.1 username cisco password 1 0822455D0A16544541 sast1 trustpoint cmeserver sast2 trustpoint sast1 CAPF Server: Example ! ip dhcp pool cme-pool network 10.1.1.0 255.255.255.0 option 150 ip 10.1.1.1 default-router 10.1.1.1 ! capf-server port 3804 auth-mode null-string cert-enroll-trustpoint iosra password 1 00071A1507545A545C trustpoint-label cmeserver source-addr 10.1.1.1 ! crypto pki server iosra grant auto mode ra database url slot0: ! crypto pki trustpoint cmeserver enrollment url http://10.1.1.100:80 serial-number revocation-check none rsakeypair cmeserver ! Cisco Unified Communications Manager Express System Administrator Guide 646 Security Example for Configuring Telephony-Service Security Parameters crypto pki trustpoint sast2 enrollment url http://10.1.1.100:80 serial-number revocation-check none rsakeypair sast2 ! ! crypto pki trustpoint iosra enrollment url http://10.1.1.200:80 revocation-check none rsakeypair iosra ! ! crypto pki certificate chain cmeserver certificate 1B 30820207 30820170 A0030201 0202011B 300D0609 2A864886 F70D0101 04050030 .... quit certificate ca 01 3082026B 308201D4 A0030201 02020101 300D0609 2A864886 F70D0101 04050030 ... quit crypto pki certificate chain sast2 certificate 1C 30820207 30820170 A0030201 0202011C 300D0609 2A864886 F70D0101 04050030 .... quit certificate ca 01 3082026B 308201D4 A0030201 02020101 300D0609 2A864886 F70D0101 04050030 ..... quit crypto pki certificate chain capf-tp crypto pki certificate chain iosra certificate 04 30820201 3082016A A0030201 02020104 300D0609 2A864886 F70D0101 04050030 ...... certificate ca 01 308201F9 30820162 A0030201 02020101 300D0609 2A864886 F70D0101 04050030 .... quit ! ! credentials ctl-service admin cisco secret 1 094F471A1A0A464058 ip source-address 10.1.1.1 port 2444 trustpoint cmeserver ! ! telephony-service no auto-reg-ephone load 7960-7940 P00307010200 load 7914 S00104000100 load 7941GE TERM41.7-0-0-129DEV load 7970 TERM70.7-0-0-77DEV max-ephones 20 max-dn 10 ip source-address 10.1.1.1 port 2000 secondary 10.1.1.100 secure-signaling trustpoint cmeserver cnf-file location flash: cnf-file perphone dialplan-pattern 1 2... extension-length 4 max-conferences 8 gain -6 transfer-pattern .... tftp-server-credentials trustpoint cmeserver server-security-mode secure device-security-mode encrypted load-cfg-file slot0:Ringlist.xml alias Ringlist.xml sign load-cfg-file slot0:P00307010200.bin alias P00307010200.bin load-cfg-file slot0:P00307010200.loads alias P00307010200.loads load-cfg-file slot0:P00307010200.sb2 alias P00307010200.sb2 load-cfg-file slot0:P00307010200.sbn alias P00307010200.sbn load-cfg-file slot0:cnu41.2-7-4-116dev.sbn alias cnu41.2-7-4-116dev.sbn Cisco Unified Communications Manager Express System Administrator Guide 647 Security Example for Configuring CTL Client Running on Cisco Unified CME Router load-cfg-file slot0:Jar41.2-9-0-101dev.sbn alias Jar41.2-9-0-101dev.sbn load-cfg-file slot0:CVM41.2-0-0-96dev.sbn alias CVM41.2-0-0-96dev.sbn load-cfg-file slot0:TERM41.DEFAULT.loads alias TERM41.DEFAULT.loads load-cfg-file slot0:TERM70.DEFAULT.loads alias TERM70.DEFAULT.loads load-cfg-file slot0:Jar70.2-9-0-54dev.sbn alias Jar70.2-9-0-54dev.sbn load-cfg-file slot0:cnu70.2-7-4-58dev.sbn alias cnu70.2-7-4-58dev.sbn load-cfg-file slot0:CVM70.2-0-0-49dev.sbn alias CVM70.2-0-0-49dev.sbn load-cfg-file slot0:DistinctiveRingList.xml alias DistinctiveRingList.xml sign load-cfg-file slot0:Piano1.raw alias Piano1.raw sign load-cfg-file slot0:S00104000100.sbn alias S00104000100.sbn create cnf-files version-stamp 7960 Aug 13 2005 12:39:24 ! ! ephone 1 device-security-mode encrypted cert-oper upgrade auth-mode null-string mac-address 000C.CE3A.817C type 7960 addon 1 7914 button 1:2 8:8 ! ! ephone 2 device-security-mode encrypted capf-auth-str 2476 cert-oper upgrade auth-mode null-string mac-address 0011.2111.6BDD type 7970 button 1:1 ! ! ephone 3 device-security-mode encrypted capf-auth-str 5425 cert-oper upgrade auth-mode null-string mac-address 000D.299D.50DF type 7970 button 1:3 ! ! ephone 4 device-security-mode encrypted capf-auth-str 7176 cert-oper upgrade auth-mode null-string mac-address 000E.D7B1.0DAC type 7960 button 1:4 ! ! ephone 5 device-security-mode encrypted mac-address 000F.9048.5077 type 7960 button 1:5 ! ! ephone 6 device-security-mode encrypted mac-address 0013.C352.E7F1 type 7941GE button 1:6 ! Example for Secure Unified CME Router# show running-config Building configuration... Current configuration : 12735 bytes ! Cisco Unified Communications Manager Express System Administrator Guide 648 Security Example for Secure Unified CME ! No configuration change since last restart ! version 12.4 service timestamps debug datetime msec service timestamps log datetime msec no service password-encryption service internal ! hostname Router ! boot-start-marker boot-end-marker ! card type e1 1 1 logging queue-limit 1000 logging buffered 9999999 debugging logging rate-limit 10000 no logging console ! aaa new-model ! ! aaa accounting connection h323 start-stop group radius ! aaa session-id common ! resource policy ! clock timezone IST 5 no network-clock-participate slot 1 ! ! ip cef ! ! isdn switch-type primary-net5 ! voice-card 0 no dspfarm ! voice-card 1 no dspfarm ! ! ctl-client server capf 10.13.32.11 trustpoint mytrustpoint1 server tftp 10.13.32.11 trustpoint mytrustpoint1 server cme 10.13.32.11 trustpoint mytrustpoint1 sast1 trustpoint mytrustpoint1> sast2 trustpoint sast2 ! capf-server port 3804 auth-mode null-string cert-enroll-trustpoint iosra password 1 mypassword trustpoint-label mytrustpoint1 source-addr 10.13.32.11 phone-key-size 512 ! voice call debug full-guid ! voice service voip srtp fallback allow-connections h323 to h323 no supplementary-service h450.2 no supplementary-service h450.3 no supplementary-service h450.7 supplementary-service media-renegotiate h323 emptycapability ras rrq ttl 4000 ! ! Cisco Unified Communications Manager Express System Administrator Guide 649 Security Example for Secure Unified CME voice class codec 2 codec preference 1 g711alaw codec preference 2 g711ulaw ! voice class codec 3 codec preference 1 g729r8 codec preference 8 g711alaw codec preference 9 g711ulaw ! voice class codec 1 codec preference 1 g729r8 codec preference 2 g728 codec preference 3 g723ar63 codec preference 4 g711ulaw ! ! voice iec syslog voice statistics type iec voice statistics time-range since-reset ! ! ! crypto pki server myra database level complete grant auto lifetime certificate 1800 ! crypto pki trustpoint myra enrollment url http://10.13.32.11:80 revocation-check none rsakeypair iosra ! crypto pki trustpoint mytrustpoint1 enrollment url http://10.13.32.11:80 revocation-check none rsakeypair mytrustpoint1 ! crypto pki trustpoint sast2 enrollment url http://10.13.32.11:80 revocation-check none rsakeypair sast2 ! ! crypto pki certificate chain myra certificate ca 01 308201F9 30820162 A0030201 02020101 300D0609 2A864886 F70D0101 04050030 10310E30 0C060355 04031305 696F7372 61301E17 0D303630 37303730 35343031 375A170D 30393037 30363035 34303137 5A301031 0E300C06 03550403 1305696F 73726130 819F300D 06092A86 4886F70D 01010105 0003818D 00308189 02818100 D8CE29F9 C9FDB1DD 0E1517E3 6CB4AAF7 52B83DE2 1C017ACA DFC4AF42 F9D10D08 E74BF95B 29378902 B49E32C4 85907384 84CAE4B2 7759BB84 8AB1F578 580793C4 B11A2DBE B2ED02CC DA0C3824 A5FCC377 18CE87EA C0C297BA BE54530F E62247D8 1483CD14 9FD89EFE 05DFBB37 E03FD3F8 B2B1C0B8 A1931BCC B1174A9E 6566F8F5 02030100 01A36330 61300F06 03551D13 0101FF04 05300301 01FF300E 0603551D 0F0101FF 04040302 0186301F 0603551D 23041830 168014B7 16F6FD67 29666C90 D0C62515 E14265A9 EB256230 1D060355 1D0E0416 0414B716 F6FD6729 666C90D0 C62515E1 4265A9EB 2562300D 06092A86 4886F70D 01010405 00038181 002B7F41 64535A66 D20D888E 661B9584 5E3A28DF 4E5A95B9 97E57CAE B07A7C38 7F3B60EE 75C7E5DE 6DF19B06 5F755FB5 190BABFC EF272CEF 865FE01B 1CE80F98 F320A569 CAFFA5D9 3DB3E7D8 8A86C66C F227FF81 6C4449F2 AF8015D9 8129C909 81AFDC01 180B61E8 85E19873 96DB3AE3 E6B70726 9BF93521 CA2FA906 99194ECA 8F quit crypto pki certificate chain mytrustpoint1 certificate 02 308201AB 30820114 A0030201 02020102 300D0609 2A864886 F70D0101 04050030 10310E30 0C060355 04031305 696F7372 61301E17 0D303630 37303730 35343233 385A170D 30393037 30363035 34303137 5A301A31 18301606 092A8648 86F70D01 09021609 32383531 2D434D45 32305C30 0D06092A 864886F7 0D010101 0500034B 00304802 4100B3ED A902646C 3851B7F6 CF94887F 0EC437E3 3B6FEDB2 2B4B45A6 3611C243 5A0759EA 1E8D96D1 60ABE028 ED6A3F2A E95DCE45 BE0921AF 82E53E57 17CC12F0 C1270203 010001A3 4F304D30 0B060355 1D0F0404 030205A0 301F0603 551D2304 18301680 14B716F6 FD672966 6C90D0C6 2515E142 65A9EB25 62301D06 03551D0E 04160414 4EE1943C EA817A9E 7010D5B8 0467E9B0 6BA76746 300D0609 Cisco Unified Communications Manager Express System Administrator Guide 650 Security Example for Secure Unified CME 2A864886 F70D0101 04050003 81810003 564A6DA1 868B2669 7C096F9A 41173CFC E49246EE C645E30B A0753E3B E1A265D1 6EA5A829 F10CD0E8 3F2E3AD4 39D8DFE8 83525F2B D19F5E15 F27D6262 62852D1F 43629B68 86D91B5F 7B2E2C25 3BD2CCC3 00EF4028 714339B2 6A7E0B2F 131D2D9E 0BE08853 5CCAE47C 4F74953C 19305A20 B2C97808 D6E01351 48366421 A1D407 quit certificate ca 01 308201F9 30820162 A0030201 02020101 300D0609 2A864886 F70D0101 04050030 10310E30 0C060355 04031305 696F7372 61301E17 0D303630 37303730 35343031 375A170D 30393037 30363035 34303137 5A301031 0E300C06 03550403 1305696F 73726130 819F300D 06092A86 4886F70D 01010105 0003818D 00308189 02818100 D8CE29F9 C9FDB1DD 0E1517E3 6CB4AAF7 52B83DE2 1C017ACA DFC4AF42 F9D10D08 E74BF95B 29378902 B49E32C4 85907384 84CAE4B2 7759BB84 8AB1F578 580793C4 B11A2DBE B2ED02CC DA0C3824 A5FCC377 18CE87EA C0C297BA BE54530F E62247D8 1483CD14 9FD89EFE 05DFBB37 E03FD3F8 B2B1C0B8 A1931BCC B1174A9E 6566F8F5 02030100 01A36330 61300F06 03551D13 0101FF04 05300301 01FF300E 0603551D 0F0101FF 04040302 0186301F 0603551D 23041830 168014B7 16F6FD67 29666C90 D0C62515 E14265A9 EB256230 1D060355 1D0E0416 0414B716 F6FD6729 666C90D0 C62515E1 4265A9EB 2562300D 06092A86 4886F70D 01010405 00038181 002B7F41 64535A66 D20D888E 661B9584 5E3A28DF 4E5A95B9 97E57CAE B07A7C38 7F3B60EE 75C7E5DE 6DF19B06 5F755FB5 190BABFC EF272CEF 865FE01B 1CE80F98 F320A569 CAFFA5D9 3DB3E7D8 8A86C66C F227FF81 6C4449F2 AF8015D9 8129C909 81AFDC01 180B61E8 85E19873 96DB3AE3 E6B70726 9BF93521 CA2FA906 99194ECA 8F quit crypto pki certificate chain sast2 certificate 03 308201AB 30820114 A0030201 02020103 300D0609 2A864886 F70D0101 04050030 10310E30 0C060355 04031305 696F7372 61301E17 0D303630 37303730 35343331 375A170D 30393037 30363035 34303137 5A301A31 18301606 092A8648 86F70D01 09021609 32383531 2D434D45 32305C30 0D06092A 864886F7 0D010101 0500034B 00304802 4100C703 840B11A7 81FCE5AE A14FE593 5114D3C2 5473F488 B8FB4CC5 41EAFA3A D99381D8 21AE6AA9 BA83A84E 9DF3E8C6 54978787 5EF6CC35 C334D55E A3051372 17D30203 010001A3 4F304D30 0B060355 1D0F0404 030205A0 301F0603 551D2304 18301680 14B716F6 FD672966 6C90D0C6 2515E142 65A9EB25 62301D06 03551D0E 04160414 EB2146B4 EE24AA61 8B5D2F8D 2AD3B786 CBADC8F2 300D0609 2A864886 F70D0101 04050003 81810057 BA0053E9 8FD54B25 72D85A4C CAB47F26 8316F494 E94DFFB9 8E9D065C 9748465C F54719CA C7724F50 67FBCAFF BC332109 DC2FB93D 5AD86583 EDC3E648 39274CE8 D4A5F002 5F21ED3C 6D524AB7 7F5B1876 51867027 9BD2FFED 06984558 C903064E 5552015F 289BA9BB 308D327A DFE0A3B9 78CF2B02 2DD4C208 80CDC0A8 43A26A quit certificate ca 01 308201F9 30820162 A0030201 02020101 300D0609 2A864886 F70D0101 04050030 10310E30 0C060355 04031305 696F7372 61301E17 0D303630 37303730 35343031 375A170D 30393037 30363035 34303137 5A301031 0E300C06 03550403 1305696F 73726130 819F300D 06092A86 4886F70D 01010105 0003818D 00308189 02818100 D8CE29F9 C9FDB1DD 0E1517E3 6CB4AAF7 52B83DE2 1C017ACA DFC4AF42 F9D10D08 E74BF95B 29378902 B49E32C4 85907384 84CAE4B2 7759BB84 8AB1F578 580793C4 B11A2DBE B2ED02CC DA0C3824 A5FCC377 18CE87EA C0C297BA BE54530F E62247D8 1483CD14 9FD89EFE 05DFBB37 E03FD3F8 B2B1C0B8 A1931BCC B1174A9E 6566F8F5 02030100 01A36330 61300F06 03551D13 0101FF04 05300301 01FF300E 0603551D 0F0101FF 04040302 0186301F 0603551D 23041830 168014B7 16F6FD67 29666C90 D0C62515 E14265A9 EB256230 1D060355 1D0E0416 0414B716 F6FD6729 666C90D0 C62515E1 4265A9EB 2562300D 06092A86 4886F70D 01010405 00038181 002B7F41 64535A66 D20D888E 661B9584 5E3A28DF 4E5A95B9 97E57CAE B07A7C38 7F3B60EE 75C7E5DE 6DF19B06 5F755FB5 190BABFC EF272CEF 865FE01B 1CE80F98 F320A569 CAFFA5D9 3DB3E7D8 8A86C66C F227FF81 6C4449F2 AF8015D9 8129C909 81AFDC01 180B61E8 85E19873 96DB3AE3 E6B70726 9BF93521 CA2FA906 99194ECA 8F quit ! ! username admin password 0 mypassword2 username cisco password 0 mypassword2 ! ! controller E1 1/0 pri-group timeslots 1-31 ! controller E1 1/1 pri-group timeslots 1-31 gw-accounting aaa ! ! Cisco Unified Communications Manager Express System Administrator Guide 651 Security Example for Secure Unified CME ! ! ! interface GigabitEthernet0/0 ip address 10.13.32.11 255.255.255.0 duplex auto speed auto fair-queue 64 256 32 h323-gateway voip interface h323-gateway voip id GK1 ipaddr 10.13.32.13 1719 h323-gateway voip id GK2 ipaddr 10.13.32.16 1719 h323-gateway voip h323-id 2851-CiscoUnifiedCME h323-gateway voip tech-prefix 1# ip rsvp bandwidth 1000 100 ! interface GigabitEthernet0/1 no ip address shutdown duplex auto speed auto ! interface Serial1/0:15 no ip address encapsulation hdlc isdn switch-type primary-net5 isdn protocol-emulate network isdn incoming-voice voice no cdp enable ! interface Serial1/1:15 no ip address encapsulation hdlc isdn switch-type primary-net5 isdn protocol-emulate network isdn incoming-voice voice no cdp enable ! ip route 0.0.0.0 0.0.0.0 10.13.32.1 ! ! ip http server ip http authentication local no ip http secure-server ip http path flash: ! ! ! ! ! ! tftp-server flash:music-on-hold.au tftp-server flash:TERM70.DEFAULT.loads tftp-server flash:TERM71.DEFAULT.loads tftp-server flash:P00308000300.bin tftp-server flash:P00308000300.loads tftp-server flash:P00308000300.sb2 tftp-server flash:P00308000300.sbn tftp-server flash:SCCP70.8-0-3S.loads tftp-server flash:cvm70sccp.8-0-2-25.sbn tftp-server flash:apps70.1-1-2-26.sbn tftp-server flash:dsp70.1-1-2-26.sbn tftp-server flash:cnu70.3-1-2-26.sbn tftp-server flash:jar70sccp.8-0-2-25.sbn radius-server host 10.13.32.241 auth-port 1645 acct-port 1646 radius-server timeout 40 radius-server deadtime 2 radius-server key cisco radius-server vsa send accounting ! control-plane ! no call rsvp-sync ! Cisco Unified Communications Manager Express System Administrator Guide 652 Security Example for Secure Unified CME ! voice-port 1/0/0 ! voice-port 1/0/1 ! voice-port 1/0:15 ! voice-port 1/1:15 ! ! ! ! ! dial-peer voice 1 voip destination-pattern ........ voice-class codec 2 session target ras incoming called-number 9362.... dtmf-relay h245-alphanumeric req-qos controlled-load audio ! dial-peer voice 2 pots destination-pattern 93621101 ! dial-peer voice 3 pots destination-pattern 93621102 ! dial-peer voice 10 voip destination-pattern 2668.... voice-class codec 1 session target ipv4:10.13.46.200 ! dial-peer voice 101 voip shutdown destination-pattern 5694.... voice-class codec 1 session target ipv4:10.13.32.10 incoming called-number 9362.... ! dial-peer voice 102 voip shutdown destination-pattern 2558.... voice-class codec 1 session target ipv4:10.13.32.12 incoming called-number 9362.... ! dial-peer voice 103 voip shutdown destination-pattern 9845.... voice-class codec 1 session target ipv4:10.13.32.14 incoming called-number 9362.... ! dial-peer voice 104 voip shutdown destination-pattern 9844.... voice-class codec 1 session target ipv4:10.13.32.15 incoming called-number 9362.... ! dial-peer voice 201 pots destination-pattern 93625... no digit-strip direct-inward-dial port 1/0:15 ! dial-peer voice 202 pots destination-pattern 93625... no digit-strip direct-inward-dial port 1/1:15 ! ! Cisco Unified Communications Manager Express System Administrator Guide 653 Security Example for Secure Unified CME gateway timer receive-rtp 1200 ! ! ! telephony-service load 7960-7940 P00308000300 max-ephones 4 max-dn 4 ip source-address 10.13.32.11 port 2000 auto assign 1 to 4 secure-signaling trustpoint mytrustpoint1 cnf-file location flash: cnf-file perphone voicemail 25589000 max-conferences 4 gain -6 call-forward pattern .T moh flash:music-on-hold.au web admin system name admin password mypassword2 dn-webedit time-webedit transfer-system full-consult transfer-pattern ........ tftp-server-credentials trustpoint mytrustpoint1 server-security-mode secure device-security-mode encrypted create cnf-files version-stamp 7960 Oct 25 2006 07:19:39 ! ! ephone-dn 1 number 93621000 name 2851-PH1 call-forward noan 25581101 timeout 10 ! ! ephone-dn 2 number 93621001 name 2851-PH2 call-forward noan 98441000 timeout 10 ! ! ephone-dn 3 number 93621002 name 2851-PH3 ! ! ephone-dn 4 number 93621003 name 2851-PH4 ! ! ephone 1 capf-ip-in-cnf no multicast-moh device-security-mode encrypted mac-address 0012.4302.A7CC type 7970 button 1:1 ! ! ! ephone 2 capf-ip-in-cnf no multicast-moh device-security-mode encrypted mac-address 0017.94CA.9CCD type 7960 button 1:2 ! ! ! ephone 3 capf-ip-in-cnf Cisco Unified Communications Manager Express System Administrator Guide 654 Security Example for Secure Unified CME no multicast-moh device-security-mode encrypted mac-address 0017.94CA.9833 type 7960 button 1:3 ! ! ! ephone 4 capf-ip-in-cnf no multicast-moh device-security-mode none mac-address 0017.94CA.A141 type 7960 button 1:4 ! ! ! line con 0 logging synchronous level all limit 20480000 line aux 0 line vty 0 4 ! scheduler allocate 20000 1000 ntp clock-period 17179791 ntp server 10.13.32.12 ! webvpn context Default_context ssl authenticate verify all ! no inservice ! ! end Example for Configuring HTTPS Support for Cisco Unified CME Configurations similar to the following example are required before HTTPS support for services like local-directory lookup, My Phone Apps, and Extension Mobility in Cisco Unified CME can be configured at four different levels: Router(config)# ip http server Router(config)# crypto pki server IOS-CA Router(cs-server)# database level complete Router(cs-server)# database url flash: Router(cs-server)# grant auto Router(cs-server)# exit Router(config)# crypto pki trustpoint IOS-CA Router(ca-trustpoint)# enrollment url http://10.1.1.1:80 Router(ca-trustpoint)# exit Router(config)# crypto pki server IOS-CA Router(cs-server)# no shutdown Router(cs-server)# exit Router(config)# crypto pki trustpoint primary-cme Router(ca-trustpoint)# enrollment url http://10.1.1.1.80 Router(ca-trustpoint)# revocation-check none Router(ca-trustpoint)# rsakeypair primary-cme Router(ca-trustpoint)# exit Router(config)# crypto pki authenticate primary-cme Router(config)# crypto pki enroll primary-cme Router(config)# crypto pki trustpoint sast-secondary Router(ca-trustpoint)# enrollment url http://10.1.1.1:80 Router(ca-trustpoint)# revocation-check none Router(ca-trustpoint)# rsakeypair sast-secondary Router(ca-trustpoint)# exit Router(config)# crypto pki authenticate sast-secondary Router(config)# crypto pki enroll sast-secondary Router(config)# ctl-client Router(config-ctl-client)# sast1 trustpoint first-sast Cisco Unified Communications Manager Express System Administrator Guide 655 Security Example for Configuring HTTPS Support for Cisco Unified CME Router(config-ctl-client)# sast2 trustpoint second-sast Router(config-ctl-client)# server application 10.1.2.3 trustpoint first-sast Router(config-ctl-client)# regenerate Router(config-ctl-client)# end For Cisco Unified SCCP IP Phones at the global level: configure terminal telephony-service cnf-file perphone service https For Cisco Unified SCCP IP Phones at the ephone-template level: configure terminal ephone-template 1 service https For Cisco Unified SIP IP Phones at the global level: configure terminal voice register global service https For Cisco Unified SIP IP Phones at the voice register template level: configure terminal voice register template 1 service https Where to Go Next PKI Management Cisco IOSpublic key infrastructure (PKI) provides certificate management to support security protocols such as IP Security (IPsec), secure shell (SSH), and secure socket layer (SSL). Cisco VG224 Analog Phone Gateway • To configure secure endpoints on the Cisco VG224 Analog Phone Gateway, see the Configuring Secure Signalling and Media Encryption on the Cisco VG224 section of Supplementary Services Features for FXS Ports on Cisco IOS Voice Gateways Configuration Guide. Feature Information for Security The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Cisco Unified Communications Manager Express System Administrator Guide 656 Security Where to Go Next Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Table 40: Feature Information for Security Feature Name Cisco Unified CME Version Feature Information Introduces HTTPS support on Cisco Unified CME. HTTPS Support in Cisco Unified 9.5 CME Allows you to import an IPphone's trusted certificate to an IP phone's CTL file using the import certificate command. HTTPS Provisioning for Cisco 8.8 Unified IP Phones Introduces media encryption on Cisco Unified CME. Media Encryption (SRTP) on 4.2 Cisco Unified CME Introduces phone authentication for Cisco Unified CME phones. Phone Authentication 4.0 Cisco Unified Communications Manager Express System Administrator Guide 657 Security Feature Information for Security Cisco Unified Communications Manager Express System Administrator Guide 658 Security Feature Information for Security CHAPTER 18 Directory Services • Information About Directory Services, page 659 • Configure Directory Services, page 661 • Configuration Examples for Directory Services, page 672 • Feature Information for Directory Services, page 676 Information About Directory Services Local Directory Cisco Unified CME automatically creates a local phone directory containing the telephone numbers that are assigned in the directory number configuration of the phone. You can make additional entries to the local directory in telephony services configuration mode. Additional entries can be nonlocal numbers such as telephone numbers on other Cisco Unified CME systems used by your company. When a phone user selects the Directories > Local Directory menu, the phone displays a search page from Unified CME. After a user enters the search information, the phone sends the information to Cisco Unified CME, which searches for the requested number or name pattern in the directory number configuration and sends the response back to the phone, which displays the matched results. The phone can display up to 32 directory entries. If a search results in more than 32 entries, the phone displays an error message and the user must refine the search criteria to narrow the results. The order of the names in the directory entries is first-name-first or last-name-first. Character strings for directory names can contain a spaces and a comma (,) and cannot contain an ampersand (&). The local directory that is displayed on an IP phone is an XML page that is accessed through HTTP without password protection. The directory HTTP service can be disabled to suppress the availability of the local directory. For configuration information, see Configure Local Directory Service, on page 661. From CME 12.0 onwards, an optional username and password can be configured for authenticating the local directory services. For more information on the CLI command service local-directoryauthenticateusername password, see Cisco Unified Communications Manager Express Command Reference. Cisco Unified Communications Manager Express System Administrator Guide 659 External Directory Cisco Unified IP Phones can support URLs in association with the four programmable feature buttons on IP phones, including the Directories button. Operation of these services is determined by the Cisco Unified IP phone capabilities and the content of the referenced URL.Provisioning the directory URL to select an external directory resource disables the Cisco Unified CME local directory service. Called-Name Display When phone agents answer calls for different departments or people, it is often helpful for them to see a display of the name, rather than the number of the called party. The Dialed Number Identification Service (or Called-Name Display) feature supports the display of the name associated with a called number for incoming calls to IP phones configured on a Unified CME. The display name is obtained from the list of Unified CME directory names using directory lookup. You need to configure the CLI command service dnis dir-lookup under telephony-service configuration mode to use this directory lookup service.For more information on the CLI command servicednisdir-lookup, see Cisco Unified Communications Manager Express Command Reference Guide. If the display name for a called number is not available in Unified CME directory names, the display name can be added using the CLI commanddirectory entry.For more information on the CLI commanddirectory entry, see Cisco Unified Communications Manager Express Command Reference Guide. When a phone receives two simultaneous calls, there is a slight time difference between the calls being acknowledged by the phone. Called-name Display is only for the first call acknowledged by the phone. Even when the first call is disconnected and the second call is in ringing state, Called-name Display feature does not work for the second call. Note For an example of Called-Name Display , see Example for Called-Name Display for Voice Hunt Group, on page 672 The called-name display feature for ephone-dns can display either of the following types of name: • Name for a directory number in a local directory • Name associated with an overlay directory number. Calls to the first directory number in a set of overlay numbers will display a caller ID. Calls to the remaining directory numbers in the overlay set will display the name associated with the directory number. This is an example of Called-Name Display for ephone-dns. If order-entry agents are servicing three catalogs with individual 800 numbers configured in one overlay ephone-dn set, they need to know which catalog is being called to give the correct greeting, such as “Thank you for calling catalog N. May I take your order?” From Unified CME Release 12.0 onwards, the Dialed Number Identification Service feature is supported for phones configured under voice hunt group. For information on configuring Called-Name Display feature, see Called-Name Display, on page 666. Cisco Unified Communications Manager Express System Administrator Guide 660 Directory Services External Directory Directory Search Cisco Unified CME 4.3 increases the number of entries supported in a search results list from 32 to up to 240 when using the directory search feature. For example, if a user enters smith as the last name, all 240 matches are displayed on eight different pages, with 30 entries per page. If multiple pages are required, the phone displays two new softkeys, “Next” and “Prev” that the phone user can press to move back and forth between the previous and next pages. Text such as “Page 2 of 3" displays to indicate the current and total pages on the search results. Configure Directory Services Configure Local Directory Service To define the format for local directory names or block the local directory display on all phones, perform the following steps. SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. directory {first-name-first |last-name-first} 5. no service local-directory 6. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 3 Step 4 directory {first-name-first |last-name-first} Defines the format for entries in the local directory. Cisco Unified Communications Manager Express System Administrator Guide 661 Directory Services Directory Search Command or Action Purpose Example: Router(config-telephony)# directory last-name-first • Default is first-name-first. no service local-directory Disables local directory service on IP phones. Example: Router(config-telephony)# no service local-directory Step 5 end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 6 Define a Name for a Directory Number on SCCP Phone To define a name to be used for caller-ID displays and as a local directory entry, perform the following steps. Restriction • The name to be associated with a directory number cannot contain special characters, such as an ampersand (&). The only special characters allowed in the name are the comma (,) and the percent sign (%). Before You Begin • Cisco CME 3.0 or a later version. • Directory number for which you are defining a directory entry must already have a number assigned by using thenumber (ephone-dn) command.For configuration information,see Create Directory Numbers for SCCP Phones, on page 253. SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-dn dn-tag 4. name name 5. end Cisco Unified Communications Manager Express System Administrator Guide 662 Directory Services Define a Name for a Directory Number on SCCP Phone DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 ephone-dn dn-tag Enters ephone-dn configuration mode. Example: Router(config)# ephone-dn 55 Step 3 Step 4 name name Associates a name with this directory number. Example: Router(config-ephone-dn)# name Smith, John • Must follow the name order that is specified with the directory command: first-name-first or last-name-first. • name—Alphanumeric string to be displayed. or Router(config-ephone-dn)# name Shipping and Handling ◦You must separate the two parts, first last or last first, of the name string with a space. ◦The second part of the name string can contain spaces, such as "and Shipping". The first part of the name string cannot contain spaces. ◦You can include a comma (,) in the name string for display purposes, for example, when you use the last-name-first pattern (last, first). end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 5 Add an Entry to a Local Directory on SCCP Phone To add an entry to the local directory, perform the following steps. Cisco Unified Communications Manager Express System Administrator Guide 663 Directory Services Add an Entry to a Local Directory on SCCP Phone Restriction • If the directory entry being configured is to be used for called-name display, the number being configured must contain at least one wildcard character. • Entry for local directory cannot include opening or closing quotation marks (‘, ‘, “, or ”). SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. directory entry {directory-tag number name name | clear} 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 3 Creates a telephone directory entry that is displayed on an IP phone. Entries appear in the order in which they are entered. directory entry {directory-tag number name name | clear} Step 4 Example: Router(config-telephony)# directory entry 1 5550111 name Sales • directory-tag—Unique sequence number that identifies this directory entry during all configuration tasks. Range is 1 to 250. • If this name is to be used for called-name display, the number associated with the names must contain at least one wildcard character. • name—1 to 24 alphanumeric characters, including spaces. Name cannot include opening or closing quotation marks ( , , , or ). end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 5 Cisco Unified Communications Manager Express System Administrator Guide 664 Directory Services Add an Entry to a Local Directory on SCCP Phone Configure External Directory Service on SCCP Phone To enable an external directory resource on supported Cisco Unified IP phones and disable local directory services on those same phones, perform the following steps. Restriction • Provisioning of the directory URL to select an external directory resource disables the Cisco Unified CME local directory service. • Configuring external directory service only works with non-Java based phones. Any Java based phone will display duplicate directories for the following: ◦Missed ◦Received ◦Placed Before You Begin To use a Cisco Unified Communications Manager directory as an external directory source for Cisco Unified CME phones, the Cisco Unified Communications Manager must be made aware of the phones. You must list the MAC addresses of the Cisco Unified CME phones in the Cisco Unified Communications Manager and reset the phones from the Cisco Unified Communications Manager. It is not necessary for you to assign ephone-dns to the phones or for the phones to register with Cisco Unified Communications Manager. SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. url directories url 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. Cisco Unified Communications Manager Express System Administrator Guide 665 Directory Services Configure External Directory Service on SCCP Phone Command or Action Purpose configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 3 Associates a URL with the programmable Directories feature button on supported Cisco Unified IP phones in Cisco Unified CME. url directories url Example: Router(config-telephony)# url directories http://10.0.0.11/localdirectory Step 4 • Provisioning the directories URL to select an external directory resource disables the Cisco Unified CME local directory service. • Operation of these services is determined by the Cisco Unified IP phone capabilities and the content of the specified URL. end Exits configuration mode and enters privileged EXEC mode. Example: Router(config-telephony)# end Step 5 Called-Name Display To enable called-name display, perform the following steps. Restriction • The service dnis overlay command can only be used to configure overlaid ephone-dns. Before You Begin • For directory numbers other than overlaid directory numbers—To display a name in the called-name display, the name to be displayed must be defined in the local directory. See Add an Entry to a Local Directory on SCCP Phone, on page 663. • For overlaid directory numbers—To display a name in the called-name display for a directory number that is in a set of overlaid directory numbers, the name to be displayed must be defined. See Define a Name for a Directory Number on SCCP Phone, on page 662. Cisco Unified Communications Manager Express System Administrator Guide 666 Directory Services Called-Name Display SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. service dnis dir-lookup 5. service dnis overlay 6. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 telephony-service Enters telephony-service configuration mode. Example: Router(config)# Step 3 Specifiesthat incoming callsto a called numbershould display the name that was defined for this directory number with the directory entry command. service dnis dir-lookup Example: Router(config-telephony)# service dnis dir-lookup Step 4 • If the servicednisdir-lookupand servicednis overlay commands are both used in one configuration, the service dnis dir-lookup command takes precedence. (For overlaid directory numbers only.) Specifies that incoming calls to a called number should display the name that was defined for this directory number with the name command. service dnis overlay Example: Router(config-telephony)# service dnis overlay Step 5 If the service dnis dir-lookup and service dnis overlay commands are both used in one configuration, the servicednis dir-lookup command takes precedence. Note end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 6 Cisco Unified Communications Manager Express System Administrator Guide 667 Directory Services Called-Name Display Verify Called-Name Display Step 1 Use the show running-config command to verify your configuration. Called-name display is shown in the telephony-service part of the output. Example: Router# show running-config telephony-service service dnis overlay Step 2 Use the show telephony-service directory-entry command to display current directory entries. Example: Router# show telephony-service directory-entry directory entry 1 5550341 name doctor1 directory entry 2 5550772 name doctor1 directory entry 3 5550263 name doctor3 Step 3 Use the show telephony-service ephone-dn command to verify that you have used at least one wildcard (period or .) in the ephone-dn primary or secondary number or to verify that you have entered a name for the number. Example: Router# show telephony-service ephone-dn ephone-dn 2 number 5002 secondary 200. name catalogN huntstop call-forward noan 5001 timeout 8 Step 4 Use the show ephone overlay command to verify the contents of overlaid ephone-dn sets. Example: Router# show ephone overlay ephone-1 Mac:0007.0EA6.353A TCP socket:[1] activeLine:0 REGISTERED mediaActive:0 offhook:0 ringing:0 reset:0 reset_sent:0 paging 0 debug:0 IP:10.2.225.205 52486 Telecaster 7960 keepalive 2771 max_line 6 button 1: dn 11 number 60011 CH1 IDLE overlay button 2: dn 17 number 60017 CH1 IDLE overlay button 3: dn 24 number 60024 CH1 IDLE overlay button 4: dn 30 number 60030 CH1 IDLE overlay button 5: dn 36 number 60036 CH1 IDLE CH2 IDLE overlay button 6: dn 39 number 60039 CH1 IDLE CH2 IDLE overlay overlay 1: 11(60011) 12(60012) 13(60013) 14(60014) 15(60015) 16(60016) overlay 2: 17(60017) 18(60018) 19(60019) 20(60020) 21(60021) 22(60022) overlay 3: 23(60023) 24(60024) 25(60025) 26(60026) 27(60027) 28(60028) overlay 4: 29(60029) 30(60030) 31(60031) 32(60032) 33(60033) 34(60034) overlay 5: 35(60035) 36(60036) 37(60037) overlay 6: 38(60038) 39(60039) 40(60040 Cisco Unified Communications Manager Express System Administrator Guide 668 Directory Services Verify Called-Name Display Define a Name for a Directory Number on SIP Phone To define name for a directory number on a SIP phone, perform the following steps. Before You Begin • Cisco CME 3.4 or a later version. • Directory number for which you are defining a name must already have a number assigned by using the number (voice register dn) command. For configuration information, see Create Directory Numbers for SIP Phones, on page 263. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register dn dn-tag 4. name name 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register dn configuration mode to define a directory number for a SIP phone, intercom line, voice port, or a message-waiting indicator (MWI). voice register dn dn-tag Example: Router(config-register-global)# voice register dn 17 Step 3 Associates a name with a directory number in Cisco Unified CME and provides caller ID for calls originating from a SIP phone. name name Example: Router(config-register-dn)# name Smith, John Step 4 • Name must follow the orderspecified by using thedirectory (telephony-service) command. or Router(config-register-dn)# name John Smith Cisco Unified Communications Manager Express System Administrator Guide 669 Directory Services Define a Name for a Directory Number on SIP Phone Command or Action Purpose end Exits configuration mode and enters privileged EXEC mode. Example: Router(config-register-dn)# end Step 5 Configure External Directory Service on SIP Service To enable an external directory resource on supported Cisco Unified IP phones and disable local directory services on those same phones, perform the following steps. Restriction • Provisioning of the directory URL to select an external directory resource disables the Cisco Unified CME local directory service. • Supported only on Cisco Unified IP Phone 7960s and 7960Gs and Cisco Unified IP Phone 7940s and 7940Gs. Before You Begin Cisco CME 3.4 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register global 4. url directory url 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Cisco Unified Communications Manager Express System Administrator Guide 670 Directory Services Configure External Directory Service on SIP Service Command or Action Purpose Enters voice register global configuration mode to set parameters for all supported SIP phones in Cisco Unified CME. voice register global Example: Router(config)# voice register global Step 3 Associates a URL with the programmable Directories feature button on supported Cisco Unified IP phones in Cisco Unified CME. url directory url Example: Router(config-register-global)# url directory http://10.0.0.11/localdirectory Step 4 • Provisioning the directory URL to select an external directory resource disablesthe Cisco Unified CME local directory service. • Operation of these services is determined by the Cisco Unified IP phone capabilities and the content of the specified URL. end Exits to privileged EXEC mode. Example: Router(config-register-global)# end Step 5 Verify Directory Services To verify the configuration for local directory services, perform the following steps. Step 1 show running-config This command displays the running configuration. Directory configuration commands are listed in the telephony-service portion of the output. Example: Router# show running-config . . . timeout busy 10 timeout ringing 100 caller-id name-only: enable system message XYZ Company web admin system name admin1 password admin1 web admin customer name Customer edit DN through Web: enabled. edit TIME through web: enabled. Log (table parameters): max-size: 150 retain-timer: 15 create cnf-files version-stamp Jan 01 2002 00:00:00 transfer-system full-consult multicast moh 239.12.20.123 port 2000 fxo hook-flash Cisco Unified Communications Manager Express System Administrator Guide 671 Directory Services Verify Directory Services local directory service: enabled. Step 2 show telephony-service This command displays only the telephony-service configuration information. Step 3 Use the show telephony-service directory-entry command to display the entries made using the directory entry command. Configuration Examples for Directory Services Example for Configuring Local Directory The following example defines the naming order for the local directory on IP phones served by the Cisco Unified CME router: telephony-service directory last-name-first The following example creates a directory of three telephone listings: telephony-service directory entry 1 14045550111 name Sales directory entry 2 13125550122 name Marketing directory entry 3 12135550144 name Support Center The following example disables the local directory on IP phones served by the Cisco Unified CME router: telephony-service no service local-directory Example for Configuring Called-Name Display This section contains the following examples: Example for Called-Name Display for Voice Hunt Group The following is an example of a voice hunt group configuration, where the CLI command service dnis dir-lookupallowsthe directory entry namesto be displayed on the IPphones when a call is placed to a number declared using the CLI command directory entry. In this example, the pilot umber is configured as 11… This means that the user can dial the numbers 1100 to 1199. When the user dials 1111, the directory name dept1 is displayed for the directory numbers 2001, 2002, and 2003. If user dials 1155, then the directory name dept2 is displayed and if user dials 5500, then the directory name dept3 is displayed for the directory numbers 2001, 2002, and 2003. telephony-service service dnis dir-lookup directory entry 1 1111 name dept1 directory entry 2 1155 name dept2 Cisco Unified Communications Manager Express System Administrator Guide 672 Directory Services Configuration Examples for Directory Services directory entry 3 5500 name dept3 voice hunt-group 1 sequential pilot 11.. list 2001, 2002, 2003 final 8888 timeout 10 Example for Configuring First Ephone-dn in the Overlay Set The following example shows a configuration for three phones that use the same set of overlaid ephone-dns for each phone’s button 1. telephony-service service dnis overlay ephone-dn 1 number 18005550100 ephone-dn 2 name department1 number 18005550101 ephone-dn 3 name department2 number 18005550102 ephone 1 button 1o1,2,3 ephone 2 button 1o1,2,3 ephone 3 button 1o1,2,3 The default display for all three phones is the number of the first ephone-dn listed in the overlay set (18005550100). A call is made to the first ephone-dn (18005550100), and the caller ID (for example, 4085550123) is displayed on all three phones. The user for phone 1 answersthe call. The caller ID (4085550123) remains displayed on phone 1, and the displays on phone 2 and phone 3 return to the default display (18005550100). A call to the next ephone-dn is made. The default display on phone 2 and phone 3 is replaced with the called ephone-dn’s name (18005550101). Example for Configuring Directory Name for an Overlaid Ephone-dn Set The following is an example of a configuration of overlaid ephone-dns that uses wildcards in the secondary numbers for the ephone-dns. The wildcards allow you to control the display according to the number that was dialed. The example is for a medical answering service with three IP phones that accept calls for nine doctors on one button. When a call to 5550001 rings on button 1 on ephone 1 through ephone 3, “doctor1” is displayed on all three ephones. telephony-service service dnis dir-lookup directory entry 1 5550001 name doctor1 directory entry 2 5550002 name doctor2 directory entry 3 5550003 name doctor3 directory entry 4 5550010 name doctor4 directory entry 5 5550011 name doctor5 directory entry 6 5550012 name doctor6 directory entry 7 5550020 name doctor7 Cisco Unified Communications Manager Express System Administrator Guide 673 Directory Services Example for Configuring Called-Name Display directory entry 8 5550021 name doctor8 directory entry 9 5550022 name doctor9 ephone-dn 1 number 5500 secondary 555000. ephone-dn 2 number 5501 secondary 555001. ephone-dn 3 number 5502 secondary 555002. ephone 1 button 1o1,2,3 mac-address 1111.1111.1111 ephone 2 button 1o1,2,3 mac-address 2222.2222.2222 ephone 3 button 1o1,2,3 mac-address 3333.3333.3333 For more information about making directory entries,see Local Directory, on page 659 .For more information about overlaid ephone-dns, see Call Coverage Features, on page 1239. Example for Configuring Directory Name for a Hunt Group with Overlaid Ephone-dns The following example shows a hunt-group configuration for a medical answering service with two phones and four doctors. Each phone has two buttons, and each button is assigned two doctors’ numbers. When a patient calls 5550341, Cisco Unified CME matches the hunt-group pilot secondary number (555....), rings button 1 on one of the two phones, and displays “doctor1.” telephony-service service dnis dir-lookup max-redirect 20 directory entry 1 5550341 name doctor1 directory entry 2 5550772 name doctor1 directory entry 3 5550263 name doctor3 directory entry 4 5550150 name doctor4 ephone-dn 1 number 1001 ephone-dn 2 number 1002 ephone-dn 3 number 1003 ephone-dn 4 number 104 ephone 1 button 1o1,2 button 2o3,4 mac-address 1111.1111.1111 ephone 2 button 1o1,2 button 2o3,4 mac-address 2222.2222.2222 ephone-hunt 1 peer pilot 5100 secondary 555.... list 1001, 1002, 1003, 1004 Cisco Unified Communications Manager Express System Administrator Guide 674 Directory Services Example for Configuring Called-Name Display final number 5556000 hops 5 preference 1 timeout 20 no-reg For more information about hunt-group behavior,see Call CoverageFeatures, on page 1239. Note that wildcards are used only in secondary numbers and cannot be used with primary numbers. For more information about making directory entries, see Call Coverage Features, on page 1239. For more information about overlaid ephone-dns, see Call Coverage Features, on page 1239. Example for Configuring Directory Name for Non-Overlaid Ephone-dns The following is a configuration for three IP phones, each with two buttons. Button 1 receives calls from doctor1, doctor2, and doctor3, and button 2 receives calls from doctor4, doctor5, and doctor6. telephony-service service dnis dir-lookup directory entry 1 5550001 name doctor1 directory entry 2 5550002 name doctor2 directory entry 3 5550003 name doctor3 directory entry 4 5550010 name doctor4 directory entry 5 5550011 name doctor5 directory entry 6 5550012 name doctor6 ephone-dn 1 number 1001 secondary 555000. ephone-dn 2 number 1002 secondary 555001. ephone 1 button 1:1 button 2:2 mac-address 1111.1111.1111 ephone 2 button 1:1 button 2:2 mac-address 2222.2222.2222 ephone 3 button 1:1 button 2:2 mac-address 3333.3333.3333 For more information about making directory entries, see Local Directory, on page 659. Example for Configuring Ephone-dn Name for Overlaid Ephone-dns The following example shows three phones that have button 1 assigned to pick up three 800 numbers for three different catalogs. The default display for all four phones is the number of the first ephone-dn listed in the overlay set (18005550000). A call is made to the first ephone-dn (18005550000), and the caller ID (for example, 4085550123) is displayed on all phones. The user for phone 1 answers the call. The caller ID (4085550123) remains displayed on phone 1, and the displays on phone 2 and phone 3 return to the default display (18005550000). A call to the second ephone-dn (18005550001) is made. The default display on phone 2 and phone 3 is replaced with the called ephone-dn's name (catalog1) and number (18005550001). telephony-service service dnis overlay Cisco Unified Communications Manager Express System Administrator Guide 675 Directory Services Example for Configuring Called-Name Display ephone-dn 1 number 18005550000 ephone-dn 2 name catalog1 number 18005550001 ephone-dn 3 name catalog2 number 18005550002 ephone-dn 4 name catalog3 number 18005550003 ephone 1 button 1o1,2,3,4 ephone 2 button 1o1,2,3,4 ephone 3 button 1o1,2,3,4 For more information about overlaid ephone-dns, see Call Coverage Features, on page 1239. Feature Information for Directory Services The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Table 41: Feature Information for Directory Services Unified CME Feature Information Version Feature Name The CLI command for accessing local directory service was enhanced to configure username and password, as service local-directory authenticate username password . Service Local Directory 12.0 Number of entries supported in a search results list was increased from 32 to 240 when using directory search. Directory Search 7.0/4.3 Cisco Unified Communications Manager Express System Administrator Guide 676 Directory Services Feature Information for Directory Services Unified CME Feature Information Version Feature Name Support for Called-Name Display on phones configured under voice hunt group. Called-Name Display 12.0 Called-Name Display was introduced. 3.2 Added support for transferring a call directly to a selected number listed in the directory. If directory transfer is not supported, the user must press Transfer and then use the keypad to manually enter the number of the monitored line to transfer the incoming call. Local Directory Service 4.0(2) External Directory Service Added support of directory services for SIP phones directly connected in Cisco Unified CME. 3.4 The ability to add local directory entries in addition to those that are automatically added from phone configurations was introduced. Authentication for local directory display was introduced. 3.0 The ability to block the display of the local directory on phones was introduced. 2.1 The specification of name format in the local directory was introduced. 2.0 Cisco Unified Communications Manager Express System Administrator Guide 677 Directory Services Feature Information for Directory Services Cisco Unified Communications Manager Express System Administrator Guide 678 Directory Services Feature Information for Directory Services CHAPTER 19 Do Not Disturb • Information About Do Not Disturb, page 679 • Configure Do Not Disturb, page 681 • Where to Go Next, page 685 • Feature Information for Do Not Disturb, page 686 Information About Do Not Disturb Do Not Disturb on SCCP Phone The Do Not Disturb (DND) feature allows phone users to disable audible ringing for incoming calls. When DND is enabled, incoming calls do not ring on the phone, however there is visual alerting and the call information displays, and a call can be answered if desired. When a local IPphone calls another local IPphone that is in the DND state, the message “Ring out DND” displays on the calling phone indicating that the target phone is in the DND state. Phone users can toggle DND on and off by using the DND softkey in the idle or ringing call states. A SSCP phone user can toggle DND on or off in the ringing state only if DND in not already active on the phone. If DND is already active when a new call comes in, the SCCP phone user cannot change the DND state by pressing the DND softkey. If an SSCP phone user toggles DND on during an incoming call, the DND state remains active for the current call only. If a SIP phone user toggles DND on during an incoming call, the DND state remains active during the current call and for all future calls until the user explicitly toggles DND off. Pressing the DND softkey during an incoming call forwards the call to the call-forward no answer destination if Call Forward No Answer is enabled. If Call Forward is not enabled, pressing the DND softkey disables audible ringing and visual alerting, but the call information is visible on the phone display. In Cisco CME 3.2.1 and later versions, DND can be blocked from phones with the feature-ring function. A feature ring is a triple-pulse ring, a type of ring cadence in addition to internal call and external call ring cadences. For example, an internal call in the United States rings for 2 seconds on and 4 seconds off (single-pulse ring), and an external call rings for 0.4 seconds on, 0.2 seconds off, 0.4 seconds on, and 0.2 seconds off (double-pulse ring). Cisco Unified Communications Manager Express System Administrator Guide 679 The triple-pulse ring is used as an audio identifier for phone users. For example, each salesperson in a sales department could have an IP phone with a button sharing the same set of ephone-dns with the sales staff and another button for their private line for preferred customers. To help a salesperson identify an incoming call to his or her private line, the private line can be configured with the feature-ring function. You can disable the DND function on feature-ring lines. In the preceding example, salespeople could activate DND on their phones and still hear calls to their private lines. Do Not Disturb on SIP Phone In Cisco Unified CME 7.1 and later versions, the Do Not Disturb (DND) feature for SIP phones prevents incoming calls from audibly ringing a phone. When DND is enabled, the phone flashes an alert to visually indicate an incoming call instead of ringing and the call can be answered if desired. The message “Do Not Disturb is active” displays on the phone and calls are logged to the Missed Calls directory. In versions earlier than Cisco Unified CME 7.1, the DND feature blocks incoming calls to a SIP phone with a busy tone. Cisco Unified CME rejects calls to all lines on the phone and plays a busy tone to the caller. Received calls are not logged to the Missed Calls directory on the phone. DND appliesto all lines on the phone. If DND and CallForward All are both enabled on a phone, CallForward All takes precedence on incoming calls. You must enable DND for a SIP phone through Cisco Unified CME. The DND softkey displays by default on supported SIP phones in both the Ringing and idle states. You can remove or change the order of this softkey using a voice register template. A phone user can toggle DND on and off at the phone by using the DND softkey. If aSIPphone user activates DND during an incoming call, the DND state remains active during the current call and for all future calls until the user explicitly toggles DND off. If a phone user toggles DND on or off at the phone, Cisco Unified CME restores the DND state after the phone resets or restarts, if you save the running configuration before Cisco Unified CME reboots. For configuration information, see Configure Do Not Disturb on SIP Phones, on page 683. Table 42: DND Feature Comparison for SIP Phones, on page 680 compares the DND configuration for SIP phones with different phone load versions: Table 42: DND Feature Comparison for SIP Phones Cisco Unified IP Phone 7911, 7941, 7961, 7970, or 7971 with 8.2 Phone Load or Cisco Unified IP Phone 7940 or 7960 Cisco Unified IP Phone 7911, 7941, 7961, 7970, or 7971 with 8.3 Phone Load dnd command in voice register pool mode dnd command in voice register pool mode DND support dnd-control command in voice register template mode softkey idle and softkey ringIn command in voice register template mode DND softkey display Call is rejected and busy tone is played to the caller. Ringer is turned off for incoming calls. Visual alerting is provided. Behavior when configured Cisco Unified Communications Manager Express System Administrator Guide 680 Do Not Disturb Do Not Disturb on SIP Phone Configure Do Not Disturb Blocking Do Not Disturb on SCCP Phone To block DND on phones that have buttons configured for feature ringing, perform the following steps. DND is enabled by using the DND softkey on Cisco Unified IP phones that support softkeys. Restriction • Phone users cannot enable DND for a shared line in a hunt group. The softkey displays in the idle and ringing states but does not enable DND for shared lines in hunt groups. Before You Begin • Cisco Unified 3.2.1 or a later version. • Phone line must be configured for feature ring with the button f command. • Call-forwarding no-answer must be set for a phone to use DND to forward calls. For configuration information, see Configure Call Transfer and Forwarding, on page 1178. No other configuration is necessary for basic DND. SUMMARY STEPS 1. enable 2. configure terminal 3. ephone phone-tag 4. no dnd feature-ring 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 ephone phone-tag Enters ephone configuration mode. Cisco Unified Communications Manager Express System Administrator Guide 681 Do Not Disturb Configure Do Not Disturb Command or Action Purpose Example: Router(config)# ephone 10 • phone-tag—Unique sequence number that identifiesthe ephone to be configured. Enables ringing on phone buttons configured for feature ring when the phone is in DND mode. no dnd feature-ring Example: Router(config-ephone)# no dnd feature-ring Step 4 end Returns to privileged EXEC mode. Example: Router(config-ephone)# end Step 5 In the following configuration example, when DND is activated on ephone 1 and ephone 2, button 1 will ring, but button 2 will not. ephone-dn 1 number 1001 ephone-dn 2 number 1002 ephone-dn 10 number 1110 preference 0 no huntstop ephone-dn 11 number 1111 preference 1 ephone 1 button 1f1 button 2o10,11 no dnd feature-ring ephone 2 button 1f2 button 2o10,11 no dnd feature-ring Verify Do Not Disturb on SCCP Phones show ephone dnd Use this command to display a list of SCCP phones that have DND enabled. Router# show ephone dnd ephone-1 Mac:0007.0EA6.353A TCP socket:[1] activeLine:0 REGISTERED mediaActive:0 offhook:0 ringing:0 reset:0 reset_sent:0 paging 0 debug:0 IP:1.2.205.205 52486 Telecaster 7960 keepalive 2729 max_line 6 DnD button 1: dn 11 number 60011 CH1 IDLE Cisco Unified Communications Manager Express System Administrator Guide 682 Do Not Disturb Verify Do Not Disturb on SCCP Phones Configure Do Not Disturb on SIP Phones To enable the Do Not Disturb (DND) feature on a SIP phone, perform the following steps. Restriction • In versions earlier than Cisco Unified CME 7.1, you enable the DND softkey onSIPphones by using the dnd-control command. • If you enable DND on the phone and remove the DND softkey, the user cannot toggle DND off at the phone. Cisco Unified IP Phone 7911G, 7941G, 7941GE, 7961G, 7961GE, 7970G, and 7971GE • For SIP phones using firmware 8.3 or a later version, the DND feature prevents calls from ringing; it does not block calls or play a busy tone to the caller. • If DND is disabled by a phone user, it is not enabled after the phone resets or restarts. DND must be enabled both in Cisco Unified CMEand by using the DND softkey on the phone. Before You Begin • Cisco CME 3.4 or a later version. • Cisco Unified CME 7.1 or a later version to use the DND softkey. • Call-forwarding busy must be set for a SIP IP phone to use DND to forward calls. For configuration information, see Configure Call Transfer and Forwarding, on page 1178. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register template template-tag 4. softkeys idle {[Cfwdall] [DND] [Gpickup] [Newcall] [Pickup] [Redial]} 5. softkeys ringIn [Answer] [DND] 6. exit 7. voice register pool phone-tag 8. dnd 9. template template-tag 10. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Cisco Unified Communications Manager Express System Administrator Guide 683 Do Not Disturb Configure Do Not Disturb on SIP Phones Command or Action Purpose Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters ephone-template configuration mode to create an ephone template. voice register template template-tag Example: Router(config)# voice register template 5 Step 3 • template-tag—Unique identifier for the ephone template that is being created. Range: 1 to 10. Modifies the order and type of softkeys that display on a SIP phone during the idle call state. softkeys idle {[Cfwdall] [DND] [Gpickup] [Newcall] [Pickup] [Redial]} Example: Router(config-register-temp)# softkeys idle Step 4 Modifies the order and type of softkeys that display on a SIP phone during the ringing call state. softkeys ringIn [Answer] [DND] Example: Router(config-register-temp)# softkeys ringin dnd answer Step 5 exit Exits ephone-template configuration mode. Example: Router(config-register-temp)# exit Step 6 Enters voice register pool configuration mode to set parameters for the SIP phone. voice register pool phone-tag Example: Router(config)# voice register pool 1 Step 7 Step 8 dnd Enables DND on the phone. Example: Router(config-register-pool)# dnd • If Call Forward No Answer is not configured for the extension, pressing the DND softkey mutes the ringer for incoming calls. Step 9 template template-tag Applies the ephone template to the phone. Example: Router(config-register-pool)# template 5 • template-tag—Unique identifier of the template that you created in Step 3, on page 684. Cisco Unified Communications Manager Express System Administrator Guide 684 Do Not Disturb Configure Do Not Disturb on SIP Phones Command or Action Purpose end Returns to privileged EXEC mode. Example: Router(config-register-pool)# end Step 10 The following example shows DND is enabled on phone 130, and the DND softkey is modified in template 6, which is assigned to the phone: voice register template 6 softkeys idle Gpickup Pickup DND Redial softkeys ringIn DND Answer ! voice register pool 130 id mac 001A.A11B.500E type 7941 number 1 dn 30 template 6 dnd Where to Go Next Agent Status Control for Ephone Hunt Groups and Cisco Unified CME B-ACD Ephone hunt group agents can control their ready/not-ready status (their ability to receive calls) using the DND function or the HLog function of their phones. When they use the DND softkey, they do not receive calls on any extension on their phones. When they use the HLog softkey, they do not receive calls on hunt group extensions, but they do receive calls on other extensions. For more information on agent status control and the HLog function, see Call Coverage Features, on page 1239. Call Forwarding To use the DND softkey to forward calls, enable call-forwarding no-answer for SCCP phones or call-forward busy for SIP IP phones. See Configure Call Transfer and Forwarding, on page 1178. Feature Access Codes (FACs) DND can be activated and deactivated using a feature access code (FAC) instead of the DND softkey when standard or custom FACs are enabled. The following is the standard FAC for DND: • DND **7 See Feature Access Codes, on page 757. Softkey Display You can remove or change the position of the DND softkey. See Customize Softkeys, on page 925. Cisco Unified Communications Manager Express System Administrator Guide 685 Do Not Disturb Where to Go Next Feature Information for Do Not Disturb The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Table 43: Feature Information for Do Not Disturb Feature Name Cisco Unified CME Version Feature Information Enhanced DND support on SIP phones to allow incoming calls to visually flash an alert. Do Not Disturb 7.1 Added support for Do-not-disturb (DND) softkey on SIP phones. 3.4 DND bypass for feature-ring phones was introduced. 3.2.1 3.2 DND was introduced. Cisco Unified Communications Manager Express System Administrator Guide 686 Do Not Disturb Feature Information for Do Not Disturb CHAPTER 20 Enhanced 911 Services • Prerequisites for Enhanced 911 Services, page 687 • Restrictions for Enhanced 911 Services, page 688 • Information About Enhanced 911 Services, page 688 • Configure Enhanced 911 Services, page 698 • Configuration Examples for Enhanced 911 Services, page 716 • Feature Information for Enhanced 911 Services, page 723 Prerequisites for Enhanced 911 Services • SCCP or SIP phones must be registered to Cisco Unified CME. • At least one CAMA or ISDN trunk must be configured from Cisco Unified CME to each of the 911 service provider’s public safety answering point (PSAP). • An Enhanced 911 network must be designed for each customer’s voice network. • Cisco Unified CME has an FXS, FXO, SIP, or H.323 trunk interface configured. Cisco Unified CME • Cisco Unified CME 4.2 or a later version. Cisco Unified CME in SRST Fallback Mode • Cisco Unified CME 4.1 or a later version, configured in SRST fallback mode. See SRST Fallback Mode, on page 1539. For information about configuring ephones, ephone-dns, voice register pools, and voice register dns, see Configure Phones to Make Basic Call, on page 315. Note Cisco Unified Communications Manager Express System Administrator Guide 687 Restrictions for Enhanced 911 Services • Enhanced 911Servicesfor Cisco Unified CME does not interface with the Cisco Emergency Responder. • The information about the most recent phone that called 911 is not preserved after a reboot of Cisco Unified CME. • Cisco Emergency Responder does not have access to any updates made to the emergency call history table when remote Cisco Unified IP phones are in SRST fallback mode. Therefore, if the PSAP calls back after the IP phones register back to Cisco Unified Communications Manager, Cisco Emergency Responder has no history of those calls. As a result, those calls are not routed to the original 911 caller. Instead, the calls are routed to the default destination that is configured on Cisco Emergency Responder for the corresponding ELIN. • For Cisco Unified Wireless 7920 and 7921 IP phones, a caller’s location can only be determined by the static information configured by the system administrator. For more information, see Precautions for Mobile Phones, on page 693. • The extension numbers of 911 callers can be translated to only two emergency location identification numbers (ELINs) for each emergency response location (ERL). For more information, see Overview of Enhanced 911 Services, on page 688. • Using ELINsfor multiple purposes can result in unexpected interactions with existing Cisco Unified CME features. These multiple uses of an ELIN can include configuring an ELIN for use as an actual phone number (ephone-dn, voice register dn, or FXS destination-pattern), a Call Pickup number, or an alias rerouting number. For more information, see Multiple Usages of an ELIN, on page 696. • Your configuration of Enhanced 911 Services can interact with existing Cisco Unified CME features and cause unexpected behavior. For a complete description of interactions between Enhanced 911 Services and existing Cisco Unified CME features, see Interactions with Existing Cisco Unified CME Features, on page 695. Information About Enhanced 911 Services Overview of Enhanced 911 Services Enhanced 911 Services enable 911 operators to: • Immediately pinpoint the location of the 911 caller based on the calling number • Callback the 911 caller if a disconnect occurs Before this feature was introduced, Cisco Unified CME supported only outbound calls to 911. With basic 911 functionality, calls were simply routed to a public safety answering point (PSAP). The 911 operator at the PSAP then had to verbally gather the emergency information and location from the caller, before dispatching a response team from the ambulance service, fire department, or police department. Calls could not be routed to different PSAPs, based on the specific geographic areas that they cover. With Enhanced 911Services, 911 calls are selectively routed to the closestPSAPbased on the caller’slocation. In addition, the caller’s phone number and address automatically display on a terminal at thePSAP. Therefore, Cisco Unified Communications Manager Express System Administrator Guide 688 Enhanced 911 Services Restrictions for Enhanced 911 Services thePSAPcan quickly dispatch emergency help, even if the caller is unable to communicate the location. Also, if the caller disconnects prematurely, the PSAP has the information it needs to contact the 911 caller. To use Enhanced 911 Services, you must define an emergency response location (ERL) for each of the geographic areas needed to cover all of the phones supported by Cisco Unified CME. The geographic specifications for ERLs are determined by local law. For example, you might have to define an ERL for each floor of a building because an ERL must be less than 7000 square feet in area. Because the ERL defines a known,specific location, thisinformation is uploaded to thePSAP’s database and is used by the 911 dispatcher to help the emergency response team to quickly locate a caller. To determine which ERL is assigned to a 911 caller, the PSAP uses the caller’s unique phone number, which is also known as the emergency location identification number (ELIN). Before you can use Enhanced 911 Services you must supply the PSAP with a list of your ELINs and street addresses for each ERL. This information is saved in the PSAP’s automatic location identification (ALI) database. Typically, you give this information to the PSAP when your phone system is installed. With the address information in the ALI database, the PSAP can find the caller’s location and can also use the ELIN to callback the 911 caller within a specified time limit. This limit applies to the Last Caller table, which provides the PSAP with the 911 caller’s ELIN. If no time limit is specified for the Last Caller table, the default expiry time is three hours. In addition to saving call formation in the temporary Last Caller table, you can configure permanent call detail records. You can view the attributesin these recordsfrom RADIUSaccounting, the syslog service, or Cisco IOS show commands. You have the option of configuring zero, one, or two ELINs for each ERL. If you configure two ELINs, the system uses a round-robin algorithm to select which ELIN is sent to the PSAP. If you do not define an ELIN for an ERL, the PSAP sees the original calling number. You may not want to define an ELIN if Cisco Unified CME is using direct-inward-dial numbers or the call is from another Cisco voice gateway that has already translated the extension to an ELIN. Optionally define a default ELIN that the PSAP can use if a 911 caller's IP phone's address does not match the IP subnet of any location in any zone. This default ELIN can be an existing ELIN that is already defined for one of the ERLs or it can be a unique ELIN. If no default ELIN is defined and the 911 caller’s IP Address does not match any of the ERLs’ IPsubnets, a syslog message isissued stating that no default ELIN is defined, and the original ANI remains intact. You can also define a designated callback number that is used when the callback information is lost in the Last Caller table because of an expiry timeout or system restart. You can use this designated callback number if the PSAP cannot reach the 911 caller at the caller’s ELIN or the default ELIN for any other reason. You can further customize your system by specifying the expiry time for data in the Last Caller table and by enabling syslog messages that announce all emergency calls. For large installations, you can optionally specify that calls from specific ERLs are routed to specific PSAPs. This is done by configuring emergency response zones, which lists the ERLs within each zone. This list of ERLs also includes a ranking of the locations which controlsthe order of ERL searches when there are multiple PSAPs. You do not need to configure emergency response zones if all 911 calls on your system are routed to a single PSAP. One or more ERLs can be grouped into a zone which could be equivalent to the area serviced by a PSAP. When an outbound emergency call is placed, configured emergency response zones allow the searching of a subset of the ERLs in any order. The ERLs can be ranked in the order of desired usage. Zones are also used to selectively route 911 calls to different PSAPs.You can configure selective routing by creating a zone with a list of unique locations and assigning each zone to a different outbound dial peer. In this case, zones route the call based on the caller’s ERL. When an emergency call is made, each dial peer matching the called number uses the zone’s list of locations to find a matching IPsubnet to the calling phone’s Cisco Unified Communications Manager Express System Administrator Guide 689 Enhanced 911 Services Overview of Enhanced 911 Services IP address. If an ERL and ELIN are found, the dial peer’s interface is used to route the call. If no ERL or ELIN is found, the next matched dial peer checks its zone. Note • If a caller’s IP address does not match any location in its dial-peers zone, the last dial peer that matched is used for routing and the default ELIN is used. • If you want 911 calls from any particular phone to always use the same dial peer when you have multiple dial peers going to the same destination-pattern (911) and the zones are different, you must configure the preferred dial peer to be the highest priority by setting the preference field. Duplicate location tags are not allowed in the same zone. However, the same location tag can be defined in multiple zones. You are allowed to enter duplicate location priorities in the same zone, however, the existing location’s priority is then increased to the next number. For example, if you configure “location 36 priority 5” followed by “location 19 priority 5,” location 19 has priority 5 and location 36 becomes priority 6. Also, if two locations are assigned priority 100, rather than bump the first location to priority 101, the first location becomes the first nonprioritized location. Figure 24: Implementation of Enhanced 911 for Cisco Unified CME, on page 690 shows an example configuration for 911 services. In this example, the phone system handles callsfrom multiple floorsin multiple buildings. Five ERLs are defined, with one ELIN defined for each ERL. At the PSAP, the ELIN is used to find the caller’s physical address from the ALI database. Building 2 is closer to the PSAP in San Francisco and Building 40 is closer to the PSAP in San Jose. Therefore, in this case, we recommend that you configure two emergency response zones to ensure that 911 calls are routed to the PSAP closest to the caller. In this example, you can configure an emergency response zone that includes all of the ERLS in building 2 and another zone that includes the ERLs in building 40. If you choose to not configure emergency response zones, 911 calls are routed based on matching the destination number configured for the outgoing dial peers. Figure 24: Implementation of Enhanced 911 for Cisco Unified CME Cisco Unified Communications Manager Express System Administrator Guide 690 Enhanced 911 Services Overview of Enhanced 911 Services Call Processing for E911 Services When a 911 call is received by Cisco Unified CME, the initial call processing is the same as for any other call. Cisco Unified CME takes the called-number and searches for dial peers that can be used to route the call to that called-number. The Enhanced 911 feature also analyzes the outgoing dial peer to see if it is going to a PSAP. If the outgoing dial peer is configured with the emergency response zone command, the system is notified that the call needs Enhanced 911 handling. If the outgoing dial peer is not configured with the emergency response zone command, the Enhanced 911 functionality is not activated and the caller’s number is not translated to an ELIN. When the Enhanced 911 functionality is activated, the first step in Enhanced 911 handling is to determine which ERL is assigned to the caller. There are two ways to determine the caller’s ERL. • Explicit Assignment—If a 911 call arrives on an inbound dial peer that has an ERL assignment, this ERL is automatically used as the caller’s location. • Implicit Assignment—If a 911 call arrives from an IP phone, its IP address is determined and Enhanced 911 searches for the IP address of the caller’s phone in one of the IP subnets configured in the ERLs. The ERLs are stored as an ordered list according to their tag numbers, and each subnet is compared to the caller’s IP address in the order listed. After the caller’s ERL is determined, the caller’s number is translated to that ERL’s ELIN. If no ERLs are implicitly or explicitly assigned to a call, you can define a default ERL for IP phones. This default ERL does not apply to nonIP-phone endpoints, such as phones on VoIP trunks or FXS/FXO trunks. After an ELIN is determined for the call, the following information is saved to the Last Caller table: • Caller’s ELIN • Caller’s original extension • Time the call originated The Last Caller table containsthisinformation for the most recent emergency callersfrom each ERL. A caller’s information is purged from the table when the specified expiry time has passed after the call was originated. If no time limit is specified, the default expiry time is three hours. After the 911 call information is saved to the Last Caller table, the system determines whether an emergency response zone is configured that contains the caller’s ERL. If no emergency response zone is configured with the ERL, all ERLs are searched sequentially to match the caller’s IP address and then route the 911 call to the appropriate PSAP. If an ERL is included in a zone, the 911 call is routed to the PSAP associated with that zone. After the 911 call is routed to appropriate PSAP, Enhanced 911 processing is complete. Call processing then proceeds as it does for basic calls, except that the ELIN replaces the original calling number for the outbound setup request. Cisco Unified Communications Manager Express System Administrator Guide 691 Enhanced 911 Services Call Processing for E911 Services Figure 25: Processing a 911 Call, on page 692 summarizes the procedure for processing a 911 call. Figure 25: Processing a 911 Call The 911 operator is unable to find information about a call in the Last Caller table if the router was rebooted or specified expiry time (three hours by default) has passed after the call was originated. If this is the case, the 911 operator hears the reorder tone. To prevent the 911 operator from getting this tone, you can configure Cisco Unified Communications Manager Express System Administrator Guide 692 Enhanced 911 Services Call Processing for E911 Services the default callback as described in Customize E911 Settings, on page 710. Alternately, you can configure a call forward number on the dial peer that goes to an operator or primary contact at the business. Because the 911 callback feature tracks the last caller by its extension number, if you change the configuration of your ephone-dns in-between a 911 call and a 911 callback and within the expiry time, the PSAP might not be able to successfully contact the last 911 caller. If two 911 calls are made from different phones in the same ERL within a short period of time, the first caller’s information is overwritten in the Last Caller table with the information for the second caller. Because the table can contain information about only one caller from each ERL, the 911 operator does not have the information needed to contact the first caller. In most cases, if Cisco Emergency Responder is configured, you should configure Enhanced 911 Services with the same data for the ELIN and ERL as used by Cisco Emergency Responder. Precautions for Mobile Phones Emergency calls placed from phones that have been removed from their primary site might not be answered by local safety authorities. IP phones should not be used to place emergency calls if removed from the site where it wasinitially configured. Therefore, we recommend that you require your mobile phone usersto agree to a policy similar to the one stated below. Telecommuters, remote office, and traveling personnel must place emergency calls on a locally configured hotel, office, or home phone (in other words, their landline). If they must use a remote IPphone for emergency calls while away from their configured site, they must be prepared to provide specific information regarding their location (their country, city, state, street address, and so on) to the answering safety authority or security operations center personnel. By accepting this policy your mobile phone users are confirming that they: • Understand this advisory • Agree to take reasonable precautions to prevent use of any remote IP phone device for emergency calls when it is removed from its configured site By not responding to or declining to accept this policy, your mobile phone users are confirming that they understand that all remote IPphone devices associated with them will be disconnected, and no future requests for these services will be fulfilled. Plan Your Implementation of Enhanced 911 Services Before you configure Enhanced 911 Services for Cisco Unified CME: Step 1 Make a list of your sites that are serviced by Cisco Unified CME, and the PSAPs serving each site. Be aware that you must use a CAMA/PRI interface to connect to each PSAP. Table 44: List of Sites and PSAPs, on page 694 shows an example of the information that you need to gather. Cisco Unified Communications Manager Express System Administrator Guide 693 Enhanced 911 Services Precautions for Mobile Phones Table 44: List of Sites and PSAPs Building Name and Address Responsible PSAP Interface to which Calls Are Routed Building 2, 201 Maple Street, San San Francisco, CA Port 1/0:D Francisco Building 40, 801 MainStreet,San Jose San Jose, CA Port 1/1:D Step 2 Use local laws to determine the number of ERLs you need to configure. According to the National Emergency Number Association (NENA) model legislation, make the location specific enough to provide a reasonable opportunity for the emergency response team to quickly locate a caller anywhere within it. Table 45: ERL Calculation, on page 694 shows an example. Table 45: ERL Calculation Building Size in Square Feet Number of Floors Number of ERLs Required Building 2 200,000 3 3 Building 40 7000 2 1 Step 3 (Optional) Assign one or two ELINs to each ERL. You must contact your phone service provider to request phone numbers that are designated as ELINs. Step 4 (Optional) Assign each of your ERLs to an emergency response zone to enable 911 calls to be routed to the PSAP that is closest to the caller. Use the voice emergency response zone command. Step 5 Configure one or more dial peers for your 911 callers with the emergency response zone command. You might need to configure multiple dial peers for different destination-patterns. Step 6 Configure one or more dial peers for the PSAP’s 911 callbacks with the emergency response callback command. Step 7 Decide what method to use to assign ERLs to phones. You have the following choices: • For a group of phonesthat are on the same subnet, you can create an IPsubnet in the ERL that includes each phone’s IP address. Each ERL can have one or two unique IP subnets. This is the easiest option to configure. Table 46: Definitions of ERL, Description, IP Subnets, and ELIN, on page 694 shows an example. Table 46: Definitions of ERL, Description, IP Subnets, and ELIN ERL Number Description IP Address Assignment ELIN 1 Building 2, 1st floor 10.5.124.xxx 408 555-0142 2 Building 2, 2nd floor 10.7.xxx.xxx 408 555-0143 Cisco Unified Communications Manager Express System Administrator Guide 694 Enhanced 911 Services Plan Your Implementation of Enhanced 911 Services ERL Number Description IP Address Assignment ELIN 408 555-0144 and 408 555-0145 10.8.xxx.xxx and 10.9.xxx.xxx 3 & 4 Building 2, 3rd floor • You can assign an ERL explicitly to a group of phones by using the ephone-template or voice register template configurations. Instead of assigning an ERL to phones individually, you can use these templates to save time if you want to apply the same set of features to several SCCP phones or SIP phones. • You can assign an ERL to a phone individually. Depending on which type of phone you have, you can use one of three methods. You can assign an ERL to a phone’s: ◦Dial-peer configuration ◦Ephone configuration (SCCP phones) ◦Voice register pool configuration (SIP phones) Table 47: Explicit ERL Assignment Per Phone, on page 695 shows examples of each of these options. Table 47: Explicit ERL Assignment Per Phone Phone Configuration ERL Dial-peer voice 213 pots 3 Dial-peer voice 214 voip 4 Ephone 100 3 Voice register pool 1 2 Step 8 (Optional) Define a default ELIN to be sent to the PSAP for use if a 911 caller's IP phone's address does not match the IP subnet of any location in any zone. Step 9 (Optional) Define a designated callback number that is used if the callback information is removed from the Last Caller table because of an expiry timeout or system restart. Step 10 (Optional) Change the expiry time for data in the Last Caller table from the default time of three hours. Step 11 (Optional) Enable RADIUS accounting or the syslog service to permanently record call detail records. Interactions with Existing Cisco Unified CME Features Enhanced 911 Services interacts with several Cisco Unified CME features. The interactions with each of the following features are described in separate sections below: Cisco Unified Communications Manager Express System Administrator Guide 695 Enhanced 911 Services Interactions with Existing Cisco Unified CME Features Note Your version of Cisco Unified CME may not support all of these features. Multiple Usages of an ELIN We recommend that you do not use ELINsfor any other purpose because of possible unexpected interactions with existing Cisco Unified CME features. Note Examples of using ELINs for other purposes include configuring an ELIN for use as an actual phone number (ephone-dn, voice register dn, FXS destination-pattern), a Call Pickup number, or an alias rerouting number. Using ELINs as an actual phone number causes problems when calls are made to that number. If a 911 call occurs and the last caller information has not expired from the Last Caller table, any outside callers will reach the last 911 caller instead of the actual phone. We recommend that you do not share the phone numbers used for ELINs with real phones. There is no impact on outbound 911 calls if you use the same number for an ELIN and a real phone number. Number Translation The Enhanced 911 feature translatesthe calling number to an ELIN during an outbound 911 call, and translates the called-number to the last caller’s extension during a 911 callback (when the PSAP makes a callback to the 911 caller). Alternative methods of number translation can conflict with the translation done by the Enhanced 911 software, such as: • Dialplan-pattern—Prefixes a pattern to an extension configured under telephony-service • Num-expansion—Expands extensions to full E.164 numbers • Voice-port translation of called and calling numbers • Outgoing number translation for dial peers • Translate-profile for dial peers • Voice translation profiles done for the dial peer, voice-port, POTS voice service, trunk group, trunk group member, voice source-group, call-manager-fallback, and ephone-dn • Ephone-dn translation • Voice register dn’s outgoing translation Configuring these translation features impacts the Enhanced 911 feature if they translate patterns that are part of your ELINs’ patterns. For an outgoing 911 call, these features might translate an Enhanced 911 ELIN to a different number, giving the PSAP a number they cannot look-up in their ALI databases. If the 911 callback number (ELIN) is translated before Enhanced 911 callback processing, the Enhanced 911 feature is unable to find the last caller’s history. Cisco Unified Communications Manager Express System Administrator Guide 696 Enhanced 911 Services Interactions with Existing Cisco Unified CME Features Call Transfer If a phone in a Cisco Unified CME environment performs a semi attended or consultative transfer to thePSAP that involves another phone that is in a different ERL, the PSAP will use the wrong ELIN. The PSAP will see the ELIN of the transferor party, not the transferred party. There is no impact on 911 callbacks (calls made by the PSAP back to a 911 caller) or transfers that are made by the PSAP. A 911 caller can transfer thePSAPto another party if there is a valid reason to do so. Otherwise, we recommend that the 911 caller remain connected to the PSAP at all times. Call Forward There is no impact if an IP phone user calls another phone that is configured to forward calls to the PSAP. If the PSAP makes a callback to a 911 caller that is using a phone that has Call Forward enabled, the PSAP is redirected to a party that is not the original 911 caller. Call Blocking Features Outbound 911 calls can be blocked by features such as After-Hours Call Blocking if the system administrator does not create an exception to 911 calls. 911 callbacks will not reach the 911 caller if the phone is configured with a blocking feature (for example, Do Not Disturb). Call Waiting After a 911 call is established with a PSAP, call waiting can interrupt the call. The 911 caller has the choice of putting the operator on hold. Although holding is not prohibited, we recommend that the 911 caller remain connected to the PSAP until the call is over. Three-Way Conference Although the 911 caller is allowed to activate three-way conferencing when talking to thePSAP, we recommend that the 911 caller remain connected privately to the PSAP until the call is over. Dial-Peer Rotary If a 911 caller uses a rotary phone, you must configure each dial peer with the emergency response zone command for the call to be processed as an Enhanced 911 call. Otherwise, calls received on dial peers that are not configured for Enhanced 911 functionality are treated as regular calls and there is no ELIN translation. Do not configure two dial peers with the same destination-pattern to route to different PSAPs. The caller’s number will not be translated to two different ELINs and the two dial peers will not route to different PSAPs. However, you can route calls to different PSAPs if you configure the dial peers with different destination-patterns (for example, 9911 and 95105558911). You might need to use the number translation feature or add prefix/forward-digits to change the 95105558911 to 9911 for the second dial peer if a specific called-number is required by the service provider. Cisco Unified Communications Manager Express System Administrator Guide 697 Enhanced 911 Services Interactions with Existing Cisco Unified CME Features We recommend that you do not configure the same dial peer using both the emergency response zone and emergency response callback commands. Caution Dial Plan Patterns Dial plan patterns expand the caller’s original extension number into a fully qualified E.164 number. If an ERL is found for a 911 caller, the expanded number is translated to an ELIN. For 911 callbacks, the called-number is translated to the 911 caller’s expanded number. Caller ID Blocking When you set Caller ID Blocking for an ephone or voice-port configuration, the far-end gateway device blocks the display of the calling party information. This feature is overridden when an Enhanced 911 call is placed because the PSAP must receive the ELIN (the calling party information). The Caller ID Blocking feature does not impact callbacks. Shared Line The Shared Line feature allows multiple phones to share a common directory number. When a shared line receives an incoming call, each phone rings. Only the first user that answers the call is connected to the caller. The Shared Line feature does not affect outbound 911 calls. For 911 callbacks, all phonessharing the directory number will ring. Therefore,someone who did not originate the 911 call might answer the phone and get connected to the PSAP. This could cause confusion if the PSAP needs to talk only with the 911 caller. Configure Enhanced 911 Services Configure the Emergency Response Location Perform this procedure to create the ERL. The ERL defines an area that allows emergency teams to quickly locate a caller. The ERL can define zero, one, or two ELINs. If one ELIN is defined, this ELIN is always used for phones calling from this ERL. If you define two ELINs, the system alternates using each ELIN for phones calling from this ERL. If you define no ELINs and phones use this ERL, the outbound calls do not have their calling numbers translated. The PSAP sees the original calling numbers for these 911 calls. If multiple ERLs are created, the Enhanced 911 software uses the ERL tag number to determine which ELIN to use. The Enhanced 911 software searches the ERLs sequentially from tag 1 to 2147483647. The first ERL that has a subnet mask encompassing the caller's IP address is used for ELIN translation. Before You Begin • Cisco Unified CME 4.1 or a later version. Cisco Unified Communications Manager Express System Administrator Guide 698 Enhanced 911 Services Configure Enhanced 911 Services • The address and name commands are supported in Cisco Unified CME 4.2 and later versions. • Plan your 911 configuration as described in Plan Your Implementation of Enhanced 911 Services, on page 693 SUMMARY STEPS 1. enable 2. configure terminal 3. voice emergency response location tag 4. elin [1 | 2] E.164-number 5. address address 6. name name 7. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters emergency response location configuration mode to define parameters for an ERL. voice emergency response location tag Example: Router(config)# voice emergency response location 4 Step 3 (Optional) Specifies the ELIN, an E.164 PSTN number that replaces the caller's extension. elin [1 | 2] E.164-number Example: Router(cfg-emrgncy-resp-location)# elin 14085550100 Step 4 • This number is displayed on the PSAP’s terminal and is used by the PSAP to query the ALI database to locate the caller. It is also used by the PSAP for callbacks. You can define a second ELIN using the optional elin 2 command. If an ELIN is not defined for the ERL, the PSAP sees the original calling number. (Optional) Defines a comma-separated string used for the automatic location identification (ALI) database upload of the caller’s address. address address Example: Router(cfg-emrgncy-resp-location)# address I,604,5550100, ,184 ,Main St,Kansas City,KS,1, Step 5 • String must conform to the record format that is required by the service provider. The string maximum is 247 characters. Cisco Unified Communications Manager Express System Administrator Guide 699 Enhanced 911 Services Configure the Emergency Response Location Command or Action Purpose • Address is saved as part of the E911 ERL configuration. When used with the show voice emergency addresses command, the address information can be saved to a text file. • This command is supported in Cisco Unified CME 4.2 and later versions. (Optional) Defines a 30-character string used internally to identify or describe the emergency response location. name name Example: Router(cfg-emrgncy-resp-location)# name Bldg C, Floor 2 Step 6 • This command is supported in Cisco Unified CME 4.2 and later versions. end Returns to privileged EXEC mode. Example: Router(cfg-emrgncy-resp-location)# end Step 7 Configure Locations under Emergency Response Zones In the configuration of emergency response zones, a list of locations within a zone is created using location tags. The zone configuration allows a ranking of the locations which controls the order of ERL searches when there are multiple PSAPs. The zone command is not used if all 911 calls on the system are routed to a single PSAP. Before You Begin • Cisco Unified CME 4.2 or a later version • Define your ERLs as described in Configure the Emergency Response Location, on page 698. SUMMARY STEPS 1. enable 2. configure terminal 3. voice emergency response zone tag 4. location location-tag [priority number] 5. end Cisco Unified Communications Manager Express System Administrator Guide 700 Enhanced 911 Services Configure Locations under Emergency Response Zones DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice emergency response zone configuration mode to define parameters for an emergency response zone. voice emergency response zone tag Example: Router(config)# voice emergency response zone 10 Step 3 • tag—Range is 1-100. Each location tag must correspond to a location tag created using the voice emergency response location command. location location-tag [priority number] Example: Router(cfg-emrgncy-resp-zone)# location 8 priority 2 Step 4 • number—(optional) Ranksthe location in the zone list. Range is 1-100, with 1 being the highest priority. • Repeat this command for each location included in the zone. end Returns to privileged EXEC mode. Example: Router(cfg-emrgncy-resp-zone)# end Step 5 Configure Outgoing Dial Peers for Enhanced 911 Services Depending on whether you decided to configure emergency response zones while you planned your 911 configuration as described in Plan Your Implementation of Enhanced 911 Services, on page 693, use one of the following procedures: • If you decided to not use zones, see Configure Dial Peers for Emergency Calls, on page 701. • If you decided to use zones, see Configure Dial Peers for Emergency Response Zones, on page 703. Configure Dial Peers for Emergency Calls Perform this procedure to create a dial peer for emergency calls to the PSAP. The destination-pattern of this dial peer is usually some variation of 911, such as 9911. This dial peer uses the port number of the CAMA Cisco Unified Communications Manager Express System Administrator Guide 701 Enhanced 911 Services Configure Outgoing Dial Peers for Enhanced 911 Services or PRI network interface card. The new command emergency response zone specifies that this dial peer translates the calling number of any outgoing call’s to an ELIN. SUMMARY STEPS 1. enable 2. configure terminal 3. dial-peer voice number pots 4. destination-pattern n 911 5. prefix number 6. emergency response zone 7. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters dial-peer configuration mode to define parameters for an individual dial peer. dial-peer voice number pots Example: Router(config)# dial-peer voice 911 pots Step 3 Matches dialed digits to a telephony device. The digits included in this command specify the E.164 or private dialing plan destination-pattern n 911 Example: Router(config-dial-peer)# destination-pattern 9911 Step 4 telephone number. For Enhanced 911 Services, the digits are usually some variation of 911. (Optional) Includes a prefix that the system adds automatically to the front of the dial string before passing it to the telephony prefix number Example: Router(config-dial-peer)# prefix 911 Step 5 interface. For Enhanced 911 Services, the dial string is some variation of 911. Defines this dial peer as the one to use to route all ERLs defined in the system to the PSAP. emergency response zone Example: Router(config-dial-peer)# emergency response zone Step 6 Cisco Unified Communications Manager Express System Administrator Guide 702 Enhanced 911 Services Configure Outgoing Dial Peers for Enhanced 911 Services Command or Action Purpose end Returns to privileged EXEC mode. Example: Router(config-dial-peer)# end Step 7 Configure Dial Peers for Emergency Response Zones You can selectively route a 911 call based on the ERL by assigning different zonesto dial peers. The emergency response zone command identifies the dial peer that routes the 911 call and the voice interface to use. Only ERLs that are defined in the zone can be routed on the dial peer. Callers dialing the same emergency number are routed to different voice interfaces based on the zone of the ERL. Before You Begin • Cisco Unified CME 4.2 or a later version • Define your ERLs and emergency response zones as described in: ◦Configure the Emergency Response Location, on page 698 ◦Configure Locations under Emergency Response Zones, on page 700 SUMMARY STEPS 1. enable 2. configure terminal 3. dial-peer voice number pots 4. destination-pattern n911 5. prefix number 6. emergency response zone tag 7. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. Cisco Unified Communications Manager Express System Administrator Guide 703 Enhanced 911 Services Configure Outgoing Dial Peers for Enhanced 911 Services Command or Action Purpose configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters dial-peer configuration mode to define parameters for an individual dial peer. dial-peer voice number pots Example: Router(config)# dial-peer voice 911 pots Step 3 Matches dialed digits to a telephony device. The digits included in this command specify the E.164 or private dialing plan telephone destination-pattern n911 Example: Router(config-dial-peer)# destination-pattern 9911 Step 4 number. For E911 services, the digits are usually some variation of 911. (Optional) Includes a prefix that the system adds automatically to the front of the dial string before passing it to the telephony prefix number Example: Router(config-dial-peer)# prefix 911 Step 5 interface. For E911 services, the dial string is some variation of 911. Defines this dial peer as the one that is used to route ERLs defined for that zone. emergency response zone tag Example: Router(config-dial-peer)# emergency response zone 10 Step 6 • tag—Points to an existing configured zone. Range is 1-100. end Returns to privileged EXEC mode. Example: Router(config-dial-peer)# end Step 7 Configure a Dial Peer for Callbacks from the PSAP Perform this procedure to create a dial peer for 911 callbacks from the PSAP. This dial peer enables the PSAP to use the ELIN to make callbacks. When a call arrives that matches this dial peer, the emergency response callback command instructs the system to find the last caller that used the ELIN and translate the destination number of the incoming call to the extension of the last caller. Cisco Unified Communications Manager Express System Administrator Guide 704 Enhanced 911 Services Configure a Dial Peer for Callbacks from the PSAP SUMMARY STEPS 1. enable 2. configure terminal 3. dial-peer voice number pots 4. incoming called-number number 5. direct-inward-dial 6. emergency response callback 7. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters dial-peer configuration mode to define parameters for an individual dial peer. dial-peer voice number pots Example: Router(config)# dial-peer voice 100 pots Step 3 (Optional) Selects the inbound dial peer based on the called number to identify the last caller. This number is the ELIN. incoming called-number number Example: Router(config-dial-peer)# incoming called-number 4085550100 Step 4 (Optional) Enables the Direct Inward Dialing (DID) call treatment for the incoming called number. For more direct-inward-dial Example: Router(config-dial-peer)# direct-inward-dial Step 5 information, see the chapter Configuring Voice Ports in the Cisco Voice, Video, and Fax Configuration Guide. emergency response callback Identifies a dial peer as an ELIN dial peer. Example: Router(config-dial-peer)# emergency response callback Step 6 end Returns to privileged EXEC mode. Example: Router(config-dial-peer)# end Step 7 Cisco Unified Communications Manager Express System Administrator Guide 705 Enhanced 911 Services Configure a Dial Peer for Callbacks from the PSAP Assign ERLs to Phones You mustspecify an ERL for each phone. The type of phonesthat you have determines which of the following tasks you use to associate an ERL with your phones, as explained in Step 7 in Plan Your Implementation of Enhanced 911 Services, on page 693. • To create an IP subnet in the ERL that includes each phone’s IP address, you must also configure each ERL to specify which phones are part of the ERL. See Assign an ERL to a Phone’s IP Subnet, on page 706. You can optionally specify up to two different subnets. • To assign an ERL to a SIP phone, you must specify the ERL in the voice register pool configuration. See Assign an ERL to a SIP Phone, on page 707. • To assign an ERL to a SCCP phone, you must specify the ERL in the ephone configuration. See Assign an ERL to a SCCP Phone, on page 708. • To assign an ERL to a phone’s dial peer, you must specify the ERL in the dial-peer configuration. See Assign an ERL to a Dial Peer, on page 709. Prerequisites for Assigning ERLs to Phones Define your ERLs and emergency response zones as described in the Configure the Emergency Response Location, on page 698. Assign an ERL to a Phone’s IP Subnet Use this procedure when you have a group of phones that are on the same subnet. You can configure an ERL to be associated with one or two unique IP subnets. This indicates that all IP phones in a specific subnet use the ELIN defined in this ERL. SUMMARY STEPS 1. enable 2. configure terminal 3. voice emergency response location tag 4. subnet [1 | 2] IPaddress-mask 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Cisco Unified Communications Manager Express System Administrator Guide 706 Enhanced 911 Services Assign ERLs to Phones Command or Action Purpose Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters emergency response location configuration mode to define parameters for an ERL. voice emergency response location tag Example: Router(config)# voice emergency response location 4 Step 3 Defines the groups of IPphones that are part of this location. You can create up to 2 different subnets. subnet [1 | 2] IPaddress-mask Example: Router(cfg-emrgncy-resp-location)# subnet 1 192.168.0.0 255.255.0.0 Step 4 • To include all IP phones on a single ERL, use the command subnet 1 0.0.0.0 0.0.0.0 to configure a default subnet. This subnet does not apply to nonIP-phone endpoints, such as phones on VoIP trunks or FXS/FXO trunks. end Returns to privileged EXEC mode. Example: Router(cfg-emrgncy-resp-location)# end Step 5 Assign an ERL to a SIP Phone Perform this procedure if you chose to assign a specific ERL to a SIP phone instead of using the phone’s IP address to match a subnet defined for an ERL. For more information about this decision, see Step 7 in Plan Your Implementation of Enhanced 911 Services, on page 693. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register pool tag 4. emergency response location tag 5. end Cisco Unified Communications Manager Express System Administrator Guide 707 Enhanced 911 Services Assign ERLs to Phones DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register pool mode to define parameters for an individual voice register pool. voice register pool tag Example: Router(config)# voice register pool 8 Step 3 Step 4 emergency response location tag Assigns an ERL to a phone s voice register pool using an ERL s tag. Example: Router(config-register-pool)# emergency response location 12 • tag—Range is 1 to 2147483647. • If the ERL'stag is not a configured tag, the phone is not associated to an ERL and the phone defaults to its IP address to find the inclusive ERL subnet. • This command can also be configured in voice register template configuration mode and applied to one or more phones. The voice register pool configuration has priority over the voice register template configuration. end Returns to privileged EXEC mode. Example: Router(config-register-pool)# end Step 5 Assign an ERL to a SCCP Phone Perform this procedure if you chose to assign an ERL to a SCCP phone instead of configuring an ERL to be associated with IP subnets. For more information about this decision, see Step 7 in Plan Your Implementation of Enhanced 911 Services, on page 693. Cisco Unified Communications Manager Express System Administrator Guide 708 Enhanced 911 Services Assign ERLs to Phones SUMMARY STEPS 1. enable 2. configure terminal 3. ephone tag 4. emergency response location tag 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters ephone configuration mode to define parametersfor an individual ephone. ephone tag Example: Router(config)# ephone 224 Step 3 Step 4 emergency response location tag Assigns an ERL to a phone s ephone configuration using an ERL s tag. Example: Router(config-ephone)# emergency response location 12 • tag—Range is 1 to 2147483647. • If the ERL's tag is not a configured tag, the phone is not associated to an ERL and the phone defaults to its IP address to find the inclusive ERL subnet. • This command can also be configured in ephone-template configuration mode and applied to one or more phones. The ephone configuration has priority over the ephone-template configuration. end Returns to privileged EXEC mode. Example: Router(config-ephone)# end Step 5 Assign an ERL to a Dial Peer Perform this procedure to assign an ERL to a FXS/FXO or VoIP dial peer. Because these interfaces do not have IP addresses associated with them, you must use this procedure instead of configuring an ERL to be Cisco Unified Communications Manager Express System Administrator Guide 709 Enhanced 911 Services Assign ERLs to Phones associated with IPsubnets.For more information about this decision, see Step 7 inPlan Your Implementation of Enhanced 911 Services, on page 693. SUMMARY STEPS 1. enable 2. configure terminal 3. dial-peer voice tag type 4. emergency response location tag 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters dial peer configuration mode to define parameters for an individual dial peer. dial-peer voice tag type Example: Router(config)# dial-peer voice 100 pots Step 3 Assigns an ERL to a phone s dial peer configuration using an ERL's tag. The tag is an integer from 1 to 2147483647. If the emergency response location tag Example: Router(config-dial-peer)# emergency response location 12 Step 4 ERL's tag is not a configured tag, no translation occurs and no Enhanced 911 information is saved to the last emergency caller table. end Returns to privileged EXEC mode. Example: Router(config-dial-peer)# end Step 5 Customize E911 Settings The E911 settings you can customize are: • Elin: The default ELIN. If a 911 caller’s IP phone address does not match the subnet of any location in any zone, the default ELIN is used to replace the original automatic number identification (ANI). The Cisco Unified Communications Manager Express System Administrator Guide 710 Enhanced 911 Services Customize E911 Settings default ELIN can be already defined in one of the ERLs or can be unique. If a default ELIN is not defined and there is no match for the 911 caller’s IP address, the PSAP sees the ANI for callback purposes. A syslog message is sent requesting the default ELIN, and no caller location information is available to the PSAP. • Expiry: The number of minutes a 911 call is associated to an ELIN in case of a callback from the 911 operator. The callback expiry can be changed from a default of 3 hours to any time between 2 minutes and 48 hours. The timer is started the moment the 911 call goes to the PSAP. The PSAP can call back the ELIN and reach the last caller within this expiry time. • Callback: The default phone number to contact if a 911 callback cannot find the last 911 caller from the Last Caller table. This can happen if the callback occurs after a router has rebooted or if the expiration has elapsed. • Logging: A syslog informational message is printed to the console every time an emergency call is made. Such a message is required for third party applications to send an e-mail or page to an in-house emergency administrator. This is a default feature that can be disabled using the no logging command. The following is an example of a syslog notification message: %E911-5-EMERGENCY_CALL_PLACED: calling #[4085550100] called #[911] ELIN [4085550199] Before You Begin • Cisco Unified CME 4.2 or a later version SUMMARY STEPS 1. enable 2. configure terminal 3. voice emergency response settings 4. expiry time 5. callback number 6. logging 7. elin number 8. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Cisco Unified Communications Manager Express System Administrator Guide 711 Enhanced 911 Services Customize E911 Settings Command or Action Purpose Enters voice emergency response settings mode to define settings you can customize for E911 calls. voice emergency response settings Example: Router(config)# voice emergency response settings Step 3 (Optional) Defines the time period (in minutes) that the emergency caller history information for each ELIN is stored in the Last Caller expiry time Example: Router(cfg-emrgncy-resp-settings)# expiry 300 Step 4 table. The time can be an integer in the range of 2 minutes to 2880 minutes. The default value is 180 minutes. (Optional) Defines the E.164 callback number (for example, a company operator or main help desk) if a 911 callback cannot find the last caller associated to the ELIN. callback number Example: Router(cfg-emrgncy-resp-settings)# callback 7500 Step 5 (Optional) Enables syslog messages that announce every emergency call. The syslog messages can be tracked to send pager or e-mail logging Example: Router(cfg-emrgncy-resp-settings)# no logging Step 6 notifications to an in-house support number. By default, logging is enabled. Use the no form of this command to disable logging. Specifies the E.164 number to be used as the default ELIN if no ERL has a subnet mask that matches the current 911 caller s IP phone address. elin number Example: Router(cfg-emrgncy-resp-settings)# elin 4085550100 Step 7 end Returns to privileged EXEC mode. Example: Router (cfg-emrgncy-resp-settings)# end Step 8 Using the Address Command for Two ELINS For ERLs that have two ELINs defined, you cannot use just one address field to have two address entries for each ELIN in the ALI database. Instead of entering the specific phone number, a key phrase is entered to represent each ELIN. The show voice emergency address command produces output that replaces the key phrase with the ELIN information and generates two lines of addresses. To define the expression, use the keyword elin (context-insensitive), followed by a period, the starting position of the ELIN to use, followed by another period, and finally the ending position of the ELIN. For example: address I,ELIN.1.3,ELIN.4.7,678 ,Alder Drive ,Milpitas ,CA,95035 Cisco Unified Communications Manager Express System Administrator Guide 712 Enhanced 911 Services Using the Address Command for Two ELINS In the example, the second parameter of address following I are digits 1-3 of each ELIN. The third parameter are digits 4-7 of each ELIN. When you enter the show voice emergency address command, the output will replace the key phrase as seen in the following: I,408,5550101,678,Alder Drive ,Milpitas ,CA,95035 I,408,5550190,678,Alder Drive ,Milpitas ,CA,95035 Enable Call Detail Records To conform to internal policy or external regulations, you may be required to save 911 call history data including the following information: • Original caller’s extension • ELIN information • ERL information (the integer tag and the text name) • Original caller’s phone IP address These attributes are visible from the RADIUS accounting server and syslog server output, or by using the show call history voice command. You must enable the RADIUS server or the syslog server to display these details. See your RADIUS or syslog server documentation. Note Output from a RADIUS Accounting Server For RADIUS accounting, the emergency call information is under a feature-vsa record. The fields are: • EMR: Emergency call • CGN: Original calling number • ELIN: Emergency line identification number; the translated number • CDN: Called number • ERL: Emergency response location tag number • ERLN: Emergency response location name; the name entered for the ERL, if one exists • CIP: Caller’s IP address; nonzero for implicit ERL assignments • ETAG: ERL tag; nonzero for explicit ERL assignments The following shows an output example from a RADIUS server: *Jul 18 15:37:43.691: RADIUS: Cisco AVpair [1] 202 "feature-vsa=fn:EMR ,ft:07/18/2007 15:37:32.227,frs:0,fid:6,fcid:A2444CAF347B11DC8822F63A1B4078DE, legID:57EC,cgn:6045550101,elin:6045550199,cdn:911,erl:2,erln:Fisco,cip:1.5.6.200,etag:0" Cisco Unified Communications Manager Express System Administrator Guide 713 Enhanced 911 Services Enable Call Detail Records Output from a Syslog Server If gateway accounting is directed to the syslog server, a VOIP_FEAT_HISTORY system message appears. The feature-vsa parameters are the same ones described for RADIUS accounting. The following shows an output example from a syslog server: *Jul 18 15:37:43.675: %VOIPAAA-5-VOIP_FEAT_HISTORY: FEAT_VSA=fn:EMR,ft:07/18/2007 15:37:32.227,frs:0,fid:6,fcid:A2444CAF347B11DC8822F63A1B4078DE,legID:57EC,cgn:6045550199, elin:6045550100,cdn:911,erl:2,erln:ABCDEFGHIJKLMNOPQRSTUVWXYZ123,cip:1.5.6.200,etag:0, bguid:A23F6AD7347B11DC881DF63A1B4078DE Output from the show call history voice Command View emergency call information on the gateway using show call active voice and show call history voice. Some emergency call information is already in existing fields. The original caller’s number is under OriginalCallingNumber. The ELIN is at TranslatedCallingNumber. The four new fields are the ERL, ERL name, the calling phone’s IP address, and any explicit ERL assignments. These fields only appear if an ELIN translation occurs. For example, any 911 calls from an ERL with no ELIN defined do not print the four emergency fields in the show call commands. If no ERLs match the calling phone and the default ELIN is used, the ERL field displays No Match. The following shows an output example using the show call history voice command: EmergencyResponseLocation=3 (Cisco Systems 3) ERLAssignment=3 DeviceIPAddress=1.5.6.202 Verify E911 Configuration New show commands are introduced to display E911 configuration or usage. • Use the show voice emergency callers command to see the translations made by outbound 911 calls. This command lists the originating number, the ELIN used, and the time for each 911 call. This history is active for only three hours after the call is placed. Expired calls are not shown in this output. router# show voice emergency callers EMERGENCY CALLS CALL BACK table ELIN | CALLER | TIME 6045550100 | 6045550150 | Oct 12 2006 03:59:43 6045550110 | 8155550124 | Oct 12 2006 04:05:21 • Use the show voice emergency command to display IP addresses, subnet masks, and ELINs for each ERL. Router# show voice emergency EMERGENCY RESPONSE LOCATIONS ERL | ELIN 1 | ELIN2 | SUBNET 1 | SUBNET 2 1 | 6045550101 | | 10.0.0.0 | 255.0.0.0 2 | 6045550102 | 6045550106 | 192.168.0.0 | 255.255.0.0 3 | | 6045550107 | 172.16.0.0 | 255.255.0.0 4 | 6045550103 | | 192.168.0.0 | 255.255.0.0 5 | 6045550105 | | 209.165.200.224 | 255.0.0.0 6 6045550198 | | 6045550109 | 209.165.201.0 | 255.255.255.224 Cisco Unified Communications Manager Express System Administrator Guide 714 Enhanced 911 Services Verify E911 Configuration • Use the show voice emergency addresses command to display address information for each ERL. Router# show voice emergency addresses 3850 Zanker Rd, San Jose,604,5550101 225 W Tasman Dr, San Jose,604,5550102 275 W Tasman Dr, San Jose,604,5550103 518 Bellew Dr,Milpitas,604,5550104 400 Tasman Dr,San Jose,604,5550105 3675 Cisco Way,San Jose,604,5550106 • Use the show voice emergency all command to display all ERL information. Router# show voice emergency all VOICE EMERGENCY RESPONSE SETTINGS Callback Number: 6045550103 Emergency Line ID Number: 6045550155 Expiry: 2 minutes Logging Enabled EMERGENCY RESPONSE LOCATION 1 Name: Cisco Systems 1 Address: 3850 Zanker Rd, San Jose,elin.1.3,elin.4.10 IP Address 1: 209.165.200.226 IP mask 1: 255.255.255.254 IP Address 2: 209.165.202.129 IP mask 2: 255.255.0.0 Emergency Line ID 1: 6045550180 Emergency Line ID 2: Last Caller: 6045550188 [Jan 30 2007 16:05.52 PM] Next ELIN For Emergency Call: 6045550166 EMERGENCY RESPONSE LOCATION 3 Name: Cisco Systems 3 Address: 225 W Tasman Dr, San Jose,elin.1.3,elin.4.10 IP Address 1: 209.165.202.133 IP mask 1: 255.255.0.0 IP Address 2: 209.165.202.130 IP mask 2: 255.0.0.0 Emergency Line ID 1: Emergency Line ID 2: 6045550150 Last Caller: Next ELIN For Emergency Call: 6045550151 • Use the show voice emergency zone command to display each zone’slist of locationsin order of priority. Router# show voice emergency zone EMERGENCY RESPONSE ZONES zone 90 location 4 location 5 location 6 location 7 location 2147483647 zone 100 location 1 priority 1 location 2 priority 2 location 3 priority 3 Troubleshooting Enhanced 911 Services Use the debug voice application error and the debug voice application callsetup command. These are existing commands for calls made using the default session or TCL applications. Cisco Unified Communications Manager Express System Administrator Guide 715 Enhanced 911 Services Troubleshooting Enhanced 911 Services This example shows the debug output when a call to 911 is made: Router# debug voice application error Router# debug voice application callsetup Nov 10 23:49:05.855: //emrgncy_resp_xlate_callingNum: InDialPeer[20001], OutDialPeer[911] callingNum[6046692003] Nov 10 23:49:05.855: //ER_HistTbl_Find_CallHistory: 6046699100 Nov 10 23:49:05.855: //59//Dest:/DestProcessEmergencyCall: Emergency Call detected: Using ELIN 6046699100 This example shows the debug output when a PSAP calls back an emergency caller: Router# debug voice application error Router# debug voice application callsetup Nov 10 23:49:37.279: //emrgncy_resp_xlate_calledNum: calledNum[6046699100], dpeerTag[6046699] Nov 10 23:49:37.279: //ER_HistTbl_Find_CallHistory: 6046699100 Nov 10 23:49:37.279: //HasERHistoryExpired: elapsedTime[10 minutes] Nov 10 23:49:37.279: //67//Dest:/DestProcessEmergencyCallback: Emergency Response Callback: Forward to 6046692003. Nov 10 23:49:37.279: //67//Dest:/DestCaptureCallForward: forwarded to 6046692003 reason 1 Error Messages The Enhanced 911 feature introduces a new system error message. The following error message displays if a 911 callback cannot route to the last 911 caller because the saved history was lost because of a reboot, an expiration of an entry, or a software error: %E911_NO_CALLER: Unable to contact last 911 caller. Configuration Examples for Enhanced 911 Services Example for Configuring Enhanced E911 Services with Cisco Unified CME 4.2 Emergency response settings are: • default elin if no elin match is found: 604 555-0120 • expiry time for information in the Last Caller table: 180 minutes • callback number if thePSAPoperator must call back the 911 caller and the call back history has expired: 604 555-0199 Cisco Unified Communications Manager Express System Administrator Guide 716 Enhanced 911 Services Error Messages Zone 1 has four locations, 1, 2, 3, and 4, and a name, address, and elin are defined for each location. Each of the four locations is assigned a priority. In this example, because location 4 has been assigned the highest priority, it is the first that is searched for IP subnet matches to identify the ELIN assigned to the 911 caller’s phone. A dial peer is configured to route 911 calls to the PSAP (voice port 1/0/0). Callback dial peers are also configured. ! voice emergency response settings elin 6045550120 expiry 180 callback 6045550199 ! voice emergency response location 1 name Bldg C, Floor 1 address I,604,5550135, ,184 ,Main St,Kansas City,KS,1, elin 1 6045550125 subnet 1 172.16.0.0 255.255.0.0 ! voice emergency response location 2 name Bldg C, Floor 2 address I,elin.1.3,elin.4.7, ,184 ,Main St,Kansas City,KS,2, elin 1 6045550126 elin 2 6045550127 subnet 1 192.168.0.0 255.255.0.0 ! voice emergency response location 3 name Bldg C, Floor 3 address I,604,5550138, ,184 ,Main St,Kansas City,KS,3, elin 2 6045550128 subnet 1 209.165.200.225 255.255.0.0 subnet 2 209.165.200.240 255.255.0.0 ! voice emergency response location 4 name Bldg D address I,604,5550139, ,192 ,Main St,Kansas City,KS, elin 1 6045550129 subnet 1 209.165.200.231 255.255.0.0 ! voice emergency response zone 1 location 4 priority 1 location 3 priority 2 location 2 priority 3 location 1 priority 4 ! dial-peer voice 911 pots description Public Safety Answering Point emergency response zone 1 destination-pattern 911 port 1/0/0 ! dial-peer voice 6045550 voip emergency response callback destination-pattern 6045550... session target loopback:rtp codec g711ulaw ! dial-peer voice 1222 pots emergency response location 4 destination-pattern 6045550130 port 1/0/1 ! dial-peer voice 5550144 voip emergency response callback session target ipv4:1.5.6.10 incoming called-number 604555.... codec g711ulaw ! Cisco Unified Communications Manager Express System Administrator Guide 717 Enhanced 911 Services Example for Configuring Enhanced E911 Services with Cisco Unified CME 4.2 Example for Configuring Enhanced E911 Services with Cisco Unified CME 4.1 in SRST Fallback Mode In this example, Enhanced 911 Services is configured to assign an ERL to the following: • The 10.20.20.0 IP subnet • Two dial peers • An ephone • A SI P phone Router#show running-config Building configuration... Current configuration : 7557 bytes ! version 12.4 service timestamps debug datetime msec service timestamps log datetime msec no service password-encryption ! hostname rm-uut3-2821 ! boot-start-marker boot-end-marker ! no logging console ! no aaa new-model network-clock-participate wic 1 network-clock-participate wic 2 no network-clock-participate wic 3 ! ! ! ip cef no ip dhcp use vrf connected ! ip dhcp pool sccp-7912-phone1 host 10.20.20.122 255.255.0.0 client-identifier 0100.1200.3482.cd default-router 10.20.20.3 option 150 ip 10.21.20.218 ! ip dhcp pool sccp-7960-phone2 host 10.20.20.123 255.255.0.0 client-identifier 0100.131a.a67d.cf default-router 10.20.20.3 option 150 ip 10.21.20.218 dns-server 10.20.20.3 ! ip dhcp pool sip-phone1 host 10.20.20.121 255.255.0.0 client-identifier 0100.15f9.b38b.a6 default-router 10.20.20.3 option 150 ip 10.21.20.218 ! ip dhcp pool sccp-7960-phone1 host 10.20.20.124 255.255.0.0 client-identifier 0100.14f2.37e0.00 default-router 10.20.20.3 option 150 ip 10.21.20.218 dns-server 10.20.20.3 Cisco Unified Communications Manager Express System Administrator Guide 718 Enhanced 911 Services Example for Configuring Enhanced E911 Services with Cisco Unified CME 4.1 in SRST Fallback Mode ! ! no ip domain lookup ip host rm-uut3-c2821 10.20.20.3 ip host RescuMe01 10.21.20.218 multilink bundle-name authenticated ! isdn switch-type basic-net3 ! ! voice service voip allow-connections h323 to h323 allow-connections h323 to sip allow-connections sip to h323 allow-connections sip to sip supplementary-service h450.12 sip registrar server ! ! voice register global system message RM-SIP-SRST max-dn 192 max-pool 48 ! voice register dn 1 number 32101 ! voice register dn 185 number 38301 ! voice register dn 190 number 38201 ! voice register dn 191 number 38202 ! voice register dn 192 number 38204 ! voice register pool 1 id mac DCC0.2222.0001 number 1 dn 1 emergency response location 2100 ! voice register pool 45 id mac 0015.F9B3.8BA6 number 1 dn 185 ! voice emergency response location 1 elin 1 22222 subnet 1 10.20.20.0 255.255.255.0 ! voice emergency response location 2 elin 1 21111 elin 2 21112 ! ! voice-card 0 no dspfarm ! ! archive log config hidekeys ! ! controller T1 0/1/0 framing esf Cisco Unified Communications Manager Express System Administrator Guide 719 Enhanced 911 Services Example for Configuring Enhanced E911 Services with Cisco Unified CME 4.1 in SRST Fallback Mode linecode b8zs pri-group timeslots 8,24 ! controller T1 0/1/1 framing esf linecode b8zs pri-group timeslots 2,24 ! controller T1 0/2/0 framing esf clock source internal linecode b8zs ds0-group 1 timeslots 2 type e&m-immediate-start ! controller T1 0/2/1 framing esf linecode b8zs pri-group timeslots 2,24 ! ! translation-rule 5 Rule 0 ^37103 1 ! ! translation-rule 6 Rule 6 ^2 911 ! ! interface GigabitEthernet0/0 ip address 31.20.0.3 255.255.0.0 duplex auto speed auto ! interface GigabitEthernet0/1 ip address 10.20.20.3 255.255.0.0 duplex auto speed auto ! interface Serial0/1/0:23 no ip address encapsulation hdlc isdn switch-type primary-5ess isdn incoming-voice voice no cdp enable ! interface Serial0/1/1:23 no ip address encapsulation hdlc isdn switch-type primary-net5 isdn incoming-voice voice no cdp enable ! interface Serial0/2/1:23 no ip address encapsulation hdlc isdn switch-type primary-net5 isdn incoming-voice voice no cdp enable ! interface BRI0/3/0 no ip address isdn switch-type basic-5ess isdn twait-disable isdn point-to-point-setup isdn autodetect isdn incoming-voice voice no keepalive ! interface BRI0/3/1 no ip address isdn switch-type basic-5ess isdn point-to-point-setup ! Cisco Unified Communications Manager Express System Administrator Guide 720 Enhanced 911 Services Example for Configuring Enhanced E911 Services with Cisco Unified CME 4.1 in SRST Fallback Mode ! ip http server ! ! voice-port 0/0/0 ! voice-port 0/0/1 ! voice-port 0/1/0:23 ! voice-port 0/2/0:1 ! voice-port 0/1/1:23 ! voice-port 0/2/1:23 ! voice-port 0/3/0 ! voice-port 0/3/1 ! ! dial-peer voice 2002 pots shutdown destination-pattern 2.... port 0/2/0:1 forward-digits all ! dial-peer voice 2005 pots description for-cme2-408-pri emergency response location 2000 shutdown incoming called-number 911 direct-inward-dial port 0/2/1:23 forward-digits all ! dial-peer voice 2004 voip description for-cme2-408-thru-ip emergency response location 2000 shutdown session target loopback:rtp incoming called-number 911 ! dial-peer voice 1052 pots description 911callbackto-cme2-3 shutdown incoming called-number ..... direct-inward-dial port 0/1/1:23 forward-digits all ! dial-peer voice 1013 pots description for-analog destination-pattern 39101 port 0/0/0 forward-digits all ! dial-peer voice 1014 pots description for-analog-2 destination-pattern 39201 port 0/0/1 forward-digits all ! dial-peer voice 3111 pots emergency response Zone destination-pattern 9.... port 0/1/0:23 forward-digits all ! dial-peer voice 3121 pots Cisco Unified Communications Manager Express System Administrator Guide 721 Enhanced 911 Services Example for Configuring Enhanced E911 Services with Cisco Unified CME 4.1 in SRST Fallback Mode emergency response callback incoming called-number 2.... direct-inward-dial port 0/1/0:23 forward-digits all ! ! telephony-service srst mode auto-provision none load 7960-7940 P00307020200 load 7970 TERM70.7-0-1-0s load 7912 CP7912060101SCCP050429B.sbin max-ephones 50 max-dn 190 ip source-address 10.20.20.3 port 2000 system message RM-SCCP-CME-SRST max-conferences 8 gain -6 moh flash:music-on-hold.au multicast moh 236.1.1.1 port 3000 transfer-system full-consult transfer-pattern ..... transfer-pattern 911 ! ! ephone-dn 1 dual-line number 31101 ! ! ephone-dn 2 dual-line number 31201 ! ! ephone-dn 3 dual-line number 31301 ! ! ephone-dn 100 dual-line number 37101 secondary 37111 name 7960-sccp-1 ! ! ephone-dn 101 dual-line number 37102 ! ! ephone-dn 102 dual-line number 37103 ! ! ephone-dn 105 number 37201 ! ! ephone-dn 106 dual-line number 37101 ! ! ephone-dn 107 dual-line number 37302 ! ! ephone-dn 108 dual-line number 37303 ! ! ephone-dn 110 dual-line number 37401 ! ! ephone-dn 111 dual-line number 37402 Cisco Unified Communications Manager Express System Administrator Guide 722 Enhanced 911 Services Example for Configuring Enhanced E911 Services with Cisco Unified CME 4.1 in SRST Fallback Mode ! ! ephone 1 mac-address DCC0.1111.0001 type 7960 button 1:1 ! ! ephone 2 mac-address DCC0.1111.0002 type 7960 button 1:2 ! ! ephone 3 mac-address DCC0.1111.0003 type 7970 button 1:3 ! ! ephone 40 mac-address 0013.1AA6.7DCF type 7960 button 1:100 2:101 3:102 ! ! ephone 41 mac-address 0012.0034.82CD type 7912 button 1:105 ! ! ephone 42 mac-address 0014.F237.E000 emergency response location 2 type 7940 button 1:107 2:108 ! ! ephone 43 mac-address 000F.90B0.BE0B type 7960 button 1:110 2:111 ! ! line con 0 exec-timeout 0 0 line aux 0 line vty 0 4 login ! scheduler allocate 20000 1000 ! end Feature Information for Enhanced 911 Services The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Cisco Unified Communications Manager Express System Administrator Guide 723 Enhanced 911 Services Feature Information for Enhanced 911 Services Table 48: Feature Information for Enhanced 911 Services Feature Name Cisco Unified CME Version Feature Information • Assigns ERLs to zones to enable routing to the PSAP that is closest to the caller • Customizes E911 by defining a default ELIN, identifying a designated number if the 911 caller cannot be reached on callback, specifying the expiry time for data in the Last Caller table, and enabling syslog messagesthat announce all emergency calls • Expands the E911 location information to include name and address • Uses templates to assign ERLs to a group of phones • Adds new permanent call detail records Enhanced 911 Services for 4.2 Cisco Unified CME Enhanced 911 Services was introduced for Cisco Unified CME in SRST Fallback Mode. Enhanced 911 Services 4.1 Cisco Unified Communications Manager Express System Administrator Guide 724 Enhanced 911 Services Feature Information for Enhanced 911 Services CHAPTER 21 Extension Mobility This chapter describes features in Cisco Unified Communications Manager Express (Cisco Unified CME) that provide support for phone mobility for end users. • Prerequisites for Configuring Extension Mobility, page 725 • Restrictions for Configuring Extension Mobility, page 725 • Information About Configuring Extension Mobility, page 726 • Enable Extension Mobility, page 730 • Configuration Examples for Extension Mobility, page 744 • Where to Go Next, page 746 • Feature Information for Extension Mobility, page 746 Prerequisites for Configuring Extension Mobility • Cisco Unified CME 4.2 or a later version. • To use the web-based Cisco Unified CME GUI to configure personal speed dials on an Extension Mobility phone, Cisco Unified CME 4.2(1) or a later version must be installed. • To use the phone user interface to configure personal speed dials directly on an Extension Mobility phone, Cisco Unified CME 4.3 or a later version must be installed. • SIP phone support is available with Cisco Unified CME 8.6 or a later version. Restrictions for Configuring Extension Mobility • Extension Mobility on remote Cisco Unified CME routers is not supported; a phone user can log into any local Cisco Unified IP phone only. Cisco Unified Communications Manager Express System Administrator Guide 725 Information About Configuring Extension Mobility Extension Mobility Extension Mobility in Cisco Unified CME 4.2 and later versions provides the benefit of phone mobility for end users. A user login service allows phone users to temporarily access a physical phone other than their own phone and utilize their personal settings, such as directory number, speed-dial lists, and services, as if the phone is their own desk phone. The phone user can make and receive calls on that phone using the same personal directory number as is on their own desk phone. Each Cisco Unified IP phone that is enabled for Extension Mobility is configured with a logout profile. This profile determines the default appearance of a phone that is enabled for Extension Mobility when there is no phone user logged into that phone. Minimally, the logout profile allows calls to emergency services such as 911. A single logout profile can be applied to multiple phones. After a Cisco Unified IP phone that is enabled for Extension Mobility boots up, the Services feature button on the phone is configured with a login service URL hosted by Cisco Unified CME that pointsto the Extension Mobility Login page. No feature-button-specifc configuration is required to add Extension Assigner to the Services feature button. The option for Extension Mobility appears last in the list of options displayed when the phone user presses the Services feature button A phone user logs in to a Cisco Unified IP phone that is enabled for Extension Mobility by pressing the Services button or a Unified CCX agent can log in using a Unified CCX Cisco Agent Desktop. User authentication and authorization is performed by Cisco Unified CME. If the login is successful, Cisco Unified CME retrieves the appropriate user profile, based on user name and password match, and replaces the phone’s logout profile with the user profile. After the phone user is logged in, the service URL points to a logout URL hosted by Cisco Unified CME to provide a logout prompt on the phone. Logging into a different device automatically closes the first session and start a new session on the new device. When a phone user is not logged in to any phone, incoming calls to the phone user’s directory number are sent to the phone user’s voice mailbox. For button appearance, Extension Mobility associates directory numbersthen speed-dial numbersin the logout profile or user profile to phone buttons. The sequence in which directory numbers are associated is based on line type and ring behavior as follows: first normal, then silent ring, beep ring, feature ring, monitor ring, and overlay, followed by speed dials. If the profile contains more numbers than there are buttons on the physical phone to which the profile is downloaded, the remaining numbers in the profile are ignored. For configuration information, see Enable Extension Mobility, on page 730. Personal Speed Dials on an Extension Mobility Phone In Cisco Unified CME 4.2(1) and later versions, phone users can use the web-based GUI to set up personal speed dials on an Extension Mobility phone. Previously, the speed-dial configuration for a phone could only be done in Cisco Unified CME using Cisco IOS commands. The same credential for logging on to an Extension Mobility phone is used to log into the Cisco Unified CME GUI. Any modifications made by using the phone user options in the GUI are applied to the phone user’s user profile in Extension Mobility. Speed dial options in Cisco Unified CME GUI cannot be accessed from the System Administrator or Customer Administrator login screens. Cisco Unified Communications Manager Express System Administrator Guide 726 Extension Mobility Information About Configuring Extension Mobility For information about using the Cisco Unified CME GUI, see Cisco Unified CME Graphical User Interface User Guide. The user name parameter of any authentication credential must be unique and cannot be the same as the user name for any other credential. Do not use the same value for a user name when you configure any two or more authentication credentials in Cisco Unified CME, such as the username for any Cisco United CME GUI account and the user name in a logout or user profile for Extension Mobility. For configuration information, see Enable the GUI, on page 525. In Cisco Unified CME 4.3 and later versions, Extension Mobility users can configure their own speed-dial settings directly on the phone.Speed-dialsettings are added or modified on the phone by using a menu available with theServicesfeature button. Any changesto the speed-dialsettings made through the phone user interface are applied to the user’s profile in Extension Mobility. For information about using the phone user interface on a Cisco Unified IP phone, see Cisco Unified IP Phone 7900 Series End-User Guides. The phone user-interface is enabled by default on all phones with displays. You can disable the capability for an individual phone to prevent a phone user from accessing the interface. For configuration information, see Enable Phone User Interface for Configuring Speed-Dial and Fast-Dial, on page 978. Cisco Unified CME Extension Mobility Enhancements Enhancements to Extension Mobility in Cisco Unified CME 4.3 include the following: • Configurable Automatic Logout • Automatic Clear Call History Automatic Logout Cisco Unified CME 4.3 and later versions includes an Automatic Timeout feature for Extension Mobility. After an automatic logout is executed, Cisco Unified CME sends the logout profile to the phone and restarts the phone. After an automatic logout, Extension Mobility users can log in again. You can configure up to three different times on a 24-hour clock for automatically logging out Extension Mobility users based on time-of-day. The system clock triggers an alarm at the specified time and the EM Manager in Cisco Unified CME logs outs every logged in Extension Mobility user in the system. If an Extension Mobility user is using the phone when automatic logout occurs, the user is logged out after the active call is completed. For configuration information, see Configure Cisco Unified CME for Extension Mobility, on page 730. Users log out from Extension Mobility by pressing the Services button and choosing Logout. If a user does not manually log out before leaving the phone, the phone is idle and the individual’s user profile remains loaded on that phone. To automatically log out individual usersfrom idle Extension Mobility phones, configure an idle-duration timer for Extension Mobility. The timer monitors the phone and if the specified maximum idle time is exceeded, the EM Manager logs out the user. The idle-duration timer is reset whenever the phone goes offhook. For configuration information, see Configure a User Profile, on page 741. Automatic Clear Call History In Cisco Unified CME 4.3 and later versions, the EM manager in Cisco Unified CME issues commands to phones to clear call history whenever a user logs out of Extension Mobility. An HTTP GET/POST is sent Cisco Unified Communications Manager Express System Administrator Guide 727 Extension Mobility Cisco Unified CME Extension Mobility Enhancements between the Extension Mobility phone and the authentication server in Cisco Unified CME. The authentication server authorizes the request and the call history is cleared based on the result. You can configure Cisco Unified CME to disable Automatic Clear Call History.For configuration information, see Configure Cisco Unified CME for Extension Mobility, on page 730. Privacy on an Extension Mobility Phone In Cisco Unified CME 4.3 and later versions, the Privacy feature enables phone users to block other users from seeing call information or barging into a call on a shared octo-line directory number. When a phone receives an incoming call on a shared octo-line, the user can make the call private by pressing the Privacy feature button, which toggles between on and off to allow the user to alter the privacy setting on their phone. The privacy state is applied to all new calls and current calls owned by the phone user. For Extension Mobility phones, you can enable the privacy button in the user profile and logout profile. To enable the privacy button, see Configure a Logout Profile for an IP Phone, on page 733 and Configure a User Profile, on page 741. For more information about Privacy, see Barge and Privacy, on page 1047. Extension Mobility for SIP Phones Enhancement Cisco Unified CME 8.6 enhances the Extension Mobility feature to allow support for SIP phones. Extension Mobility allows you to access any EM enabled physical phone and utilize your own personal settings, such as directory numbers, speed-dials, after-hour personal identification number (PIN), and feature button layout, as if the phone is your own desk phone. A user login service allows you to temporarily access a physical phone other than your own phone and utilize your personal settings, such as directory number, speed-dial lists, and services, as if the phone is your own desk phone. The features of Extension Mobility for SIP phones is identical to SCCP phones, only the configuration procedure is different. For information on configuring Extension Mobility for SIP phones, see Configure Extension Mobility for SIP Phones, on page 738. Note You can login to either an SCCP phone or a SIP phone with the same user profile. Only the normal lines configured in your user profile are applied when you login to a SIP phone. Other lines such as overlay, monitor, and feature-ring lines are ignored. Note Only Cfwdall, Confrn, DnD, Endcall, Hold, NewcallGroup Pickup, Park, Privacy, Redial, and Trnsfer feature buttons configured in your user profile will be applied when you login to aSIPphone. Other feature buttons will be ignored. Note Cisco Unified Communications Manager Express System Administrator Guide 728 Extension Mobility Privacy on an Extension Mobility Phone MIB Support for Extension Mobility in Cisco Unified SCCP IP Phones In Cisco Unified CME 9.0 and later versions, new MIB objects are added to monitor Cisco Unified SCCP IP Extension Mobility (EM) phones. These enhancements allow the retrieval of the following information: • user-profile tag for a Cisco Unified SCCP IP EM phone, when it is logged in • logout-profile tag for a Cisco Unified SCCP IP EM phone • DN and its type, and the overlay or call waiting numbers if applicable, for each user-profile • DN and its type, and the overlay or call waiting numbers if applicable, for each logout-profile • number of Cisco Unified SCCP IP phones configured as EM phones • number of registered Cisco Unified SCCP IP EM phones Table 49: MIB Variables and Object Identifiers for EM in Cisco Unfied SCCP IP Phones , on page 729 lists the MIB variables and object identifiers for retrieving the new MIB database. Table 49: MIB Variables and Object Identifiers for EM in Cisco Unfied SCCP IP Phones MIB Variables Object identifiers ccmeEMUserProfileTag 1.3.6.1.4.1.9.9.439.1.1.43.1.19 ccmeEMLogOutProfileTag 1.3.6.1.4.1.9.9.439.1.1.43.1.20 ccmeEMUserDirNumConfTable 1.3.6.1.4.1.9.9.439.1.1.68 ccmeEMUserDirNumConfEntry 1.3.6.1.4.1.9.9.439.1.1.68.1 ccmeEMUserDirNum 1.3.6.1.4.1.9.9.439.1.1.68.1.3 ccmeEMUserDirNumOverlay 1.3.6.1.4.1.9.9.439.1.1.68.1.4 ccmeEMLogoutDirNumConfTable 1.3.6.1.4.1.9.9.439.1.1.69 ccmeEMLogoutDirNumConfEntry 1.3.6.1.4.1.9.9.439.1.1.69.1 ccmeEMLogoutDirNum 1.3.6.1.4.1.9.9.439.1.1.69.1.3 ccmeEMLogoutDirNumOverlay 1.3.6.1.4.1.9.9.439.1.1.69.1.4 ccmeEMphoneTot 1.3.6.1.4.1.9.9.439.1.2.9 ccmeEMphoneTotRegistered 1.3.6.1.4.1.9.9.439.1.2.10 Table 50: Descriptions of MIB Variables for EM in Cisco Unfied SCCP IP Phones, on page 730 provides a description of each of the MIB variables for EM in Cisco Unified SCCP IP Phones. Cisco Unified Communications Manager Express System Administrator Guide 729 Extension Mobility MIB Support for Extension Mobility in Cisco Unified SCCP IP Phones Table 50: Descriptions of MIB Variables for EM in Cisco Unfied SCCP IP Phones MIB Variables Descriptions ccmeEMUserProfileTag User-profile tag for the EM phone ccmeEMLogOutProfileTag Logout-profile tag for the EM phone ccmeEMUserDirNumConfTable Table of entries for the EM phone’s user profile ccmeEMUserDirNumConfEntry A user-profile entry for the EM phone ccmeEMUserDirNum A directory number for the user profile Number type for the user profile, including the overlay identifier ccmeEMUserDirNumOverlay ccmeEMLogoutDirNumConfTable Table of entries for the EM phone’s logout profile ccmeEMLogoutDirNumConfEntry A logout entry for the EM phone ccmeEMLogoutDirNum A directory number for the logout profile Number type for the logout profile, including the overlay identifer ccmeEMLogoutDirNumOverlay ccmeEMphoneTot Total number of EM phones ccmeEMphoneTotRegistered Total number of registered EM phones Extension mobility is supported in Cisco Unified CME but not in Cisco Unified SRST. Enable Extension Mobility Configure Cisco Unified CME for Extension Mobility To configure Extension Mobility in Cisco Unified CME, perform the following steps. Before You Begin • For authentication server in Cisco Unified CME, Cisco Unified CME 4.3 or a later version. • For Automatic Logout, Cisco Unified CME 4.3 or a later version. Cisco Unified Communications Manager Express System Administrator Guide 730 Extension Mobility Enable Extension Mobility SUMMARY STEPS 1. enable 2. configure terminal 3. ip http server 4. telephony-service 5. url authentication url-address application-name password 6. service phone webAccess 0 7. authentication credential application-name password 8. em keep-history 9. em logout time1 [time2 ] [time3 ] 10. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enables the HTTP server on the Cisco Unified CME router that hosts the service URL for the Extension Mobility Login and Logout pages. ip http server Example: Router(config)# ip http server Step 3 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 4 Instructs phones to send HTTP requests to the authentication server and specifies which credential to use in the requests. url authentication url-address application-name password Example: Router(config-telephony)# url authentication http://192.0.2.0/CCMCIP/authenticate.asp secretname psswrd Step 5 • This command is supported in Cisco Unified CME 4.3 and later versions. Required to support Automatic Clear Call history. or To support Extension Mobility and VoiceView Express 3.2 or earlier versions Router(config-telephony)# url authentication http://192.0.2.0/voiceview/authentication/authenticate.do secretname psswrd • URL for internal authentication server in Cisco Unified CME is http://CME IP Address/CCMCIP/authenticate.asp. Cisco Unified Communications Manager Express System Administrator Guide 731 Extension Mobility Configure Cisco Unified CME for Extension Mobility Command or Action Purpose • To support Extension Mobility and Cisco VoiceView Express 3.2 or an earlier version only: ◦In Cisco Unified CME: Configure the url authentication command using the URL for Cisco Unity Express. The URL for Cisco Unity Express is http://CUE IPAddress/voiceview/authentication/authenticate.do. ◦In Cisco Unity Express: Configure the fallback-url command using the URL for the authentication server in Cisco Unified CME. ◦See Examples, on page 733. Enables webAccess for IP phones. This is required for 9.x firmware because the web server is disabled by service phone webAccess 0 Example: Router(config-telephony)# service phone webAccess 0 Step 6 default. 8.x firmware and lower had the web server enabled by default. (Optional) Creates an entry for an application's credential in the database used by the Cisco Unified CME authentication server. authentication credential application-name password Example: Router(config-telephony)#authentication credential secretname psswrd Step 7 • This command is supported in Cisco Unified CME 4.3 and later versions. • Required to support requests requests from applications other than Extension Mobility, such as Cisco VoiceView Express. (Optional) Specifies that Extension Mobility will keep, and not automatically clear, call histories when userslog out from Extension Mobility phones. em keep-history Example: Router(config-telephony)# em keep-history Step 8 • This command is supported in Cisco Unified CME 4.3 and later versions. • Default: Automatic Clear Call History is enabled. (Optional) Defines up to three time-of-day timers for automatically logging out all Extension Mobility users. em logout time1 [time2 ] [time3 ] Example: Router(config-telephony)# em logout 19:00 24:00 Step 9 • This command is supported in Cisco Unified CME 4.3 and later versions. • time—Time of day after which logged-in users are automatically logged out from Extension Mobility. Range: 00:00 to 24:00 on a 24-hour clock. Cisco Unified Communications Manager Express System Administrator Guide 732 Extension Mobility Configure Cisco Unified CME for Extension Mobility Command or Action Purpose • To configure a idle-duration timer for automatically logging out an individual user, see Configure a User Profile, on page 741. Exits configuration mode and returnsto privileged EXEC mode. end Example: Router(config-telephony)# end Step 10 Examples The following example shows how to configure Cisco Unified CME 4.3 or a later version and Cisco Unity Express 3.2 or an earlier version to support Extension Mobility and Cisco VoiceView Express. When running Extension Mobility and Cisco VoiceView Express 3.2 or an earlier version, you must also configure the fallback-url command in Cisco Unity Express. For configuration information, see the appropriate Cisco Unity Express Administrator Guide. Note Cisco Unified CME 4.3 or a later version telephony-service url authentication http://192.0.2.0/voiceview/authentication/authenticate.do secretname psswrd authentication credentials secretname psswrd Cisco Unity Express 3.2 or an earlier version service phone-authentication fallback-url http://192.0.2.0/CCMCIP/authenticate.asp?UserID=secretname&Password=psswrd Configure a Logout Profile for an IP Phone To create a logout profile to define the default appearance for a Cisco Unified IP phone that is enabled for Extension Mobility, perform the following steps. Cisco Unified Communications Manager Express System Administrator Guide 733 Extension Mobility Configure a Logout Profile for an IP Phone Restriction • For button appearance, Extension Mobility associates directory numbers, then speed-dial definitions in the logout profile or user profile to phone buttons. The sequence in which directory numbers are associated is based on line type and ring behavior as follows: first normal, then silent ring, beep ring, feature ring, monitor ring, and overlay, followed by speed dials. If the profile contains more directory numbers and speed-dial numbers than there are buttons on the physical phone to which the profile is downloaded, not all numbers are downloaded to buttons. • The first number to be configured for line appearance cannot be a monitored directory number. • The user name parameter of any authentication credential must be unique. Do not use the same value for a user name when you configure any two or more authentication credentialsin Cisco Unified CME, such as the user name for any Cisco Unified CME GUI account and the user name in a logout or user profile for Extension Mobility. Before You Begin • All directory numbers to be included in a logout profile or a user profile must be already configured in Cisco Unified CME. For configuration information, see Configure Phones to Make Basic Call, on page 315. • For Privacy on extension mobility phones, Cisco Unified 4.3 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. voice logout-profile profile-tag 4. user name password password 5. number number type type 6. speed-dial speed-tag number [ label label ] [blf] 7. pin number 8. privacy-button 9. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Cisco Unified Communications Manager Express System Administrator Guide 734 Extension Mobility Configure a Logout Profile for an IP Phone Command or Action Purpose Enters voice logout-profile configuration mode for creating a logout profile to define the default appearance for a Cisco Unified IP phone enabled for Extension Mobility. voice logout-profile profile-tag Example: Router(config)# voice logout-profile 1 Step 3 • profile-tag—Unique number that identifies this profile during configuration tasks. Range: 1 to maximum number of phones supported by the Cisco Unified CME router. Type ? to display the maximum number. Creates credential to be used by a TAPI phone device to log into Cisco Unified CME. user name password password Example: Router(config-logout-profile)# user 23C2-8 password 43214 Step 4 • name—Unique alphanumeric string to identify a user for this authentication credential only. • password—Alphanumeric string. Step 5 number number type type Creates line definition. Example: Router(config-logout-profile)# number 3001 type silent-ring • number—Directory number to be associated with and displayed next to a button on a Cisco Unified IP phone that is configured with this profile. Router(config-logout-profile)# number 3002 • [, ...number]—(Optional) For overlay lines only, with or without call waiting. The directory number that is the far left in command type beep-ring Router(config-logout-profile)# number 3003 type feature-ring list is the highest priority. Can contain up to 25 numbers. Individual numbers must be separated by commas (,). Router(config-logout-profile)# number 3004 type monitor-ring Router(config-logout-profile)# number 3005,3006 type overlay • type type—Denotes characteristicsto be associated with thisline. Type ? for list of options. Router(config-logout-profile)# number 3007,3008 type cw-overly Step 6 speed-dial speed-tag number [ label label ] [blf] Creates speed-dial definition. Example: Router(config-logout-profile)# speed-dial 1 2001 • speed-tag—Unique sequence number that identifies a speed-dial definition during configuration tasks. Range: 1 to 36. • number—Digitsto be dialed when the speed-dial button is pressed. Router(config-logout-profile)# speed-dial 2 2002 blf • label label—(Optional)String that containsidentifying text to be displayed next to the speed-dial button. Enclose the string in quotation marks if the string contains a space. • blf—(Optional) Enables Busy Lamp Field (BLF) monitoring for a speed-dial number. Sets a personal identification number (PIN) to be used by a phone user to disable the call blocking configuration for a Cisco Unified IP phone on which this profile is downloaded. pin number Example: Router(config-logout-profile)# pin 1234 Step 7 • number—Numeric string containing four to eight digits. Cisco Unified Communications Manager Express System Administrator Guide 735 Extension Mobility Configure a Logout Profile for an IP Phone Command or Action Purpose Step 8 privacy-button (Optional) Enables the privacy feature button on the IP phone. Example: Router(config-logout-profile)# privacy-button • Enable this command only on phones that share an octo-line directory number. • This command is supported in Cisco Unified CME 4.3 and later versions. end Exits to privileged EXEC mode. Example: Router(config-logout-profile)# end Step 9 Enable an IP Phone for Extension Mobility To enable the Extension Mobility feature on an individual Cisco Unified IP phone in Cisco Unified CME, perform the following steps. All SCCP Cisco Unified IP phones with displays that support URL provisioning for Feature buttons are supported by Extension Mobility, including the Cisco Unified Wireless IP Phone 7920, Cisco Unified Wireless IP Phone 7921, and Cisco IP Communicator. Note Restriction • Extension Mobility is not supported on Cisco Unified IP phones without phone screens. • Extension Mobility is not supported for analog devices. Before You Begin • HTTPserver is enabled on the Cisco Unified CME router.For configuration information, see Configure Cisco Unified CME for Extension Mobility, on page 730. • Logout profile to be assigned to a phone must be configured in Cisco Unified CME. • Cisco IP Communicator to be enabled for Extension Mobility must be already registered in Cisco Unified CME. Cisco Unified Communications Manager Express System Administrator Guide 736 Extension Mobility Enable an IP Phone for Extension Mobility SUMMARY STEPS 1. enable 2. configure terminal 3. ephone phone-tag 4. mac-address mac-address 5. type phone-type 6. logout-profile profile-tag 7. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 ephone phone-tag Enables phone configuration mode. Example: Router(config)# ephone 1 • phone-tag—Unique number that identifies this phone during configuration tasks. Range is 1 to maximum number supported phones, where maximum is platform and version dependent and defined by using the max-ephone command. mac-address mac-address Associates a physical phone with this ephone configuration. Example: Router(config-ephone)# mac-address 000D.EDAB.3566 Step 4 type phone-type Defines a phone type for the phone being configured. Example: Router(config-ephone)# type 7960 Step 5 Enables Cisco Unified IP phone for Extension Mobility and assigns a logout profile to this phone. logout-profile profile-tag Example: Router(config-ephone)# logout-profile 1 Step 6 • tag—Unique identifier of logout profile to be used when no phone user is logged in to this phone. This tag number corresponds to a tag number created when this logout profile was configured by using the voice logout-profile command. Cisco Unified Communications Manager Express System Administrator Guide 737 Extension Mobility Enable an IP Phone for Extension Mobility Command or Action Purpose end Exits to privileged EXEC mode. Example: Router(config-ephone)# end Step 7 Configure Extension Mobility for SIP Phones To prepare Extension Mobility for use with SIP phones, perform the following steps. Before You Begin • Cisco IOS Release 15.1(4)M. • Cisco Unified CME 8.6 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. ip http server 4. voice register global 5. url authentication url-address application-name password 6. exit 7. telephony-service 8. authentication credential application-name password 9. em keep-history 10. em logout time1 [time2] [time3] 11. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable Enter your password if prompted. Note configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Cisco Unified Communications Manager Express System Administrator Guide 738 Extension Mobility Configure Extension Mobility for SIP Phones Command or Action Purpose Enables the HTTP server on the Cisco Unified CME router which hosts the service URL for the Extension Mobility login and logout pages. ip http server Example: Router(config)# ip http server Step 3 voice register global Defines global voice register commands. Example: Router(config)# voice register global Step 4 Instructs phones to send HTTPrequests to the authentication server and specifies which credential to use in the requests. url authenticationurl-address application-name password Step 5 Example: Router(config-register-global)# url authentication • Required to support Automatic Clear Call history. • application-name—user name you choose and define in this command. http://192.0.2.0/CCMCIP/authenticate.asp secretname psswrd • password—password you define using this command. • URL—URL address for the authentication server in Cisco Unified CME is http://CMEIP Address/CCMCIP/authenticate.asp. exit Exits voice register global confiuration mode. Example: Router(config-register-global)# exit Step 6 telephony-service Enters telephony service configuration mode. Example: Router(config)# telephony-service Step 7 authentication credential application-name Specifies authorized credentials. Use credentials from Step 5. password Step 8 This step is needed only when you set the CME internal authentication server as your phone authentication server in Step 5. Note Example: Router(config-telephony)# authentication credential application-name password (Optional) Specifies that Extension Mobility will keep, and not automatically clear, call histories when userslog out from Extension Mobility phones. em keep-history Example: Router(config-telephony)# em keep-history Step 9 Default: Automatic Clear Call History is enabled. Note Cisco Unified Communications Manager Express System Administrator Guide 739 Extension Mobility Configure Extension Mobility for SIP Phones Command or Action Purpose (Optional) Defines up to three time-of-day timers for automatically logging out all Extension Mobility users. em logout time1 [time2] [time3] Example: Router(config-telephony)# em logout 19:00 24:00 Step 10 • time—Time of day after which logged-in users are automatically logged out from Extension Mobility. Range: 00:00 to 24:00 on a 24-hour clock. end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 11 Enable SIP Phones for Extension Mobility To enable the Extension Mobility feature on a SIP phone in Cisco Unified CME, perform the following steps. All Cisco Unified SIP phones with displays that support URL provisioning are supported by Extension Mobility. Note Before You Begin • HTTP server is enabled on the Cisco Unified CME router. • Default logout and user profiles to be assigned to a phone must be configured in Cisco Unified CME. • The voice register directory numbers in default logout and user profiles must be configured in Cisco Unified CME. To configureSIPdirectory numbers,see Cisco Unified Communications Manager Express Command Reference Guide. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register pool pool-tag 4. id mac mac-address 5. type phone-type 6. logout-profile profile-tag 7. end Cisco Unified Communications Manager Express System Administrator Guide 740 Extension Mobility Enable SIP Phones for Extension Mobility DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 voice register pool pool-tag Enables phone configuration mode. Example: Router(config)# voice register pool 22 • pool-tag—Unique number that identifies this register pool during configuration tasks. Range is 1 to 42. Step 4 id mac mac-address Associates a physical phone with this ephone configuration. Example: Router(config-register-pool)# id mac 0123.4567.89AB • mac-address—mac address of the physical phone type phone-type Defines a phone type for the phone being configured. Example: Router(config-register-pool)# type 7970 Step 5 Enables Cisco UnifiedSIPphone for Extension Mobility and assigns a logout profile to this phone. logout-profile profile-tag Example: Router(config-register-pool)# logout-profile 22 Step 6 • profile tag—Unique identifier of a logout profile to be used when no phone user is logged in to this phone. This tag number correspondsto a tag number created when thislogout profile was configured by using the voice logout-profile command. end Exits to privileged EXEC mode. Example: Router(config-ephone)# end Step 7 Configure a User Profile To configure a user profile for a phone user who logsinto a Cisco Unified IPphone that is enabled for Extension Mobility, perform the following steps. Cisco Unified Communications Manager Express System Administrator Guide 741 Extension Mobility Configure a User Profile Templates created using the ephone-template and ephone-dn-template commands can be applied to a user profile for Extension Mobility. Note Restriction • For button appearance, Extension Mobility associates directory numbers, then speed-dial definitions in the logout profile or user profile to phone buttons. The sequence in which directory numbers are associated is based on line type and ring behavior as follows: first normal, then silent ring, beep ring, feature ring, monitor ring, and overlay, followed by speed dials. If the profile contains more directory numbers and speed-dial numbers than there are buttons on the physical phone to which the profile is downloaded, not all numbers are downloaded to buttons. • The first number to be configured for line appearance cannot be a monitored directory number. • The user name parameter of any authentication credential must be unique. Do not use the same value for a user name when you configure any two or more authentication credentialsin Cisco Unified CME, such as the user name for any Cisco Unified CME GUI account and the user name in a logout or user profile for Extension Mobility. Before You Begin • All directory numbers to be included in a logout profile or user profile must be already configured in Cisco Unified CME. For configuration information, see Configure Phones to Make Basic Call, on page 315. • For Automatic Logout, Cisco Unified CME 4.3 or a later version. • For Privacy on extension mobility phones, Cisco Unified CME 4.3 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. voice user-profile profile-tag 4. user name password password 5. number number type type 6. speed-dial speed-tag number [ label label ] [blf] 7. pin number 8. max-idle-time minutes 9. privacy-button 10. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Cisco Unified Communications Manager Express System Administrator Guide 742 Extension Mobility Configure a User Profile Command or Action Purpose Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice user-profile configuration mode for configuring a user profile for Extension Mobility. voice user-profile profile-tag Example: Router(config)# voice user-profile 1 Step 3 • profile-tag—Unique number that identifies this profile during configuration tasks. Range: 1 to three times the maximum number supported phones, where maximum is platform dependent. Type ? to display value. Creates credential to be authenticated by Cisco Unified CME before allowing the phone user to log into a Cisco Unified IP phone phone enabled for Extension Mobility. user name password password Example: Router(config-user-profile)# user me password pass123 Step 4 • name—Unique alphanumeric string to identify a user for this authentication credential only. • password—Password for authorized user. Step 5 number number type type Creates line definition. Example: Router(config-user-profile)# number 2001 type silent-ring • number—Directory number to be associated with and displayed next to a button on a phone that is configured with this profile. • [, ...number]—(Optional) For overlay lines only, with or without call waiting. The directory number that is far left in the command Router(config-user-profile)# number 2002 type beep-ring Router(config-user-profile)# number list is given the highest priority. Can contain up to 25 numbers. Individual numbers must be separated by commas (,) 2003 type feature-ring Router(config-user-profile)# number 2004 type monitor-ring • type type—Denotes characteristics to be associated with this line. Type ? for list of options. Router(config-user-profile)# number 2005,2006 type overlay Router(config-user-profile)# number 2007,2008 type cw-overly speed-dial speed-tag number [ label label ] Creates speed-dial definition. [blf] Step 6 • speed-tag—Unique sequence number that identifies a speed-dial definition during configuration tasks. Range: 1 to 36. Example: Router(config-user-profile)# speed-dial 1 3001 • number—Digits to be dialed when the speed-dial button is pressed. • label label—(Optional) String that contains identifying text to be displayed next to the speed-dial button. Enclose the string in quotation marks if the string contains a space. Router(config-user-profile)# speed-dial 2 3002 blf Cisco Unified Communications Manager Express System Administrator Guide 743 Extension Mobility Configure a User Profile Command or Action Purpose • blf—(Optional) Enables Busy Lamp Field (BLF) monitoring for a speed-dial number. Sets a personal identification number (PIN) to be used by a phone user to disable the call blocking configuration for a Cisco Unified IP phone on which this profile is downloaded. pin number Example: Router(config-user-profile)# pin 12341 Step 7 • number—Numeric string containing four to eight digits. (Optional) Creates an idle-duration timer for automatically logging out an Extension Mobility user. max-idle-time minutes Example: Router(config-user-profile)# max-idle-time 30 Step 8 • This command is supported in Cisco Unified CME 4.3 and later versions. • minutes—Maximum number of minutes after which a user islogged out from an idle Extension Mobility phone. Range:1 to 9999. Step 9 privacy-button (Optional) Enables the privacy feature button on the IP phone. Example: Router(config-user-profile)# privacy-button • Enable this command only on phones that share an octo-line directory number. • This command is supported in Cisco Unified CME 4.3 and later versions. end Exits to privileged EXEC mode. Example: Router(config-user-profile)# end Step 10 Configuration Examples for Extension Mobility Example for Configuring Extension Mobility for Use with SIP Phones The following example shows a sample configuration for enabling Extension Mobility for use withSIPphones: Router#en Router#conf t Enter configuration commands, one per line. End with CNTL/Z. Router(config)#ip http server Router(config)#voice register global Router(config-register-global)#$.2.0/CCMCIP/authenticate.asp admin password Router(config-register-global)#exit Router(config)#telephony-service Router(config-telephony)#authentication credential admin password Cisco Unified Communications Manager Express System Administrator Guide 744 Extension Mobility Configuration Examples for Extension Mobility Router(config-telephony)#em keep-history Router(config-telephony)#em logout 19:00 Router(config-telephony)#end Example for Configuring SIP Phones for Use with Extension Mobility The following example shows a sample configuration for enabling a SIP phone to use Extension Mobility: Router#en Router#conf t Enter configuration commands, one per line. End with CNTL/Z. Router#en Router#conf t Enter configuration commands, one per line. End with CNTL/Z. Router(config)#voice register pool 1 Router(config-register-pool)#id mac 12.34.56 Router(config-register-pool)#type 7960 Router(config-register-pool)#logout-profile 22 Enabling extension mobility will replace current phone configuration with logout profile, continue?? [yes]: y Router(config-register-pool)#end Example for Configuring Logout Profile The following example shows the configuration for a logout profile that defines the default appearance for a Cisco Unified IP phone that is enabled for Extension Mobility. Which lines and speed-dial buttons in this profile are configured on a phone depends on the phone type. For example, for a Cisco Unified IP Phone 7970, all buttons are configured according to logout profile1. However, if the phone is a Cisco Unified IP Phone 7960, all six lines are mapped to phone buttons and the speed dial is ignored because there is no button available for speed dial. voice logout-profile 1 pin 9999 user 23C2-8 password 43214 number 3001 type silent-ring number 3002 type beep-ring number 3003 type feature-ring number 3004 type monitor-ring number 3005,3006 type overlay number 3007,3008 type cw-overly speed-dial 1 2000 speed-dial 2 2001 blf Example for Enabling an IP Phone for Extension Mobility The following example shows the ephone configurations for three IP phones. All three phones are enabled for Extension Mobility and share the same logout profile number 1, to be downloaded when these phones boot and when no phone user is logged into the phone. ephone 1 mac-address 000D.EDAB.3566 type 7960 logout-profile 1 ephone 2 mac-address 0012.DA8A.C43D type 7970 logout-profile 1 Cisco Unified Communications Manager Express System Administrator Guide 745 Extension Mobility Example for Configuring SIP Phones for Use with Extension Mobility ephone 3 mac-address 1200.80FC.9B01 type 7911 logout-profile 1 Example for Configuring User Profile The following example shows the configuration for a user profile to be downloaded when a phone user logs into a Cisco Unified IP phone that is enabled for Extension Mobility. Which lines and speed-dial buttons in this profile are configured on a phone after the user logs in depends on the phone type. For example, if the user logs into a Cisco Unified IP Phone 7970, all buttons are configured according to voice-user profile1. However, if the phone user logs into a Cisco Unified IPPhone 7960, all six lines are mapped to phone buttons and the speed dial is ignored because there is no button available for speed dial. voice user-profile 1 pin 12345 user me password pass123 number 2001 type silent-ring number 2002 type beep-ring number 2003 type feature-ring number 2004 type monitor-ring number 2005,2006 type overlay number 2007,2008 type cw-overly speed-dial 1 3001 speed-dial 2 3002 blf Where to Go Next • If you created a new or modified an existing logout or user profile, you must restart the phones to propagate the changes. See Reset and Restart Cisco Unified IP Phones, on page 397. • If you enabled one or more Cisco Unified IPphonesfor Extension Mobility, generate a new configuration file and restart the phones. See Configuration Files for Phones, on page 387. Feature Information for Extension Mobility The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Table 51: Feature Information for Extension Mobility Feature Name Cisco Unified CME Version Modification Adds new MIB objects to monitor Cisco Unified SCCP IP EM phones. MIB Support for Extension 9.0 Mobility in Cisco Unified SCCP IP Phones Support for SIP phones 8.6 Adds support for SIP phones. Cisco Unified Communications Manager Express System Administrator Guide 746 Extension Mobility Example for Configuring User Profile Feature Name Cisco Unified CME Version Modification Adds support for the following: • Automatic Logout, including: • Configurable time-of-day timers for automatically logging out all Extension Mobility users. • Configurable idle-duration timer for logging out an individual user from an idle Extension Mobility phone. • Automatic Clear Call History when a user logs out from Extension Mobility. Extension Mobility Enhancement 7.0/4.3 Adds a phone user interface allowing Extension Mobility users to configure their own speed-dial settings directly on the phone. Phone User-Interface for Speed 7.0/4.3 Dial Provides the benefit of phone mobility for end users by enabling the user to log into any local Cisco Unified IP Phone that is enabled for Extension Mobility. Extension Mobility 4.2 Cisco Unified Communications Manager Express System Administrator Guide 747 Extension Mobility Feature Information for Extension Mobility Cisco Unified Communications Manager Express System Administrator Guide 748 Extension Mobility Feature Information for Extension Mobility CHAPTER 22 Fax Relay This chapter describes how to enable Skinny Client Control Protocol (SCCP) Fax Relay for analog foreign exchange service (FXS) ports under the control of Cisco Unified CME. • Prerequisites for Fax Relay, page 749 • Restrictions for Fax Relay, page 750 • Information About Fax Relay, page 750 • Configure Fax Relay, page 753 • Configuration Examples for Fax Relay, page 754 • Feature Information for Fax Relay, page 755 Prerequisites for Fax Relay • Cisco Unified CME 4.0(3) or a later version. • If your voice gateway is a separate router than the Cisco Unified CME router, an IP voice image of Cisco IOS Release 12.4(11)T or later is required. • SCCP Telephony Control (STC) application is enabled. Cisco Unified Communications Manager Express System Administrator Guide 749 Note • For Cisco Unified CME versions before Cisco Unified CME 4.0(3), there are two manually-controlled options for setting up facsimiles: ◦Fax Gateway Protocol Configure the Cisco VG224, FXS port, or analog telephone adaptor (ATA) to use H.323 or Session Initiation Protocol (SIP) with a specific fax relay protocol. See Fax, Modem, and Text Support over IP Configuration Guide. ◦G.711 Fax Pass-Through with SCCP This is the default setup for facsimile on the Cisco VG224 and FXS ports before Cisco Unified CME 4.0(3). See Fax, Modem, and Text Support over IP Configuration Guide. Restrictions for Fax Relay • RFC2833 dual tone multifrequency (DTMF) digit relay under Cisco Unified CME for SCCP FXS ports is not supported. • SCCP FXS ports under Cisco Unified CME control do not natively support RFC2833 DTMF-relay. However, Cisco Unified CME can support conversion of DTMFdigitsto and from RFC2833 DTMF-relay on its H323 and SIP interfaces when used with SCCP-controlled FXS ports. • Cisco Fax Relay is only supported on those Cisco IOS gateways and network modules listed in Table 52: Supported Gateways, Modules, and VICs for Fax Relay , on page 752. Information About Fax Relay Fax Relay and Equipment • The fax relay feature supports the use of existing customer premises equipment (CPE) in voice networks by allowing legacy analog phones attached to a Cisco IOS gateway to be controlled by Cisco Unified CME, and by providing feature interoperability between analog and IP endpoints. • The voice gateway can be the same router that is being used for Cisco Unified CME or it may be a separate router (for example, the Cisco VG224). • The fax relay feature facilitatesreplacement of thePSTN time-division multiplexing (TDM) infrastructure with VoIP. Feature Design of Cisco Fax Relay Cisco Fax Relay is a proprietary fax relay implementation that uses Real-time Transport Protocol (RTP) to transport fax data. It is the default fax relay type on Cisco voice gateways and the only supported fax option Cisco Unified Communications Manager Express System Administrator Guide 750 Fax Relay Restrictions for Fax Relay for Cisco Unified CME 4.0(3) and later versions. The fax relay feature provides enhanced supplementary feature capability on analog ports connected to a Cisco integrated servicesrouter (ISR) or Cisco VG224 analog gateway. Calls through the analog FXS ports are controlled by the Cisco Unified CME system. Before the introduction of SCCP-enhanced features, SCCP gateways supported fax pass-through only. SCCP-enhanced features add support for Cisco Fax Relay and Super Group 3 (SG3) to G3 fax relay. This feature allows the fax stream between two SG3 fax machines to negotiate down to G3 speeds (less than 14.4 kbps) allowing SG3 fax machines to interoperate over fax relay with G3 fax machines. The SCCP telephony control (STC) application on the Cisco voice gateway presents the locally attached analog telephones as individual endpoints to the call-control system, which allows the analog phones to be controlled in the same way as IP phones. With this capability, gateway-attached endpoints share the same telephony features that are available on IPphones directly connected to Cisco Unified CME.SCCP-enhanced features provide analog endpoint to analog endpoint interoperability within the IP telephony network. Figure 26: Cisco Unified CME Fax Relay Deployment, on page 751 shows a multisite deployment of the fax relay feature in a Cisco Unified CME topology. Figure 26: Cisco Unified CME Fax Relay Deployment For information on configuring gateway-controlled fax relay features, see ConfigureFax Relay, on page 753. Supported Gateways, Modules, and Voice Interface Cards for Fax Relay Table 52: Supported Gateways, Modules, and VICs for Fax Relay , on page 752 lists supported gateways, modules, and voice interface cards (VICs). Cisco Unified Communications Manager Express System Administrator Guide 751 Fax Relay Feature Design of Cisco Fax Relay Table 52: Supported Gateways, Modules, and VICs for Fax Relay Network Modules and VICs Expansion Modules Gateways Extension Modules • VIC2-2FXS • VIC-4FXS/DID • VIC2-2BRI-NT/TE • NM-HD-1V • NM-HD-2V • NM-HD-2VE — • Cisco 2801 • Cisco 2811 • Cisco 2821 • Cisco 2851 • Cisco 3825 • Cisco 3845 — • EVM-HD-8FXS/DID • EM-3FXS/4FXO • EM-HDA-8FXS • EM-4BRI-NT/TE • Cisco 2801 • EVM-HD • Cisco 2821 • Cisco 2851 • Cisco 3825 • Cisco 3845 • VIC2-2FXS • VIC-4FXS/DID • VIC2-2BRI-NT/TE • NM-HDV2 • NM-HDV2-1T1/E1 • NM-HDV2-2T1/E1 — • Cisco 2801 • Cisco 2811 • Cisco 2821 • Cisco 2851 • Cisco 3825 • Cisco 3845 — — — • Cisco VG 224 Cisco Unified Communications Manager Express System Administrator Guide 752 Fax Relay Feature Design of Cisco Fax Relay Configure Fax Relay Configure Fax Relay on SCCP Phones SUMMARY STEPS 1. enable 2. configure terminal 3. voice service voip 4. fax protocol cisco 5. fax-relay sg3-to-g3 6. exit DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice service configuration mode and specifies VoIP encapsulation. voice service voip Example: Router(config)# voice service voip Step 3 Specifies the Cisco-proprietary fax protocol as the fax protocol for SCCP analog endpoints. fax protocol cisco Example: Router(config-voi-serv)# fax protocol cisco Step 4 • This command is enabled by default. • This is the only supported option for Cisco Unified CME 4.0(3) and later versions. (Optional) Enablesthe fax stream between twoSG3 fax machines to negotiate down to G3 speeds. fax-relay sg3-to-g3 Example: Router(config-voi-serv)# fax relay sg3-to-g3 Step 5 Cisco Unified Communications Manager Express System Administrator Guide 753 Fax Relay Configure Fax Relay Command or Action Purpose exit Exits the current configuration mode. Example: Router(config-voi-serv)# exit Step 6 Verify and Troubleshoot Fax Relay Configuration To verify the CiscoFax Relay configuration, use the show-running config command.Sample output islocated in the Example for Configuring Fax Relay, on page 754. Use the following commands to verify and troubleshoot SCCP gateway-controlled Fax Relay: • show voice call summary—Displays fax relay voice port settings. • show voice dsp—Displays fax relay digital signal processor (DSP) channel status. • debug voip application stcapp all— Displays SCCP telephony control (STC) application fax relay information. • debug voip dsm all—Displays fax relay DSP stream manager (DSM) messages. • debug voip dsmp all—Displays fax relay distributed stream media processor (DSMP) messages. • debug voip hpi all—Displays gateway DSP fax relay information on RTP packet events. • debug voipvtspall—Displays gateway voice telephony service provider (VTSP) debugging information for fax calls. For more information on these and other commands, see Cisco IOS Voice Command Reference, Cisco Unified Communications Manager Express Command Reference, and Cisco IOS Configuration Fundamentals Command Reference. Note Configuration Examples for Fax Relay Example for Configuring Fax Relay voice service voip fax-relay sg3-to-g3 ephone-dn 44 number 1234 name fax machine ephone 33 mac-address 1111.2222.3333 Cisco Unified Communications Manager Express System Administrator Guide 754 Fax Relay Verify and Troubleshoot Fax Relay Configuration button 1:44 type anl Feature Information for Fax Relay The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Table 53: Feature Information for Cisco Fax Relay Feature Name Cisco Unified CME Version Feature Information Enables Fax Relay on analog FXS ports on Cisco IOSvoice gateways under the control of Cisco Unified CME. Fax Relay 4.0(3) Cisco Unified Communications Manager Express System Administrator Guide 755 Fax Relay Feature Information for Fax Relay Cisco Unified Communications Manager Express System Administrator Guide 756 Fax Relay Feature Information for Fax Relay CHAPTER 23 Feature Access Codes • Information About Feature Access Codes, page 757 • Configure Feature Access Codes, page 759 • Verify Feature Access Codes, page 760 • Configuration Examples for Feature Access Codes, page 761 • Feature Information for Feature Access Codes, page 761 Information About Feature Access Codes Feature Access Codes Feature Access Codes (FACs) are special patterns of characters that are dialed from a telephone keypad to invoke particular features.For example, a phone user might press **1, then press 2345 to forward all incoming calls to extension 2345. Typically, FACs are invoked using a short sequences of digits that are dialed using the keypad on an analog phone, while IP phone users select softkeys to invoke the same features. In Cisco Unified CME 4.0 and later, the same FACs that are available for analog phones can be enabled on IP phones. This allows phone users to select a particular feature or activate/deactivate a function in the same manner regardless of phone type. FACs are disabled on IP phones until they are explicitly enabled. You can enable all standard FACs for all SCCP phones registered in Cisco Unified CME or you can define a custom FAC or alias to enable one or more individual FACs. All FACs except the call-park FAC are valid only immediately after a phone is taken off hook. The call-park FAC is considered a transfer to a call-park slot and therefore is only valid after the Transfer softkey (IPphones) or hookflash (analog phones) is used to initiate a transfer. Directory Numbers configured on the Unified CME routershould not overlap with the numbers you assign for FAC Standard or FAC Custom in a FAC configuration. Also, ensure that the FAC code always starts with an asterisk, followed by digits. Note Cisco Unified Communications Manager Express System Administrator Guide 757 Table 54: Standard Feature Access Codes, on page 758 contains a list of the standard predefined FACs. Table 54: Standard Feature Access Codes Standard FAC Description **1 plus optional extension number Call forward all. **2 Call forward all cancel. **3 Pick up local group. Pick up a ringing call in the specified pickup group. Specified pickup group must already configured in Cisco Unified CME. **4 plus group number **5 plus extension number Pick up direct extension. Call park, if the phone user has an active call and if the phone user pressesthe Transfersoftkey (IPphone) or hookflash (analog phone) before dialing thisFAC. Target park slot must be already configured in Cisco Unified CME. **6 plus optional park-slot number **7 Do not disturb. **8 Redial. **9 Dial voice-mail number. Join ephone-hunt group. If multiple hunt groups have been created that allow dynamic membership, the hunt group to be joined is identified by its pilot number. *3 plus hunt group pilot number Activate or deactivate hunt group logout functionality to toggle between ready/not-ready status of an extension when the hunt group agent is off-hook. *4 Activate or deactivate phone-level hunt group logout to toggle between ready/not-ready status of all extensions on a individual phone that is a member of an ephone hunt group when the phone is idle. *5 *6 Dials the voice-mail number. Leave ephone-hunt group. Telephone or extension number must already be configured as a dynamic member of a hunt group. #3 Cisco Unified Communications Manager Express System Administrator Guide 758 Feature Access Codes Feature Access Codes Configure Feature Access Codes To enable standard FACs or create custom FACs, perform the following steps: SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. fac {standard | custom {alias alias-tag custom-fac to existing-fac [extra-digits]} | feature custom-fac}} 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 3 fac {standard | custom {alias alias-tag Enables standard FACs or creates a custom FAC or alias. custom-fac to existing-fac [extra-digits]} | feature custom-fac}} Step 4 • standard—Enables standard FACs for all phones. Example: Router(config-telephony)# fac custom callfwd *#5 • custom—Creates a custom FAC for a FAC type. • alias—Creates a custom FAC for an existing FAC or a existing FAC plus extra digits. • alias-tag—Unique identifying number for this alias. Range: 0 to 9. • custom-fac—User-defined code to be dialed using the keypad on an IP or analog phone. Custom FAC can be up to 256 characters long and contain numbers 0 to 9 and * and #. • to—Maps custom FAC to specified target. • existing-fac—Already configured custom FAC that is automatically dialed when the phone user dials the custom FAC being configured. Cisco Unified Communications Manager Express System Administrator Guide 759 Feature Access Codes Configure Feature Access Codes Command or Action Purpose • extra-digits—(Optional) Additional digitsthat are automatically dialed when the phone user dials the custom FAC being configured. • feature—Predefined alphabetic string that identifies a particular feature or function. Type ? for a list. end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 5 Verify Feature Access Codes To verify the FAC configuration, perform the following step. show telephony-service fac Example: This command displays a list of FACs that are configured on the Cisco Unified CME router. The following example shows the output when standard FACs are enabled: Router# show telephony-service fac telephony-service fac standard callfwd all **1 callfwd cancel **2 pickup local **3 pickup group **4 pickup direct **5 park **6 dnd **7 redial **8 voicemail **9 ephone-hunt join *3 ephone-hunt cancel #3 ephone-hunt hlog *4 ephone-hunt hlog-phone *5 trnsfvm *6 The following example shows the output when custom FACs are configured: Router# show telephony-service fac telephony-service fac custom callfwd all #45 alias 0 #1 to **4121 alias 1 #2 to **4122 alias 4 #4 to **4124 Cisco Unified Communications Manager Express System Administrator Guide 760 Feature Access Codes Verify Feature Access Codes Configuration Examples for Feature Access Codes Example for Enabling Standard FACs for All Phones The following example shows how to enable standard FACs for all phones: Router# telephony-service Router(config-telephony)# fac standard fac standard is set! Router(config-telephony)# The following example shows how the standard FAC for the Call Forward All feature is changed to a custom FAC (#45). Then an alias is created to map a second custom fac to #45 plus an extension (1111). The custom FAC (#44) allows the phone user to press #44 to forward all calls to extension 1111, without requiring the phone user to dial the extra digits that are the extension number. Router# telephony-service Router(config-telephony)# fac custom callfwd all #45 fac callfwd all code has been configured to #45 Router(config-telephony)# fac custom alias 0 #44 to #451111 fac alias0 code has been configurated to #44! alias0 map code has been configurated to #451111! The following example shows how to define an alias for the group pickup of group 123. The alias substitutes the digits #4 for the standard FAC for group pickup (**4) and adds the group number (123) to the dial pattern. Using this custom FAC, a phone user can dial #4 to pick up a ringing call in group 123, instead of dialing the standard FAC **4 plus the group number 123. Router# telephony-service Router(config-telephony)# fac custom alias 5 #4 to **4123 Feature Information for Feature Access Codes The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Table 55: Feature Information for Feature Access Codes Feature Name Cisco Unified CME Version Feature Information FAC for Transfer to Voice Mail was added. Transfer to Voice Mail. 7.0/4.3 Cisco Unified Communications Manager Express System Administrator Guide 761 Feature Access Codes Configuration Examples for Feature Access Codes Feature Name Cisco Unified CME Version Feature Information Feature Access Codes (FACs) 4.0 FACs were introduced. Cisco Unified Communications Manager Express System Administrator Guide 762 Feature Access Codes Feature Information for Feature Access Codes CHAPTER 24 Forced Authorization Code • Information About Forced Authorization Code, page 763 • Configure Forced Authorization Code, page 770 • Configuration Example for Forced Authorization Code, page 774 • Feature Information for Forced Authorization Code, page 775 Information About Forced Authorization Code Forced Authorization Code Overview Cisco Unified CME 8.5 allows you to manage call access and call accounting through theForced Authorization Code (FAC) feature. The FAC feature regulates the type of call a certain caller may place and forces the caller to enter a valid authorization code on the phone before the call is placed. FAC allows you to track callers dialing non-toll-free numbers, long distance numbers, and also for accounting and billing purposes. In Cisco Unified CME and Cisco Voice Gateways, devices and endpoints are logically partitioned into different logical partitioning class of restriction (LPCOR) groups. For example, IP phones, Analog phones, PSTN trunks, and IP (h323/SIP) trunks as shown in Figure 27: Forced Authorization Code Network Overview, on page 764, are partitioned into five LPCOR groups under the voice lpcor custom mode, such as: • voice lpcor custom • group 10 Manager • group 11 LocalUser • group 12 RemoteUser • group 13 PSTNTrunk Cisco Unified Communications Manager Express System Administrator Guide 763 • group 14 IPTrunk Figure 27: Forced Authorization Code Network Overview For each group, the LPCOR group policy of a routing endpoint is enhanced to define incoming calls from individual LPCOR groups that are restricted by FAC. A LPCOR group call to a destination is accepted only when a valid FAC is entered. FAC service for a routing endpoint is enabled through the service fac defined in a LPCOR group policy. For more information, see Enable Forced Authorization Code (FAC) on LPCOR Groups, on page 770. The following are the group policy rules applicable to the PSTNTrunk LPCOR group: • FAC is required by PSTNTrunk if a call is initiated from either LocalUser or RemoteUser group. • Any calls from Manager group are allowed to terminate to PSTNTrunk without restriction. • Any incoming callsfrom either IPTrunk orPSTNTrunk group are rejected and terminated toPSTNTrunk group. For information on configuring LPCOR groups and associating LPCOR group with different device types, see Call Restriction Regulations, on page 1101. FAC Call Flow FAC is required for an incoming call based on the LPCOR policy defined for the call destination. Once the authentication is finished, the success or failure status and the collected FAC digits are saved to the call detail records (CDRs). Calls are handled by a new built-in application authorization package which first plays a user-prompt for the caller to enter a username (in digits), then the application plays a passwd-prompt for the caller to collect the password (in digits). The collected username and password digits are then used forFAC,see DefineParameters for Authorization Package, on page 772. When FAC authentication is successful, the outgoing call setup is continued to the same destination. If FAC authentication fails, the call is then forwarded to the next destination. FAC operations are invoked to the call if FAC service is enabled in the next destination and no valid FAC status is saved for the call. Cisco Unified Communications Manager Express System Administrator Guide 764 Forced Authorization Code Forced Authorization Code Overview Any calls failing because of FAC blocking are disconnected with a LPCOR Q.850 disconnect cause code. Once theFAC is invoked for a call, the collected authorization digits and the authentication status information is collected by call active or call history records. You can retrieve the FAC information through the show call active voice and show call history voice commands. Forced Authorization Code Specification The authorization code used for call authentication must follow these specifications: • The authorization code must be in numeric (0 – 9) format. • A digit collection operation must be completed if either one of the following conditions occur: • maximum number of digits are collected • digit input times out • a terminating digit is entered Once digit collection is completed, the authentication is done by either the external Radius server or Cisco Unified CME or Cisco Voice Gateways by using AAA Login Authentication setup. For more information on AAA login authentication methods, see Configuring Authentication. When authentication is done by local Cisco Unified CME or Cisco Voice Gateways, the username ac-code password 0 password command is required to authenticate the collected authorization code digits. FAC data is stored through the CDR and new AAA fac-digits and fac-status attributes and are supported in a CDR STOPrecord. This CDR STOPrecord is formatted for file accounting, RADIUSorSyslog accounting purpose. FAC Requirement for Different Types of Calls Table 56: FAC Support for Different Types of Calls, on page 765 shows FAC support for different types of calls. Table 56: FAC Support for Different Types of Calls Types of Calls FAC Behavior for Different Calls A calls B. B requires A to enter a FAC. A is routed to B only when A enters a valid FAC. Basic Call When A (with no FAC) calls B, A is call forwarded to C: • No FAC is required when B enables Call Forward All or Call Forward Busy to C. • FAC is required on A when A is call forwarded to C. Call Forward All Call Forward Busy Cisco Unified Communications Manager Express System Administrator Guide 765 Forced Authorization Code Forced Authorization Code Overview Types of Calls FAC Behavior for Different Calls When A (with no FAC) calls B and A (with FAC) calls C: A calls B: • No FAC is required when A calls B. A is Call Forward No Answer (CFNA) to C. • FAC is required on A when A is call forward to C. Call Forward No Answer FAC is required, if B calls C and A, and A calls C. Example: A calls B. B answers the call. B initiates a blind transfer call to C. A is prompted to enter FAC. A is routed to C only if a valid FAC is entered by A. Call Transfer (Blind) Cisco Unified Communications Manager Express System Administrator Guide 766 Forced Authorization Code Forced Authorization Code Overview Types of Calls FAC Behavior for Different Calls 1 FAC is required if B calls C. FAC is not required when A calls C, Example: a A calls B. B answers the call and initiates a consultation transfer to C. b B is prompted to enter a FAC and B is not allowed to complete the call transfer when FAC is not completed. c B (the transfer call) is forwarded to C after a validFAC is entered. B completesthe transfer while the transfer call is still ringing on C. A is then transferred to C. 2 FAC is required if B calls C and A calls C. Example: a A calls B. B answers the call and initiates a consultation transfer to C. b B is prompted to enter a FAC and B is not allowed to complete the call transfer when FAC is not completed. c NoFAC is required to A, A is then transferred to C. 3 FAC is not required if B calls C but FAC is required if A calls C. Example: a A calls B, B answers the call. b B initiates a consultation transfer to C and completes the transfer. c No FAC required to A, A is then transferred to C. Call Transfer (Consultation) Transfer Complete at Alerting State Cisco Unified Communications Manager Express System Administrator Guide 767 Forced Authorization Code Forced Authorization Code Overview Types of Calls FAC Behavior for Different Calls 1 FAC is required when A calls C. Example: a A calls B, B answers the call and initiates a consultation transfer to C. b C answers the transfer call and B completes the transfer. c No FAC required to connect to A (including local hairpin calls because the call transfer is complete) and A is connected to C. Transfer Complete at Connected State 1 FAC is not invoked when a call is joined to a conference connection. 2 FAC is required between A and C, B and C. Example: a A calls B, B answers the call and initiates a conference call to C. b B enters a valid authorization code and is routed to C. c C answers the conference call and the conference is complete. d No FAC is required to connect to A and A is joined to a conference connection. Conference Call (Software/Adhoc) 1 FAC is not invoked for a caller to join the meetme conference. 2 FAC is required between A and C, B and C. Example: a C joins the meetme conference first. b No FAC is required if B joins the same meetme conference. c No FAC is required if C also joins the same meetme conference. Meetme Conference Cisco Unified Communications Manager Express System Administrator Guide 768 Forced Authorization Code Forced Authorization Code Overview Types of Calls FAC Behavior for Different Calls 1 FAC is not invoked for the parked call. 2 FAC is required if C calls A. Example: a A calls B, B answers the call and parks the caller on A. b C retrieves the parked call (A), no FAC is required to reach C, and C is connected to A. Call Park and Retrieval 1 FAC is required if A calls D. Example: a A calls B, B answers the call and parks the caller on A. b Parked call (A) is timed out from a call-park slot and is forwarded to D. c No FAC is required for D and the parked call (A) will ring on D. Call Park Restore 1 FAC is not provided if a caller picks up a group call. 2 FAC is required if C calls A. Example: a A calls B, A is ringing on B, and C attempts to pickup call A. b No FAC is required for C and C is connected to A. Group Pickup Single Number Redirection (SNR) FAC is not supported for an SNR call. FAC is not supported for a three-party call control (3pcc) outgoing call. Third Party Call Control (3pcc) Parallel Hunt Groups FAC is not supported on parallel hunt groups. Whisper intercom FAC is not supported for whisper intercom calls. Cisco Unified Communications Manager Express System Administrator Guide 769 Forced Authorization Code Forced Authorization Code Overview Configure Forced Authorization Code Enable Forced Authorization Code (FAC) on LPCOR Groups Authenticated FAC data is saved to a call-log from which the authorization code is collected. When a call-forward or blind transfer call scenario triggers a new call due to theSIPnotify feature, the same caller is required to enter the authorization code again for FAC authentication. Restriction A FAC pin code must be unique and not the same as an extension number. Cisco Unified CME, Cisco Unified SRST, and Cisco Voice Gateways will not validate whether a collected FAC pin code matches an extension number. Warning Before You Begin • You must enable the voice lpcor enable command before configuring FAC. • Trunks (IP and PSTN) must be associated with phones into different LPCOR groups. See Associate a LPCOR Policy with Analog Phone or PSTN Trunk Calls, on page 1114 for more information. SUMMARY STEPS 1. enable 2. configure terminal 3. voice lpcor enable 4. voice lpcor custom 5. group number lpcor-group 6. exit 7. voice lpcor policy lpcor-group 8. accept lpcor-group fac 9. service fac 10. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. Cisco Unified Communications Manager Express System Administrator Guide 770 Forced Authorization Code Configure Forced Authorization Code Command or Action Purpose configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enables LPCOR functionality on the Cisco Unified CME router. voice lpcor enable Example: Router(config)# voice lpcor enable Step 3 Defines the name and number of LPCOR resource groups on the Cisco Unified CME router. voice lpcor custom Example: Router(config)# voice lpcor custom Step 4 Step 5 group number lpcor-group Adds a LPCOR resource group to the custom resource list. Example: Router(cfg-lpcor-custom)#group 10 Manager • number—Group number of the LPCOR entry. Range: 1 to 64. • lpcor-group—String that identifies the LPCOR resource group. Router(cfg-lpcor-custom)#group 11 LocalUser Router(cfg-lpcor-custom)#group 12 RemoteUser Router(cfg-lpcor-custom)#group 13 PSTNTrunk Router(cfg-lpcor-custom)#group 14 IPTrunk exit Exits voice-service configuration mode. Example: Router(conf-voi-serv)# exit Step 6 Step 7 voice lpcor policy lpcor-group Creates a LPCOR policy for a resource group. Example: Router(cfg-lpcor-custom)#group 10 Manager • lpcor-group—Name of the resource group that you defined in Step 5. Router(cfg-lpcor-custom)#group 11 LocalUser Router(cfg-lpcor-custom)#group 12 RemoteUser Router(cfg-lpcor-custom)#group 13 PSTNTrunk Router(cfg-lpcor-custom)#group 14 IPTrunk Allows a LPCOR policy to accept calls associated with the specified resource group. accept lpcor-group fac Example: Router(cfg-lpcor-policy)# accept PSTNTrunk Step 8 • Default: Calls from other groups are rejected; calls from the same resource group are accepted. fac Router(cfg-lpcor-policy)# accept Manager fac • fac—Valid forced authorization code that the caller needs to enter before the call is routed to its destination. • Repeat this command for each resource group whose calls you want this policy to accept. Step 9 service fac Enables force authorization code service for a LPCOR group. Cisco Unified Communications Manager Express System Administrator Guide 771 Forced Authorization Code Enable Forced Authorization Code (FAC) on LPCOR Groups Command or Action Purpose Example: Router(cfg-lpcor-policy)#service fac • Default: No form of the service fac command is the default setting of a LPCOR group policy. end Returns to privileged EXEC mode. Example: Router(config-ephone)# end Step 10 Example: Router# show voice lpcor policy voice lpcor policy PSTNTrunk (group 13): service fac is enabled ( accept ) Manager (group 10) ( reject ) LocalUser (group 11) ( reject ) RemoteUser (group 12) ( accept ) PSTNTrunk (group 13) ( reject ) IPTrunk (group 14) Define Parameters for Authorization Package To define required parameters for user name and password, follow these steps: SUMMARY STEPS 1. enable 2. configure terminal 3. application 4. package auth 5. param passwd 6. param user-prompt filename 7. param passwd-prompt filename 8. param max-retries 9. param term-digit 10. param abort-digit 11. param max-digits 12. exit DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Cisco Unified Communications Manager Express System Administrator Guide 772 Forced Authorization Code Define Parameters for Authorization Package Command or Action Purpose Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 application Enters the application configuration mode. Example: Router(config)#application Router(config-app)# Step 3 package auth Enters package authorization configuration mode. Example: Router(config-app)#package auth Step 4 Character string that defines a predefined password for authorization. param passwd Example: Router(config-app)#package param passwd 12345 Step 5 Password digits collection is optional if password digits are predefined in the param passwd command. Note Allows you to enter the user name parameters required for package authorization for FAC authentication. param user-prompt filename Example: Router(config-app-param)#param user-prompt flash:en_bacd_enter_dest.au Step 6 • user-prompt filename — Plays an audio prompt requesting the caller to enter a valid username (in digits) for authorization. Allows you to enter the password parametersrequired for package authorization for FAC authentication. param passwd-prompt filename Example: Router(config-app-param)#param passwd-prompt flash:en_welcome.au Step 7 • passwd-prompt filename— Plays an audio prompt requesting the caller to enter a valid password (in digits) for authorization. Step 8 param max-retries Specifies number of attemptsto re-enter an account or a password. Example: Router(config-app-param)#param max-retries 0 • max-entries—Value ranges from 0-10, default value is 0. Cisco Unified Communications Manager Express System Administrator Guide 773 Forced Authorization Code Define Parameters for Authorization Package Command or Action Purpose Specifies digit for terminating an account or a password digit collection. param term-digit Example: Router(config-app-param)#param term-digit # Step 9 Specifiesthe digit for aborting username or password digit input. Default value is *. param abort-digit Example: Router(config-app-param)#param abort-digit * Step 10 Maximum number of digits in a username or password. Range of valid value: 1 - 32. Default value is 32. param max-digits Example: Router(config-app-param)#param max-digits 32 Step 11 exit Exits package authorization parameter configuration mode. Example: Router(conf-app-param)# exit Step 12 Configuration Example for Forced Authorization Code Example for Configuring Forced Authorization Code This section provides configuration example for Forced Authorization Code. ! gw-accounting aaa ! aaa new-model ! aaa authentication login default local aaa authentication login h323 local aaa authorization exec h323 local aaa authorization network h323 local ! aaa session-id common ! voice lpcor enable voice lpcor custom group 11 LocalUser group 12 AnalogPhone ! voice lpcor policy LocalUser service fac accept LocalUser fac accept AnalogPhone fac ! Cisco Unified Communications Manager Express System Administrator Guide 774 Forced Authorization Code Configuration Example for Forced Authorization Code voice lpcor policy AnalogPhone service fac accept LocalUser fac accept AnalogPhone fac ! application package auth param passwd-prompt flash:en_bacd_welcome.au param passwd 54321 param user-prompt flash:en_bacd_enter_dest.au param term-digit # param abort-digit * param max-digits 32 ! username 786 password 0 54321 ! voice-port 0/1/0 station-id name Phone1 station-id number 1235 caller-id enable ! voice-port 0/1/1 lpcor incoming AnalogPhone lpcor outgoing AnalogPhone ! dial-peer voice 11 pots destination-pattern 99329 port 0/1/1 ! ephone-dn 102 dual-line number 786786 label HussainFAC ! ! ephone 102 lpcor type local lpcor incoming LocalUser lpcor outgoing LocalUser device-security-mode none mac-address 0005.9A3C.7A00 type CIPC button 1:102 Feature Information for Forced Authorization Code The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Table 57: Feature Information for Forced Authorization Code Feature Name Cisco Unified CME Version Modification Forced Authorization Code 8.5 Introduced the FAC feature. Cisco Unified Communications Manager Express System Administrator Guide 775 Forced Authorization Code Feature Information for Forced Authorization Code Cisco Unified Communications Manager Express System Administrator Guide 776 Forced Authorization Code Feature Information for Forced Authorization Code CHAPTER 25 Headset Auto Answer • Information About Headset Auto Answer, page 777 • Configure Headset Auto Answer, page 779 • Configuration Example for Headset Auto Answer, page 780 • Feature Information for Headset Auto Answer, page 781 Information About Headset Auto Answer Auto Answering Calls Using a Headset In Cisco Unified CME 4.0 and later versions you can configure lines on specific phones to automatically connect to incoming calls when the headset key is activated. The phone cannot be busy with an active call and the headset key must be engaged to automatically answer calls. Incoming calls are automatically answered one by one on the phone as long as the headset light remains lit. For each ephone, you can specify one or more lines for headset auto answer. After a phone is configured for headset auto answer, the phone user must press the headset key to start auto answer. The headset light is lit to indicate that auto answer is active for the lines that are designated in the configuration. When the phone auto answers a call, a zip tone is played to alert the phone user that a call is present. To stop auto answer, the phone user presses the headset key again and the headset light goes out. At this time, the phone user can answer calls in a normal manner using the handset. Difference Between a Line and a Button Note that a line is similar to, but not exactly the same as, a button on the phone. A line represents a phone’s capability to make a call connection, so each button that can make a call connection becomes a line. (For example, unoccupied buttons or speed-dial buttons are not lines.) Note also that a line is not the same as an ephone-dn. A button with overlaid ephone-dnsis only one line, regardless of whether it hasseveral ephone-dns (extension numbers) associated with it. In most cases an ephone’s line numbers do match its button numbers, but in a few cases they do not. Cisco Unified Communications Manager Express System Administrator Guide 777 Figure 28: When is a Line the Same as a Button?, on page 778 illustrates a comparison of line numbers and button numbers for different types of ephone configurations. Figure 28: When is a Line the Same as a Button? Cisco Unified Communications Manager Express System Administrator Guide 778 Headset Auto Answer Difference Between a Line and a Button Configure Headset Auto Answer Enable Headset Auto Answer SUMMARY STEPS 1. enable 2. configure terminal 3. ephone phone-tag 4. headset auto-answer line line-number 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 ephone phone-tag Enters ephone configuration mode. Example: Router(config)# ephone 25 • phone-tag—Unique sequence number that identifies this ephone during configuration tasks. The maximum number of ephones for a particular Cisco Unified CME system is version- and platform-specific. For the range of values, see the CLI help. Specifies a line on an ephone that will be answered automatically when the headset button is depressed. headset auto-answer line line-number Example: Router(config-ephone)# headset auto-answer line 1 Step 4 • line-number—Number of the phone line that should be automatically answered. Repeat this command to add additional lines. Note end Returns to privileged EXEC mode. Example: Router(config-ephone)# end Step 5 Cisco Unified Communications Manager Express System Administrator Guide 779 Headset Auto Answer Configure Headset Auto Answer Verify Headset Auto Answer Step 1 Use the show running-config command to verify your configuration. Headset auto answer islisted in the ephone portion of the output. Router# show running-config ephone 1 headset auto-answer line 1 headset auto-answer line 2 headset auto-answer line 3 headset auto-answer line 4 username "Front Desk" mac-address 011F.92B0.BE03 speed-dial 1 330 label “Billing” type 7960 addon 1 7914 no dnd feature-ring keep-conference button 1f40 2f41 3f42 4:30 button 5:405 7m20 8m21 9m22 button 10m23 11m24 12m25 13m26 button 14m499 15:1 16m31 17f498 button 18s500 night-service bell Step 2 Use the show telephony-service ephone command to display only the ephone configuration portion of the running configuration. Configuration Example for Headset Auto Answer Example for Enabling Headset Auto Answer The following example enables headset auto answer on ephone 3 for line 1 (button 1) and line 4 (button 4). ephone 3 button 1:2 2:4 3:6 4o21,22,23,24,25 headset auto-answer line 1 headset auto-answer line 4 The following example enables headset auto answer on ephone 17 for line 2 (button 2), which has overlaid ephone-dns, and line 3 (button 3), which is an overlay rollover line. ephone 17 button 1:2 2o21,22,23,24,25 3x2 Cisco Unified Communications Manager Express System Administrator Guide 780 Headset Auto Answer Verify Headset Auto Answer headset auto-answer line 2 headset auto-answer line 3 The following example enables headset auto answer on ephone 25 for line 2 (button 3) and line 3 (button 5). In this case, the button numbers do not match the line numbers because buttons 2 and 4 are not used. ephone 25 button 1:2 3:4 5:6 headset auto-answer line 2 headset auto-answer line 3 Feature Information for Headset Auto Answer The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Table 58: Feature Information for Headset Auto Answer Feature Name Cisco Unified CME Version Feature Information Headset auto answer was introduced. Headset Auto Answer 4.0 Cisco Unified Communications Manager Express System Administrator Guide 781 Headset Auto Answer Feature Information for Headset Auto Answer Cisco Unified Communications Manager Express System Administrator Guide 782 Headset Auto Answer Feature Information for Headset Auto Answer CHAPTER 26 Intercom Lines • Information About Intercom Lines, page 783 • Configure Intercom Lines, page 786 • Configuration Examples for Intercom Lines, page 795 • Where to Go Next, page 795 • Feature Information for Intercom Lines, page 796 Information About Intercom Lines Intercom Auto-Answer Lines An intercom line is a dedicated two-way audio path between two phones. Cisco Unified CME supports intercom functionality for one-way and press-to-answer voice connections using a dedicated pair of intercom directory numbers on two phones that speed-dial each other. When an intercom speed dial button is pressed, a call is speed-dialed to the directory that is the other half of the dedicated pair. The called phone automatically answersthe call in speaker-phone mode with mute activated, providing a one-way voice path from the initiator to the recipient. A beep is sounded when the call is auto-answered to alert the recipient to the incoming call. To respond to the intercom call and open a two-way voice path, the recipient deactivates the mute function by pressing the Mute button or, on phones such as the Cisco Unified IP Phone 7910, lifting the handset. In Cisco CME 3.2.1 and later versions, you can deactivate the speaker-mute function on intercom calls. For example, if phone user 1 makes an intercom call to phone user 2, both users hear each other on connection when no-mute is configured. The benefit is that people who receive intercom calls can be heard without them having to disable the mute function. The disadvantage is that nearby background sounds and conversations can be heard the moment a person receives an intercom call, regardless of whether they are ready to take a call or not. Intercom lines cannot be used in shared-line configurations. If a directory number is configured for intercom operation, it must be associated with one IP phone only. The intercom attribute causes an IP phone line to operate as an autodial line for outbound calls and as an autoanswer-with-mute line for inbound calls. Figure 29: Intercom Lines, on page 784 shows an intercom between a receptionist and a manager. Cisco Unified Communications Manager Express System Administrator Guide 783 To prevent an unauthorized phone from dialing an intercom line (and creating a situation in which a phone automatically answers a nonintercom call), you can assign the intercom a directory number that includes an alphabetic character. No one can dial the alphabetic character from a normal phone, but the phone at the other end of the intercom can be configured to dial the number that contains the alphabetic character through the Cisco Unified CME router. For example, the intercom ephone-dns in Figure 29: Intercom Lines, on page 784 are assigned numbers with alphabetic characters so that only the receptionist can call the manager on his or her intercom line, and no one except the manager can call the receptionist on his or her intercom line. Note An intercom requires the configuration of two ephone-dns, one each on a separate phone. Figure 29: Intercom Lines Whisper Intercom When a phone user dials a whisper intercom line, the called phone automatically answers using speaker-phone mode, providing a one-way voice path from the caller to the called party, regardless of whether the called party is busy or idle. Unlike the standard intercom feature, this feature allows an intercom call to a busy extension. The calling party can only be heard by the recipient. The original caller on the receiving phone does not hear the whisper page. The phone receiving a whisper page displays the extension and name of the party initiating the whisper page and Cisco Unified CME plays a zipzip tone before the called party hears the caller's voice. If the called party wants to speak to the caller, the called party selects the intercom line button on their phone. The lamp for intercom buttons are colored amber to indicate one-way audio for whisper intercom and green to indicate two-way audio for standard intercom. You must configure a whisper intercom directory number for each phone that requires the Whisper Intercom feature. A whisper intercom directory number can place calls only to another whisper intercom directory Cisco Unified Communications Manager Express System Administrator Guide 784 Intercom Lines Whisper Intercom number. Calls between a whisper intercom directory number and a standard directory number or intercom directory number are rejected with a busy tone. This feature is supported in Cisco Unified CME 7.1 and later versions. For configuration information, see Configure Whisper Intercom on SCCP Phones, on page 788. SIP Intercom In Cisco Unified CME 8.8, the SIP Intercom feature is released as part of the 8.3(1) IP Phone firmware. The SIP intercom line provides a one-way voice path from the caller to the called phone. When a phone user dials the intercom line, the called phone automatically answers the call in speaker-phone mode with Mute activated. If the called SIP phone is busy with a connected call or with an outgoing call that has not been connected, the call is whispered into the called phone. As soon as the called phone auto-answers, the intercom call recipient has three options: • Listen to the one-way audio of the intercom caller without answering. • End the call by pressing the speaker-phone button or the EndCall softkey. • Press the intercom button to create a two-way voice path and respond to the intercom caller. If the called phone is busy when the intercom call arrives and a response is requested, the active call is put on hold and the outgoing call that is not connected yet is canceled before the intercom call is connected for a two-way voice path. The lamp for the intercom line button displays an amber light for one-way intercom and green for a two-way voice path. Note You should configure an intercom directory number to begin and end an intercom call for each phone that requires the Intercom feature. For configuration information, see Configure Intercom Call Option on SIP Phones, on page 792. However, a standard directory number without the intercom option configured can also place an intercom call. The called phone also has the option of responding to the call by pressing the intercom line button to establish a two-way voice path with the originator without the intercom option configured. Table 59: SIP-SCCP Interactions for the SIP Intercom Feature, on page 785 shows the supported SIP-SCCP interactions for the SIP Intercom feature. Table 59: SIP-SCCP Interactions for the SIP Intercom Feature Originator Terminator Intercom SIP normal line SIP intercom line Supported SIP intercom line SIP intercom line Supported SIP normal line SCCP whisper intercom line Not Supported SIP intercom line SCCP whisper intercom line Not Supported Cisco Unified Communications Manager Express System Administrator Guide 785 Intercom Lines SIP Intercom Originator Terminator Intercom SCCP normal line SIP intercom line Supported SCCP normal line SCCP whisper intercom line Not Supported SCCP whisper intercom line SIP intercom line Not Supported SCCP whisper intercom line SCCP whisper intercom line Supported SIP normal line SIP normal line Not Supported SIP intercom line SIP normal line Not Supported SCCP normal line SIP normal line Not Supported SCCP intercom line SIP normal line Not Supported SIP normal line SCCP normal line Not Supported SIP intercom line SCCP normal line Not Supported SCCP normal line SCCP normal line Not Supported SCCP intercom line SCCP normal line Not Supported Extension Number The extension number of an intercom line can be included in an extension mobility user-profile or extension mobility logout-profile. The BLF feature can define the extension number of an intercom line as a speed dial on a Cisco Unified CME phone, allowing the line status of the intercom line to be monitored. For configuration information, see Configure Extension Mobility for SIP Phones, on page 738. Configure Intercom Lines Configure an Intercom Auto-Answer Line on SCCP Phones To enable a two-way audio path between two phones, perform the following steps for each Cisco Unified SCCP IP phone at both ends of the two-way voice path. Cisco Unified Communications Manager Express System Administrator Guide 786 Intercom Lines Configure Intercom Lines Restriction • Intercom lines cannot be dual-line. • If a directory number is configured for intercom operation, it can be associated with only one Cisco Unified IP phone. • Each phone, at both ends of the two-way voice path, requires a separate configuration. SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-dn dn-tag 4. number number 5. name name 6. intercom extension-number [[barge-in [no-mute] | no-auto-answer | no-mute] [label label]] | label label] 7. exit 8. ephone phone-tag 9. button button-number: dn-tag [[button-number: dn-tag] ...] 10. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 ephone-dn dn-tag Enters ephone-dn configuration mode. Example: Router(config)# ephone-dn 11 • Do not use the dual-line keyword with this command. Intercom ephone-dns cannot be dual-line. Step 4 number number Assigns a valid intercom number. Example: Router(config-ephone-dn)# number A2345 • Using one or more alphabetic characters in an intercom number ensures that the number can only be dialed from the one other intercom number that is programmed to dial this number. The number cannot be dialed from a normal phone if it contains an alphabetic character. Cisco Unified Communications Manager Express System Administrator Guide 787 Intercom Lines Configure an Intercom Auto-Answer Line on SCCP Phones Command or Action Purpose Step 5 name name Sets a name to be associated with the ephone-dn. Example: Router(config-ephone-dn)# name intercom • This name is used for caller-ID displays and also shows up in the local directory associated with the ephone-dn. Defines the directory number that is speed-dialed for the intercom feature when this line is used. intercom extension-number[[barge-in[no-mute] |no-auto-answer |no-mute] [label label]] | label label] Step 6 Example: Router(config-ephone-dn)# intercom A2346 label Security exit Exits ephone-dn configuration mode. Example: Router(config-ephone-dn)# exit Step 7 ephone phone-tag Enters ephone configuration mode. Example: Router(config)# ephone 24 Step 8 Assigns a button number to the intercom ephone-dn being configured. button button-number: dn-tag [[button-number: dn-tag] ...] Step 9 Example: Router(config-ephone)# button 1:1 2:4 3:14 • Use the colon separator (:) between the button number and the intercom ephone-dn tag to indicate a normal ring for the intercom line. Exits ephone configuration mode and enters privileged EXEC mode. end Example: Router(config)# exit Step 10 Configure Whisper Intercom on SCCP Phones To enable the Whisper Intercom feature on a directory number, perform the following steps. Cisco Unified Communications Manager Express System Administrator Guide 788 Intercom Lines Configure Whisper Intercom on SCCP Phones Restriction • Single-line phone models, such as the Cisco Unified IP Phone 7906 or 7911, are not supported. • Whisper intercom directory numbers can place calls only to other whisper intercom numbers. • A directory number can be configured as either a regular intercom or a whisper intercom, not both. • Dual-line and octo-line directory numbers are not supported as intercom lines. • Only one intercom call, either incoming or outgoing, is allowed on the phone at one time. • Call features are not supported on intercom calls. Before You Begin • Cisco Unified CME 7.1 or a later version. • IP phones require SCCP 12.0 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-dn dn-tag 4. whisper-intercom [label string | speed-dial number [label string]] 5. end 6. show ephone-dn whisper DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters ephone configuration mode to create a directory number for a SCCP phone. ephone-dn dn-tag Example: Router(config)# ephone-dn 1 Step 3 whisper-intercom [label string | speed-dial Enables whisper intercom on a directory number. number [label string]] Step 4 Cisco Unified Communications Manager Express System Administrator Guide 789 Intercom Lines Configure Whisper Intercom on SCCP Phones Command or Action Purpose • labelstring—(Optional) Alphanumeric label that identifies the whisper intercom button. String can contain a maximum of 30 characters. Example: Router(config-ephone-dn)# whisper intercom • speed-dial number—(Optional) Telephone number to speed dial. end Exits to privileged EXEC mode. Example: Router(config-ephone-dn)# end Step 5 Displays information about whisper intercom ephone-dns that have been created. show ephone-dn whisper Example: Router# show ephone-dn whisper Step 6 The following example shows Whisper Intercom configured on extension 2004: ephone-dn 24 number 2004 whisper-intercom label "sales"! ! ! ephone 24 mac-address 02EA.EAEA.0001 button 1:24 Configure an Intercom Auto-Answer Line on SIP Phones To enable the Intercom Auto-Answer feature for Cisco Unified SIP IP phones, perform the following steps for each IP phone at both ends of the two-way voice path. Restriction • If a directory number is configured for intercom operation, it can be associated with only one Cisco Unified IP phone. • Each phone, at each end of the two-way voice path, requires a separate configuration. Before You Begin Cisco CME 3.4 or a later version. Cisco Unified Communications Manager Express System Administrator Guide 790 Intercom Lines Configure an Intercom Auto-Answer Line on SIP Phones SUMMARY STEPS 1. enable 2. configure terminal 3. voice register dn dn-tag 4. number number 5. auto-answer 6. exit 7. voice register pool pool-tag 8. id {mac address} 9. type phone-type 10. number tag dn dn-tag 11. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register dn configuration mode to define a directory number for a Cisco Unified SIP IP phone, intercom line, voice port, or an MWI. voice register dn dn-tag Example: Router(config-register-global)# voice register dn 1 Step 3 Step 4 number number Defines a valid number for the directory number being configured. Example: Router(config-register-dn)# number A5001 • To prevent non-intercom originators from manually dialing an intercom destination, the number string can contain alphabetic characters enabling the number to be dialed only by the Cisco Unified CME router and not from telephone keypads. Enablesthe Intercom Auto-Answer feature on the directory number being configured. auto-answer Example: Router(config-register-dn)# auto-answer Step 5 Cisco Unified Communications Manager Express System Administrator Guide 791 Intercom Lines Configure an Intercom Auto-Answer Line on SIP Phones Command or Action Purpose exit Exits voice register dn configuration mode. Example: Router(config-register-dn)# exit Step 6 Enters voice register pool configuration mode to set phone-specific parameters for a Cisco Unified SIP IP phone in Cisco Unified CME. voice register pool pool-tag Example: Router(config)# voice register pool 3 Step 7 Explicitly identifies a locally available individual Cisco Unified SIP IP phone to support a degree of authentication. id {mac address} Example: Router(config-register-pool)# id mac 0009.A3D4.1234 Step 8 Defines a phone type for the Cisco Unified SIP IP phone being configured. type phone-type Example: Router(config-register-pool)# type 7960-7940 Step 9 Associates a directory number with the Cisco UnifiedSIPIPphone being configured. number tag dn dn-tag Example: Router(config-register-pool)# number 1 dn 17 Step 10 Exits voice register pool configuration mode and enters privileged EXEC mode. end Example: Router(config-register-pool)# end Step 11 Configure Intercom Call Option on SIP Phones Restriction • The Intercom feature is not supported on single-line phones because the intercom line cannot be the primary line of a Cisco Unified CME SIP IP phone. • The intercom line cannot be shared among SIP phones. • FAC is not supported on a SIP intercom call because the keys are disabled. Cisco Unified Communications Manager Express System Administrator Guide 792 Intercom Lines Configure Intercom Call Option on SIP Phones Before You Begin • Cisco Unified CME 8.8 or a later version. • 8.3(1) phone firmware or a later version is installed on the Cisco Unified SIP IP phone. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register dn dn-tag 4. number number 5. intercom [speed-dial digit-string] [label label-text] 6. exit 7. voice register pool pool-tag 8. id {network address mask mask | ip address mask mask | mac address} 9. type phone-type 10. number tag dn dn-tag 11. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register dn configuration mode to define an extension for a SIP intercom line. voice register dn dn-tag Example: Router(config)# voice register dn 4 Step 3 Associates a telephone or extension number with a Cisco Unified SIP phone in a Cisco Unified CME system. number number Example: Router(config-register-dn)# number 4001 Step 4 intercom [speed-dial digit-string] [label Enables the intercom call option on a Cisco UnifiedSIPIPphone. label-text] Step 5 • (Optional) speed-dial—Enables the intercom line user to place a call to a pre-configured destination. If the speed dial Cisco Unified Communications Manager Express System Administrator Guide 793 Intercom Lines Configure Intercom Call Option on SIP Phones Command or Action Purpose Example: Router(config-register-dn)# intercom [speed-dial 4002] [label intercom4001] is not configured, it simply initiates a new call on the intercom line and waits for the user to dial the destination number. • (Optional) label label-text—String that contains identifying text to be displayed next to the speed dial button. Enclose the string in quotation marks if the string contains a space. Exits configuration mode to the next highest mode in the configuration mode hierarchy. exit Example: Router(config-register-dn)# exit Step 6 Enters voice register pool configuration mode to set phone-specific parameters for a Cisco Unified SIP phone in Cisco Unified CME. voice register pool pool-tag Example: Router(config)# voice register pool 3 Step 7 Explicitly identifies a locally available individual Cisco Unified SIP phone to support a degree of authentication. id {network address mask mask | ip address mask mask | mac address} Example: Router(config-register-pool)# id mac 0009.A3D4. Step 8 Defines a phone type for the Cisco Unified SIP phone being configured. type phone-type Example: Router(config-register-pool)# type 7940 Step 9 Associates a directory number tag with the Cisco Unified SIP IP phone being configured. number tag dn dn-tag Example: Router(config-register-pool)# number 1 dn 17 Step 10 end Exits to privileged EXEC mode. Example: Router(config-register-dn)# end Step 11 Cisco Unified Communications Manager Express System Administrator Guide 794 Intercom Lines Configure Intercom Call Option on SIP Phones Configuration Examples for Intercom Lines Example for Configuring Intercom Lines The following example shows an intercom between two Cisco Unified IPphones. In this example, ephone-dn 2 and ephone-dn 4 are normal extensions, while ephone-dn 18 and ephone-dn 19 are set as an intercom pair. Ephone-dn 18 is associated with line button 2 on Cisco Unified IP phone 4. ephone-dn 19 is associated with line button 2 on Cisco Unified IP phone 5. The two ephone-dns provide a two-way intercom between the two Cisco Unified IP phones. ephone-dn 2 number 5333 ephone-dn 4 number 5222 ephone-dn 18 number 5001 name “intercom” intercom 5002 barge-in ephone-dn 19 name “intercom” number 5002 intercom 5001 barge-in ephone 4 button 1:2 2:18 ephone 5 button 1:4 2:19 Example for Configuring SIP Intercom Support The following example shows SIP Intercom configured on extension 1001: voice register dn 1 number 1001 intercom [speed-dial 1002] [label intercom1001] voice register pool 1 id mac 001D.452D.580C type 7962 number 1 dn 2 number 2 dn 1 Where to Go Next If you are done modifying parameters for phones in Cisco Unified CME, generate a new configuration file and restart the phones. See Generate Configuration Files for Phones, on page 388. Cisco Unified Communications Manager Express System Administrator Guide 795 Intercom Lines Configuration Examples for Intercom Lines Paging The paging feature sets up a one-way audio path to deliver information to a group of phones at one time. For more information, see Paging, on page 857. Feature Information for Intercom Lines The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Table 60: Feature Information for Intercom Lines Feature Name Cisco Unified CME Version Feature Information Adds intercom support to Cisco Unified SIP IP phones connected to a Cisco Unified CME system. SIP Intercom 8.8 Introduces whisper intercom feature. Whisper Intercom 7.1 Adds intercom feature, with no-mute function, for supported Cisco Unified IP phones that are connected to a Cisco Unified CME router and running SIP. Intercom Lines 3.4 3.2.1 Introduces the no-mute function. 2.0 Introduces the Intercom feature. Cisco Unified Communications Manager Express System Administrator Guide 796 Intercom Lines Feature Information for Intercom Lines CHAPTER 27 Loopback Call Routing • Information About Loopback Call Routing, page 797 • Configure Loopback Call Routing, page 798 • Configuration Example for Loopback Call Routing, page 801 • Feature Information for Loopback Call Routing, page 802 Information About Loopback Call Routing Loopback Call Routing Loopback call routing in a Cisco Unified CME system is provided through a mechanism called loopback-dn, which provides a software-based limited emulation of back-to-back physical voice ports connected together to provide a loopback call-routing path for voice calls. Loopback call routing and loopback-dn restrictsthe passage of call-transfer and call-forwarding supplementary service requests through the loopback. Instead of passing these requests through, the loopback-dn mechanism attempts to service the requests locally. This allows loopback-dn configurations to be used in call paths where one of the external devices does notsupport call transfer or call forwarding (Cisco-proprietary or H.450-based). Control messages that request call transfer or call forwarding are intercepted at the loopback virtual port and serviced on the local voice gateway. If needed, this mechanism creates VoIP-to-VoIP call-routing paths. Loopback call routing may be used for routing H.323 calls to Cisco Unity Express. For information on configuring Cisco Unity Express, see the Cisco Unity Express documentation. A preferred alternative to loopback call routing was introduced in Cisco CME 3.1. This alternative blocks H.450-based supplementary service requests by using the following Cisco IOS commands: no supplementary-service h450.2, no supplementary-service h450.3, and supplementary-service h450.12. For more information, see Configure Call Transfer and Forwarding, on page 1178. Note Use of loopback-dn configurations within a VoIP network should be restricted to resolving critical network interoperability service problems that cannot otherwise be solved. Loopback-dn configurations are intended for use in VoIP network interworking where the alternative would be to make use of back-to-back-connected Cisco Unified Communications Manager Express System Administrator Guide 797 physical voice ports. Loopback-dn configurations emulate the effect of a back-to-back physical voice-port arrangement without the expense of the physical voice-port hardware. Because digitalsignal processors(DSPs) are not involved in loopback-dn arrangements, the configuration does notsupport interworking or transcoding between calls that use different voice codecs. In many cases, use of back-to-back physical voice ports that do involve DSPsto resolve VoIPnetwork interworking issuesis preferred, because it introducesfewer restrictions in terms of supported codecs and call flows. Loopback call routing requires two extensions (ephone-dns) to be separately configured, each as half of a loopback-dn pair. Ephone-dnsthat are defined as a loopback-dn pair can only be used for loopback call routing. In addition to defining the loopback-dn pair, you must specify preference, huntstop, class of restriction (COR), and translation rules. Configure Loopback Call Routing Enable Loopback Call Routing To enable loopback call-routing, perform the following stepsfor each ephone-dn that is part of the loopback-dn pair. Restriction Loopback-dns do not support T.38 fax relay. SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-dn dn-tag 4. number number [secondary number] [no-reg [both | primary ]] 5. caller-id {local | passthrough} 6. no huntstop 7. preference preference-order [secondary secondary-order] 8. cor {incoming | outgoing} cor-list-name 9. translate {called | calling} translation-rule-tag 10. loopback-dn dn-tag [forward number-of-digits | strip number-of-digits ] [ prefix prefix-digit-string ] [ suffix suffix-digit-string ] [retry seconds] [auto-con ] [codec {g711alaw | g711ulaw}] 11. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. Cisco Unified Communications Manager Express System Administrator Guide 798 Loopback Call Routing Configure Loopback Call Routing Command or Action Purpose configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters ephone-dn configuration mode, creates an ephone-dn, and optionally assigns it dual-line status. ephone-dn dn-tag Example: Router(config)# ephone-dn 15 Step 3 • dn-tag—Unique sequence number that identifies this ephone-dn during configuration tasks. Range is platform- and version-dependent. Ephone-dns used for loopback cannot be dual-line ephone-dns. Note number number [secondary number] Associates a number with this extension (ephone-dn). [no-reg [both | primary ]] Step 4 • number—String of up to 16 digitsthat represents a telephone or extension number to be associated with this ephone-dn. Example: Router(config-ephone-dn)# number 2001 • secondary—(Optional) Allows you to associate a second telephone number with an ephone-dn. • no-reg—(Optional) Specifies that this number should not register with the H.323 gatekeeper. The no-reg keyword indicates that only the secondary numbershould not register. Theno-regbothkeywordsindicate that both numbersshould not register, and theno-regprimary keywords indicate that only the primary number should not register. Specifies caller-ID treatment for outbound calls originated from the ephone-dn. The default if this command is not used is as follows. For transferred calls, caller-id {local | passthrough} Example: Router(config-ephone-dn)# caller-id local Step 5 caller ID is provided by the number and name fields from the outbound side of the loopback-dn. For forwarded calls, caller ID is provided by the original caller ID of the incoming call. Settings for the caller-id block command and translation rules on the outbound side are executed. • local—Passesthe local caller ID on redirected calls. Thisisthe preferred usage. • passthrough—Passes the original caller ID on redirected calls. Disables huntstop and allows call hunting behavior for an extension (ephone-dn). no huntstop Example: Router(config-ephone-dn)# no huntstop Step 6 preference preference-order [secondary Sets dial-peer preference for an extension (ephone-dn). secondary-order] Step 7 • preference-order—Preference order for the primary number associated with an extension (ephone-dn). Range is 0 to 10, where 0 is the highest preference and 10 is the lowest preference. Default is 0. Example: Router(config-ephone-dn)# preference 1 Cisco Unified Communications Manager Express System Administrator Guide 799 Loopback Call Routing Enable Loopback Call Routing Command or Action Purpose • secondary secondary-order—(Optional) Preference order for the secondary number associated with the ephone-dn. Range is 0 to 10, where 0 is the highest preference and 10 is the lowest preference. Default is 9. Applies a class of restriction (COR) to the dial peers associated with an extension. COR specifies which incoming dial peer can use which outgoing cor {incoming | outgoing} cor-list-name Example: Router(config-ephone-dn)# cor incoming corlist1 Step 8 dial peer to make a call. Each dial peer can be provisioned with an incoming and an outgoing COR list. For information about COR, see Dial Peer Configuration on Voice Gateway Routers. Selects an existing translation rule and applies it to a calling number or a number that has been called. This command enables the manipulation of translate {called | calling} translation-rule-tag Step 9 numbers as part of a dial plan to manage overlapping or nonconsecutive numbering schemes. Example: Router(config-ephone-dn)# translate called 1 • called—Translates the called number. • calling—Translates the calling number. • translation-rule-tag—Unique sequence number of the previously defined translation rule. Range is 1 to 2147483647. This command requires that you have previously defined appropriate translation rules using the voice translation-rule and rule commands. Note Enables H.323 call transfer and call forwarding by using hairpin call routing for VoIP endpoints that do not support Cisco-proprietary or H.450-based call-transfer and call-forwarding. loopback-dn dn-tag [forward number-of-digits | strip number-of-digits ] [ prefix prefix-digit-string ] [ suffix Step 10 suffix-digit-string ] [retry seconds] [auto-con] [codec {g711alaw | g711ulaw}] • dn-tag—Unique sequence number that identifies the ephone-dn that is being paired for loopback with the ephone-dn that is being configured. The paired ephone-dn must be one that is already defined in the system. Example: Router(config-ephone-dn)# loopback-dn 24 forward 15 prefix 415353.... • forward number-of-digits—(Optional) Number of digits in the original called number to forward to the other ephone-dn in the loopback-dn pair. Range is 1 to 32. Default is to forward all digits. • strip number-of-digits—(Optional) Number of leading digits to be stripped from the original called number before forwarding to the other ephone-dn in the loopback-dn pair. Range is 1 to 32. Default is to not strip any digits. • prefix prefix-digit-string—(Optional) Defines a string of digits to add in front of the forwarded called number. Maximum number of digits in the string is 32. Default is that no prefix is defined. • suffix suffix-digit-string—(Optional) Defines a string of digits to add to the end of the forwarded called number. Maximum number of digits in the string is 32. Default is that no suffix is defined. If you add a suffix that starts with the pound character (#), the string must be enclosed in quotation marks. Cisco Unified Communications Manager Express System Administrator Guide 800 Loopback Call Routing Enable Loopback Call Routing Command or Action Purpose • retry seconds—(Optional) Number of seconds to wait before retrying the loopback target when it is busy or unavailable. Range is 0 to 32767. Default is that retry is disabled and appropriate call-progress tones are passed to the call originator. • auto-con—(Optional) Immediately connectsthe call and providesin-band alerting while waiting for the far-end destination to answer. Default is that automatic connection is disabled. • codec—(Optional) Explicitly forces the G.711 A-law or G.711 mu-law voice coding type to be used for calls that pass through the loopback-dn. This overrides the G.711 coding type that is negotiated for the call and provides conversion from mu-law to A-law, if needed. Default is that Real-Time Transport Protocol (RTP) voice packets are passed through the loopback-dn without considering the G.711 coding type negotiated for the calls. • g711alaw—G.711 A-law, 64000 bits per second, for T1. • g711ulaw—G.711 mu-law, 64000 bits per second, for E1. end Exits to privileged exec mode. Example: Router(config-ephone-dn)# end Step 11 Verify Loopback Call Routing Use the show running-config or show telephony-service ephone-dn command to display ephone-dn configurations. Configuration Example for Loopback Call Routing Example for Enabling Loopback Call Routing The following example uses ephone-dns 15 and 16 as a loopback-dn pair. Calls are routed through thisloopback ephone-dn pair in the following way: • An incoming call to 4085552xxx enters the loopback pair through ephone-dn 16 and exits the loopback via ephone-dn 15 as an outgoing call to 2xxx (based on the forward 4 digits setting). Cisco Unified Communications Manager Express System Administrator Guide 801 Loopback Call Routing Verify Loopback Call Routing • An incoming call to 6xxx enters the loopback pair through ephone-dn 15 and exits the loopback via ephone-dn 16 as an outgoing call to 4157676xxx (based on the prefix 415767 setting). ephone-dn 15 number 6... loopback-dn 16 forward 4 prefix 415767 caller-id local no huntstop ! ephone-dn 16 number 4085552... loopback-dn 15 forward 4 caller-id local no huntstop Feature Information for Loopback Call Routing The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Table 61: Feature Information for Loopback Call Routing Feature Name Cisco Unified CME Version Feature Information Loopback call routing was introduced. Loopback Call Routing 2.0 Cisco Unified Communications Manager Express System Administrator Guide 802 Loopback Call Routing Feature Information for Loopback Call Routing CHAPTER 28 Multilevel Precedence and Preemption This document describes the Multilevel Precedence and Preemption (MLPP) service introduced in Cisco Unified Communications Manager Express 7.1 (Cisco Unified CME). • Prerequisites for MLPP, page 803 • Information About MLPP, page 803 • Configure MLPP, page 813 • Feature Information for MLPP, page 827 Prerequisites for MLPP • Cisco Unified CME 7.1 • Cisco IOS Release 12.4(24)T • To use Cisco Unified CME basic automatic call distribution (B-ACD) and auto-attendant (AA) service as the MLPP attendant-console application, you must download and install the B-ACD scripts. These scripts are available from the Cisco Unified CME Software Download site at http://www.cisco.com/ cgi-bin/tablebuild.pl/ip-iostsp. • You can use your own audio filesfor the blocked precedence announcement and busy station not equipped for preemption announcement or you can use the audio files available from the Cisco Unified CME Software Download site at http://www.cisco.com/cgi-bin/tablebuild.pl/ip-iostsp. Information About MLPP Multilevel Precedence and Preemption (MLPP) service allows validated users to place priority calls, and if necessary, to preempt lower-priority calls. Precedence indicates the priority level of a call. Preemption is the process of terminating a lower-precedence call so a call of higher precedence can proceed. This capability assures high-ranking personnel can communicate with critical organizations and personnel during network stress situations, such as a national emergency or degraded network situation. Cisco Unified Communications Manager Express System Administrator Guide 803 Precedence Precedence indicates the priority level associated with an MLPP call. Phone users can apply a precedence level when making a call. You define an MLPPaccess digit in Cisco Unified CME and assign a maximum precedence level to individual phones. Phone users request a precedence call by dialing the access code NP, where N specifies the pre-configured access digit and P specifies the requested precedence level, followed by the phone number. Table 62: DSN Precedence Levels lists the precedence levels that can be associated with an MLPP call in the Defense Switched Network (DSN) domain. Table 62: DSN Precedence Levels Level Precedence 0 (high) Flash Override 1 Flash 2 Immediate 3 Priority 4 (low) Routine Table 63: DRSN Precedence Levels lists the precedence levels that can be associated with an MLPP call in the Defense Red Switched Network (DRSN) domain. Table 63: DRSN Precedence Levels Level Precedence 0 (high) Flash Override Override 1 Flash Override 2 Flash 3 Immediate 4 Priority 5 (low) Routine A precedence call is any call with a precedence level higher than Routine. If precedence is not specifically invoked, the system processes a call using normal call processing and call forwarding. Emergency 911 calls are automatically assigned precedence level 0. Cisco Unified Communications Manager Express System Administrator Guide 804 Multilevel Precedence and Preemption Precedence Cisco Unified CME provides precedence indications to the source and destination of a precedence call, respectively, if either has MLPP indication enabled. For the source, this indication includes a precedence ringback tone and display of the precedence level of the call, if the device supports display.For the destination, the indication includes a precedence ringer tone and display of the precedence level of the call, if the device supports display. Basic Precedence Call Setup The following sequence of events occurs during the setup of a precedence call: 1 Phone user goes off hook and dials a precedence call. The call pattern is NP-xxxx, where N isthe precedence access digit, P is the precedence level for the call, and xxx is the extension or phone number of the called party. 2 The calling party receives the precedence ringback tone and the precedence display while the call is processing. 3 The called party receivesthe precedence ringer tone and the precedence display that indicatesthe precedence call. Example Party 1000 makes a precedence call to party 1001. To do so, party 1000 dials the precedence call pattern, such as 80-1001. While the call processes, the calling party (1000) receivesthe precedence ringback tone and precedence display on their Cisco Unified IP Phone. After acknowledging the precedence call, the called party (1001) receives a precedence ringer tone and a precedence display on their Cisco Unified IP Phone. Preemption Preemption is the process of terminating an active call of lower precedence so a call of higher precedence can proceed. Preemption includes the notification and acknowledgment of preempted users and the reservation of shared resources immediately after preemption and before call termination. Preemption can take one of the following two forms: • User Access Preemption—This type of preemption applies to phones and other end-user devices. If a called party is busy with a lower precedence call, both the called party and the party to which it is connected, receive preemption notification and the existing call is cleared immediately. For calls to Cisco Unified IP phones, the called party can hang up immediately to connect to the new higher precedence call, or if the called party does not hang up, Cisco Unified CME forces the phone on-hook after the configured preemption tone timer expires and connects the call. For FXS ports, the called party must acknowledge the preemption by going on-hook, before being connected to the new higher precedence call. • Common Network Facility Preemption—This type of preemption applies to trunks. If all channels of a PRI trunk are busy with calls of lower precedence, a call of lower precedence is preempted to complete the higher precedence call. Cisco Unified CME selects a trunk by first searching for an idle channel on all corresponding trunks (based on matching the called number in the dial peer). Cisco Unified Communications Manager Express System Administrator Guide 805 Multilevel Precedence and Preemption Preemption If an idle channel is not found, Cisco Unified CME performs a preemptive-search by searching one trunk at a time for an idle channel. If no idle-channel is available on a trunk, preemption is performed on the lowest of lower-precedence calls corresponding to the trunk. If none of the calls corresponding to the trunk is of lower precedence, the next trunk is searched and so on. SCCP phones support up to eight calls per directory number. When all lines are busy and a higher precedence MLPP call comes in, Cisco Unified CME preempts a lower precedence call on one of the channels of the directory number. The maximum precedence level that a user can assign to an MLPP call originating from a specific phone is set using ephone templates and applied to individual phones. Calls from directory numbers that are shared by SCCP phones can have different maximum precedence levels, based on the precedence level of the phone. Basic Preemption Call Figure 30: User Access Preemption Example shows an example of user access preemption. Figure 30: User Access Preemption Example In this example, the following sequence of events occurs: 1 User 1000 places a call with precedence level 1 (flash) to user 1001, and preemption is enabled for user 1001. In this example, user 1000 dials 81-1001 to place the precedence call. 2 User 1002 places a precedence call to user 1001 by dialing 80-1001. This call, which is of precedence level 0 (flash override), is a higher precedence call than the active precedence call. 3 Phone 1002 receives precedence display (flash override display), and the phones that are involved in the existing lower precedence call both play preemption tones (users 1000 and 1001). 4 To complete preemption, the parties who are involved in the lower precedence call hang up (users 1000 and 1001). 5 The higher level precedence call is offered to user 1001, who receives a precedence ringer tone (if MLPP indication is enabled). The calling party, user 1002, receives precedence ringback. Cisco Unified Communications Manager Express System Administrator Guide 806 Multilevel Precedence and Preemption Preemption DSN Dialing Format Cisco Unified CME 8.0 and later releases provide complete support of the DSN dialing format, as outlined in Table 64: DSN Dialing Format. Table 64: DSN Dialing Format [Access-digit {Precedence-level [Route-code] [Area-code] Switch-code Line-number |Service-digit}] [N {P | S}] [1X] [KXX] KXX XXXX N is 2 - 9 P is 0 - 4 S is 5 - 9 X is 0 - 9 K is 2 - 8 Service Digit The service digit provides information to the switch for connecting calls to government or public telephone services or networks. The services are reached through the trunk or route that is selected based on the dialed digits. Phone users request a service by dialing the access code NS, where N specifies the pre-configured access digit and S specifies the requested service, followed by the phone number. Table 65: Service Digit lists the service digits supported in Cisco Unified CME 8.0 and later versions. Table 65: Service Digit Service Digit Precedence 5 Off-net 700 services 6 Not assigned 7 DSN CONUS FTS 8 Not assigned 9 Local PSTN In Cisco Unified CME, the route pattern is configured to supply secondary dial-tone and the remainder of the digits are collected and passed to the PSTN trunk as the called number. The digits that follow the access digit and service digit must be NANP compliant (E.164 number). Cisco Unified CME provides secondary dial tone after the two digits and then routes the call based on the remaining collected digits(using the dial plan configuration). These services are assumed to be reached through the trunk (or route) selected based on the dialed digits (dialed after the route digits). Cisco Unified Communications Manager Express System Administrator Guide 807 Multilevel Precedence and Preemption DSN Dialing Format Route Code The route code allows a phone user to inform the switch of special routing or termination requirements. The route code determines whether a call uses circuit-switched data or voice-grade trunking and can be used to disable echo suppressors and cancellers, and override satellite link control. The first digit of the route code is 1. It is a required part of the dialing plan to inform the switch that the next digit, the route digit, provides network instructions for specialized routing. Phone users dial route codes in the form 1X, where X is the route digit. The supported route digits that a user can dial are 0 and 1. Table 66: Route Codes lists the route codes supported in Cisco Unified CME 8.0 and later versions: Table 66: Route Codes Route Code Use Description Any codec that carries voice or voice band data, such as G.711, G.729, or fax or modem pass-through. 10 Voice call (default) Any codec that carries unaltered DS0 traffic over IP (circuit emulation). For Cisco Unified CME, this is the audio/clearmode codec (RFC-4040). 11 Circuit-switched data Example for Dialing If the first digit that the user dials is the configured access digit, this indicates an access code where the next digit is either a precedence digit or a service digit. If the next digit dialed is: • 0-4—Thisis a precedence call. Cisco Unified CME setsthe precedence indication,storesthe precedence value, and discards the digits. • 5-9—This is a call to a particular service. Cisco Unified CME passes the call to the designated trunk, discards the digits, and plays secondary dial tone. If the first digit that the user dials or the next digit dialed after the access code is: • 1—This is a route code and the next digit is a route digit. The supported route digits that a user can dial are 0 and 1. Cisco Unified CME stores the route code for use later in route selection, sets a trunk-type indication, and discards the route code digits. If the first digit that the user dials or the next digit dialed after the access code or route code is: • 2-8—This is the first digit of the area code or switch code. Area codes and switch codes in the DSN are allocated so there is no overlap. The area code and/or switch code are used for route selection. Cisco Unified Communications Manager Express System Administrator Guide 808 Multilevel Precedence and Preemption DSN Dialing Format MLPP Service Domains Cisco Unified CME 8.0 and later versions support MLPP service domains. A service domain consists of a group of MLPPsubscribers and network resources. Calls and resources can only be preempted by higher-priority calls from MLPP subscribers within the same domain. You can configure each device with a domain type, such as DSN or DRSN, and a domain identifier. You can assign a global MLPPdomain type and identifier to the Cisco Unified CME router and assign differentservice domains to the individual phones registered to Cisco Unified CME through an ephone template. Calls from any phone that is not configured with a specific service domain use the global domain type and identifier. The MLPP precedence and preemption applies only within the same domain. Only calls within the same domain can be preempted. If a call is placed between two subscribers with different MLPP service domains, Cisco Unified CME assigns the service domain of the originator to the call. Figure 31: Service Domains with Different identifiers shows an example of preemption attempted across domains with different identifier numbers. Figure 31: Service Domains with Different identifiers In the example shown in Figure 31: Service Domains with Different identifiers, the following sequence of events occurs: 1 User 1000, from service domain 0100, places a call with precedence level 1 (flash) to user 1001 in service domain 0200. The call is assigned domain number 0100 because that is the service domain of the call originator. 2 User 1002, from domain number 0200, places a precedence call to user 1001. This call, which is of precedence level 0 (flash override), is a higher precedence call than the active precedence call. 3 The active call is not preempted because the incoming call is from a different service domain than the active call; a call from domain 0200 cannot preempt a call from domain 0100. Cisco Unified Communications Manager Express System Administrator Guide 809 Multilevel Precedence and Preemption MLPP Service Domains In the example shown in Figure 32: Service Domains with Different Domain Types, the active call is not preempted because the incoming call is from a different domain type than the active call; a call from the DSN cannot preempt a call from the DRSN. Figure 32: Service Domains with Different Domain Types In the example shown in Figure 33: Service Domains with Same Type and identifier, the active call is successfully preempted because the incoming call has the same domain type and identifier as the active call. Figure 33: Service Domains with Same Type and identifier MLPP Indication For basic MLPP calls with MLPP indication enabled, Cisco Unified CME instructs SCCP phones to play the precedence ringer tone and display the precedence level. For basic MLPP calls with preemption involved and MLPP indication enabled, Cisco Unified CME instructs both parties to play the preemption tone and display the precedence level of the MLPP call on the phone. For an MLPPcall with call waiting, if MLPPindication is enabled, Cisco Unified CME instructsSCCPphones to play priority the call waiting tone instead of the regular call waiting tone. Users receive an error tone if they attempt to make a call with a higher level of precedence than the highest precedence level that is authorized for their phone. For example, user 1002 dials 80 to start a precedence call. Eight (8) represents the precedence access digit, and zero (0) specifies the precedence level that the user attempts to use. If this user is not authorized to make level 0 (flash override) precedence calls, the user receives an error tone. MLPP Announcements Users who are unable to place MLPP calls receive announcements that detail the reasons why a call was unsuccessful. Table 67: MLPP Announcements lists the supported MLPP announcements. Cisco Unified Communications Manager Express System Administrator Guide 810 Multilevel Precedence and Preemption MLPP Indication Table 67: MLPP Announcements Announcement Condition Blocked Precedence Announcement (BPA) (Switch name and Location). Equal or higher An equal or higher precedence call is in progress. precedence calls have prevented completion of your call.Please hang up and try again. Thisis a recording. (Switch name and Location). Users receive the BPA if the destination party for the precedence call is off hook or if the destination party is busy with a precedence call of an equal or higher precedence. BPA is not played if the destination party is configured for Call Waiting or Call Forwarding, or uses automatic call diversion to an attendant-console service. Supported in Cisco Unified CME 7.1 and later versions. Busy Not Equipped Announcement (BNEA) (Switch name and Location). A service disruption has Busy station not equipped for preemption. prevented the completion of your call.Please wait 30 minutes and try again. In case of emergency call your operator. This is a recording. (Switch name and Location). Users receive the BNEA if the dialed number is busy and non-preemptable. BNEA is not played if the dialed number is configured for Call Waiting or Call Forwarding, or has alternate party designations. Supported in Cisco Unified CME 7.1 and later versions. Isolated Code Announcement (ICA) (Switch name and Location). A service disruption has Operating or equipment problems encountered. prevented the completion of your call.Please wait 30 minutes and try again. In case of emergency call your operator. This is a recording. (Switch name and Location). The complete trunk group including all routes is busied manually at either end of the circuit or the complete trunk group including all routes is in a carrier group alarm state (for example, Loss ofSignal, Remote Alarm Indication, or Alarm Indication Signal). Supported in Cisco Unified CME 8.0 and later versions. Loss of C2 Features Announcement (LOC2) Cisco Unified Communications Manager Express System Administrator Guide 811 Multilevel Precedence and Preemption MLPP Announcements Announcement Condition - Call leaves DSN. Usersreceive the LOC2 announcement when the call leaves the Cisco Unified CME router on the trunk or when the user places a call to a different domain. For example, DSN callers who place callsto locations that permit off-net terminations may receive an announcement informing them that they have left the DSN. Supported in Cisco Unified CME 8.0 and later versions. Unauthorized Precedence Level Announcement (UPA) (Switch name and Location). The precedence used is Unauthorized precedence level is attempted. not authorized for your line.Please use an authorized precedence or ask your attendant for assistance. This is a recording. (Switch name and Location). Users receive the UPA when they attempt to make a precedence call by using a higher level of precedence than the highest precedence level that is authorized for their line. Supported in Cisco Unified CME 8.0 and later versions. Vacant Code Announcement (VCA) (Switch name and Location). Your call cannot be No such service or invalid code. completed as dialed. Please consult your directory and call again or ask your operator for assistance. This is a recording. (Switch name and Location). Users receive the VCA when they dial an invalid or unassigned number. Supported in Cisco Unified CME 8.0 and later versions. Automatic Call Diversion (Attendant Console) Cisco Unified CME supports automatic diversion of all unanswered precedence calls above Routine to a designated directory number or attendant console after a selected period of time. If automatic call diversion of MLPP calls is configured in Cisco Unified CME, it overrides the Call Forward settings on the phone for all incoming precedence calls above Routine and forwards these calls to the attendant-console application specified in the MLPP configuration. Cisco Unified CME treats MLPP calls with a precedence level of Routine as normal calls and honors the Call Forward setting configured on the phone. How Cisco Unified CME handles forwarded MLPP calls depends on the following Call Forward options: Cisco Unified Communications Manager Express System Administrator Guide 812 Multilevel Precedence and Preemption Automatic Call Diversion (Attendant Console) • Call Forward All (CFA)—Precedence calls are routed to the target number of the attendant console immediately. The CFA target is not used for MLPP calls. • Call Forward Busy (CFB)—Precedence calls are forwarded to the configured CFB destination. If the CFB destination is Voice Mail or an off-net endpoint, the call is forwarded to the target number of the attendant-console service. • CallForward No Answer (CFNA)—Precedence calls are forwarded to the configured CFNA destination. If the CFNA destination does not answer before the CFNA timer expires, or it is voice mail or an off-net endpoint, the call is forwarded to the target number of the attendant-console service. Calls diverted to the attendant console are indicated by a visual signal and placed in the queue for attendant service by precedence and time interval. The call with the highest precedence and longest holding time is answered first. Attendant Queue Announcement is played to calls waiting in the queue for attendant service. Call distribution is performed to reduce excessive waiting time and each attendant position operates from a common queue. Cisco Unified CME supports attendant console service for MLPP using Basic Automatic Call Distribution (B-ACD) and auto-attendant (AA) service. Configure MLPP Enable MLPP Service Globally in Cisco Unified CME This task covers the basic steps necessary to enable MLPP on the router. Restriction • SIP phones are not supported. • Cisco Unified IP Phone 6900 Series phones are not supported. • Cisco Unified CME in SRST Fallback mode is not supported. • Supports only ISDN PRI E1 and T1interfaces. • Supports MLPP service within the local Cisco Unified CME router only. • Cisco Unified CME 7.1 supports only Basic Calls, CallForward, Call Hold and Resume, Consultative Call-Transfer, and Call Waiting. Blind Transfer is not supported. • Cisco Unified CME 8.0 and later versionssupport Three-Party Ad Hoc Conferencing and CallPickup. • Call Park Retrieval based on precedence level is not supported; Cisco Unified CME must be configured to accept only one call per park slot. Before You Begin Trunks must belong to a trunk group and have preemption enabled.For configuration information,see Enabling Preemption on the Trunk Group in Integrating Data and Voice ServicesforISDN PRI Interfaces on Multiservice Access Routers. Cisco Unified Communications Manager Express System Administrator Guide 813 Multilevel Precedence and Preemption Configure MLPP SUMMARY STEPS 1. enable 2. configure terminal 3. voice mlpp 4. access-digit digit 5. bnea audio-url 6. bpa audio-url 7. upa audio-url 8. service-domain { drsn | dsn}identifier domain-number 9. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 voice mlpp Enters voice MLPP configuration mode. Example: Router(config)# voice mlpp Step 3 Step 4 access-digit digit Defines the access digit that phone users dial to make an MLPP call. Example: Router(config-voice-mlpp)# access-digit 8 • digit—Single-digit number that users dial. Range: 0 to 9. Default: 0. Your domain type must support the access digit that you select. For example, the valid range for the DSN is 2 to 9. Note Specifies the audio file to play for the busy station not equipped for preemption announcement. bnea audio-url Example: Router(config-voice-mlpp)# bnea flash:bnea.au Step 5 • audio-url—Location of the announcement audio file in URL format. Valid storage locations are TFTP, FTP, HTTP, and flash memory. bpa audio-url Specifiesthe audio file to play for the blocked precedence announcement. Example: Router(config-voice-mlpp)# bpa flash:bpa.au Step 6 Cisco Unified Communications Manager Express System Administrator Guide 814 Multilevel Precedence and Preemption Enable MLPP Service Globally in Cisco Unified CME Command or Action Purpose Specifies the audio file to play for the unauthorized precedence announcement. upa audio-url Example: Router(config-voice-mlpp)# upa flash:upa.au Step 7 • This command is supported in Cisco Unified CME 8.0 and later versions. service-domain { drsn | dsn}identifier (Optional) Sets the global MLPP domain type and number. domain-number Step 8 • drsn—Defense Red Switched Network (DRSN). Example: Router(config-voice-mlpp)# service-domain dsn 0010 • dsn—DefenseSwitched Network (DSN). Thisisthe default value. • domain-number—Number to identify the global domain, in three-octet format. Range: 0x000000 to 0xFFFFFF. Default: 0. • A phone uses this global domain for MLPP calls if it is not configured with the mlpp service-domain command. • This command is supported in Cisco Unified CME 8.0 and later versions. end Exits to privileged EXEC mode. Example: Router(config-voice-mlpp)# end Step 9 Example The following example shows MLPP enabled on the Cisco Unified CME router. voice mlpp access-digit 8 bpa flash:bpa.au bnea flash:bnea.au upa flash:upa.au service-domain dsn identifier 000010 Enable MLPP Service on SCCP Phones The mlpp max-precedence command is not supported in Cisco Unified CME 8.0 and later versions; it is replaced by the mlpp service-domain command. Restriction Before You Begin MLPP must be enabled globally on the Cisco Unified CME router. See Enable MLPP Service Globally in Cisco Unified CME. Cisco Unified Communications Manager Express System Administrator Guide 815 Multilevel Precedence and Preemption Enable MLPP Service on SCCP Phones SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-template template-tag 4. mlpp service-domain{drsn | dsn} identifier domain-number max-precedence level 5. mlpp preemption 6. mlpp indication 7. exit 8. ephone phone-tag 9. ephone-template template-tag 10. restart 11. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 ephone-template template-tag Enters ephone-template configuration mode to create an ephone template. Example: Router(config)# ephone-template 15 • template-tag—Unique identifier for the ephone template that is being created. Range: 1 to 20. Sets the service domain and maximum precedence (priority) level for MLPP calls from this phone. mlpp service-domain{drsn | dsn} identifier domain-number max-precedence level Step 4 • drsn—Phone belongs to the Defense Red Switched Network (DRSN). Example: Router(config-ephone-template)# mlpp service-domain dsn identifier 0010 max-precedence 0 • dsn—Phone belongs to the Defense Switched Network (DSN). This is the default value. • domain-number—Number to identify the global domain, in three-octet format. Range: 0x000000 to 0xFFFFFF. • level—Maximum precedence level. Phone user can specify a precedence level that is less than or equal to this value. ◦DSN—Range: 0 to 4, where 0 is the highest priority. Cisco Unified Communications Manager Express System Administrator Guide 816 Multilevel Precedence and Preemption Enable MLPP Service on SCCP Phones Command or Action Purpose ◦DRSN—Range: 0 to 5, where 0 is the highest priority. • This command is supported in Cisco Unified CME 8.0 and later versions. Step 5 mlpp preemption (Optional) Enables calls on the phone to be preempted. Example: Router(config-ephone-template)# no mlpp preemption • Preemption is enabled by default. Skip this step unless you want to disable preemption with the no mlpp preemption command. (Optional) Enables the phone to play precedence and preemption tones, and display the preemption level of calls. mlpp indication Example: Router(config-ephone-template)# no mlpp indication Step 6 • MLPP indication is enabled by default. Skip this step unless you want to disable MLPP indication with the no mlpp indication command. exit Exits ephone-template configuration mode. Example: Router(config-ephone-template)# exit Step 7 Step 8 ephone phone-tag Enters ephone configuration mode. Example: Router(config)# ephone 36 • phone-tag—Unique sequence number that identifies this ephone during configuration tasks. ephone-template template-tag Applies an ephone template to the ephone that is being configured. Example: Router(config-ephone)# ephone-template 15 Step 9 Performs a fast reboot of this ephone. Does not contact the DHCP or TFTP server for updated information. restart Example: Router(config-ephone)# restart Step 10 Restart all ephones using the restart all command in telephony-service configuration mode. Note end Returns to privileged EXEC mode. Example: Router(config-ephone)# end Step 11 Cisco Unified Communications Manager Express System Administrator Guide 817 Multilevel Precedence and Preemption Enable MLPP Service on SCCP Phones Examples The following example shows a basic configuration for three phones, all using template 1 with MLPPdefined. Figure 34: Preemption Call Example shows an example of a precedence call using this configuration. voice mlpp access-digit 8 bpa flash:BPA.au bnea flash:BNEA.au upa flash:UPA.au ephone-template 1 mlpp service-domain dsn identifier 000000 max-precedence 0 !Configures MLPP domain as DSN, identifier as 000000, and max-precedence set to 0 ephone-dn 1 number 1001 ephone-dn 2 number 1002 ephone-dn 3 dual-line number 1003 huntstop channel ephone 1 description Phone-A mac-address 1111.2222.0001 button 1:1 ephone-template 1 ! MLPP configuration inherited from ephone-template 1 ephone 2 description Phone-B mac-address 1111.2222.0002 button 1:2 ephone-template 1 ephone-3 description Phone-C mac-address 1111.2222.0003 button 1:3 ephone-template 1 Cisco Unified Communications Manager Express System Administrator Guide 818 Multilevel Precedence and Preemption Enable MLPP Service on SCCP Phones The huntstop channel command must be configured on dual-line and octo-line directory numbers to preempt a call on those types of lines. Otherwise the dual-line or octo-line receives Call Waiting indication and the call is not preempted. Note Figure 34: Preemption Call Example In this example, the following sequence of events occurs: 1 Phone A places a precedence call to Phone C by dialing 831003 (access digit 8 + precedence level 3 + destination number 1003). Phone C answers the call. 2 Phone C hears the precedence ringer tone and Phone A hears the precedence ringback. 3 Phone B places a higher precedence call to Phone C by dialing 821003. Phone A and Phone C both hear the preemption tone for the duration of the preemption tone timer command (default value is three seconds). 4 Phone A is preempted after three seconds. 5 Phone C starts ringing (precedence ringer) and Phone B hears the precedence ringback. 6 Phone C answers the call. Enable MLPP Service on Analog FXS Phone Ports Before You Begin MLPP must be enabled globally on the Cisco Unified CME router. See Enable MLPP Service Globally in Cisco Unified CME. Cisco Unified Communications Manager Express System Administrator Guide 819 Multilevel Precedence and Preemption Enable MLPP Service on Analog FXS Phone Ports SUMMARY STEPS 1. enable 2. configure terminal 3. voice-port port 4. mlpp service-domain{drsn | dsn} identifier domain-number max-precedence level 5. mlpp preemption 6. mlpp indication 7. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 voice-port port Enters voice-port configuration mode. Example: Router(config)# voice-port 0/1/0 • Port argument is platform-dependent; type ? to display syntax. Sets the service domain and maximum precedence (priority) level for MLPP calls from this port. mlpp service-domain{drsn | dsn} identifier domain-number max-precedence level Step 4 • drsn—Port belongsto the Defense RedSwitched Network (DRSN). Example: Router(config-voiceport)# mlpp service-domain dsn identifier 0020 max-precedence 0 • dsn—Port belongs to the Defense Switched Network (DSN). • domain-number—Number to identify the global domain, in three-octet format. Range: 0x000000 to 0xFFFFFF. • level—Maximum precedence level. Phone user can specify a precedence level that is less than or equal to this value. ◦DSN—Range: 0 to 4, where 0 is the highest priority. ◦DRSN—Range: 0 to 5, where 0 is the highest priority. • This command is supported in Cisco Unified CME 8.0 and later versions. Step 5 mlpp preemption (Optional) Enables calls on the port to be preempted. Cisco Unified Communications Manager Express System Administrator Guide 820 Multilevel Precedence and Preemption Enable MLPP Service on Analog FXS Phone Ports Command or Action Purpose Example: Router(config-voiceport)# no mlpp preemption • Preemption is enabled by default. Skip this step unless you want to disable preemption with the no mlpp preemption command. (Optional) Enables the phone to play precedence and preemption tones, and display the preemption level of calls. mlpp indication Example: Router(config-voiceport)# no mlpp indication Step 6 • MLPP indication is enabled by default. Skip this step unless you want to disable MLPP indication with the no mlpp indication command. end Returns to privileged EXEC mode. Example: Router(config-voiceport)# end Step 7 Example The following example shows that the analog FXS phone connected to voice port 0/1/0 can make MLPP calls with the highest precedence and its calls cannot be preempted. voice-port 0/1/0 mlpp service-domain dsn identifier 000020 max-precedence 0 no mlpp preemption station-id name uut1-fxs1 caller-id enable Configure an MLPP Service Domain for Outbound Dial Peers To assign a service domain to MLPP calls that must leave the Cisco Unified CME router through the trunk, perform the following steps for the corresponding dial peer. SUMMARY STEPS 1. enable 2. configure terminal 3. voice class mlpp tag 4. service-domain {drsn | dsn} 5. exit 6. dial-peer voice tag {pots | voip} 7. voice-class mlpp tag 8. end Cisco Unified Communications Manager Express System Administrator Guide 821 Multilevel Precedence and Preemption Configure an MLPP Service Domain for Outbound Dial Peers DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 voice class mlpp tag Creates a voice class for the MLPP service. Example: Router(config)# voice class mlpp 1 • tag—Unique number to identify the voice class. Range: 1 to 10000. Step 4 service-domain {drsn | dsn} Sets the network domain in the MLPP voice class. Example: Router(config-voice-class)# service-domain dsn • drsn—Defense Red Switched Network (DRSN). • dsn—Defense Switched Network (DSN). exit Exits voice-class configuration mode. Example: Router(config-voice-class)# exit Step 5 dial-peer voice tag {pots | voip} Enters dial peer voice configuration mode. Example: Router(config)# dial-peer voice 101 voip Step 6 Assigns a previously configured MLPPvoice classto aPOTS or VoIP dial peer. voice-class mlpp tag Example: Router(config-dial-peer)# voice-class mlpp 1 Step 7 • tag—Unique number of the voice class that you created in Step 3. end Exits dial-peer voice configuration mode. Example: Router(config-dial-peer)# end Step 8 Cisco Unified Communications Manager Express System Administrator Guide 822 Multilevel Precedence and Preemption Configure an MLPP Service Domain for Outbound Dial Peers Example The following example shows an MLPP voice class defined for the DSN service domain. This voice class is assigned to a POTS dial peer so that calls leaving port 0/1/0 use the DSN protocol. voice class mlpp 1 service-domain dsn ! ! dial-peer voice 1011 pots destination-pattern 19101 voice-class mlpp 1 port 0/1/0 Configure MLPP Options To configure optional MLPP features or modify default settings, perform the following steps. SUMMARY STEPS 1. enable 2. configure terminal 3. voice mlpp 4. preemption trunkgroup 5. preemption user 6. preemption tone timer seconds 7. preemption reserve timer seconds 8. service-domain midcall-mismatch{method1 | method2 | method3 | method4} 9. service-digit 10. route-code 11. attendant-console number redirect-timer seconds 12. ica audio-url 13. loc2 audio-url 14. vca audio-url voice-class cause-code tag 15. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Cisco Unified Communications Manager Express System Administrator Guide 823 Multilevel Precedence and Preemption Configure MLPP Options Command or Action Purpose voice mlpp Enters voice MLPP configuration mode. Example: Router(config)# voice mlpp Step 3 preemption trunkgroup Enables preemption capabilities on a trunk group. Example: Router(config-voice-mlpp)# preemption trunkgroup Step 4 preemption user Enables all supported phones to preempt calls. Example: Router(config-voice-mlpp)# preemption user Step 5 Sets the amount of time that the preemption tone plays on the called phone when a lower precedence call is being preempted. preemption tone timer seconds Example: Router(config-voice-mlpp)# preemption tone timer 15 Step 6 • seconds—Expiry time, in seconds. Range: 3 to 30. Default: 0 (disabled). Step 7 preemption reserve timer seconds Sets the amount of time to reserve a channel for a preemption call. Example: Router(config-voice-mlpp)# preemption reserve timer 10 • seconds—Range: 3 to 30. Default: 0 (disabled). Definesthe behavior when there is a domain mismatch between the two legs of a call. service-domain midcall-mismatch{method1 | method2 | method3 | method4} Step 8 Example: Router(config-voice-mlpp)# service-domain midcall-mismatch method2 • method1—Domain remains unchanged for each of the connections and the precedence level of the lower priority call changes to that of the higher priority call. This is the default value. • method2—Domain and precedence level of the lower priority call changes to that of the higher priority call. • method3—Domain remains unchanged for each of the connections and the precedence levels change to Routine for both calls. • method4—Domains change to that of the connection for which supplementary service was invoked (for example, transferee in case of transfer). Precedence levels change to Routine for both calls. • This command is supported in Cisco Unified CME 8.0 and later versions. Cisco Unified Communications Manager Express System Administrator Guide 824 Multilevel Precedence and Preemption Configure MLPP Options Command or Action Purpose Enables phone users to request off-net services by dialing a service digit. service-digit Example: Router(config-voice-mlpp)# service-digit Step 9 • This command is supported in Cisco Unified CME 8.0 and later versions. Enables phone users to specify special routing for a call by dialing a route code. route-code Example: Router(config-voice-mlpp)# route-code Step 10 • This command is supported in Cisco Unified CME 8.0 and later versions. Specifies the telephone number of the MLPP attendant-console service where calls are redirected if the phone does not answer. attendant-console number redirect-timer seconds Step 11 Example: Router(config-voice-mlpp)# attendant-console 8100 redirect-timer 10 • number—Extension or E.164 telephone number of the Cisco Unified CME basic automatic call distribution (B-ACD) and auto-attendant (AA) service. • seconds—Number of seconds to wait for the phone to answer before redirecting the call. (Optional) Specifies the audio file to play for the isolated code announcement. ica audio-url Example: Router(config-voice-mlpp)# ica flash:ica.au Step 12 • This command is supported in Cisco Unified CME 8.0 and later versions. (Optional) Specifies the audio file to play for the loss of C2 features announcement. loc2 audio-url Example: Router(config-voice-mlpp)# loc2 flash:loc2.au Step 13 • This command is supported in Cisco Unified CME 8.0 and later versions. (Optional) Specifies the audio file to play for the vacant code announcement. vca audio-url voice-class cause-code tag Example: Router(config-voice-mlpp)# vca flash:vca.au voice-class cause-code 29 Step 14 • tag—Number of the voice class that defines the cause codes for which the VCA is played. Range: 1 to 64. • This command is supported in Cisco Unified CME 8.0 and later versions. end Exits to privileged EXEC mode. Example: Router(config-voice-mlpp)# end Step 15 Cisco Unified Communications Manager Express System Administrator Guide 825 Multilevel Precedence and Preemption Configure MLPP Options Examples The following example shows an MLPP configuration with optional parameters. voice mlpp preemption trunkgroup preemption user preemption tone timer 15 preemption reserve timer 10 access-digit 8 attendant-console 8100 redirect-timer 10 service-digit route-code bpa flash:bpa.au bnea flash:bnea.au upa flash:upa.au ica flash:ica.au loc2 flash:loc2.au vca flash:vca.au voice-class cause-code 29 service-domain midcall-mismatch method2 service-domain dsn identifier 000010 Troubleshooting MLPP Service SUMMARY STEPS 1. enable 2. debug ephone mlpp 3. debug voice mlpp DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. Displays debugging information for MLPP calls to phones in a Cisco Unified CME system. debug ephone mlpp Example: Router# debug ephone mlpp Step 2 debug voice mlpp Displays debugging information for the MLPP service. Example: Router# debug voice mlpp Step 3 Cisco Unified Communications Manager Express System Administrator Guide 826 Multilevel Precedence and Preemption Troubleshooting MLPP Service Feature Information for MLPP The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Table 68: Feature Information for MLPP Feature Name Cisco Unified CME Version Feature Information Adds support for the following: • Additional MLPP announcements • Multiple service domains • Route codes and service digits • Interaction with supplementary services,such as Three-Way Conference, Call Pickup, and Cancel Call Waiting on AnalogFXSports MLPP Enhancements 8.0 Allows validated users to place priority calls, and if necessary, to preempt lower-priority calls. MLPP for Cisco Unified CME 7.1 Cisco Unified Communications Manager Express System Administrator Guide 827 Multilevel Precedence and Preemption Feature Information for MLPP Cisco Unified Communications Manager Express System Administrator Guide 828 Multilevel Precedence and Preemption Feature Information for MLPP CHAPTER 29 Music on Hold • Prerequisites for Music on Hold, page 829 • Restrictions for Music on Hold, page 829 • Information About Music on Hold, page 830 • Configure Music on Hold, page 834 • Feature Information for Music on Hold, page 854 Prerequisites for Music on Hold • For Unified CME Release 11.6 and previous releases, phones receiving Music on Hold (MOH) in a system using G.729 require transcoding between G.711 and G.729. From Unified CME Release 11.7 onwards, transcoding is not required if G.729 codec format MOH file is configured on Unfiied CME. For information about transcoding, see Configure Transcoding Resources, on page 479. • Transcoding for MOH is supported on Cisco 4000Series IntegratedServices Router from Unified CME Release 11.7 onwards. Restrictions for Music on Hold • IP phones do not support multicast at 224.x.x.x addresses. • Cisco Unified CME 3.3 and earlier versions do not support MOH for local Cisco Unified CME phones that are on hold with other Cisco Unified CME phones; these parties hear a periodic repeating tone instead. • Cisco Unified CME 4.0 and later versions support MOH for internal calls on SCCP Phones only if the multicast moh command is used to enable the flow of packets to the subnet on which the phones are located. • Internal extensions that are connected through a Cisco VG224 Analog Voice Gateway or through a WAN (remote extensions) do not hear MOH on internal calls. Cisco Unified Communications Manager Express System Administrator Guide 829 • Multicast MOH is not supported on a phone if the phone is configured with the mtp command or the paging-dn command with the unicast keyword. • For calls from SCCP to SCCP phones, Unicast MoH is not supported. Multicast MoH is supported if it is enabled. If Multicast MoH is not enabled, Tone on Hold is supported. • Multicast MOH is not supported on SIP Phones. Information About Music on Hold Music on Hold Summary MOH is an audio stream that is played to PSTN and VoIP G.711 or G.729 callers who are placed on hold by phones in a Cisco Unified CME system. This audio stream is intended to reassure callers that they are still connected to their calls. Table 69: Music on Hold (MOH) provides a summary of options for MOH for PSTN and multicast MOH for local IP phones. Table 69: Music on Hold (MOH) Audio Source Description How to Configure Configure Music on Hold from an AudioFile toSupply AudioStream Flash memory No external audio input isrequired. Configure Music on Hold from a Live Feed The multicast audio stream has minimal delay for local IP phones. The MOH stream forPSTN callers is delayed by a few seconds. If the live feed audio input fails, callers on hold hear silence. Live feed Configure Music on Hold from an AudioFile toSupply AudioStream and Configure Music on Hold from a Live Feed The live feed stream has a few seconds of delay for both PSTN and local IP phone callers. The flash MOH acts as backup for the live-feed MoH. If MOH from a live feed is not found or fails, Unified CME swtichesto playback of MOH from the flash memory. Live feed and flash memory Cisco Unified Communications Manager Express System Administrator Guide 830 Music on Hold Information About Music on Hold Music on Hold MOH is an audio stream that is played to PSTN and VoIP G.711 or G.729 callers who are placed on hold by phones in a Cisco Unified CME system. This audio stream is intended to reassure callers that they are still connected to their calls. For Unified CME Release 11.6 and previous releases, when the phone receiving MOH is part of a system that uses a G.729 codec, transcoding is required between G.711 and G.729. The G.711 MOH must be translated to G.729. Note that because of compression, MOH using G.729 is of significantly lower fidelity than MOH using G.711.From Unified CME Release 11.7 onwards, transcoding is not required if G.711 and G.729 codec format MOH files are configured on Unified CME. For information about transcoding, see Configure Transcoding Resources. The audio stream that is used for MOH can derive from one of two sources: • Audio file—A MOH audio stream from an audio file is supplied from a .au or .wav file held in router flash memory.For configuration information,see Configure Music on Hold from an AudioFile toSupply Audio Stream. • Live feed—A MOH audio stream from a live feed issupplied from a standard line-level audio connection that is directly connected to the router through an FXO or “ear and mouth” (E&M) analog voice port. For configuration information, see Configure Music on Hold from a Live Feed. Music on Hold from a Live Feed The live-feed feature is typically used to connect to a CD jukebox player. To configure MOH from a live feed, you establish a voice port and dial peer for the call and also create a “dummy” ephone-dn. The ephone-dn must have a phone or extension number assigned to it so that it can make and receive calls, but the number is never assigned to a physical phone. Only one live MOH feed is supported per system. Using an analog E&M port as the live-feed MOH interface requires the minimum number of external components. You connect a line-level audio feed (standard audio jack) directly to pins 3 and 6 of an E&M RJ-45 connector. The E&M voice interface card (VIC) has a built-in audio transformer that provides appropriate electrical isolation for the external audio source. An audio connection on an E&M port does not require loop-current. The signal immediate and auto-cut-through commands disable E&M signaling on this voice port. A G.711 audio packet stream is generated by a digital signal processor (DSP) on the E&M port. If you use an FXO port as the live-feed MOH interface, connect the MOH source to the FXO port using a MOD-SC cable if the MOH source has a different connector than the FXO RJ-11 connector. MOH from a live feed is supported on the VIC2-2FXO, VIC2-4FXO, EM-HDA-3FXS/4FXO, EM-HDA-6FXO, and EM2-HDA-4FXO. You can directly connect a live-feed source to an FXO port if the signal loop-start live-feed command is configured on the voice port; otherwise, the port must connect through an external third-party adapter to provide a battery feed. An external adapter must supply normal telephone company (telco) battery voltage with the correct polarity to the tip and ring leads of the FXO port and it must provide transformer-based isolation between the external audio source and the tip and ring leads of the FXO port. Music from a live feed is continuously fed into the MOH playout buffer instead of being read from a flash file, so there is typically a 2-second delay. An outbound call to a MOH live-feed source is attempted (or reattempted) every 30 seconds until the connection is made by the directory number that has been configured for MOH. If the live-feed source is shut down for any reason, the flash memory source will be automatically activated. Cisco Unified Communications Manager Express System Administrator Guide 831 Music on Hold Music on Hold A live-feed MOH connection is established as an automatically connected voice call that is made by the Unified CME MOH system or by an external source directly calling in to the live-feed MOH port. An MOH call can be from or to the PSTN or can proceed via VoIP with voice activity detection (VAD) disabled. The call is assumed to be an incoming call unless the optional out-call keyword is used with the moh command during configuration. The Unified CME router uses the audio stream from the call as the source for the MOH stream, displacing any audio stream that is available from a flash file. An example of an MOH stream received over an incoming call is an external H.323-based server device that calls the ephone-dn to deliver an audio stream to the Cisco Unified CME router. For configuration information, see Configure Music on Hold from a Live Feed. For configuration example, see Examples. Multicast MOH In Cisco CME 3.0 and later versions, you can configure the MOH audio stream as a multicast source. A Cisco Unified CME router that is configured for multicast MOH also transmitsthe audio stream on the physical IP interfaces of the specified router to permit access to the stream by external devices. Certain IP phones do not support multicast MOH because they do not support IP multicast. In Cisco Unified CME 4.0 and later versions, you can disable multicast MOH to individual phonesthat do notsupport multicast. Callers hear a repeating tone when they are placed on hold. Music on Hold for SIP Phones In Cisco Unified CME 4.1 and later versions, the MOH feature is supported when a call is put on hold from a SIP phone and when the user of a SIP phone is put on hold by a SIP, SCCP, or POTS endpoint. The holder (party that pressed the hold key) or holdee (party who is put on hold) can be on the same Cisco Unified CME or a different Cisco Unified CME connected through a SIP trunk. MOH is also supported for call transfers and conferencing, with or without a transcoding device. Configuring MOH for SIP phones is the same as configuring MOH for SCCP phones. For configuration information, see Configure Music on Hold. Music On Hold Enhancement Cisco Unified CME 8.0 and later versions enhance the MOH feature by playing different media streams to PSTN and VoIP callers who are placed on hold. The MOH enhancement allows you to configure up to five additional media streams supplied from multiple media files stored in a router’s flash memory and eliminates the need for separate routers for streaming MOH media files. Cisco Unified CME 8.0 MOH enhancement allows you to create MOH groups and assign ephone extension numbersto these MOH groupsto receive different media streams. Callersto the extension numbers configured under the MOH groups can listen to different MOH media streams when they are placed on hold. You can configure up to five MOH groups. The size of each media source file can range between 64KB to 10MB long on the Cisco Unified CME router for ephones in different departments in a branch. A MOH group islinked to an ephone using the extension number of that ephone.For configuration information,see Configure Music on Hold Groups to Support Different Media Sources. Cisco Unified Communications Manager Express System Administrator Guide 832 Music on Hold Multicast MOH You can also configure individual directory numbers to select any MOH group as a MOH source on the Cisco Unified CME router. The extension number of a directory associates an ephone to a specific MOH group and callers to these extension numbers can listen to different media streams when placed on hold. For configuration information, see Assign a MOH Group to a Directory Number. Similarly, callers from internal directory numbers can listen to different media streams when a MOH group is assigned for an internal call. For configuration information, see Assign a MOH Group to all Internal Calls Only to SCCP Phones. Following precedence rules are applicable when an ephone caller is placed on hold: • MOH group defined for internal calls takes highest precedence. • MOH group defined in ephone-dn takes the second highest precedence. • MOH groupdefined in ephone-dn-template takes precedence if MOH group is not defined in ephone-dn or internal call. • Extension numbers defined in a MOH-group has the least precedence. • Phones not associated with any MOH groups default to the MOH parameters defined in the mohcommand under telephony-service configuration mode. Note If a selected MOH group does not exist, the caller will hear tone on hold. We recommend that departmentsin a branch must have mutually exclusive extension numbers and multicast destinations for configuring MOH groups. Note Caching MOH Files for Enhanced System Performance Caching MOH files helps enhance the system performance by reducing the CPU usage. However, caching requires memory buffer to store a large MOH file. You can set up a buffer file size for caching MOH files that you might use in the future. The default MOH file buffer size is 64 KB (8 seconds). The maximum buffer size (per file) can be configured anywhere between 64 KB (8 minutes) to 10000 KB (approximately 20 minutes), You can use the moh-file-buffer command to allocate MOH file buffer for future MOH files, see Configure Buffer Size for MOH Files. To verify if a file is being cached and to update a cached moh-file, see Verify MOH File Caching. Note If the file size is too large, buffer size falls back to 64 KB. Configure G.711 and G.729 Files for Music on Hold From Cisco Unified CME 11.7 Release onwards, G.711 and G.729 codec format MOH files can be configured on Unified CME. For calls (line or trunk calls) that need to be placed on hold and MOH needs to be played, transcode insertion is not required if the codec used is G.729 or G.711. The new feature dynamically selects Cisco Unified Communications Manager Express System Administrator Guide 833 Music on Hold Caching MOH Files for Enhanced System Performance the matching codec (either G.729 or G.711) based on the codec used on phones or trunk. Transcode insertion is required only if the codec on the phone playing Music on Hold is neither G.729 nor G.711. For more information on configuration of MOH, see Configure Music on Hold, on page 834. If G.711 and G.729 codec format MOH files are configured on Unified CME, you will need transcoding only to support other codec format MOH files, such as iLBC. You need the G.711 codec format MOH file to be configured under telephony-service for MOH to be supported on Unified CME. You have to configure the primary G.711 codec format MOH file before configuring the G.729 or G.729A codec format MOH file. We recommend that G.711 and G.729 codec format MOH files are available on the flash memory of Unified CME router. Note In a scenario where a call between an SCCP line and SIP trunk has a codec other than G.729 or G.711, then MOH is not played when the SCCP line places the SIP phone on hold. In a scenario where a call is placed between an SCCP line and a SIP line, and the call is placed on hold from the SIP end, MOH is played only from the G.711 codec format MOH file. Note Configure Music on Hold Configure Music on Hold from an Audio File to Supply Audio Stream If you configure MOH from an audio file and from a live feed, the router seeks the live feed first. If a live feed is found, it displaces an audio file source. If the live feed is not found or fails at any time, the router falls back to the audio file source. Note Note The MOH file packaged with the CME software is completely royalty free. Restriction • To change the audio file to a different file, you must remove the first file using theno mohcommand before specifying a second file. If you configure a second file without removing the first file, the MOH mechanism stops working and may require a router reboot to clear the problem. • The volume level of a MOH file cannot be adjusted through Cisco IOS software, so it cannot be changed when the file is loaded into the flash memory of the router. To adjust the volume level of a MOH file, edit the file in an audio editor before downloading the file to router flash memory. Cisco Unified Communications Manager Express System Administrator Guide 834 Music on Hold Configure Music on Hold Before You Begin • SIP phones require Cisco Unified CME 4.1 or a later version. • A music file must be in stored in the router’s flash memory. This file should be in G.711 format. The file can be in .au or .wav file format, but the file format must contain 8-bit 8-kHz data; for example, ITU-T A-law or mu-law data format. • From Cisco Unified CME Release 11.7 onwards, you can configure and store an MOH file in G.729 codec format in the router's flash memory. The G.729 file can be used as MOH source. SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. moh filename 5. multicast moh ip-address port port-number [route ip-address-list] 6. exit 7. ephone phone-tag 8. multicast-moh 9. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 3 Step 4 moh filename Enables music on hold using the specified file. Example: Router(config-telephony)# moh minuet.au • If you specify a file with this command and later want to use a different file, you must disable use of the first file with the no moh command before configuring the second file. Cisco Unified Communications Manager Express System Administrator Guide 835 Music on Hold Configure Music on Hold from an Audio File to Supply Audio Stream Command or Action Purpose • G.729 MOH file can be configured along with the G.711 MOH file. Unified CME would pick the MOH file to be played based on the negotiated codec on line or trunk. OR Router(config-telephony)# moh flash:moh_g711u_music.wav Router(config-telephony)# moh g729 flash:SampleAudioSource.g729.wav multicast moh ip-address port Specifies that this audio stream is to be used for multicast and also for MOH. port-number [route ip-address-list] Step 5 This command is required to use MOH for internal calls and it must be configured after MOH is enabled with the moh command. Note Example: Router(config-telephony)# multicast moh 239.10.16.4 port 16384 route 10.10.29.17 10.10.29.33 • ip-address—Destination IP address for multicast. • port port-number—Media port for multicast. Range is 2000 to 65535. We recommend port 2000 because it is already used for normal RTP media transmissions between IP phones and the router. Valid port numbers for multicast include even numbers that range from 16384 to 32767. (The system reserves odd values.) Note • route—(Optional) List of explicit router interfaces for the IP multicast packets. • ip-address-list—(Optional) List of up to four explicit routesfor multicast MOH. The default is that the MOH multicast stream is automatically output on the interfaces that correspond to the address that was configured with the ip source-address command. For MOH on internal calls, packet flow must be enabled to the subnet on which the phones are located. Note exit Exits telephony-service configuration mode. Example: Router(config-telephony)# exit Step 6 ephone phone-tag Enters ephone configuration mode. Example: Router(config)# ephone 28 Step 7 Step 8 multicast-moh (Optional) Enables multicast MOH on a phone. This is the default. Example: Router(config-ephone)# no multicast-moh • This command is supported in Cisco Unified CME 4.0 and later versions. • The no form of this command disables MOH for phones that do not support multicast. Callers hear a repeating tone when they are placed on hold. • This command can also be configured in ephone-template configuration mode. The value set in ephone configuration mode has priority over the value set in ephone-template mode. Cisco Unified Communications Manager Express System Administrator Guide 836 Music on Hold Configure Music on Hold from an Audio File to Supply Audio Stream Command or Action Purpose end Returns to privileged EXEC mode. Example: Router(config-ephone)# end Step 9 Examples The following example enables music on hold and specifies the music file to use: telephony-service moh minuet.wav The following example enables MOH and specifies a multicast address for the audio stream: telephony-service moh minuet.wav multicast moh 239.23.4.10 port 2000 Configure Music on Hold from a Live Feed To configure music on hold from a live feed, perform the following steps. If you configure MOH from an audio file and from a live feed, the router seeks the live feed first. If a live feed is found, it displaces an audio file source. If the live feed is not found or fails at any time, the router falls back to the audio file source. Note Restriction • A foreign exchange station (FXS) port cannot be used for a live feed. Before You Begin • SIP phones require Cisco Unified CME 4.1 or a later version. • VIC2-2FXO, VIC2-4FXO, EM-HDA-3FXS/4FXO, EM-HDA-6FXO, or EM2-HDA-4FXO • For a live feed from VoIP, VAD must be disabled. Cisco Unified Communications Manager Express System Administrator Guide 837 Music on Hold Configure Music on Hold from a Live Feed SUMMARY STEPS 1. enable 2. configure terminal 3. voice-port port 4. input gain decibels 5. auto-cut-through 6. operation 4-wire 7. signal immediate 8. signal loop-start live-feed 9. no shutdown 10. exit 11. dial peer voice tag pots 12. destination-pattern string 13. port port 14. exit 15. ephone-dn dn-tag 16. number number 17. moh[out-call outcall-number] [ip ip-address port port-number [route ip-address-list]] 18. exit 19. ephone phone-tag 20. multicast-moh 21. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 voice-port port Enters voice-port configuration mode. Example: Router(config)# voice-port 1/1/0 • Port argument is platform-dependent; type ? to display syntax. Cisco Unified Communications Manager Express System Administrator Guide 838 Music on Hold Configure Music on Hold from a Live Feed Command or Action Purpose Specifies, in decibels, the amount of gain to be inserted at the receiver side of the interface. input gain decibels Example: Router(config-voice-port)# input gain 0 Step 4 • decibels—Acceptable values are integers –6 to 14. (E&M ports only) Enables call completion when a PBX does not provide an M-lead response. auto-cut-through Example: Router(config-voice-port)# auto-cut-through Step 5 • MOH requires that you use this command with E&M ports. Step 6 operation 4-wire (E&M ports only) Selects the 4-wire cabling scheme. Example: Router(config-voice-port)# operation 4-wire • MOH requires that you specify 4-wire operation with this command for E&M ports. (E&M ports only) For E&M tie trunk interfaces, directs the calling side to seize a line by going off-hook on its E-lead and to send address information as dual tone multifrequency (DTMF) digits. signal immediate Example: Router(config-voice-port)# signal immediate Step 7 (FXO ports only) Enables an MOH audio stream from a live feed to be directly connected to the router through an FXO port. signal loop-start live-feed Example: Router(config-voice-port)# signal loop-start live-feed Step 8 • This command issupported in Cisco IOS Release 12.4(15)T and later releases. Step 9 no shutdown Activates the voice port. Example: Router(config-voice-port)# no shutdown • To shut the voice port down and disable MOH from a live feed, use the shutdown command. exit Exits voice-port configuration mode. Example: Router(config-voice-port)# exit Step 10 dial peer voice tag pots Enters dial-peer configuration mode. Example: Router(config)# dial peer voice 7777 pots Step 11 Specifies either the prefix or the full E.164 telephone number to be used for a dial peer. destination-pattern string Example: Router(config-dial-peer)# destination-pattern 7777 Step 12 Cisco Unified Communications Manager Express System Administrator Guide 839 Music on Hold Configure Music on Hold from a Live Feed Command or Action Purpose port port Associates the dial peer with the voice port that was specified in Step 3. Example: Router(config-dial-peer)# port 1/1/0 Step 13 exit Exits dial-peer configuration mode. Example: Router(config-dial-peer)# exit Step 14 Step 15 ephone-dn dn-tag Enters ephone-dn configuration mode. Example: Router(config)# ephone-dn 55 • dn-tag—Unique sequence number that identifies this ephone-dn during configuration tasks. Range is 1 to 288. Step 16 number number Configures a valid extension number for this ephone-dn. Example: Router(config-ephone-dn)# number 5555 • This number is not assigned to any phone; it is only used to make and receive calls that contain an audio stream to be used for MOH. • number—String of up to 16 digits that represents a telephone or extension number to be associated with this ephone-dn. Specifies that this ephone-dn is to be used for an incoming or outgoing call that is the source for an MOH stream. moh[out-call outcall-number] [ip ip-address port port-number [route ip-address-list]] Step 17 • (Optional) out-call outcall-number—Indicatesthat the router is calling out for a live feed for MOH and specifies the number to be called. Example: Router(config-ephone-dn)# moh out-call 7777 ip 239.10.16.8 port 2311 route 10.10.29.3 10.10.29.45 Forces a connection to the local voice port that wasspecified inStep 3. If this command is used without this keyword, the MOH stream is received from an incoming call. or Router(config-ephone-dn)# moh out-call 7777 • (Optional) ip ip-address—Destination IP address for multicast. If you are configuring MOH from a live feed and from an audio file for backup, do not configure a multicast IPaddressfor this command. If the live feed fails or is not found, MOH will fall back to the ip address that you configured using the multicast moh command in telephony-service configuration mode.See Configure Music on Hold from an Audio File to Supply Audio Stream. If you specify an address for multicast with this command and a different address with the multicast moh command in telephony-service configuration mode, you can send the MOH audio stream to two multicast addresses. • (Optional) port port-number—Media port for multicast. Range is 2000 to 65535. We recommend port 2000 because it is already used for RTP media transmissions between IP phones and the router. • (Optional) route ip-address-list—Indicates specific router interfaces on which to transmit the IP multicast packets. Up to four IPaddresses Cisco Unified Communications Manager Express System Administrator Guide 840 Music on Hold Configure Music on Hold from a Live Feed Command or Action Purpose can be listed. Default: The MOH multicast stream is automatically output on the interfaces that correspond to the address that was configured with the ip source-address command. exit Exits ephone-dn configuration mode. Example: Router(config-ephone-dn)# exit Step 18 ephone phone-tag Enters ephone configuration mode. Example: Router(config)# ephone 28 Step 19 Step 20 multicast-moh (Optional) Enables multicast MOH on a phone. This is the default. Example: Router(config-ephone)# no multicast-moh • This command is supported in Cisco Unified CME 4.0 and later versions. • The no form of this command disables MOH for phones that do not support multicast. Callers hear a repeating tone when they are placed on hold. • This command can also be configured in ephone-template configuration mode. The value set in ephone configuration mode has priority over the value set in ephone-template mode. end Returns to privileged EXEC mode. Example: Router(config-ephone)# end Step 21 Examples The following example enables MOH from an outgoing call on voice port 1/1/0 and dial peer 7777: voice-port 1/1/0 auto-cut-through operation 4-wire signal immediate ! dial-peer voice 7777 pots destination-pattern 7777 port 1/1/0 ! ephone-dn 55 number 5555 moh out-call 7777 Cisco Unified Communications Manager Express System Administrator Guide 841 Music on Hold Configure Music on Hold from a Live Feed The following example enables MOH from a live feed and if the live feed is not found or fails at any time, the router falls back to the music file (music-on-hold.au) and multicast address for the audio stream specified in the telephony-service configuration: voice-port 0/1/0 auto-cut-through operation 4-wire signal immediate timeouts call-disconnect 1 description MOH Live Feed ! dial-peer voice 7777 pots destination-pattern 7777 port 0/1/0 ! telephony-service max-ephones 24 max-dn 192 ip source-address 10.232.222.30 port 2000 moh music-on-hold.au multicast moh 239.1.1.1 port 2000 ! ephone-dn 52 number 1 moh out-call 7777 Configure Music on Hold Groups to Support Different Media Sources Restriction • Media files from live-feed source are not supported. • Each MOH group must contain a unique flash media file name, extension numbers, and multicast destination. If you enter any extension ranges, MOH filenames, and multicast IP addresses that already exist in another MOH-group, an error message is issued and the new input in the current voice MOH-group is discarded. • Media file CODEC format is limited to G.711 and G.729. Before You Begin • Cisco Unified CME 8.0 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. voice moh-group moh-group-tag 4. description string 5. moh filename 6. multicast moh ip-address port port-number route ip-address-list 7. extension-range starting-extension to ending-extension 8. end Cisco Unified Communications Manager Express System Administrator Guide 842 Music on Hold Configure Music on Hold Groups to Support Different Media Sources DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters the voice moh-group configuration mode. You can create up to five voice moh-groups for ephones receiving music on hold voice moh-group moh-group-tag Example: Router(config-telephony)# voice moh-group 1 Step 3 audio files when placed on hold. Range for the voice moh-groups is 1 to 5. (Optional) Allows you to add a brief description specific to a voice MOH group. You can use up to 80 characters to describe the voice MOH group. description string Example: Router(config-voice-moh-group)# description moh group for sales Step 4 Enables music on hold using the specified MOH source file. The MOH file must be in .au and .wav format. MOH filename length moh filename Example: Router(config-voice-moh-group)# moh flash:/minuet.au Step 5 should not exceed 128 characters. You must provide the directory and filename of the MOH file in URL format. For example: moh flash:/minuet.au • If you specify a file with this command and later want to use a different file, you must disable use of the first file with the no moh command before configuring the second file. Specifies that this audio stream is to be used for multicast and also for MOH. multicast moh ip-address port port-number route ip-address-list Step 6 Example: Router((config-voice-moh-group)# multicast moh 239.10.16.4 port 16384 route 10.10.29.17 10.10.29.33 This command is required to use MOH for internal calls and it must be configured after MOH is enabled with the moh command. Note • ip-address—Destination IP address for multicast. • port port-number—Media port for multicast. Range is 2000 to 65535. We recommend port 2000 because it is already used for normal RTP media transmissions between IP phones and the router. Valid port numbers for multicast include even numbers that range from 16384 to 32767. (The system reserves odd values.) Note Cisco Unified Communications Manager Express System Administrator Guide 843 Music on Hold Configure Music on Hold Groups to Support Different Media Sources Command or Action Purpose • route—(Optional) List of explicit router interfaces for the IP multicast packets. • ip-address-list—(Optional) List of up to four explicit routes for multicast MOH. The default is that the MOH multicast stream is automatically output on the interfacesthat correspond to the address that was configured with the ipsource-address command. For MOH on internal calls, packet flow must be enabled to the subnet on which the phones are located. Note (Optional) identifies MOH callers calling the extension numbers specified in a MOH group. Extension number must be in extension-range starting-extension to ending-extension Example: Router(config-voice-moh-group)#extension-range 1000 to 1999 Step 7 hexadecimal digits(0-9) or (A-F). Both extension numbers(starting extension and ending extension) must contain equal number of digits. Repeat this command to add additional extension ranges. • starting-extension—(Optional) Lists the starting extension number for a moh-group. Router(config-voice-moh-group)#extension-range 2000 to 2999 • ending-extension—(Optional) Lists the ending extension number for a moh-group. The ending extension number must be greater than or equal to the starting extension number. Extension-ranges must not overlap with any other extension-range configured in any other MOH group. Note If extension range is defined and a moh-group is also defined in an ephone-dn, the ephone-dnparameterstakes precedence. Note end Returns to privileged EXEC mode. Example: Router(config-voice-moh-group)# end Step 8 Examples In the following example, totalsix MOH groups are configured. MOH group 1 through 5 are configured under voice-moh-group configuration mode and MOH group 0 is the MOH source file configured under telephony-services. router# show voice moh-group telephony-service moh alaska.wav Moh multicast 239.1.1.1 port 16384 route 10.1.4.31 10.1.1.2 voice moh-group 1 description this moh group is for sales moh flash:/hello.au multicast moh 239.1.1.1 port 16386 route 239.1.1.3 239.1.1.3 extension-range 1000 to 1999 Cisco Unified Communications Manager Express System Administrator Guide 844 Music on Hold Configure Music on Hold Groups to Support Different Media Sources extension-range 2000 to 2999 extension-range 3000 to 3999 extension-range A1000 to A1999 voice moh-group 2 description (not configured) moh flash1:/minuet.au multicast moh 239.23.4.10 port 2000 extension-range 7000 to 7999 extension-range 8000 to 8999 voice moh-group 3 description This is for marketing moh flash2:/happy.au multicast moh 239.15.10.1 port 3000 extension-range 9000 to 9999 voice moh-group 4 description (not configured) moh flash:/audio/sun.au multicast moh 239.16.12.1 port 4000 extension-range 10000 to 19999 voice moh-group 5 description (not configured) moh flash:/flower.wav multicast moh 239.12.1.2 port 5000 extension-range 0012 to 0024 extension-range 0934 to 0964 === Total of 6 voice moh-groups === Assign a MOH Group to a Directory Number Restriction • Do not use same extension number for different MOH groups. Before You Begin • Cisco Unified CME 8.0 or a later version. • MOH groups must be configured under global configuration mode. SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-dn tag 4. number 5. moh-group tag 6. end Cisco Unified Communications Manager Express System Administrator Guide 845 Music on Hold Assign a MOH Group to a Directory Number DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 ephone-dn tag Enters ephone-dn configuration mode. Example: Router(config)# ephone-dn 1 In ephone-dn configuration mode, you assign an extension number using the number command. You can also configure a MOH group to an ephone-dn- template for use across a range of ephone-dns. If two different MOH groups are configured as a result of this command, the MOH group configured under the ephone-dn configuration takes precedence. MOH group configuration for ephone-template-dn configuration command is temporarily prohibited when any directory number using that template is on hold. Note Allows you to define an extension number and associate this number to a telephone. number Example: Router(config)# ephone-dn 1 Router(config-ephone-dn)# number 1001 Step 4 Step 5 moh-group tag Allows you to assign a MOH group to a directory number. Example: Router(config-telephony)#voice moh-group 1 Router(config-voice-moh-group)# • MOH group tag— identifiesthe unique number assigned to a MOH group for configuration tasks. end Returns to privileged EXEC mode. Example: Router(config-ephone)# end Step 6 Cisco Unified Communications Manager Express System Administrator Guide 846 Music on Hold Assign a MOH Group to a Directory Number Examples In the following example different moh groups are assigned to different directory numbers (ephone-dn) moh group1 is assigned to ephone-dn 1, moh-group 4 is assigned to ephone-dn 4, and moh-group 5 is assigned to ephone-dn 5. ephone-dn 1 octo-line number 7001 name DN7001 moh-group 1 ! ephone-dn 2 dual-line number 7002 name DN7002 call-forward noan 6001 timeout 4 ! ephone-dn 3 number 7003 name DN7003 snr 7005 delay 3 timeout 10 allow watch call-forward noan 8000 timeout 30 ! ! ephone-dn 4 dual-line number 7004 allow watch call-forward noan 7001 timeout 10 moh-group 4 ! ephone-dn 5 number 7005 name DN7005 moh-group 5 ! Assign a MOH Group to all Internal Calls Only to SCCP Phones Restriction • Do not use same extension number for different MOH groups. Before You Begin • Cisco Unified CME 8.0 or a later version. • MOH groups must be configured under global configuration mode. SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. internal-call moh-group tag 5. end Cisco Unified Communications Manager Express System Administrator Guide 847 Music on Hold Assign a MOH Group to all Internal Calls Only to SCCP Phones DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 telephony-service Enters telephony-service configuration mode. Example: Router(config-telephony)# ephone-dn 1 In ephone-dn configuration mode, you assign an extension number using the number command. Step 4 internal-call moh-group tag Allows to assign a MOH-group for all internal directory numbers. Example: Router(config)# • Moh group tag— identifies the unique number assigned to a MOH group for configuration tasks, Range for the tag isfrom 0 to 5, where 0 represents MOH configuration in telephony service. Router(config-telephony)# internal call moh-group 4 end Returns to privileged EXEC mode. Example: Router(config-ephone)# end Step 5 Examples The following examples shows moh-group 4 configured for internal directory calls. telephony-service sdspfarm conference mute-on *6 mute-off *8 sdspfarm units 4 sdspfarm transcode sessions 2 sdspfarm tag 1 moto-HW-Conf moh flash1:/minuet.au Moh multicast 239.1.1.1 port 16384 route 10.1.4.31 10.1.1.2 internal-call moh-group 4 em logout 0:0 0:0 0:0 max-ephones 110 max-dn 288 ip source-address 15.2.0.5 port 2000 auto assign 1 to 1 caller-id block code *9999 service phone settingsAccess 1 service phone spanTOPCPort 0 service dss timeouts transfer-recall 12 Cisco Unified Communications Manager Express System Administrator Guide 848 Music on Hold Assign a MOH Group to all Internal Calls Only to SCCP Phones Configure Buffer Size for MOH Files Restriction • MOH file caching is prohibited if live-feed is enabled for MOH-group 0. • MOH file buffer size must be larger than the MOH file (size) that needs to be cached. • Sufficient system memory must be available for MOH file caching. Before You Begin • Cisco Unified CME 8.0 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. moh-file-buffer file size 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 telephony-service Enters telephony-service configuration mode. Example: Router(config-telephony)# ephone-dn 1 In ephone-dn configuration mode, you assign an extension number using the number command. (Optional) Allows to set a buffer for the MOH file size. You can configure a max file buffer size (per file) anywhere between 64 KB moh-file-buffer file size Example: Router(config-telephony)# moh-file-buffer 2000 Step 4 (8 seconds) to 10000 KB (approximately 20 minutes), Default moh-file-buffer size is 64 KB (8 seconds). A large buffer size is desirable to cache the largest MOH file and a better system performance. Note Cisco Unified Communications Manager Express System Administrator Guide 849 Music on Hold Configure Buffer Size for MOH Files Command or Action Purpose end Returns to privileged EXEC mode. Example: Router(config-ephone)# end Step 5 Examples The following examples shows 90 KB as the configured moh-file-buffer size. telephony-service sdspfarm conference mute-on *6 mute-off *8 sdspfarm units 4 sdspfarm transcode sessions 2 sdspfarm tag 1 moto-HW-Conf moh flash1:/minuet.au Moh multicast 239.1.1.1 port 16384 route 10.1.4.31 10.1.1.2 moh-file-buffer 90 em logout 0:0 0:0 0:0 max-ephones 110 max-dn 288 ip source-address 15.2.0.5 port 2000 auto assign 1 to 1 caller-id block code *9999 service phone settingsAccess 1 service phone spanTOPCPort 0 service dss timeouts transfer-recall 12 Verify MOH File Caching Use the show ephone moh command to verify if the MOH file is being cached. The following examples shows that the minuet.au music file in MOH group 1 is not cached. Follow steps a through d to verify the MOH file is being cached. Example: Router #show ephone moh Skinny Music On Hold Status (moh-group 1) Active MOH clients 0 (max 830), Media Clients 0 File flash:/minuet.au (not cached) type AU Media_Payload_G711Ulaw64k 160 bytes Moh multicast 239.10.16.6 port 2000 a) If the file is not cached as in MOH group 1 in the above example, then check file size in the flash. Example: Router#dir flash:/minuet.au Directory of flash:/minuet.au 32 -rw- 1865696 Apr 25 2009 00:47:12 +00:00 moh1.au b) Under telephony-service, configure “moh-file-buffer ”. Default file size is 64 KB (8 seconds). Make sure you enter a larger file size to cache large MOH files that you may use in future. Cisco Unified Communications Manager Express System Administrator Guide 850 Music on Hold Verify MOH File Caching Example: Router(config)# telephony-service Router(config-telephony)# moh-file-buffer 2000 c) Under voice moh-group , configure “no moh”, and immediately configure “moh ”. This allows the MOH server to read the file immediately from flash again. Example: Router(config-telephony)#voice moh-group 1 Router(config-voice-moh-group)#no moh Router(config-voice-moh-group)#moh flash:/minuet.au d) Depending on the size of the file, you should see the MOH file caching after a few minutes(approximately, 2 minutes). Example: Router #show ephone moh Skinny Music On Hold Status - group 1 Active MOH clients 0 (max 830), Media Clients 0 File flash:/moh1.au (cached) type AU Media_Payload_G711Ulaw64k 160 bytes Moh multicast 239.10.16.6 port 2000 MOH file caching is prohibited under the following conditions: if live feed is configured in moh-group 0, If file buffer size smaller than file size, or insufficient system memory. Note Verify Music on Hold Group Configuration Step 1 Use the show voice moh-group command to display one or the entire moh-group configuration. The following example shows allsix MOH groups with extension ranges, MOH files, and multicast destination addresses. router# show voice moh-group telephony-service moh alaska.wav Moh multicast 239.1.1.1 port 16384 route 10.1.4.31 10.1.1.2 voice moh-group 1 description this moh group is for sales moh flash:/audio?minuet.au multicast moh 239.1.1.1 port 16386 route 239.1.1.2 239.1.1.3 extension-range 1000 to 1999 extension-range 2000 to 2999 extension-range 3000 to 3999 extension-range 20000 to 22000 extension-range A1000 to A1999 voice moh-group 2 Cisco Unified Communications Manager Express System Administrator Guide 851 Music on Hold Verify Music on Hold Group Configuration description (not configured) moh flash:/audio/hello.au multicast moh 239.23.4.10 port 2000 extension-range 7000 to 7999 extension-range 8000 to 8999 voice moh-group 3 description This is for marketing moh flash:/happy.au multicast moh 239.15.10.1 port 3000 extension-range 9000 to 9999 voice moh-group 4 description (not configured) moh flash:/audio/sun.au multicast moh 239.16.12.1 port 4000 extension-range 10000 to 19999 voice moh-group 5 description (not configured) moh flash:/flower.wav multicast moh 239.12.1.2 port 5000 extension-range 0012 to 0024 extension-range 0934 to 0964 === Total of 6 voice moh-groups === Step 2 Use the show ephone moh to display information about the different MOH group configured. The following example displays information about five different MOH groups. Router # show ephone moh Skinny Music On Hold Status (moh-group 1) Active MOH clients 0 (max 830), Media Clients 0 File flash:/minuet.au (not cached) type AU Media_Payload_G711Ulaw64k 160 bytes Moh multicast 239.10.16.6 port 2000 Skinny Music On Hold Status (moh-group 2) Active MOH clients 0 (max 830), Media Clients 0 File flash:/audio/hello.au type AU Media_Payload_G711Ulaw64k 160 bytes Moh multicast on 239.10.16.6 port 2000 via 0.0.0.0 Skinny Music On Hold Status (moh-group 3) Active MOH clients 0 (max 830), Media Clients 0 File flash:/bells.au type AU Media_Payload_G711Ulaw64k 160 bytes Moh multicast on 239.10.16.5 port 2000 via 0.0.0.0 Skinny Music On Hold Status (moh-group 4) Active MOH clients 0 (max 830), Media Clients 0 File flash:/3003.au type AU Media_Payload_G711Ulaw64k 160 bytes Moh multicast on 239.10.16.7 port 2000 via 0.0.0.0 Skinny Music On Hold Status (moh-group 5) Cisco Unified Communications Manager Express System Administrator Guide 852 Music on Hold Verify Music on Hold Group Configuration Active MOH clients 0 (max 830), Media Clients 0 File flash:/4004.au type AU Media_Payload_G711Ulaw64k 160 bytes Moh multicast on 239.10.16.8 port 2000 via 0.0.0.0 Step 3 Use the show voice moh-group statistics command to display the MOH subsystem statistics information. In the following example, the MOH Group Streaming Interval Timing Statistics shows the media packet counts during streaming intervals. Each packet counter is of 32 bit size and holds a count limit of 4294967296. This means that with 20 milliseconds packet interval (for G.711), the counters will restart from 0 any time after 2.72 years (2 years 8 months). Use the clear voice moh-group statistics once in every two years to reset the packet counters. MOH GroupPacket Transmission TimingStatisticsshowsthe maximum and minimum amount of time (in microseconds) taken by the MOH groups to send out media packets. The MOH Group Loopback Interval Timing Statistics is available when loopback interface is configured as part of the multicast MOH routes as in the case of SRST. These counts are loopback packet counts within certain streaming timing intervals. router# show voice moh-group statistics MOH Group Streaming Interval Timing Statistics: Grp# ~19 msec 20~39 40~59 60~99 100~199 200+ msec ==== ========== ========== ========== ========== ========== ========== 0: 25835 17559966 45148 0 0 1 1: 19766 17572103 39079 0 0 1 2: 32374 17546886 51687 0 0 1 3: 27976 17555681 47289 0 0 1 4: 34346 17542940 53659 0 0 1 5: 14971 17581689 34284 0 0 1 MOH Group Packet Transmission Timing Statistics: Grp# max(usec) min(usec) ==== ========== ========== 0: 97 7. 1: 95 7. 2: 97 7. 3: 96 7. 4: 94 7. 5: 67 7. MOH Group Loopback Interval Timing Statistics: loopback event array: svc_index=1542, free_index=1549, max_q_depth=31 Grp# ~19 msec 20~39 40~59 60~99 100~199 200+ msec ==== ========== ========== ========== ========== ========== ========== 0: 8918821 8721527 10023 0 1 1 1: 9007373 8635813 7184 0 1 1 2: 8864760 8772851 12758 0 1 1 3: 8924447 8715457 10464 0 1 1 4: 8858393 8778957 13017 0 1 1 5: 9005511 8639936 4919 0 1 1 Statistics collect time: 4 days 2 hours 5 minutes 39 seconds. Step 4 Use the clear voice moh-group statistics command to clear the display of MOH subsystem statistics information. Cisco Unified Communications Manager Express System Administrator Guide 853 Music on Hold Verify Music on Hold Group Configuration For Example: router# clear voice moh-group statistics All moh group stats are cleared Feature Information for Music on Hold The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Table 70: Feature Information for Music on Hold Feature Name Cisco Unified CME Version Feature Information Music on Hold Support for configuration of G.711 and G.729 codec format MOH file on Unified CME is added. 11.7 Music on hold from different media sources is added. 8.0 Music on hold for SIP phones is supported. 4.1 • Music on hold is introduced for internal calls. • The ability to disable multicast MOH per phone is introduced. 4.0 The ability to use a live audio feed as a multicastsource isintroduced. 3.0 Music on hold from a live audio feed is introduced for external calls. 2.1 Music on hold from an audio file is introduced for external calls. 2.0 Cisco Unified Communications Manager Express System Administrator Guide 854 Music on Hold Feature Information for Music on Hold Cisco Unified Communications Manager Express System Administrator Guide 855 Music on Hold Feature Information for Music on Hold Cisco Unified Communications Manager Express System Administrator Guide 856 Music on Hold Feature Information for Music on Hold CHAPTER 30 Paging • Restrictions for Paging, page 857 • Information About Paging, page 857 • Configure Paging, page 860 • Configuration Examples for Paging, page 869 • Where to Go Next, page 873 • Feature Information for Paging, page 873 Restrictions for Paging • Paging is not supported on IP phones without speaker phones. • Paging is not supported on Cisco Unified 3905 SIP IP phones. • Paging is only supported on G711ulaw codec. Information About Paging Audio Paging A paging number can be defined to relay audio pages to a group of designated phones. When a caller dials the paging number (ephone-dn), each idle IP phone that has been configured with the paging number automatically answers using its speaker-phone mode. Displays on the phones that answer the page show the caller ID that has been set using the name command under the paging ephone-dn. When the caller finishes speaking the message and hangs up, the phones are returned to their idle states. Audio paging provides a one-way voice path to the phones that have been designated to receive paging. It does not have a press-to-answer option like the intercom feature. A paging group is created using a dummy ephone-dn, known as the paging ephone-dn, that can be associated with any number of local IP phones. The paging ephone-dn can be dialed from anywhere, including on-net. Cisco Unified Communications Manager Express System Administrator Guide 857 After you have created two or more simple paging groups, you can unite them into combined paging groups. By creating combined paging groups, you provide phone users with the flexibility to page a small local paging group (for example, paging four phones in a store’s jewelry department) or to page a combined set of several paging groups(for example, by paging a group that consists of both the jewelry department and the accessories department). The paging mechanism supports audio distribution using IP multicast, replicated unicast, and a mixture of both (so that multicast is used where possible, and unicast is used for specific phones that cannot be reached using multicast). Figure 35: Paging Group, on page 858 shows a paging group with two phones. Figure 35: Paging Group Cisco Unified Communications Manager Express System Administrator Guide 858 Paging Audio Paging Paging Group Support for Cisco Unified SIP IP Phones Paging provides a one-way voice path from the paging phone to the paged phone. The paged phone automatically answers the page in speaker-phone mode with Mute activated. The paged phone receives a page when it is idle or busy. When it is busy with a connected call, the user of the paged phone can hear both the active conversation and whisper paging. Before Cisco Unified CME 9.0, you can specify a paging-dn tag and dial the paging extension number to page the Cisco Unified SCCP IP phone associated with the paging-dn tag or paging group using the paging-dn command in ephone or ephone-template configuration mode. You can also page a combined paging group composed of two or more previously established paging groups of Cisco Unified SCCP IP phone directory numbers using the paging group command in ephone-dn configuration mode. In Cisco Unified CME 9.0 and later versions, support is extended so that you can specify a paging-dn tag and dial the paging extension number to page the Cisco Unified SIP IP phone associated with the paging-dn tag or paging group using the paging-dn command in voice register pool or voice register template configuration mode. Paging on Cisco Unified SIP IP phones support both unicast and multicast paging in the same way that these features are supported on Cisco Unified SCCP IP Phones. In Cisco Unified CME 9.0 and later versions, support is also extended so that you can create a combined paging group composed of two or more previously established paging groups of ephone and voice register directory numbers using the same paging group command used for paging groups of Cisco Unified SCCP IP phone directory numbers. The paging port for Cisco Unified SIP IP phones is an even number from 20480 to 32768. If you enter a wrong port number, a SIP REFER message request is sent to the IP phone but the Cisco Unified SIP IP phone is not paged. Note With a paging-dn, there is only one paging endpoint and there is only one paging number for both Cisco Unified SCCP and Cisco Unified SIP IP phones. However, when paging to a Cisco Unified SIP shared line, each phone on the shared line is treated separately. A phone that can be paged by two paging-dns receives the page from the first paging-dn and ignores the page from the second paging-dn. When the first paging-dn is disconnected, the phone can receive the page from the second paging-dn. The paging group support for Cisco UnifiedSIPIPphones uses an ephone paging-dn to dial the paging number before branching out to each Cisco Unified SCCP and Cisco Unified SIP IP phone. The show ephone-dn paging command displays which paging-dn is specified and which phone is being paged. Because paging is not considered a call, a paging phone that is in a connected state can press another line to make a call using the phone’s softkeys. The Cisco Unified SIP IP phone Paging feature also supports: • multicast paging (default) • unicast paging For more information, see Configure Paging Group Support for SIP IP Phones, on page 864. Cisco Unified Communications Manager Express System Administrator Guide 859 Paging Paging Group Support for Cisco Unified SIP IP Phones Configure Paging Configure a Simple Paging Group on SCCP Phones To set up a paging number that relays incoming pages to a group of phones, perform the following steps. Restriction IP phones do not support multicast at 224.x.x.x addresses. SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-dn paging-dn-tag 4. number number 5. name name 6. paging [ip multicast-address port udp-port-number] 7. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 ephone-dn paging-dn-tag Enters ephone-dn configuration mode. Example: Router(config)# ephone-dn 42 • paging-dn-tag—A unique sequence number that identifies this paging ephone-dn during all configuration tasks. This is the ephone-dn that is dialed to initiate a page. This ephone-dn is not associated with a physical phone. Range is 1 to 288. Do not use the dual-line keyword with this command. Paging ephone-dns cannot be dual-line. Note Cisco Unified Communications Manager Express System Administrator Guide 860 Paging Configure Paging Command or Action Purpose Defines an extension number associated with the paging ephone-dn. This is the number that people call to initiate a page. number number Example: Router(config-ephone-dn)# number 3556 Step 4 Assigns to the paging number a name to appear in caller-ID displays and directories. name name Example: Router(config-ephone-dn)# name paging4 Step 5 Specifies that this ephone-dn is to be used to broadcast paging messages to the idle IPphonesthat are associated with the paging dn-tag. If the optional keywords paging [ip multicast-address port udp-port-number] Step 6 and arguments are not used, IP phones are paged individually using IP unicast Example: Router(config-ephone-dn)# paging ip 239.1.1.10 port 2000 transmission (to a maximum of ten IP phones). The optional keywords and arguments are as follows: • ip multicast-addressport udp-port-number—Specifies multicast broadcast using the specified IP address and UDP port. When multiple paging numbers are configured, each paging number must use a unique IP multicast address. We recommend port 2000 because it is already used for normal non-multicast RTP media streams between phones and the Cisco Unified CME router. IP phones do not support multicast at 224.x.x.x addresses. Note The correct paging port for the paging-dn of Cisco Unified SIP IP phones is an even number from 20480 to 32768. If you enter a wrong port number, a SIP REFER message request is sent to the IP phone but the Cisco Unified SIP IP phone is not paged. Note end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 7 Configure a Combined Paging Group for SCCP Phones To set up a combined paging group consisting of two or more simple paging groups, perform the following steps. Before You Begin Simple paging groups must be configured. See Configure a Simple Paging Group on SCCP Phones, on page 860. Cisco Unified Communications Manager Express System Administrator Guide 861 Paging Configure a Combined Paging Group for SCCP Phones SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-dn paging-dn-tag 4. number number 5. name name 6. paging group paging-dn-tag, paging-dn-tag [[,paging-dn-tag]...] 7. exit 8. ephone phone-tag 9. paging-dn paging-dn-tag {multicast | unicast} 10. exit 11. Repeat Step 8 to Step 10 to add additional IP phones to a paging group. 12. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters ephone-dn configuration mode to create a paging number for a combined paging group. ephone-dn paging-dn-tag Example: Router(config)# ephone-dn 42 Step 3 • paging-dn-tag—A unique sequence number that identifies this paging ephone-dn during all configuration tasks. This is the ephone-dn that is dialed to initiate a page. This ephone-dn is not associated with a physical phone. Range is 1 to 288. Do not use the dual-line keyword with this command. Paging ephone-dns cannot be dual-line. Note Defines an extension number associated with the combined group paging ephone-dn. Thisisthe number that people call to initiate a page to the combined group. number number Example: Router(config-ephone-dn)# number 3556 Step 4 Cisco Unified Communications Manager Express System Administrator Guide 862 Paging Configure a Combined Paging Group for SCCP Phones Command or Action Purpose (Optional) Assigns to the combined group paging number a name to appear in caller-ID displays and directories. name name Example: Router(config-ephone-dn)# name paging4 Step 5 Sets the paging directory number for a combined group. This command combines the individual paging group ephone-dns that you specify into a paging group paging-dn-tag, paging-dn-tag [[,paging-dn-tag]...] Step 6 combined group so that a page can be sent to more than one paging group at a time. Example: Router(config-ephone-dn)# paging group 20,21 • paging-dn-tag—Unique sequence number associated with the paging number for an individual paging group. Lists the paging-dn-tags of all the individual groups that you want to include in this combined group, separated by commas. You can include up to ten paging ephone-dn tags in this command. Configure the paging command for all ephone-dns in a paging group before configuring the paging group command for that group. Note exit Exits ephone-dn configuration mode. Example: Router(config-ephone-dn)# exit Step 7 Step 8 ephone phone-tag Enters ephone configuration mode to add IP phones to the paging group. Example: Router(config)# ephone 2 • phone-tag—Unique sequence number of a phone to receive audio pages when the paging ephone-dn is called. Associates this ephone with an ephone-dn tag that is used for a paging ephone-dn (the number that people call to deliver a page). Note that the paging ephone-dn tag is not associated with a line button on this ephone. paging-dn paging-dn-tag {multicast | unicast} Example: Router(config-ephone)# paging-dn 42 multicast Step 9 The paging mechanism supports audio distribution using IP multicast, replicated unicast, and a mixture of both (so that multicast is used where possible and unicast is allowed to specific phones that cannot be reached through multicast). • paging-dn-tag—Unique sequence number for a paging ephone-dn. • multicast—(Optional) Multicast paging for groups. By default, paging is transmitted to the Cisco Unified IP phone using multicast. • unicast—(Optional) Unicast paging for a single Cisco Unified IPphone. This keyword indicates that the Cisco Unified IP phone is not capable of receiving paging through multicast and requests that the phone receive paging through a unicast transmission directed to the individual phone. The number of phones supported through unicast is limited to a maximum of ten phones. Note Cisco Unified Communications Manager Express System Administrator Guide 863 Paging Configure a Combined Paging Group for SCCP Phones Command or Action Purpose exit Exits ephone configuration mode. Example: Router(config-ephone)# exit Step 10 Repeat Step 8 to Step 10 to add — additional IPphones to a paging group. Step 11 end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 12 Configure Paging Group Support for SIP IP Phones Note • Paging Group is supported in Cisco Unified CME but not in Cisco Unified SRST. • Paging is not supported on Cisco Unified 3905 SIP IP phones. • Cisco Unified SCCP IP phones do not support whisper paging. Only idle IP phones can receive paging requests. Before You Begin Cisco Unified CME 9.0 or a later version. Cisco Unified Communications Manager Express System Administrator Guide 864 Paging Configure Paging Group Support for SIP IP Phones SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-dn dn-tag 4. number number 5. paging [ip multicast-address port udp-port-number] 6. Repeat Step 3 to Step 5 to add more Cisco Unified SCCP IP phones to the paging group. Skip Step 7 for each IP phone except for the last one. 7. paging group paging-dn-tag, paging-dn-tag 8. exit 9. voice register dn dn-tag 10. number number 11. exit 12. Repeat Step 9 to Step 11 to associate more telephone or extension numbers with Cisco Unified SIP IP phones. 13. voice register pool pool-tag 14. id mac address 15. type phone-type 16. number tag dn dn-tag 17. paging-dn paging-dn-tag 18. RepeatStep 13 toStep 17 to register additional Cisco UnifiedSIPIPphones to ephone-dn paging directory numbers. Exit from voice register pool configuration mode after each additional phone is registered. After the last phone is added, go directly to Step 19. 19. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 ephone-dn dn-tag Enters ephone-dn configuration mode. Example: Router(config)# ephone-dn 20 • dn-tag—Unique number that identifies an ephone-dn during configuration tasks. Range is 1 to the number set by the max-dn command. Cisco Unified Communications Manager Express System Administrator Guide 865 Paging Configure Paging Group Support for SIP IP Phones Command or Action Purpose Step 4 number number Associates a telephone or extension number with this ephone-dn. Example: Router(config-ephone-dn)# number 2000 • number—String of up to 16 characters that represents an E.164 telephone number. Normally, the string is composed of digits, but the string may contain alphabetic characters when the number is dialed only by the router, as with an intercom number. One or more periods (.) can be used as wildcard characters. Defines an extension (ephone-dn) as a paging extension that can be called to broadcast an audio page to a set of Cisco Unified IP phones. paging [ip multicast-address port udp-port-number] Step 5 Example: Router(config-ephone-dn)# paging ip 239.0.1.20 port 20480 • ip multicast-address—(Optional) Uses an IP multicast address to multicast voice packets for audio paging; for example, 239.0.1.1. IP phones do not support multicast at 224.x.x.x addresses. Default is that multicast is not used and IP phones are paged individually using IP unicast transmission (up to ten phones). Note • port udp-port-number—(Optional) Uses this UDP port for the multicast. Range: 2000 to 65535. If any of the paged phones is a Cisco Unified SIP IP phone, the correct paging port for the paging-dn is an even number from 20480 to 32768. If you enter a wrong port number, aSIP REFER message request is sent to the IP phone but the Cisco Unified SIP IP phone is not paged. Note Repeat Step 3 to Step 5 to add more Cisco — UnifiedSCCPIPphonesto the paging group. Step 6 Skip Step 7 for each IP phone except for the last one. Creates a combined paging group from two or more previously established paging sets. paging group paging-dn-tag, paging-dn-tag Example: Router(config-ephone-dn)# paging group 20 Step 7 • paging-dn-tag—Comma-separated list of paging-dn-tagsthat have previously been associated with the paging extension of a paging set using the paging-dn command. You can include up to ten paging-dn-tags separated by commas; for example, 4, 6, 7, 8. exit Exits ephone-dn configuration mode. Example: Router(config-ephone-dn)# exit Step 8 Step 9 voice register dn dn-tag Enters voice register dn configuration mode. Example: Router(config)# voice register dn 1 • dn-tag—Unique sequence number that identifies a particular directory number during configuration tasks. Range is 1 to 150 or the maximum defined by the max-dn command. Cisco Unified Communications Manager Express System Administrator Guide 866 Paging Configure Paging Group Support for SIP IP Phones Command or Action Purpose Associates a telephone or extension number with a Cisco Unified SIP IP phone in a Cisco Unified CME system. number number Example: Router(config-register-dn)# number 1201 Step 10 • number—String of up to 16 characters that represents an E.164 telephone number. Normally, the string is composed of digits, but the string may contain alphabetic characters when the number is dialed only by the router, as with an intercom number. exit Exits voice register dn configuration mode. Example: Router(config-register-dn)# exit Step 11 Repeat Step 9 to Step 11 to associate more — telephone or extension numbers with Cisco Unified SIP IP phones. Step 12 Enters voice register pool configuration mode and creates a pool configuration for a Cisco Unified SIP IP phone in Cisco Unified CME. voice register pool pool-tag Example: Router(config)# voice register pool 1 Step 13 • pool-tag—Unique number assigned to the pool. Range: 1 to 100. For Cisco Unified CME systems, the upper limit for this argument is defined by the max-pool command. Note Step 14 id mac address identifies a locally available Cisco Unified SIP IP phone. Example: Router(config-register-pool)# id mac 0019.305D.82B8 • mac address—identifies the MAC address of a particular Cisco Unified SIP IP phone. Step 15 type phone-type Defines a phone type for a Cisco Unified SIP IP phone. Example: Router(config-register-pool)# type 7961 • phone-type—Type of Cisco Unified SIP IP phone that is being defined. Indicates the E.164 phone numbers that the registrar permits to handle the Register message from the Cisco Unified SIP IP phone. number tag dn dn-tag Example: Router(config-register-pool)# number 1 dn 1 Step 16 • tag—identifies the telephone number when there are multiple number commands. Range: 1 to 10. • dn dn-tag—identifies the directory number tag for this phone number as defined by the voice register dn command. Range: 1 to 150. Registers a Cisco UnifiedSIPIPphone to an ephone-dn paging directory number. paging-dn paging-dn-tag Example: Router(config-register-pool)# paging-dn 20 Step 17 • paging-dn-tag—Ephone-dn tag designated asthe paging ephone-dn to which a Cisco Unified SIP IP phone is registered. Cisco Unified Communications Manager Express System Administrator Guide 867 Paging Configure Paging Group Support for SIP IP Phones Command or Action Purpose Repeat Step 13 to Step 17 to register — additional Cisco Unified SIP IP phones to Step 18 ephone-dn paging directory numbers. Exit from voice register pool configuration mode after each additional phone isregistered. After the last phone is added, go directly toStep 19. Exits voice register pool configuration mode and enters privileged EXEC mode. end Example: Router(config-register-pool)# end Step 19 Troubleshooting Tips Use the debug ephone paging command to collect debugging information on paging for both Cisco Unified SIP IP and Cisco Unified SCCP IP phones. Verify Paging Step 1 Use the show running-config command to display the running configuration. Paging ephone-dns are listed in the ephone-dn portion of the output. Phones that belong to paging groups are listed in the ephone part of the output. Router# show running-config ephone-dn 48 number 136 name PagingCashiers paging ip 239.1.1.10 port 2000 ephone 2 headset auto-answer line 1 headset auto-answer line 4 ephone-template 1 username "FrontCashier" mac-address 011F.2A0.A490 paging-dn 48 type 7960 no dnd feature-ring no auto-line button 1f43 2f44 3f45 4:31 Step 2 Use the show telephony-service ephone-dn and show telephony-service ephone commands to display only the configuration information for ephone-dns and ephones. Cisco Unified Communications Manager Express System Administrator Guide 868 Paging Verify Paging Configuration Examples for Paging Example for Configuring Simple Paging Group The following example sets up an ephone-dn for multicast paging. This example creates a paging number for 5001 on ephone-dn 22 and adds ephone 4 as a member of the paging set. Multicast is set for the paging-dn. ephone-dn 22 name Paging Shipping number 5001 paging ip 239.1.1.10 port 2000 ephone 4 mac-address 0030.94c3.8724 button 1:1 2:2 paging-dn 22 multicast In this example, paging calls to 2000 are multicast to Cisco Unified IP phones 1 and 2, and paging calls to 2001 go to Cisco Unified IP phones 3 and 4. Note that the paging ephone-dns (20 and 21) are not assigned to any phone buttons. ephone-dn 20 number 2000 paging ip 239.0.1.20 port 2000 ephone-dn 21 number 2001 paging ip 239.0.1.21 port 2000 ephone 1 mac-address 3662.024.6ae2 button 1:1 paging-dn 20 ephone 2 mac-address 9387.678.2873 button 1:2 paging-dn 20 ephone 3 mac-address 0478.2a78.8640 button 1:3 paging-dn 21 ephone 4 mac-address 4398.b694.456 button 1:4 paging-dn 21 Example for Configuring Combined Paging Groups This example sets the following paging behavior: • When extension 2000 is dialed, a page is sent to ephones 1 and 2 (single paging group). • When extension 2001 is dialed, a page is sent to ephones 3 and 4 (single paging group). Cisco Unified Communications Manager Express System Administrator Guide 869 Paging Configuration Examples for Paging • When extension 2002 is dialed, a page is sent to ephones 1, 2, 3, 4, and 5 (combined paging group). Ephones 1 and 2 are included in paging ephone-dn 22 through the membership of ephone-dn 20 in the combined paging group. Ephones 3 and 4 are included in paging ephone-dn 22 through membership of ephone-dn 21 in the combined paging group. Ephone 5 is directly subscribed to paging-dn 22. ephone-dn 20 number 2000 paging ip 239.0.1.20 port 2000 ephone-dn 21 number 2001 paging ip 239.0.1.21 port 2000 ephone-dn 22 number 2002 paging ip 239.0.2.22 port 2000 paging group 20,21 ephone-dn 6 number 1103 name user3 ephone-dn 7 number 1104 name user4 ephone-dn 8 number 1105 name user5 ephone-dn 9 number 1199 ephone-dn 10 number 1198 ephone 1 mac-address 1234.8903.2941 button 1:6 paging-dn 20 ephone 2 mac-address CFBA.321B.96FA button 1:7 paging-dn 20 ephone 3 mac-address CFBB.3232.9611 button 1:8 paging-dn 21 ephone 4 mac-address 3928.3012.EE89 button 1:9 paging-dn 21 ephone 5 mac-address BB93.9345.0031 button 1:10 paging-dn 22 Cisco Unified Communications Manager Express System Administrator Guide 870 Paging Example for Configuring Combined Paging Groups Example for Configuring a Combined Paging Group of Cisco Unified SIP IP Phones and Cisco Unified SCCP IP Phones The following example shows how to configure a combined paging group composed of Cisco Unified SIP IP phones and Cisco Unified SCCP IP phones. In the following configuration tasks, paging sets 20 and 21 are defined and then combined into paging group 22. Paging set 20 has a paging extension of 2000. When someone dials extension 2000 to deliver a page, the page is sent to Cisco Unified SCCP IP phones (ephones) 1 and 2. Paging set 21 has a paging extension of 2001. When someone dials extension 2001 to deliver a page, the page is sent to ephones 3 and 4.Paging group 22 combines sets 20 and 21, and when someone dials its paging extension, 2002, the page is sent to all the phones in both sets and to ephone 5, which is directly subscribed to the combined paging group. ephone-dn 20 number 2000 paging ip 239.0.1.20 port 2000 ephone-dn 21 number 2001 paging ip 239.0.1.21 port 2000 ephone-dn 22 number 2002 paging ip 239.0.2.22 port 2000 paging group 20,21 ephone 1 button 1:1 paging-dn 20 ephone 2 button 1:2 paging-dn 20 ephone 3 button 1:3 paging-dn 21 ephone 4 button 1:4 paging-dn 21 ephone 5 button 1:5 paging-dn 22 The following configuration tasksshow how to configure a combined paging group composed of Cisco Unified SCCP IP phone directory numbers only. When extension 2000 is dialed, a page is sent to ephones 1 and 2 (first single paging group). When extension 2001 is dialed, a page is sent to ephones 3 and 4 (second single paging group). Finally, when extension 2002 is dialed, a page is sent to ephones 1, 2, 3, 4, and 5, producing the combined paging group (composed of the first single paging group, the second single paging group, and ephone 5). Ephones 1 and 2 are included in paging ephone-dn 22 through the membership of ephone-dn 20 as paging group 20 in the combined paging group. Ephones 3 and 4 are included in paging ephone-dn 22 through membership of ephone-dn 21 as paging group 21 in the combined paging group. Ephone 5 is directly subscribed to paging-dn 22. ephone-dn 20 Cisco Unified Communications Manager Express System Administrator Guide 871 Paging Example for Configuring a Combined Paging Group of Cisco Unified SIP IP Phones and Cisco Unified SCCP IP Phones number 2000 paging ip 239.0.1.20 port 20480 ephone-dn 21 number 2001 paging ip 239.1.1.21 port 20480 ephone-dn 22 number 2002 paging ip 239.1.1.22 port 20480 paging group 20,21 ephone-dn 6 number 1103 ephone-dn 7 number 1104 ephone-dn 8 number 1105 ephone-dn 9 number 1199 ephone-dn 10 number 1198 ephone 1 mac-address 1234.8903.2941 button 1:6 paging-dn 20 ephone 2 mac-address CFBA.321B.96FA button 1:7 paging-dn 20 ephone 3 mac-address CFBB.3232.9611 button 1:8 paging-dn 21 ephone 4 mac-address 3928.3012.EE89 button 1:9 paging-dn 21 ephone 5 mac-address BB93.9345.0031 button 1:10 paging-dn 22 In the following configuration tasks, thepaging groupcommand is used to configure combined paging groups composed of ephone and voice register directory numbers. When extension 2000 is dialed, a page is sent to ephones 1 and 2 and voice register pools 1 and 2 (new first single paging group). When extension 2001 is dialed, a page is sent to ephones 3 and 4 and voice register pools 3 and 4 (new second single paging group). Finally, when extension 2002 is dialed, a page is sent to ephones 1, 2, 3, 4, and 5 and voice register pools 1, 2, 3, 4, and 5 (new combined paging group). Ephones 1 and 2 and voice register pools 1 and 2 are included in paging ephone-dn 22 through the membership of ephone-dn 20 as paging group 20 in the combined paging group. Ephones 3 and 4 and voice register pools 3 and 4 are included in paging ephone-dn 22 through membership of ephone-dn 21 as paging group 21 in the combined paging group. Ephone 5 and voice register pool 5 are directly subscribed to paging-dn 22. voice register dn 1 number 1201 Cisco Unified Communications Manager Express System Administrator Guide 872 Paging Example for Configuring a Combined Paging Group of Cisco Unified SIP IP Phones and Cisco Unified SCCP IP Phones voice register dn 2 number 1202 voice register dn 3 number 1203 voice register dn 4 number 1204 voice register dn 5 number 1205 voice register pool 1 id mac 0019.305D.82B8 type 7961 number 1 dn 1 paging-dn 20 voice register pool 2 id mac 0019.305D.2153 type 7961 number 1 dn 2 paging-dn 20 voice register pool 3 id mac 1C17.D336.58DB type 7961 number 1 dn 3 paging-dn 21 voice register pool 4 id mac 0017.9437.8A60 type 7961 number 1 dn 4 paging-dn 21 voice register pool 5 id mac 0016.460D.E469 type 7961 number 1 dn 5 paging-dn 22 Where to Go Next Intercom The intercom feature is similar to paging because it allows a phone user to deliver an audio message to a phone without the called party having to answer. The intercom feature is different than paging because the audio path between the caller and the called party is a dedicated audio path and because the called party can respond to the caller. See Intercom Lines, on page 783. Speed Dial Phone users who make frequent pages may want to include the paging ephone-dn numbers in their list of speed-dial numbers. See Speed Dial, on page 965. Feature Information for Paging The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Cisco Unified Communications Manager Express System Administrator Guide 873 Paging Where to Go Next Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Table 71: Feature Information for Paging Feature Name Cisco Unified CME Version Feature Information Paging 2.0 Paging was introduced. Allows you to specify a paging-dn tag and dial the paging extension number to page the Cisco Unified SIP IP phone associated with the paging-dn tag or paging group using the paging-dn command in voice register pool or voice register template configuration mode. Paging Group Support for Cisco 9.0 Unified SIP IP Phones Cisco Unified Communications Manager Express System Administrator Guide 874 Paging Feature Information for Paging CHAPTER 31 Presence Service • Prerequisites for Presence Service, page 875 • Restrictions for Presence Service, page 875 • Information About Presence Service, page 875 • Configure Presence Service, page 879 • Configuration Examples for Presence Service, page 893 • Feature Information for Presence Service, page 896 Prerequisites for Presence Service • Cisco Unified CME 4.1 or a later version. Restrictions for Presence Service • Presence features such as Busy Lamp Field (BLF) notification are supported for SIP trunks only; these features are not supported on H.323 trunks. • Presence requiresthatSIPphones are configured with a directory number (usingdnkeyword innumber command); direct line numbers are not supported. Information About Presence Service Presence Service A presence service, as defined in RFC 2778 and RFC 2779, is a system for finding, retrieving, and distributing presence information from a source, called a presence entity (presentity), to an interested party called a watcher. When you configure presence in a Cisco Unified CME system with a SIP WAN connection, a phone user, or watcher, can monitor the real-time status of another user at a directory number, the presentity.Presence enables Cisco Unified Communications Manager Express System Administrator Guide 875 the calling party to know before dialing whether the called party is available. For example, a directory application may show that a user is busy, saving the caller the time and inconvenience of not being able to reach someone. Presence usesSIPSUBSCRIBE and NOTIFY methodsto allow users and applicationsto subscribe to changes in the line status of phonesin a Cisco Unified CME system.Phones act as watchers and a presentity isidentified by a directory number on a phone. Watchers initiate presence requests (SUBSCRIBE messages) to obtain the line status of a presentity. Cisco Unified CME responds with the presentity’sstatus. Each time a status changes for a presentity, all watchers of this presentity are sent a notification message. SIP phones and trunks use SIP messages; SCCP phones use presence primitives in SCCP messages. Presence supports Busy Lamp Field (BLF) notification features for speed-dial buttons and directory call lists for missed calls, placed calls, and received calls. SIP and SCCP phones that support the BLF speed-dial and BLF call-list features can subscribe to status change notification for internal and external directory numbers. Figure 36: BLF Notification UsingPresence shows a Cisco Unified CME system supporting BLFnotification for internal and external directory numbers. If the watcher and the presentity are not both internal to the Cisco Unified CME router, the subscribe message is handled by a presence proxy server. Figure 36: BLF Notification Using Presence The following line states display through BLF indicators on the phone: • Line is idle—Displays when this line is not being used. • Line is in-use—Displays when the line is in the ringing state and when a user is on the line, whether or not this line can accept a new call. • BLF indicator unknown—Phone is unregistered or this line is not allowed to be watched. Cisco Unified CME acts as a presence agent for internal lines (both SIP and SCCP) and as a presence server for external watchers connected through a SIP trunk, providing the following functionality: • Processes SUBSCRIBE requests from internal lines to internal lines. Notifies internal subscribers of any status change. Cisco Unified Communications Manager Express System Administrator Guide 876 Presence Service Presence Service • Processes incoming SUBSCRIBE requests from a SIP trunk for internal SCCP and SIP lines. Notifies external subscribers of any status change. • Sends SUBSCRIBE requests to external presentities on behalf of internal lines. Relays status responses to internal lines. Presence subscription requests from SIP trunks can be authenticated and authorized. Local subscription requests cannot be authenticated. For configuration information, see Configure Presence Service. BLF Monitoring of Ephone-DNs with DnD, Call Park, Paging, and Conferencing In versions earlier than Cisco Unified CME 7.1, BLF monitoring does not provide notification ofstatus changes when a monitored directory number becomes DND-enabled, and the Busy Lamp Field (BLF) indicators for directory numbers configured as call-park slots, paging numbers, or ad hoc or meet-me conference numbers display only the unknown line-status. Cisco Unified CME 7.1 and later versionssupport idle, in-use, and unknown BLFstatusindicatorsfor monitored ephone-dns configured as call-park slots, paging numbers, and ad hoc or meet-me conference numbers. This allows an administrator (watcher) to monitor a call-park slot to see if calls are parked and not yet retrieved, which paging number is available for paging, or which conference number is available for a conference. An ephone-dn configured as a park-slot is not registered with any phone. In Cisco Unified CME 7.1 and later versions, if a monitored park-slot is idle, the BLF status shows idle on the watcher. If there is a call parked on the monitored park-slot, the BLF status indicates in-use. If the monitored park-slot is not enabled for BLF monitoring with the allow watch command, the BLF indicator for unknown status displays on the watcher. An ephone-dn configured for paging or conferencing is also not registered with any phone. The indicators for the idle, in-use, and unknown BLFstatus are displayed for the monitored paging number and ad hoc or meet-me conference numbers, as with the call-park slots. Cisco Unified CME 7.1 and later versions support the Do Not Disturb (DnD) BLF status indicator for ephone-dns in the DnD state. When a user presses the DnD softkey on an SCCP phone, all directory numbers assigned to the phone become DnD-enabled and a silent-ring is played for all calls to any directory number on the phone. If a monitored ephone-dn becomes DnD-enabled, the corresponding BLF speed-dial lamp (if available) on the watcher displays solid red with the DnD icon for both the idle and in-use BLF status. The BLF status notification occurs if the monitored ephone-dn is: • The primary directory number on only one SCCP phone • A directory number that is not shared • A shared directory number and all associated phones are DnD-enabled No new configuration is required to support these enhancements. For information on configuring BLF monitoring of directory numbers,see Enable BLF Monitor forSpeed-Dials and Call Lists UsingSCCPPhones. Table 72: Feature Comparison of Directory Number BLF Monitoring compares the different BLF monitoring features that can be configured in Cisco Unified CME. Cisco Unified Communications Manager Express System Administrator Guide 877 Presence Service BLF Monitoring of Ephone-DNs with DnD, Call Park, Paging, and Conferencing Table 72: Feature Comparison of Directory Number BLF Monitoring Monitor Mode (Button “m”) Watch Mode (Button “w”) BLF Monitoring Basic Operation SCCP and SIP phones. Watches all ephone-dn instances with the same (primary) extension number. The BLFlamp is on if any instance of the monitored extension is in use. Indicates DND state of the phone. SCCP phones only. Watches all activity on the phone for which the designated ephone-dn is the primary extension. (The ephone-dn is “primary” for a phone if the extension appears on button 1 or on the button indicated by the auto-line command.) Ephone-dn can be shared but cannot be the primary extension on any other phone. Indicates DND state of the phone. SCCP phones only. Watches a single ephone-dn instance. If there are multiple ephone-dns with the same extension (such as in an overlay), this mode watches only a single ephone-dn (specified with thebuttoncommand using m keyword). Does not indicate DND state of the phone. Shared Lines Cannot distinguish which phone is using the ephone-dn, if the DN is shared across multiple phones. Designed for cases where ephone-dns are shared across multiple phones. Each phone must have a unique primary ephone-dn. Used to indicate that a specific phone is in use as opposed (button m) to indicating that a specific ephone-dn is in use. Can not distinguish which phone is using the ephone-dn if the DN is shared across multiple phones. Local vs. Remote Can monitor extension numbers on a remote Cisco Unified CME using SIP Subscribe and Notify. Cannot monitor local and remote at the same time. Can only monitor DNs that are on the local Cisco Unified CME system Monitors only DNs on the local Cisco Unified CME system. Device-Based BLF Monitoring Device-based BLF monitoring provides a phone user or administrator (watcher) information about the status of a monitored phone (presentity). Cisco Unified CME 4.1 and later versions support BLF monitoring of directory numbers associated with speed-dial buttons, call logs, and directory listings. Cisco Unified CME 7.1 and later versions support device-based BLF monitoring, allowing a watcher to monitor the status of a phone, not only a line on the phone. Cisco Unified Communications Manager Express System Administrator Guide 878 Presence Service Device-Based BLF Monitoring To identify the phone being monitored for BLFstatus, Cisco Unified CME selectsthe phone with the monitored directory number assigned to the first button, or the directory number whose button isselected by the auto-line command (SCCP only). If more than one phone uses the same number as its primary directory number, the phone with the lowest phone tag is monitored for BLF status. For Extension Mobility phones, the first number configured in the user profile indicates the primary directory number of the Extension Mobility phone. If the Extension Mobility phone is being monitored, the BLF status of the corresponding phone is sent to the watcher when an extension-mobility user logs in or out, is idle, or busy. If a shared directory number is busy on a monitored SCCP phone, and the monitored device is on-hook, the monitored phone is considered idle. When a monitored phone receives a page, if the paging directory number is also monitored, the BLF status of the paging directory number shows busy on the watcher. If device-based monitoring is enabled on a directory number configured as a call-park slot, and there is a call parked on this park-slot, the device-based BLF status indicates busy. All directory numbers associated with a phone are in the DnD state when the DnD softkey is pressed. If a monitored phone becomes DnD-enabled, watchers are notified of the DnD status change. For configuration information, see Enable BLF Monitor for Speed-Dials and Call Lists Using SCCP Phones or Enable BLF Monitoring for Speed-Dials and Call Lists on SIP Phones. Phone User Interface for BLF-Speed-Dial Cisco Unified CME 8.5 and later versions allows the extension mobility (EM) users to configure dn-based Busy Lamp Field (BLF)-speed-dial settings directly on the phone through the services feature button. BLF-speed-dial settings are added or modified (changed or deleted) on the phone using a menu available with the Services button. Any changes to the BLF-speed-dial settings made through the phone user interface are applied to the user's profile in extension mobility. You can configure the BLF-speed-dial menu for SCCP phones using the blf-speed-dial command in ephone or ephone-template mode. For more information, see Enable BLF-Speed-Dial Menu. For information on how phone users configure BLF-speed-dial using the phone user-interface, see the Cisco Unified IP Phone documentation for Cisco Unified CME . For phones that do not have EM feature, the BLF-speed-dial service is available in service url page. You can disable the BLF-speed- dial feature using the no phone-ui blf-speed-dial command on phones that do not have Extension Mobility. Configure Presence Service Enable Presence for Internal Lines Perform the following steps to enable the router to accept incoming presence requests from internal watchers and SIP trunks. Cisco Unified Communications Manager Express System Administrator Guide 879 Presence Service Phone User Interface for BLF-Speed-Dial Restriction • A presentity can be identified by a directory number only. • BLF monitoring indicates the line status only. • Instant Messaging is not supported. SUMMARY STEPS 1. enable 2. configure terminal 3. sip-ua 4. presence enable 5. exit 6. presence 7. max-subscription number 8. presence call-list 9. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 sip-ua EntersSIPuser-agent configuration mode to configure the user agent. Example: Router(config)# sip-ua Step 3 presence enable Allows the router to accept incoming presence requests. Example: Router(config-sip-ua)# presence enable Step 4 exit Exits SIP user-agent configuration mode. Example: Router(config-sip-ua)# exit Step 5 Cisco Unified Communications Manager Express System Administrator Guide 880 Presence Service Enable Presence for Internal Lines Command or Action Purpose presence Enables presence service and enters presence configuration mode. Example: Router(config)# presence Step 6 (Optional) Sets the maximum number of concurrent watch sessions that are allowed. max-subscription number Example: Router(config-presence)# max-subscription 128 Step 7 • number—Maximum watch sessions. Range: 100 to the maximum number of directory numbers supported on the router platform. Type ? to display range. Default: 100. Globally enables BLF monitoring for directory numbers in call lists and directories on all locally registered phones. presence call-list Example: Router(config-presence)# presence call-list Step 8 • Only directory numbers that you enable for watching with the allow watch command display BLF status indicators. • This command enables the BLF call-list feature globally. To enable the feature for a specific phone, see Enable BLF Monitor for Speed-Dials and Call Lists Using SCCP Phones. end Exits to privileged EXEC mode. Example: Router(config-presence)# end Step 9 Enable a Directory Number to be Watched To enable a line associated with a directory number to be monitored by a phone registered to a Cisco Unified CME router, perform the following steps. The line is enabled as a presentity and phones can subscribe to its line status through the BLF call-list and BLF speed-dial features. There is no restriction on the type of phone that can have its lines monitored; any line on any IP phone or on an analog phone on supported voice gateways can be a presentity. Restriction • A presentity is identified by a directory number only. • BLF monitoring indicates the line status only. Cisco Unified Communications Manager Express System Administrator Guide 881 Presence Service Enable a Directory Number to be Watched SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-dn dn-tag [dual-line] or voice register dn dn-tag 4. number number 5. allow watch 6. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters the configuration mode to define a directory number for an IP phone, intercom line, voice port, or a message-waiting indicator (MWI). ephone-dndn-tag [dual-line] or voice register dn dn-tag Step 3 Example: Router(config)# ephone-dn 1 • dn-tag—identifies a particular directory number during configuration tasks. Range is 1 to the maximum number of directory numbers allowed on the router platform, or the or Router(config)# voice register dn 1 maximum defined by the max-dn command. Type ? to display range. Associates a phone number with a directory number to be assigned to an IP phone in Cisco Unified CME. number number Example: Router(config-ephone-dn)# number 3001 Step 4 • number—String of up to 16 characters that represents an E.164 telephone number. or Router(config-register-dn)# number 3001 Allows the phone line associated with this directory number to be monitored by a watcher in a presence service. allow watch Example: Router(config-ephone-dn)# allow watch Step 5 • This command can also be configured in ephone-dn template configuration mode and applied to one or more phones. The or Router(config-register-dn)# allow watch ephone-dn configuration has priority over the ephone-dn template configuration. Cisco Unified Communications Manager Express System Administrator Guide 882 Presence Service Enable a Directory Number to be Watched Command or Action Purpose end Exits to privileged EXEC mode. Example: Router(config-ephone-dn)# end Step 6 or Router(config-register-dn)# end Enable BLF Monitor for Speed-Dials and Call Lists Using SCCP Phones A watcher can monitor the status of lines associated with internal and external directory numbers (presentities) through the BLF speed-dial and BLF call-list presence features. To enable the BLF notification features on an IP phone using SCCP, perform the following steps. Restriction • Device-based BLF monitoring for call lists is not supported. • Device-based BLF-speed-dial monitoring is not supported for a remote watcher or presentity. BLF Call-List • Not supported on Cisco Unified IP Phone 7905, 7906, 7911, 7912, 7931, 7940, 7960, or 7985, Cisco Unified IP Phone Expansion Modules, or Cisco Unified IP Conference Stations. BLF Speed-Dial • Not supported on Cisco Unified IP Phone 7905, 7906, 7911, 7912, or 7985, or Cisco Unified IP Conference Stations. Cisco Unified IP Phone 7931 • BLF status is displayed through monitor lamp only; BLF status icons are not displayed. Before You Begin • Presence must be enabled on the Cisco Unified CME router. See Enable Presence for Internal Lines. • A directory number must be enabled as a presentity with the allow watch command to provide BLF status notification. See Enable a Directory Number to be Watched. • Device-based monitoring requires Cisco Unified CME 7.1 or a later version. All directory numbers associated with the monitored phone must be configured with the allow watch command. Otherwise, if any of the directory numbers is missing this configuration, an incorrect status could be reported to the watcher. Cisco Unified Communications Manager Express System Administrator Guide 883 Presence Service Enable BLF Monitor for Speed-Dials and Call Lists Using SCCP Phones SUMMARY STEPS 1. enable 2. configure terminal 3. ephone phone-tag 4. button button-number {separator} dn-tag [,dn-tag...] [button-number{x}overlay-button-number] [button-number...] 5. blf-speed-dial tag number label string [device] 6. presence call-list 7. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters ephone configuration mode to set phone-specific parameters for aSIP phone. ephone phone-tag Example: Router(config)# ephone 1 Step 3 • phone-tag—Unique sequence number of the phone to be configured. Range is version and platform-dependent; type ? to display range. You can modify the upper limit for this argument with the max-ephones command. Associates a button number and line characteristics with a directory number on the phone. button button-number {separator} dn-tag [,dn-tag...] Step 4 [button-number{x}overlay-button-number] [button-number...] • button-number—Number of a line button on an IP phone. Example: Router(config-ephone)# button 1:10 2:11 3b12 4o13,14,15 • separator—Single character that denotes the type of characteristics to be associated with the button. • dn-tag—Unique sequence number of the ephone-dn that you want to appear on this button. For overlay lines (separator is o orc), this argument can contain up to 25 ephone-dn tags, separated by commas. • x—Separator that creates an overlay rollover button. • overlay-button-number—Number of the overlay button that should overflow to this button. Cisco Unified Communications Manager Express System Administrator Guide 884 Presence Service Enable BLF Monitor for Speed-Dials and Call Lists Using SCCP Phones Command or Action Purpose Enables BLF monitoring of a directory number associated with a speed-dial number on the phone. blf-speed-dial tag number label string [device] Step 5 Example: Router(config-ephone)# blf-speed-dial 3 3001 label sales device • tag—Number that identifies the speed-dial index. Range: 1 to 33. • number—Telephone number to speed dial. • string—Alphanumeric label that identifiesthe speed-dial button.String can contain a maximum of 30 characters. • device—(Optional) Enables phone-based monitoring. This keyword is supported in Cisco Unified CME 7.1 and later versions. Enables BLF monitoring of directory numbers that appear in call lists and directories on this phone. presence call-list Example: Router(config-ephone)# presence call-list Step 6 • For a directory number to be monitored, it must have the allow watch command enabled. • To enable BLF monitoring for call lists on all phones in this Cisco Unified CME system, use this command in presence mode. See Enable Presence for Internal Lines, on page 879. end Exits to privileged EXEC mode. Example: Router(config-ephone)# end Step 7 The following example shows that the directory numbers for extensions 2001 and 2003 are allowed to be watched and the BLF status of these numbers display on phone 1. ephone-dn 201 number 2001 allow watch ! ! ephone-dn 203 number 2003 allow watch ! ! ephone 1 mac-address 0012.7F54.EDC6 blf-speed-dial 2 201 label "sales" device blf-speed-dial 3 203 label "service" device button 1:100 2:101 3b102 What to Do Next If you are done modifying parameters for SCCP phones in Cisco Unified CME, generate a new configuration profile by using the create cnf-files command and then restart the phones with the restart command. See Generate Configuration Files for SCCP Phones and Use the restart Command on SCCP Phones. Cisco Unified Communications Manager Express System Administrator Guide 885 Presence Service Enable BLF Monitor for Speed-Dials and Call Lists Using SCCP Phones Enable BLF Monitoring for Speed-Dials and Call Lists on SIP Phones A watcher can monitor the status of lines associated with internal and external directory numbers (presentities) through the BLF speed-dial and BLF call-list presence features. To enable the BLF notification features on a SIP phone, perform the following steps. Restriction • Device-based BLF-speed-dial monitoring is not supported for a remote watcher or presentity. • TCP based, device-based BLF-speed-dial monitoring is not supported on Unified CME. BLF Call-List • Not supported on Cisco Unified IP Phone 7905, 7906, 7911, 7912, 7931, 7940, 7960, or 7985, Cisco Unified IP Phone Expansion Modules, or Cisco Unified IP Conference Stations. BLF Speed-Dial • Not supported on Cisco Unified IP Phone 7905, 7906, 7911, 7912, or 7985, or Cisco Unified IP Conference Stations. Before You Begin • Presence must be enabled on the Cisco Unified CME router. See Enable Presence for Internal Lines. • A directory number must be enabled as a presentity with the allow watch command to provide BLF status notification. See Enable a Directory Number to be Watched. • SIP phones must be configured with a directory number under voice register pool configuration mode (use dn keyword in number command); direct line numbers are not supported. • Device-based monitoring requires Cisco Unified CME 7.1 or a later version. All directory numbers associated with the monitored phone must be configured with the allow watch command. Otherwise, if any of the directory numbers is missing this configuration, an incorrect status could be reported to the watcher. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register pool pool-tag 4. number tag dn dn-tag 5. blf-speed-dial tag number label string [device] 6. presence call-list 7. end Cisco Unified Communications Manager Express System Administrator Guide 886 Presence Service Enable BLF Monitoring for Speed-Dials and Call Lists on SIP Phones DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register pool configuration mode to set phone-specific parameters for a SIP phone. voice register pool pool-tag Example: Router(config)# voice register pool 1 Step 3 • pool-tag—Unique sequence number of theSIPphone to be configured. Range is version and platform-dependent; type ? to display range. You can modify the upper limit for this argument with the max-pool command. Step 4 number tag dn dn-tag Assigns a directory number to the SIP phone. Example: Router(config-register-pool)# number 1 dn 2 • tag—identifier when there are multiple number commands. Range: 1 to 10. • dn-tag—Directory number tag that was defined using the voice register dn command. Enables BLF monitoring of a directory number associated with a speed-dial number on the phone. blf-speed-dial tag number label string [device] Step 5 Example: Router(config-register-pool)# blf-speed-dial 3 3001 label sales device • tag—Number that identifies the speed-dial index. Range: 1 to 7. • number—Telephone number to speed dial. • string—Alphanumeric label that identifies the speed-dial button. The string can contain a maximum of 30 characters. • device—(Optional) Enables phone-based monitoring. This keyword is supported in Cisco Unified CME 7.1 and later versions. Enables BLF monitoring of directory numbers that appear in call lists and directories on this phone. presence call-list Example: Router(config-register-pool)# presence call-list Step 6 • For a directory number to be monitored, it must have the allow watch command enabled. • To enable BLF monitoring for call lists on all phones in this Cisco Unified CME system, use this command in presence mode. See Enable Presence for Internal Lines. Cisco Unified Communications Manager Express System Administrator Guide 887 Presence Service Enable BLF Monitoring for Speed-Dials and Call Lists on SIP Phones Command or Action Purpose end Exits to privileged EXEC mode. Example: Router(config-register-pool)# end Step 7 What to Do Next If you are done modifying parameters for SIP phones in Cisco Unified CME, generate a new configuration profile by using the create profile command and then restart the phones with the restart command. See Generate Configuration Profiles for SIP Phones and Use the restart Command on SIP Phones. Enable BLF-Speed-Dial Menu Restriction • EM user cannot modify the logout profile from phone user interface (UI). • Extension Mobility (EM) users must log into EM profile to update BLF-speed-dial number. Before You Begin • Cisco Unified CME 8.5 or later versions. SUMMARY STEPS 1. enable 2. configure terminal 3. ephone phone-tag 4. blf-speed-dial [index index number] [phone-number number] [label label text] 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. Cisco Unified Communications Manager Express System Administrator Guide 888 Presence Service Enable BLF-Speed-Dial Menu Command or Action Purpose configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 ephone phone-tag Enters ephone configuration mode. Example: Router(config)# ephone 10 • phone-tag—Unique number of the phone for which you want to configure BLF-speed-dial numbers. blf-speed-dial [index index number] Creates an entry for a BLF-speed-dial number on this phone. [phone-number number] [label label text] Step 4 • BLF-speed-dial index—Unique identifier to identify this entry during configuration. Range is 1 to 75. Example: Router(config-ephone)#blf-speed-dial 1 2001 label "customer support" • phone number—Telephone number or extension to be dialed. end Returns to privileged EXEC mode. Example: Router(config-ephone)# end Step 5 Configure Presence to Watch External Lines To enable internal watchers to monitor external directory numbers on a remote Cisco Unified CME router, perform the following steps. Before You Begin Presence service must be enabled for internal lines. See Enable Presence for Internal Lines. Cisco Unified Communications Manager Express System Administrator Guide 889 Presence Service Configure Presence to Watch External Lines SUMMARY STEPS 1. enable 2. configure terminal 3. presence 4. server ip-address 5. allow subscribe 6. watcher all 7. sccp blf-speed-dial retry-interval seconds limit number 8. exit 9. voice register global 10. authenticate presence 11. authenticate credential tag location 12. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 presence Enables presence service and enters presence configuration mode. Example: Router(config)# presence Step 3 Specifies the IPaddress of a presence server for sending presence requests from internal watchers to external presentities. server ip-address Example: Router(config-presence)# server 10.10.10.1 Step 4 allow subscribe Allows internal watchers to monitor external directory numbers. Example: Router(config-presence)# allow subscribe Step 5 watcher all Allows external watchers to monitor internal directory numbers. Example: Router(config-presence)# watcher all Step 6 Cisco Unified Communications Manager Express System Administrator Guide 890 Presence Service Configure Presence to Watch External Lines Command or Action Purpose (Optional)Setsthe retry timeout for BLF monitoring ofspeed-dial numbers on phones running SCCP. sccp blf-speed-dial retry-interval seconds limit number Step 7 Example: Router(config-presence)# sccp blf-speed-dial retry-interval 90 limit number 15 • seconds—Retry timeout in seconds. Range: 60 to 3600. Default: 60. • number—Maximum number of retries. Range: 10 to 100. Default: 10. exit Exits presence configuration mode. Example: Router(config-presence)# exit Step 8 Enters voice register global configuration mode to set global parameters for all supportedSIPphones in a Cisco Unified CME environment. voice register global Example: Router(config)# voice register global Step 9 (Optional) Enables authentication of incoming presence requests from a remote presence server. authenticate presence Example: Router(config-register-global)# authenticate presence Step 10 (Optional) Specifies the credential file to use for authenticating presence subscription requests. authenticate credential tag location Example: Router(config-register-global)# authenticate credential 1 flash:cred1.csv Step 11 • tag—Number that identifies the credential file to use for presence authentication. Range: 1 to 5. • location—Name and location of the credential file in URL format. Valid storage locations are TFTP, HTTP, and flash memory. end Exits to privileged EXEC mode. Example: Router(config-register-global)# end Step 12 Verify Presence Configuration Step 1 show running-config Cisco Unified Communications Manager Express System Administrator Guide 891 Presence Service Verify Presence Configuration Use this command to verify your configuration. Router# show running-config ! voice register global mode cme source-address 10.1.1.2 port 5060 load 7971 SIP70.8-0-1-11S load 7970 SIP70.8-0-1-11S load 7961GE SIP41.8-0-1-0DEV load 7961 SIP41.8-0-1-0DEV authenticate presence authenticate credential 1 tftp://172.18.207.15/labtest/cred1.csv create profile sync 0004550081249644 . . . presence server 10.1.1.4 sccp blf-speed-dial retry-interval 70 limit 20 presence call-list max-subscription 128 watcher all allow subscribe ! sip-ua presence enable Step 2 show presence global Use this command to display presence configuration settings. Router# show presence global Presence Global Configuration Information: ============================================= Presence feature enable : TRUE Presence allow external watchers : FALSE Presence max subscription allowed : 100 Presence number of subscriptions : 0 Presence allow external subscribe : FALSE Presence call list enable : TRUE Presence server IP address : 0.0.0.0 Presence sccp blfsd retry interval : 60 Presence sccp blfsd retry limit : 10 Presence router mode : CME mode Step 3 show presence subscription [details |presentity telephone-number | subid subscription-id summary] Use this command to display information about active presence subscriptions. Router# show presence subscription summary Presence Active Subscription Records Summary: 15 subscription Watcher Presentity SubID Expires SibID Status Cisco Unified Communications Manager Express System Administrator Guide 892 Presence Service Verify Presence Configuration ======================== ======================== ====== ======= ====== ====== 6002@10.4.171.60 6005@10.4.171.34 1 3600 0 idle 6005@10.4.171.81 6002@10.4.171.34 6 3600 0 idle 6005@10.4.171.81 6003@10.4.171.34 8 3600 0 idle 6005@10.4.171.81 6002@10.4.171.34 9 3600 0 idle 6005@10.4.171.81 6003@10.4.171.34 10 3600 0 idle 6005@10.4.171.81 6001@10.4.171.34 12 3600 0 idle 6001@10.4.171.61 6003@10.4.171.34 15 3600 0 idle 6001@10.4.171.61 6002@10.4.171.34 17 3600 0 idle 6003@10.4.171.59 6003@10.4.171.34 19 3600 0 idle 6003@10.4.171.59 6002@10.4.171.34 21 3600 0 idle 6003@10.4.171.59 5001@10.4.171.34 23 3600 24 idle 6002@10.4.171.60 6003@10.4.171.34 121 3600 0 idle 6002@10.4.171.60 5002@10.4.171.34 128 3600 129 idle 6005@10.4.171.81 1001@10.4.171.34 130 3600 131 busy 6005@10.4.171.81 7005@10.4.171.34 132 3600 133 idle Troubleshooting Presence Service You can use the following commands to troubleshoot presence service: • debug presence {all | asnl |errors | event | info | timer | trace | xml} • debug ephone blf [mac-address mac-address] Configuration Examples for Presence Service Example for Configuring Presence in Cisco Unified CME Router# show running-config Building configuration... Current configuration : 5465 bytes ! version 12.4 service timestamps debug datetime msec service timestamps log datetime msec no service password-encryption ! hostname CME-3825 ! boot-start-marker boot-end-marker ! logging buffered 2000000 debugging enable password lab ! no aaa new-model ! resource policy Cisco Unified Communications Manager Express System Administrator Guide 893 Presence Service Troubleshooting Presence Service ! no network-clock-participate slot 1 no network-clock-participate slot 2 ip cef ! ! no ip domain lookup ! voice-card 1 no dspfarm ! voice-card 2 no dspfarm ! ! voice service voip allow-connections sip to sip h323 sip registrar server expires max 240 min 60 ! voice register global mode cme source-address 11.1.1.2 port 5060 load 7971 SIP70.8-0-1-11S load 7970 SIP70.8-0-1-11S load 7961GE SIP41.8-0-1-0DEV load 7961 SIP41.8-0-1-0DEV authenticate presence authenticate credential 1 tftp://172.18.207.15/labtest/cred1.csv create profile sync 0004550081249644 ! voice register dn 1 number 2101 allow watch ! voice register dn 2 number 2102 allow watch ! voice register pool 1 id mac 0015.6247.EF90 type 7971 number 1 dn 1 blf-speed-dial 1 1001 label "1001" ! voice register pool 2 id mac 0012.0007.8D82 type 7912 number 1 dn 2 ! interface GigabitEthernet0/0 description $ETH-LAN$$ETH-SW-LAUNCH$$INTF-INFO-GE 0/0$ ip address 11.1.1.2 255.255.255.0 duplex full speed 100 media-type rj45 no negotiation auto ! interface GigabitEthernet0/1 no ip address shutdown duplex auto speed auto media-type rj45 negotiation auto ! ip route 0.0.0.0 0.0.0.0 11.1.1.1 ! ip http server ! ! ! Cisco Unified Communications Manager Express System Administrator Guide 894 Presence Service Example for Configuring Presence in Cisco Unified CME tftp-server flash:Jar41sccp.8-0-0-103dev.sbn tftp-server flash:cvm41sccp.8-0-0-102dev.sbn tftp-server flash:SCCP41.8-0-1-0DEV.loads tftp-server flash:P00303010102.bin tftp-server flash:P00308000100.bin tftp-server flash:P00308000100.loads tftp-server flash:P00308000100.sb2 tftp-server flash:P00308000100.sbn tftp-server flash:SIP41.8-0-1-0DEV.loads tftp-server flash:apps41.1-1-0-82dev.sbn tftp-server flash:cnu41.3-0-1-82dev.sbn tftp-server flash:cvm41sip.8-0-0-103dev.sbn tftp-server flash:dsp41.1-1-0-82dev.sbn tftp-server flash:jar41sip.8-0-0-103dev.sbn tftp-server flash:P003-08-1-00.bin tftp-server flash:P003-08-1-00.sbn tftp-server flash:P0S3-08-1-00.loads tftp-server flash:P0S3-08-1-00.sb2 tftp-server flash:CP7912080000SIP060111A.sbin tftp-server flash:CP7912080001SCCP051117A.sbin tftp-server flash:SCCP70.8-0-1-11S.loads tftp-server flash:cvm70sccp.8-0-1-13.sbn tftp-server flash:jar70sccp.8-0-1-13.sbn tftp-server flash:SIP70.8-0-1-11S.loads tftp-server flash:apps70.1-1-1-11.sbn tftp-server flash:cnu70.3-1-1-11.sbn tftp-server flash:cvm70sip.8-0-1-13.sbn tftp-server flash:dsp70.1-1-1-11.sbn tftp-server flash:jar70sip.8-0-1-13.sbn ! control-plane ! dial-peer voice 2001 voip preference 2 destination-pattern 1... session protocol sipv2 session target ipv4:11.1.1.4 dtmf-relay sip-notify ! presence server 11.1.1.4 sccp blf-speed-dial retry-interval 70 limit 20 presence call-list max-subscription 128 watcher all allow subscribe ! sip-ua authentication username jack password 021201481F presence enable ! ! telephony-service load 7960-7940 P00308000100 load 7941GE SCCP41.8-0-1-0DEV load 7941 SCCP41.8-0-1-0DEV load 7961GE SCCP41.8-0-1-0DEV load 7961 SCCP41.8-0-1-0DEV load 7971 SCCP70.8-0-1-11S load 7970 SCCP70.8-0-1-11S load 7912 CP7912080000SIP060111A.sbin max-ephones 100 max-dn 300 ip source-address 11.1.1.2 port 2000 url directories http://11.1.1.2/localdirectory max-conferences 6 gain -6 call-forward pattern .T transfer-system full-consult transfer-pattern .T create cnf-files version-stamp Jan 01 2002 00:00:00 ! ! ephone-dn 1 dual-line Cisco Unified Communications Manager Express System Administrator Guide 895 Presence Service Example for Configuring Presence in Cisco Unified CME number 2001 allow watch ! ! ephone-dn 2 dual-line number 2009 allow watch application default ! ! ephone-dn 3 number 2005 allow watch ! ! ephone-dn 4 dual-line number 2002 ! ! ephone 1 mac-address 0012.7F57.62A5 fastdial 1 1002 blf-speed-dial 1 2101 label "2101" blf-speed-dial 2 1003 label "1003" blf-speed-dial 3 2002 label "2002" type 7960 button 1:1 2:2 ! ! ! ephone 3 mac-address 0015.6247.EF91 blf-speed-dial 2 1003 label "1003" type 7971 button 1:3 2:4 ! ! ! line con 0 exec-timeout 0 0 password lab stopbits 1 line aux 0 stopbits 1 line vty 0 4 password lab login ! scheduler allocate 20000 1000 ! end Feature Information for Presence Service The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Cisco Unified Communications Manager Express System Administrator Guide 896 Presence Service Feature Information for Presence Service Table 73: Feature Information for Presence Service Feature Name Cisco Unified CME Version Modification Added support for BLFSpeed Dial through Phone User Interface. Phone User Interface for 8.5 BLF-Speed-Dial • Added support for device-based BLF monitoring. • Added support for BLF Monitoring of ephone-DNs with DnD, CallPark,Paging, and Conferencing BLF Monitoring 7.1 Presence Service 4.1 Presence with BLF wasintroduced. Cisco Unified Communications Manager Express System Administrator Guide 897 Presence Service Feature Information for Presence Service Cisco Unified Communications Manager Express System Administrator Guide 898 Presence Service Feature Information for Presence Service CHAPTER 32 Ringtones • Information About Ringtones, page 899 • Configure Ringtones, page 900 • Configuration Examples for Ringtones, page 905 • Feature Information for Ringtones, page 906 Information About Ringtones Distinctive Ringing Distinctive ring is used to identify internal and external incoming calls. An internal call is defined as a call originating from any Cisco Unified IP phone that is registered in Cisco Unified CME or is routed through the local FXS port. In Cisco CME 3.4 and earlier versions, the standard ring pattern is generated for all calls to local SCCP endpoints. In Cisco Unified CME 4.0, the following distinctive ring features are supported forSCCPendpoints: • Specify one of three ring patterns to be used for all types of incoming calls to a particular directory number, on all phones on which the directory number appears. If a phone is already in use, an incoming call is presented as a call-waiting call and uses a distinctive call-waiting beep. • Specify whether the distinctive ring is used only if the incoming called number matches the primary or secondary number defined for the ephone-dn. If no secondary number is defined for the ephone-dn, the secondary ring option has no effect. • Associate a feature ring pattern with a specific button on a phone so that different phones that share the same directory number can use a different ring style. For local SIP endpoints, the type of ring sound requested is signaled to the phone using an alert-info signal. If distinctive ringing is enabled, Cisco Unified CME generates the alert-info for incoming calls from any phone that is not registered in Cisco Unified CME, to the local endpoint. Alert-info from an incoming leg can be relayed to an outgoing leg with the internally generated alert-info taking precedence. Cisco Unified IP phones use the standard Telcordia Technologies distinctive ring types. Cisco Unified Communications Manager Express System Administrator Guide 899 Customized Ringtones Cisco Unified IP Phones have two default ring types: Chirp1 and Chirp2. Cisco Unified CME also supports customized ringtones using pulse code modulation (PCM) files. An XML file called RingList.xml specifies the ringtone options available for the default ring on an IP phone registered to Cisco Unified CME. An XML file called DistinctiveRingList.xmlspecifiesthe ringtones available on each individual line appearance on an IP phone registered to Cisco Unified CME. On-Hold Indicator On-hold indicator is an optional feature that generates a ring burst on idle IP phones that have placed a call on hold. An option is available to generate call-waiting beeps for occupied phones that have placed calls on hold. This feature is disabled by default. For configuration information, see Configure On-Hold Indicator, on page 903. LED color display for hold state, also known as I-Hold, is supported in Cisco Unified CME 4.0(2) and later versions. The I-Hold feature provides a visual indicator for distinguishing a local hold from a remote hold on shared lines on supported phones,such asthe Cisco Unified IPPhone 7931G. Thisfeature requires no additional configuration. Configure Ringtones Configure Distinctive Ringing To set the ring pattern for all incoming calls to a directory number, perform the following steps. Before You Begin Cisco Unified CME 4.0 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-dn dn-tag [dual-line] 4. number number [secondary number] [no-reg [both | primary]] 5. ring {external | internal | feature} [primary | secondary] 6. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Cisco Unified Communications Manager Express System Administrator Guide 900 Ringtones Customized Ringtones Command or Action Purpose Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters ephone-dn configuration mode, creates an ephone-dn, and optionally assigns it dual-line status. ephone-dn dn-tag [dual-line] Example: Router(config)# ephone-dn 29 Step 3 number number [secondary number] [no-reg [both | Configures a valid extension number for this ephone-dn. primary]] Step 4 Example: Router(config-ephone-dn)# number 2333 Designates which ring pattern to be used for all types of incoming calls to this directory number, on all phones on which the directory number appears. ring {external | internal | feature} [primary | secondary] Example: Router(config-ephone-dn)# ring internal Step 5 end Returns to privileged EXEC mode. Example: Router(config-ephone-dn)# end Step 6 Configure Customized Ringtones To create a customized ringtone, perform the following steps. Before You Begin Cisco Unified CME 4.0 or a later version. Step 1 Create aPCM file for each customized ringtone (one ring per file). ThePCM files must comply with the following format guidelines. • Raw PCM (no header) • 8000 samples per second Cisco Unified Communications Manager Express System Administrator Guide 901 Ringtones Configure Customized Ringtones • 8 bits per sample • mLaw compression • Maximum ring size—16080 samples • Minimum ring size—240 samples • Number of samples in the ring must be evenly divisible by 240 • Ring should start and end at the zero crossing Use an audio editing package that supports these file format requirements to create PCM files for customized phone rings. Sample ring files are in the ringtone.tar file at http://www.cisco.com/cgi-bin/tablebuild.pl/ip-iostsp Step 2 Edit the RingList.xml and DistinctiveRingList.xml files using a text editor. The RingList.xml and DistinctiveRingList.xml files contain a list of phone ring types. Each file shows thePCM file used for each ring type and the text that is displayed on the Ring Type menu on a Cisco Unified IP Phone for each ring. Sample XML files are in the ringtone.tar file at http://www.cisco.com/cgi-bin/tablebuild.pl/ip-iostsp The RingList.xml and DistinctiveRingList.xml files use the following format to specify customized rings: The XML ring files use the following tag definitions: • Ring files contain two fields, DisplayName and FileName, which are required for each phone ring type. Up to 50 rings can be listed. • DisplayName defines the name of the customized ring for the associated PCM file that will be displayed on the Ring Type menu of the Cisco Unified IP Phone. • FileName specifies the name of the PCM file for the customized ring to associate with DisplayName. • The DisplayName and FileName fields can not exceed 25 characters. The following sample RingList.xml file defines two phone ring types: Piano1 Piano1.raw Chime Chime.raw Cisco Unified Communications Manager Express System Administrator Guide 902 Ringtones Configure Customized Ringtones Step 3 Copy the PCM and XML files to system Flash on the Cisco Unified CME router. For example: copy tftp://192.168.1.1/RingList.xml flash: copy tftp://192.168.1.1/DistinctiveRingList.xml flash: copy tftp://192.168.1.1/Piano1.raw flash: copy tftp://192.168.1.1/Chime.raw flash: Step 4 Use the tftp-server command to enable access to the files. For example: tftp-server flash:RingList.xml tftp-server flash:DistinctiveRingList.xml tftp-server flash:Piano1.raw tftp-server flash:Chime.raw Step 5 Reboot the IP phones. After reboot, the IP phones download the XML and ringtone files. Select the customized ring by pressing the Settings button followed by the Ring Type menu option on a phone. Configure On-Hold Indicator The Call Hold feature is available by default. To define an audible indicator as a reminder that a call is waiting on hold, perform the following steps. SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-dn dn-tag [dual-line] 4. hold-alert timeout {idle | originator | shared | shared-idle} [recurrence recurrence-timeout] [ring-silent-dn] 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Cisco Unified Communications Manager Express System Administrator Guide 903 Ringtones Configure On-Hold Indicator Command or Action Purpose Enters ephone-dn configuration mode, creates an ephone-dn, and optionally assigns it dual-line status. ephone-dn dn-tag [dual-line] Example: Router(config)# ephone-dn 20 Step 3 Sets audible alert notification on the Cisco Unified IP phone for alerting the user about on-hold calls. hold-alert timeout {idle | originator | shared | shared-idle} [recurrence recurrence-timeout] [ring-silent-dn] Step 4 From the perspective of the originator of the call on hold, the originator and shared keywords provide the same functionality. Note Example: Router(config-ephone-dn)# hold-alert 15 idle recurrence 3 end Returns to privileged EXEC mode. Example: Router(config-ephone-dn)# end Step 5 Enable Distinctive Ringing on SIP Phones To set the ring pattern for distinguishing between external and internal incoming calls, perform the following steps. Restriction bellcore-dr1 to bellcore-dr5 are the only Telcordia options that are supported for SIP phones. Before You Begin Cisco Unified CME 3.4 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register global 4. external-ring {bellcore-dr1 | bellcore-dr2 |bellcore-dr3 | bellcore-dr4 | bellcore-dr5} 5. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Cisco Unified Communications Manager Express System Administrator Guide 904 Ringtones Enable Distinctive Ringing on SIP Phones Command or Action Purpose Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register global configuration mode to set parameters for all supported SIP phones in Cisco Unified CME. voice register global Example: Router(config)# voice register global Step 3 Specifies the type of audible ring sound to be used for external calls external-ring {bellcore-dr1 | bellcore-dr2 |bellcore-dr3 | bellcore-dr4 | bellcore-dr5} Step 4 Example: Router(config-register-global)# external-ring bellcore-dr3 • Default—Internal ring sound is used for all incoming calls. end Exits configuration mode and enters privileged EXEC mode. Example: Router(config-register-global)# end Step 5 Configuration Examples for Ringtones Example for Configuring Distinctive Ringing for Internal Calls The following example sets distinctive ringing for internal calls on extension 2333. ephone-dn 34 number 2333 ring internal Example for Configuring On-Hold Indicator In the following example, extension 2555 is configured to not forward local calls that are internal to the Cisco Unified CME system. Extension 2222 dials extension 2555. If 2555 is busy, the caller hears a busy tone. If 2555 does not answer, the caller hears ringback. The internal call is not forwarded. ephone-dn 25 number 2555 Cisco Unified Communications Manager Express System Administrator Guide 905 Ringtones Configuration Examples for Ringtones no forward local-calls call-forward busy 2244 call-forward noan 2244 timeout 45 Feature Information for Ringtones The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Table 74: Feature Information for Ringtones Feature Name Cisco Unified CME Version Feature Information Supports ringtone choices for all incoming calls to an individual directory number, for all SCCP phones on which the directory number appears. Distinctive Ringing 4.0 Generate the alert-info for incoming callsfrom any phone that is not registered in Cisco Unified CME, to local SIP endpoints. 3.4 Customized Ringtonesfeature was introduced. Customized Ringtones 4.0 Controls LED color display for hold state to provide visual indicator for distinguishing a local hold from a remote hold on shared lines on supported phones, such as the Cisco Unified IPPhone 7931G. On-Hold Indictor 4.0(2) Audible on-hold indicator was introduced. 2.0 1.0 Call Hold was introduced. Cisco Unified Communications Manager Express System Administrator Guide 906 Ringtones Feature Information for Ringtones CHAPTER 33 Single Number Reach • Information About Single Number Reach, page 907 • Configure Single Number Reach, page 911 • Feature Information for Single Number Reach, page 923 Information About Single Number Reach Overview of Single Number Reach The Single Number Reach (SNR) feature allows users to answer incoming calls to their extension on either their desktop IP phone or at a remote destination, such as a mobile phone. Users can pick up active calls on the desktop phone or the remote phone without losing the connection. This enables callers to dial a single number to reach the phone user. Calls that are not answered can be forwarded to voice mail. Remote destinations may include the following devices: • Mobile (cellular) phones. • Smart phones. • IP phones not belonging to the same Cisco Unified CME router as the desktop phone. • Home phone numbers in the PSTN. Supported PSTN interfaces include PRI, BRI, SIP, and FXO. For incoming calls to theSNR extension, Cisco Unified CME rings the desktop IPphone first. If the IPphone does not answer within the configured amount of time, it ringsthe configured remote number while continuing to ring the IP phone. Unanswered calls are sent to a configured voice-mail number. The IP phone user has these options for handling calls to the SNR extension: • Pull back the call from the remote phone—Phone user can manually pull back the call to the SNR extension by pressing the Resume softkey, which disconnects the call from the remote phone. • Send the call to remote phone—Phone user can send the call to the remote phone by using the Mobility softkey. While connected to the call, the phone user can press the Mobility softkey and select Send call to mobile. The call is forwarded to the remote phone. Cisco Unified Communications Manager Express System Administrator Guide 907 • Enable or disable Single Number Reach—While the IP phone is in the idle state, the user can toggle the SNR feature on and off by using the Mobility softkey. If the user disables SNR, Cisco Unified CME does not ring the remote number. IP phone users can modify their own SNR settings directly from the phone by using the menu available with the Services feature button. You must enable the feature on the phone to allow a phone user to access the user interface. Thisfeature issupported in Cisco Unified CME 7.1 and later versions onSCCPIPphonesthatsupportsoftkeys. SNR Enhancements Cisco Unified CME 8.5 supports the following enhancements in the Single Number Reach (SNR) feature: Hardware Conference In Cisco Unified CME 8.5, you can send a call to a mobile phone after joining a hardware conference. After joining the hardware conference, all conference callers are blind-transferred to hardware DN. The call character of the ephone changes from incoming call to outgoing call and you are able to send a call to the mobile. Call Park, Call Pickup, and Call Retrieval In earlier versions of Cisco Unified CME, CallPark, CallPickup, and Call Retrieval features were notsupported for SNR. Cisco Unified CME 8.5 and later versions allows you to park, pickup, or retrieve an SNR call, Cisco Unified CME 8.5 enhances the SNR feature to allow you to see the local number on your cell phone instead of the calling party number. You can configure the snr calling number local command under ephone-dn configuration mode to view the caller ID of the SNR phone. For information on configuring SNR calling number local, see Configure Single Number Reach Enhancements on SCCP Phones, on page 915. Answer Too Soon Timer On non-FXO ports, you can set an snr answer too soon timer to prevent the calls from rolling to the voice mailbox of your cell phone. When the cell phone rolls to the voice mail within the answer too soon timer range (1 to 5 seconds), the mobile phone call leg is immediately disconnected. You can configure the snr answer too soon command under ephone-dn mode. For more information, see Configure Single Number Reach Enhancements on SCCP Phones, on page 915. The answer-too soon timer is not applicable when sending the call to a mobile. SNR Phone Stops Ringing After Mobile Phone Answers When SNR is deployed on non-FXO ports, if cell phone picks up an SNR call, you are connected to the call. The ephone stops ringing further and is placed on hold. You can configure the snr ring-stop command under ephone-dn configuration mode to stop the ephone from ringing and to place the phone on hold. For more information, see Configure Single Number Reach Enhancements on SCCP Phones, on page 915. Cisco Unified Communications Manager Express System Administrator Guide 908 Single Number Reach SNR Enhancements Single Number Reach for Cisco Unified SIP IP Phones Before Cisco Unified CME 9.0, the Single Number Reach (SNR) feature enabled the user to be reached on two numbers: a regular directory number (DN) on the ephone and a public switched telephone network (PSTN) connection (either aPRI/BRI/FXO port or aSIPinterface).For incoming callsto the ephone, the Cisco Unified CME called the ephone DN first. When the ephone DN did not answer within a configured time, the Cisco Unified CME called a preconfigured PSTN number while continually calling the ephone DN. In Cisco Unified CME 9.0 and later versions, the following SNR features are supported for Cisco Unified SIP IP phones: • Enable and disable the Extension Mobility (EM) feature on a Cisco Unified SIP IP phone—Use the Mobility softkey orPLK as a toggle or use the mobility andno mobility commands to enable or disable the Mobility feature on a Cisco Unified SIP IP phone. • Manual pull back of a call on a mobile phone—Use the Resume softkey to manually bring a call back to the SNR DN. • Send a call to a mobile PSTN phone—Send a call to the mobile PSTN phone using the Mobility softkey while the Cisco Unified SIP IP phone is on a call. Select “Send call to mobile” and the call is handed off to the mobile phone. • Send a call to a mobile phone regardless of whether the SNR phone is the originating or the terminating side—Ensure that the SNR feature is configured in voice register dn or ephone-dn configuration mode to send a call to a mobile phone regardless of whether the SNR phone is the originating or terminating side. Use the Mobility softkey, select “Send call to mobile,” and the call is handed off to the mobile phone. For calls from a PSTN, local, or VoIP phone to a Cisco Unified SIP IP phone configured as an SNR phone, the Cisco Unified CME calls the SIP SNR or the mobile phone DN. When you answer the call on the SIP SNR phone, you can send the call to the PSTN/BRI/PRI/SIP phone. When you answer the call on the mobile phone, the Resume softkey is displayed on the SIP SNR phone and allows the call to be pulled back to the SIP SNR phone. You can repeatedly pull the call back from the PSTN phone to the SIP SNR phone or from the SIP SNR phone to the PSTN phone. If the cfwd-noan keyword is configured and both the mobile and SIP SNR phones do not answer, the call is redirected to a preconfigured extension number when the end of a preconfigured time delay is reached. The following shows how SNR phones configured with Cisco Unified SIP IP phones behave differently from those configured with Cisco Unified SCCP IP phones when sending a call to a mobile: • For Cisco Unified SCCP IP phones, the Resume softkey is displayed on the SCCP SNR phone as soon as the call is sent to the mobile phone. • For Cisco Unified SIP IP phones, the Resume softkey is displayed on the SIP SNR phone as soon as the mobile phone answers the call. Note When the Resume softkey is pressed, the call is returned to the SNR phone. Cisco Unified CME 9.0 supports the SNR feature in Cisco Unified SIP 7906, 7911, 7941, 7942, 7945, 7961, 7962, 7965, 7970, 7971, 7975, 8961, 9951, and 9971 IP Phones. Cisco Unified Communications Manager Express System Administrator Guide 909 Single Number Reach Single Number Reach for Cisco Unified SIP IP Phones Virtual SNR DN for Cisco Unified SCCP IP Phones A virtual SNR DN is a DN not associated with any registered phone. It can be called, forwarded to a preconfigured mobile phone, or put on an Auto Hold state when the mobile phone answers the call or the time delay is reached. In the Auto Hold state, the DN can either be floating or unregistered. A floating DN is a DN not configured for any phone while an unregistered DN is one associated with phones not registered to a Cisco Unified CME system. Before Cisco Unified CME 9.0, an SNR DN feature did not launch when the SNR DN was not associated with any registered phone. Although a call could be forwarded to the mobile phone using the call-forward busy command, the SNR DN had to be configured under a phone. Users who were assigned floating DNs could not forward calls unless they had a phone assigned to them. In Cisco Unified CME 9.0 and later versions, an SNR DN is not required to be associated with a registered phone to have the SNR DN feature launched. A call can be made to a virtual SNR DN and the SNR feature can be launched even when the SNR DN is not associated with any phone. A call to a virtual SNR DN can be forwarded to an auto-attendantservice when the preconfigured mobile phone is out ofservice and the voice mail can be retrieved using the telephone or extension number assigned to the voice mailbox. Although the virtualSNR DN feature is designed forSNR DNs that are not associated with registered phones, this feature also supports virtual SNR DNs that complete phone registration or login and registered DNs that become virtual when all associated registered phones become unregistered. Cisco Unified Communications Manager Express System Administrator Guide 910 Single Number Reach Virtual SNR DN for Cisco Unified SCCP IP Phones Configure Single Number Reach Configure Single Number Reach on SCCP Phones Restriction • Each IP phone supports only one SNR directory number. • SNR feature is not supported for the following: • SCCP-controlled analog FXS phones • MLPP calls • Secure calls • Video calls • Hunt group directory numbers (voice or ephone) • MWI directory numbers • Trunk directory numbers • An overlay set can support only one SNR directory number and that directory number must be the primary directory number. • Call forward no answer (CFNA), configured with the call-forward noan command, is disabled if SNR is configured on the directory number. To forward unanswered calls to voice mail, use the cfwd-noan keyword in the snr command. • Call forwarding of unanswered calls, configured with the cfwd-noan keyword in the snr command, is not supported for PSTN calls from FXO trunks because the calls connect immediately. • Calls from an internal extension to an extension which is busy, is forwarded to the SNR destination even if no forward local-calls is configured under the Directory Number. • Calls always remain private. If a call is answered on a remote phone, the desktop IP phone can not listen to the call unless it resumes the call. • U.S. English is the only locale supported for SNR calls. Before You Begin • Cisco Unified CME 7.1 or a later version • Cisco IP Communicator requires version 2.1.4 or later Cisco Unified Communications Manager Express System Administrator Guide 911 Single Number Reach Configure Single Number Reach SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-dn dn-tag 4. number number 5. mobility 6. snr e164-number delay seconds timeout seconds [cfwd-noan extension-number] 7. snr calling-number local 8. exit 9. ephone-template template-tag 10. softkeys connected {[Acct] [ConfList] [Confrn] [Endcall] [Flash] [HLog] [Hold] [Join] [LiveRcd] [Mobility] [Park] [RmLstC] [Select] [TrnsfVM] [Trnsfer]} 11. softkeys idle {[Cfwdall] [ConfList] [Dnd] [Gpickup] [HLog] [Join] [Login] [Mobility] [Newcall] [Pickup] [Redial] [RmLstC]} 12. exit 13. ephone phone-tag 14. ephone-template template-tag 15. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 ephone-dn dn-tag Enters directory number configuration mode. Example: Router(config)# ephone-dn 10 Step 3 Step 4 number number Associates an extension number with this directory number. Example: Router(config-ephone-dn)# number 1001 • number—String of up to 16 digits that represents an extension or E.164 telephone number. Cisco Unified Communications Manager Express System Administrator Guide 912 Single Number Reach Configure Single Number Reach on SCCP Phones Command or Action Purpose mobility Enables the Mobility feature on the directory number. Example: Router(config-ephone-dn)# mobility Step 5 snr e164-numberdelay secondstimeoutseconds Enables SNR on the extension. [cfwd-noan extension-number] Step 6 • e164-number—E.164 telephone number to ring if IP phone extension does not answer. Example: Router(config-ephone-dn)# snr 4085550133 delay 5 timeout 15 cfwd-noan 2001 • delay seconds—Sets the number of seconds that the call rings the IP phone before ringing the remote phone. Range is from 0 to 10. Default: disabled. • timeout seconds—Sets the number of seconds that the call rings after the configured delay. Call continues to ring for this length of time on the IP phone even if the remote phone answers the call. Range is from 5 to 60. Default: disabled. • cfwd-noan extension-number—(Optional) Forwards the call to this target number if the phone does not answer after both the delay and timeout seconds have expired. This is typically the voice-mail number. The cfwd-noanoption is not supported for calls from FXO trunks because the calls connect immediately. Note (Optional) Replaces the original calling party number with the SNR extension number in the caller ID display of the remote phone. snr calling-number local Example: Router(config-ephone-dn)# snr calling-number local Step 7 • This command is supported in Cisco Unified CME 8.0 and later versions. exit Exits ephone-dn configuration mode. Example: Router(config-ephone-dn)# exit Step 8 Enters ephone-template configuration mode to create an ephone template. ephone-template template-tag Example: Router(config)# ephone-template 1 Step 9 • template-tag—Unique identifier for the ephone template that is being created. Range is from 1 to 20. Modifies the order and type of softkeys that display on an IP phone during the connected call state. softkeys connected{[Acct] [ConfList] [Confrn] [Endcall] [Flash] [HLog] [Hold] [Join] Step 10 [LiveRcd] [Mobility] [Park] [RmLstC] [Select] [TrnsfVM] [Trnsfer]} • Pressing the Mobility softkey during the connected call state forwards the call to the PSTN number defined in Step 6. Cisco Unified Communications Manager Express System Administrator Guide 913 Single Number Reach Configure Single Number Reach on SCCP Phones Command or Action Purpose Example: Router(config-ephone-template)# softkeys connected endcall hold livercd mobility Modifies the order and type of softkeys that display on an IP phone during the idle call state. softkeys idle {[Cfwdall] [ConfList] [Dnd] [Gpickup] [HLog] [Join] [Login] [Mobility] [Newcall] [Pickup] [Redial] [RmLstC]} Step 11 • Pressing the Mobility softkey during the idle call state enables theSNR feature. This key is a toggle; pressing it a second time disables SNR. Example: Router(config-ephone-template)# softkeys idle dnd gpickup pickup mobility exit Exits ephone-template configuration mode. Example: Router(config-ephone-template)# exit Step 12 Step 13 ephone phone-tag Enters ephone configuration mode. Example: Router(config)# ephone 21 • phone-tag—Unique number that identifies this ephone during configuration tasks. Step 14 ephone-template template-tag Applies the ephone template to the phone. Example: Router(config-ephone)# ephone-template 1 • template-tag—Unique identifier of the ephone template that you created in Step 12. end Exits configuration mode. Example: Router(config-ephone-template)# end Step 15 The following example shows extension 1001 is enabled for SNR on IP phone 21. After a call rings at this number for 5 seconds, the call also rings at the remote number 4085550133. The call continues ringing on both phones for 15 seconds. If the call is not answered after a total of 20 seconds, the call no longer rings and it is forwarded to the voice-mail number 2001. ephone-template 1 softkeys idle Dnd Gpickup Pickup Mobility softkeys connected Endcall Hold LiveRcd Mobility ! ephone-dn 10 number 1001 mobility snr 4085550133 delay 5 timeout 15 cfwd-noan 2001 snr calling-number local ! ! ephone 21 mac-address 02EA.EAEA.0001 Cisco Unified Communications Manager Express System Administrator Guide 914 Single Number Reach Configure Single Number Reach on SCCP Phones ephone-template 1 button 1:10 Configure Single Number Reach Enhancements on SCCP Phones Restriction • Software Conference— After a software conference is initiated and committed on an ephone, you cannot send the call to a mobile phone. You can only enable or disable mobility after software conference is committed. • SNR CallPickup onFXO port— For a call routed throughFXO port to thePSTN, the call issignaled as “connected” as soon as FXO port is seized outbound. The mobile phone is on FXO interface and the call (session) is in active state as soon as FXO is in connect state. The ephone will be in ringing state but you can not pick up the ephone call. • Music on hold (MOH) is notsupported if theSNR call originatesfrom the line side. MOH issupported on an SNR call if the call originates from the trunk side. Before You Begin Cisco Unified CME 8.5 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-dn dn-tag 4. number number [secondary number] [no-reg [both | primary]] 5. mobility 6. snr calling number local 7. snr answer too soon time 8. snr ring-stop 9. exit DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Cisco Unified Communications Manager Express System Administrator Guide 915 Single Number Reach Configure Single Number Reach Enhancements on SCCP Phones Command or Action Purpose ephone-dn dn-tag Enters directory number configuration mode. Example: Router(config)# ephone-dn 10 Step 3 number number [secondary number] [no-reg [both Associates an extension number with this directory number. | primary]] Step 4 • number—String of up to 16 digits that represents an extension or E.164 telephone number. Example: Router(config-ephone-dn)# number 1001 mobility Enables the Mobility feature on the directory number. Example: Router(config-ephone-dn)# mobility Step 5 Displays local number as calling number on your SNR mobile phone. snr calling number local Example: Router(config-ephone-dn)#snr calling-number local Step 6 Step 7 snr answer too soon time Enables a timer for answering the call onSNR mobile phone. Example: Router(config-ephone-dn)#snr answer-too-soon 4 • time—Time, in seconds. Range is from 1 to 5. Allows you to stop the IP phone from ringing after the SNR call is answered on a mobile phone. snr ring-stop Example: Router(config-ephone-dn)#snr ring-stop Step 8 exit Exits ephone-dn configuration mode. Example: Router(config-ephone-dn)# exit Step 9 The following example shows SNR enhancements configured for ephone-dn 10: Router#show running config ! ! telephony-service sdspfarm units 1 sdspfarm tag 1 confprof1 conference hardware max-ephones 262 max-dn 720 ip source-address 172.19.153.114 port 2000 service phone thumbButton PTTH6 Cisco Unified Communications Manager Express System Administrator Guide 916 Single Number Reach Configure Single Number Reach Enhancements on SCCP Phones load 7906 SCCP11.8-5-3S.loads load 7911 SCCP11.8-5-3S.loads ! ephone-template 6 feature-button 1 Hold ! ! ephone-dn 10 mobility snr calling-number local snr ring-stop snr answer-too-soon 4 Configure Single Number Reach on SIP Phones Restriction • Hardware Conferencing and Privacy on Hold for Cisco Unified SIP IP phones are not supported. • Mixed shared lines between Cisco Unified SIP and SCCP IP phones are not supported. • Subscribe and Notify modes for SIP shared lines are not supported. • Incoming calls from the H323 IP trunk are not supported. • Media flow around for SIP-SIP trunk calls is not supported. • SIP SNR phones that initiate software conferencing are unable to send or receive calls to or from mobile phones because the Cisco Unified SIP IP phones are put on hold after a software conference is committed. Before You Begin Cisco Unified CME 9.0 or a later version. Cisco Unified Communications Manager Express System Administrator Guide 917 Single Number Reach Configure Single Number Reach on SIP Phones SUMMARY STEPS 1. enable 2. configure terminal 3. voice register template template-tag 4. softkeys idle {[Cfwdall] [DND] [Gpickup] [Newcall] [Pickup] [Redial]} 5. softkeys connected {[Confrn] [Endcall] [Hold] [Park] [Trnsfer] [iDivert]} 6. exit 7. voice register pool pool-tag 8. session-transport {tcp} 9. exit 10. voice register dn dn-tag 11. number number 12. name name 13. mobility 14. snr calling-number local 15. snr e164-number delay seconds timeout seconds [cfwd-noan extension-number] 16. snr ring-stop 17. snr answer-too-soon time 18. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 voice register template template-tag Enters voice register template configuration mode. Example: Router(config)# voice register template 1 • template-tag—identifier for the template being created. Range: 1 to 10. Modifies the display of softkeys on Cisco Unified SIP IP phones during the idle call state. softkeys idle {[Cfwdall] [DND] [Gpickup] [Newcall] [Pickup] [Redial]} Step 4 Example: Router(config-register-temp)# softkeys idle Redial Cfwdall • Cfwdall—(Optional) Softkey for “call forward all.” Forwards all calls. • DND—(Optional) Softkey that enables the Do-Not-Disturb feature. Cisco Unified Communications Manager Express System Administrator Guide 918 Single Number Reach Configure Single Number Reach on SIP Phones Command or Action Purpose • Gpickup—(Optional) Softkey that allows a user to pickup a call that is ringing on another phone. • Newcall—(Optional) Softkey that opens a line on a speakerphone to place a new call. • Pickup—(Optional) Softkey that allows a user to pickup a call that is ringing on another phone that is a member of the same pickup group. • Redial—(Optional) Softkey that redials the last number dialed. Modifies the display of softkeys on Cisco Unified SIP IP phones during the connected call state. softkeys connected{[Confrn] [Endcall] [Hold] [Park] [Trnsfer] [iDivert]} Step 5 Example: Router(config-register-temp)# softkeys connected Confrn Hold Endcall • Confrn—(Optional) Softkey that connects callers to a conference call. • Endcall—(Optional) Softkey that ends the current call. • Hold—(Optional)Softkey that places an active call on hold and resumes the call. • Park—(Optional) Softkey that places an active call on hold, so it can be retrieved from another phone in the system. • Trnsfer—(Optional) Softkey that transfers active calls to another extension. • iDivert—(Optional) Softkey that immediately diverts a call to a voice-messaging system. exit Exits voice register template configuration mode. Example: Router(config-register-temp)# exit Step 6 Step 7 voice register pool pool-tag Enters voice register pool configuration mode. Example: Router(config)# voice register pool 10 • pool-tag—Unique number assigned to the pool. Range: 1 to 100. For Cisco Unified CME systems, the upper limit for this argument is defined by the max-pool command. Note Specifies the transport layer protocol that a Cisco Unified SIP IP phone uses to connect to Cisco Unified CME. session-transport {tcp} Example: Router(config-register-pool)# session-transport tcp Step 8 • tcp—Transmission Control Protocol (TCP) is used. exit Exits voice register pool configuration mode. Example: Router(config-register-pool)# exit Step 9 Cisco Unified Communications Manager Express System Administrator Guide 919 Single Number Reach Configure Single Number Reach on SIP Phones Command or Action Purpose Step 10 voice register dn dn-tag Enters voice register dn configuration mode. Example: Router(config)# voice register dn 3 • dn-tag—Unique sequence number that identifies a particular directory number during configuration tasks. Range is 1 to 150 or the maximum defined by the max-dn command. Associates a telephone or extension number with a Cisco Unified SIP IP phone in a Cisco Unified CME system. number number Example: Router(config-register-dn)# number 1004 Step 11 • number—String of up to 16 charactersthat represents an E.164 telephone number. Normally, the string is composed of digits, but the string may contain alphabetic characters when the number is dialed only by the router, as with an intercom number. Step 12 name name Associates a name with a directory number in Cisco Unified CME. Example: Router(config-register-dn)# name John Smith • name—Name of the person associated with a given extension. Name must follow the order specified in the directory (telephony-service) command, either first-name-first or last-name-first. mobility Enablesthe Mobility feature on an extension of a Cisco UnifiedSIPIPphone. Example: Router(config-register-dn)# mobility Step 13 Replaces the calling party number displayed on the configured mobile phone with the local SNR number. snr calling-number local Example: Router(config-register-dn)# snr calling-number local Step 14 snr e164-numberdelay seconds timeout Enables the SNR feature on an extension of a Cisco Unified SIP IP phone. seconds [cfwd-noan extension-number] Step 15 • e164-number—E.164 telephone number to call when the Cisco Unified SIP IP phone extension does not answer. Example: Router(config-register-dn)# snr 9900 delay 1 timeout 10 • delay seconds—Sets the number of seconds that the Cisco Unified SIP IP phone rings when called. When the time delay is reached, the call is transferred to the PSTN phone and the SNR directory number. Range: 0 to 30. Default: 5. • timeout seconds—Sets the number of seconds that the Cisco Unified SIP IP phone rings after the configured time delay. When the timeout value is reached, no call is displayed on the phone. You have to use the Resume softkey to pull back or the Mobility softkey to send the call to a mobile phone. Range: 30 to 60. Default: 60. When the default is enabled, the Cisco Unified SIP IP phone continues to ring for 60 seconds even if the remote phone answers the call. Note Cisco Unified Communications Manager Express System Administrator Guide 920 Single Number Reach Configure Single Number Reach on SIP Phones Command or Action Purpose • cfwd-noan extension-number—(Optional) Forwards the call to the extension number when the phone does not answer after both the time delay and timeout values are reached. The extension number istypically the voice mail number. This option is not supported for calls from FXO trunks because the calls connect immediately. Note Ends the ringing on a Cisco Unified SIP IP phone after the SNR call is answered on the configured mobile phone. snr ring-stop Example: Router(config-register-dn)# snr ring-stop Step 16 Sets the time in which SNR calls are prevented from being diverted to the voice mailbox of a mobile phone. snr answer-too-soon time Example: Router(config-register-dn)# snr answer-too-soon 2 Step 17 • time—Time, in seconds. Range: 1 to 5. end Exits voice register dn configuration mode and enters privileged EXEC mode. Example: Router(config-register-dn)# end Step 18 Configure a Virtual SNR DN on SCCP Phones Restriction • Virtual SNR DN only supports Cisco Unified SCCP IP phone DNs. • Virtual SNR DN provides no mid-call support. Mid-calls are either of the following: ◦Calls that arrive before the DN is associated with a registered phone and is still present after the DN is associated with the phone. ◦Calls that arrive for a registered DN that changes state from registered to virtual and back to registered. • Mid-calls cannot be pulled back, answered, or terminated from the phone associated with the DN. • State of the virtual DN transitions from ringing to hold or remains on hold as a registered DN. Before You Begin Cisco Unified CME 9.0 or a later version. Cisco Unified Communications Manager Express System Administrator Guide 921 Single Number Reach Configure a Virtual SNR DN on SCCP Phones SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-dn dn-tag 4. number number 5. mobility 6. snr mode [virtual] 7. snr e164-number delay seconds timeout seconds [cfwd-noan extension-number] 8. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters ephone-dn configuration mode to configure a directory number for an IP phone line. ephone-dn dn-tag Example: Router(config)# ephone-dn 10 Step 3 • dn-tag—Unique number that identifies an ephone-dn during configuration tasks. Range is 1 to the number set by the max-dn command. Step 4 number number Associates a telephone or extension number with this ephone-dn. Example: Router(config-ephone-dn)# number 1001 • number—String of up to 16 characters that represents an E.164 telephone number. Normally, the string is composed of digits, but the string may contain alphabetic characters when the number is dialed only by the router, as with an intercom number. Enables the Mobility feature on an extension of a Cisco Unified SCCP IP phone. mobility Example: Router(config-ephone-dn)# mobility Step 5 Step 6 snr mode [virtual] Sets the mode for the SNR directory number. Example: Router(config-ephone-dn)# snr mode virtual • virtual—Enables the virtual mode for an SNR DN when it is unregistered or floating. Cisco Unified Communications Manager Express System Administrator Guide 922 Single Number Reach Configure a Virtual SNR DN on SCCP Phones Command or Action Purpose EnablestheSingle Number Reach feature on the extension of a Cisco Unified SCCP IP phone. snr e164-number delay seconds timeout seconds [cfwd-noan extension-number] Step 7 Example: Router(config-ephone-dn)# snr 408550133 delay 5 timeout 15 cfwd-noan 2001 • e164-number—E.164 telephone number to ring if IP phone extension does not answer. • delay seconds—Sets the number of seconds that the call rings the IP phone before ringing the remote phone. Range: 0 to 10. Default: disabled. • timeout seconds—Sets the number of seconds that the call rings after the configured delay. Call continues to ring for this length of time on the IP phone even if the remote phone answers the call. Range: 5 to 60. Default: disabled. • cfwd-noan extension-number—(Optional) Forwards the call to this target number if the phone does not answer after both the delay and timeout seconds have expired. This is typically the voice mail number. end Exits to privileged EXEC mode. Example: Router(config-ephone-dn)# end Step 8 Feature Information for Single Number Reach The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature. Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required. Cisco Unified Communications Manager Express System Administrator Guide 923 Single Number Reach Feature Information for Single Number Reach Table 75: Feature Information for Single Number Reach Feature Name Cisco Unified CME Version Modification Supports the following SNR features for Cisco Unified SIP IP phones: • Enable and disable the EM feature. • Manual pull back of a call on a mobile phone. • Send a call to a mobilePSTN phone. • Send a call to a mobile phone regardless of whether the SNR phone is the originating or the terminating side. Single Number Reach for Cisco 9.0 Unified SIP IP Phones Allows a call to be made to a virtual SNR DN and allows the SNR feature to be launched even when theSNR DN is not associated with any phone. VirtualSNR DN for Cisco Unified SCCP IP Phones Added support for the following SNR enhancements: • Hardware Conference • Call Park, Call Pickup, and Call Retrieval • Answer Too Soon Timer • SNR Phone Stops Ringing After MobilePhone Answers SNR Enhancements 8.5 Added the snr calling-number local command to replace the calling party number with theSNR extension in the caller ID display. Calling Number Local 8.0 Single Number Reach 7.1 Introduced the SNR feature. Cisco Unified Communications Manager Express System Administrator Guide 924 Single Number Reach Feature Information for Single Number Reach CHAPTER 34 Customize Softkeys • Information About Softkeys, page 925 • Configure Softkeys, page 938 • Configuration Example for Softkeys, page 958 • Feature Information for Softkeys, page 962 Information About Softkeys Softkeys on IP Phones You can customize the display and order of softkeys that appear during various call states on individual IP phones. Softkeys that are appropriate in each call state are displayed by default. Using phone templates, you can delete softkeysthat would normally appear or change the order in which the softkeys appear.For example, you might want to display the CFwdAll and Confrnsoftkeys on a manager's phone and remove these softkeys from a receptionist's phone. You can modify softkeys for the following call states: • Alerting—When the remote point is being notified of an incoming call and the status of the remote point is being relayed to the caller as either ringback or busy. • Connected—When the connection to a remote point is established. • Hold—When a connected party is still connected but there is temporarily no voice connection. • Idle—Before a call is made and after a call is completed. • Seized—When a caller is attempting a call but has not yet been connected. • Remote-in-Use—When another phone is connected to a call on an octo-line directory number shared by this phone (Cisco Unified CME 4.3 or a later version). • Ringing—After a call is received and before the call is connected (Cisco Unified CME 4.2 or a later version). Cisco Unified Communications Manager Express System Administrator Guide 925 Not all softkeys are available in all call states. Use the CLI help to see the available softkeys for each call state. The softkeys are as follows: • Acct—Short for “account code.” Provides access to configured accounts. • Answer—Picks up incoming call. • Barge—Allows a user to join (barge) a call on a SIP shared line (Cisco Unified CME 7.1 or a later version). • Callback—Requests callback notification when a busy called line becomes free. • CBarge—Barges (joins) a call on a shared octo-line directory number (Cisco Unified CME 4.3 or a later version). • CFwdALL—Short for “call forward all.” Forwards all calls. • ConfList—Lists all parties in a conference (Cisco Unified CME 4.1 or a later version). Press Update softkey to update the list of parties in the conference, for instance, to verify that a party has been removed from the conference. Press Remove softkey to remove the appropriate parties. • Confrn—Short for “conference.” Connects callers to a conference call. • Details—Lists all the participants in a conference. This softkey is supported only on Cisco 7800 Series IPPhones.Press Update to update the list of parties in the conference.Press Remove softkey to remove the appropriate parties. The suboption Remove is available to the conference creator and phones that have conference admin configured. • DND—Short for “do not disturb.” Enables the do-not-disturb features. • EndCall—Ends the current call. • GPickUp—Short for “group call pickup.” Selectively picks up calls coming into a phone number that is a member of a pickup group. • Flash—Short for “hookflash.” Provides hookflash functionality for public switched telephone network (PSTN) services on calls connected to the PSTN via a foreign exchange office (FXO) port. • HLog—Places the phone of an ephone-hunt group agent into the not-ready status or, if the phone is in the not-ready status, places the phone into the ready status. • Hold—Places an active call on hold and resumes the call. • iDivert—Immediately diverts a call to a voice messaging system (Cisco Unified CME 8.5 or a later version) • Join—Joins an established call to a conference (Cisco Unified CME 4.1 or a later version). • LiveRcd—Starts the recording of a call (Cisco Unified CME 4.3 or a later version). • Login—Provides personal identification number (PIN) access to restricted phone features. • MeetMe—Initiates a meet-me conference (Cisco Unified CME 4.1 or a later version). • Mobility—Forwards a call to the PSTN number defined by the Single Number Reach (SNR) feature (Cisco Unified CME 7.1 or a later version). • NewCall—Opens a line on a speakerphone to place a new call. • Park—Places an active call on hold so it can be retrieved from another phone in the system. • PickUp—Selectively picks up calls coming into another extension. Cisco Unified Communications Manager Express System Administrator Guide 926 Customize Softkeys Softkeys on IP Phones • Redial—Redials the last number dialed. • Resume—Connects to the call on hold. • RmLstC—Removes the last party added to a conference. This softkey only works for the conference creator (Cisco Unified CME 4.1 or a later version). • Select—Selects a call or a conference on which to take action (Cisco Unified CME 4.1 or a later version). • Show detail—Lists all the participants in a conference. This softkey is supported only on Cisco 8800 Series IP Phones. Press Update to update the list of parties in the conference. Press Remove softkey to remove the appropriate parties. The suboption Remove is available to the conference creator and phones that have conference admin configured. • Trnsfer—Short for “call transfer.” Transfers an active call to another extension. • TrnsfVM—Transfers a call to a voice-mail extension number (Cisco Unified CME 4.3 or a later version). You change the softkey order by defining a phone template and applying the template to one or more phones. You can create up to 20 phone templatesforSCCPphones and 10 templatesforSIPphones. Only one template can be applied to a phone. If you apply a second phone template to a phone that already has a template applied to it, the second template overwrites the first phone template information. The new information takes effect only after you generate a new configuration file and restart the phone; otherwise, the previously configured template remains in effect. In Cisco Unified CME 4.1, customizing the softkey display for IP phones running SIP is supported only for the Cisco Unified IP Phones 7911G, 7941G, 7941GE, 7961G, 7961GE, 7970G, and 7971GE. For configuration information, see Customize Softkeys, on page 925. Account Code Entry The Cisco Unified IP Phones 7940 and 7940G and the Cisco Unified IP Phones 7960 and 7960G allow phone users to enter account codes during call setup or when connected to an active call using the Acct softkey. Account codes are inserted into call detail records (CDRs) on the Cisco Unified CME router for later interpretation by billing software. An account code is visible in the output of the show call active command and the show callhistory command for telephony call legs and is supported by the CISCO-VOICE-DIAL-CONTROL-MIB. The account code also appears in the “account-code” RADIUS vendor-specific attribute (VSA) for voice authentication, authorization, and accounting (AAA). To enter an account code during call setup or when in a connected state, press the Acct softkey, enter the account code using the phone keypad, then press the # key to notify Cisco Unified CME that the last digit of the code has been entered. The account code digits are processed upon receipt of the # and appear in the show output after processing. No configuration is required for this feature. If the # key is not pressed, each account code digit is processed only after a timer expires. The timer is 30 seconds for the first digit entered, then n seconds for each subsequent digit, where n equals the number of seconds configured with the timeouts interdigit (telephony-service) command. The default value for the interdigit timeout is 10 seconds. The account code digits do not appear in the show command output until after being processed. Note Cisco Unified Communications Manager Express System Administrator Guide 927 Customize Softkeys Account Code Entry Hookflash Softkey The Flash softkey provides hookflash functionality for calls made on IP phones that use FXO lines attached to the Cisco Unified CME system. Certain PSTN services, such as three-way calling and call waiting, require hookflash intervention from a phone user. When a Flash softkey is enabled on an IP phone, it can provide hookflash functionality during all calls except for local IP-phone-to-IP-phone calls. Hookflash-controlled services can be activated only if they are supported by the PSTN connection that is involved in the call. The availability of the Flash softkey does not guarantee that hookflash-based services are accessible to the phone user. For configuration information, see Enable Flash Softkey, on page 945 . Feature Blocking In Cisco Unified CME 4.0 and later versions, individual softkey features can be blocked on one or more phones. You specify the features that you want blocked by adding the features blocked command to an ephone template. The template is then applied under ephone configuration mode to one or more ephones. If a feature is blocked using the featuresblockedcommand, the softkey is not removed but it does not function. For configuration information, see Configure Feature Blocking, on page 947. To remove a softkey display, use the appropriate no softkeys command. See Modify Softkey Display on SCCP Phone, on page 938. Feature Policy Softkey Control Cisco Unified CME 8.5 allows you to control the display of softkeys on the Cisco Unified SIP IP Phones 8961, 9951, and 9971 using the Feature Policy template. The Feature Policy template allows you to enable and disable a list of feature softkeys on Cisco Unified SIP IP Phones 8961, 9951, and 9971. Table 76: Feature IDs and Default State of the Controllable Features, on page 928 lists the controllable feature softkeys with specific feature IDs and their default state on Cisco Unified SIP IP Phones 8961, 9951, and 9971. Table 76: Feature IDs and Default State of the Controllable Features Feature ID Feature Name Description Default State on CME 1 ForwardAll Forward all calls Enabled 2 Park Parks a call Enabled 3 iDivert Divert to Voicemail Enabled 4 ConfList Conference List Disabled 5 SpeedDial Abbreviated Dial Disabled 6 Callback Call back Disabled 7 Redial Redial a call Enabled Cisco Unified Communications Manager Express System Administrator Guide 928 Customize Softkeys Hookflash Softkey Feature ID Feature Name Description Default State on CME 8 Barge Barge into a call Enabled Cisco Unified CME uses the existing softkey command under voice register template configuration mode to control the controllable feature softkeys on phones. Cisco Unified CME generates a featurePolicy.xml file for each voice register template configured. The list of controllable softkey configurations are specified in the featurePolicy.xml file. Phones need to reboot or reset to download the Feature Policy template file. For Cisco IP phones that do not have a Feature Policy template assigned to them, you can use the default Feature Policy template file (featurePolicyDefault.xml file). Immediate Divert for SIP IP Phones The immediate divert (iDivert) feature allows you to immediately divert a call to a voice messaging system. You can divert a call by pressing the iDivert softkey on Cisco Unified SIP IP phones with voice messaging systems (Cisco Unity Express or Cisco Unity), such as 7940, 7040G, 7960 G, 7945, 7965, 7975, 8961, 9951, and 9971. When the call is diverted, the line becomes available to place or receive new calls. The call that is diverted using the iDivert feature can be in ringing, active, or hold state. When the call diversion is successful, the caller receives greetings from the voice messaging system. Callers can only divert the calls to their own voice mailbox. But calls on the receiver side can be diverted either to the voice mailbox of the caller who invoked the iDivert feature (last redirected party) or to the voice mailbox of the original called party. The iDivert softkey is added to the phones when they register with Cisco Unified CME using softkeyxxxx.xml file. Cisco Unified CME generates the softkeyxxxx.xml file when the create profile command is executed in voice register global configuration mode. You can disable or change the position of the iDivert softkey on the phone’s display using the softkey command. For more information, see Configure Immediate Divert (iDivert) Softkey on SIP Phone, on page 949. Programmable Line Keys ( PLK) The Programmable Line Key (PLK) feature allows you to program feature buttons or services URL buttons on line key buttons. You can configure line keys with line buttons, speed dials, BLF speed dials, feature buttons, and URL buttons. When button layout is not specified, buttons are assigned to the phone lines in the following order: line, speed-dial, blf-speed-dial, feature, and services URL buttons. Note You can program a line key to function as a services URL button on your Cisco Unified phone using the url-button command (see Configure Service URL Line Key Button on SCCP Phone, on page 951 and Configure Service URL Line Key Button on SIP Phone, on page 953 ). Similarly, you can program a line key on your Cisco IP phone to function as a feature button using the feature-button command (see Configure Feature Buttons on SCCP Phone Line Key, on page 955 and Configure Feature Buttons on SIP Phone Line Key, on page 957 for more information). Cisco Unified Communications Manager Express System Administrator Guide 929 Customize Softkeys Immediate Divert for SIP IP Phones You can also program line keys to function as feature buttons using the user-profile in phones that have Extension Mobility (EM) enabled on them. For configuring line keys to function as feature buttons on EM phones, see Cisco Unified IP Phone documentation. Table 77: PLK Feature Availability on Different Phone Models, on page 930 lists the softkeys supported as PLKs on various Cisco Unified IP Phone models. Table 77: PLK Feature Availability on Different Phone Models 8961, 9951, and 9971 SIP Phones 7942, 7962, 7965, 7975 SIP Phones 6900 Series SCCP Phones 7914, 7915, 7916 7931 Phone SCCP Phones Softkeys Supported as Programmable Line Keys (PLK) Acct Supported Supported Supported Not Supported Not Supported Call Back Supported Supported Supported Not Supported Not Supported Not Supported Supported Not Supported 9 Conference Supported Supported Conference List Supported Supported Supported Not Supported Not Supported Customized Supported Supported Supported Supported Not Supported URL Do Not Disturb Supported Supported Supported Supported Supported End Call Supported Supported Supported Supported Not Supported Extension Supported Supported Supported Not Supported Not Supported Mobility Forward All Supported Supported Supported Supported Not Supported GPickUp Supported Supported Supported Supported Supported Not Supported Supported Not Supported 1 Not Supported 1 Hold Supported Hook Flash Supported Supported Supported Not Supported Not Supported Hunt Group Supported Supported Supported Not Supported Not Supported Live Record Supported Supported Supported Not Supported Not Supported Login Supported Supported Supported Not Supported Not Supported Meet Me Supported Supported Supported Not Supported Not Supported Mobility Supported Supported Supported Not Supported Not Supported MyPhoneApps Supported Supported Supported Not Supported Not Supported Cisco Unified Communications Manager Express System Administrator Guide 930 Customize Softkeys Programmable Line Keys ( PLK) 8961, 9951, and 9971 SIP Phones 7942, 7962, 7965, 7975 SIP Phones 6900 Series SCCP Phones 7914, 7915, 7916 7931 Phone SCCP Phones Softkeys Supported as Programmable Line Keys (PLK) New Call Supported Supported Supported Supported Not Supported Night Service Supported Supported Supported Not Supported Not Supported Park Supported Supported Supported Supported Supported Personal Speed Not Supported Not Supported Not Supported Not Supported Not Supported Dial PickUp Supported Supported Supported Supported Supported Privacy Supported Supported Supported Supported Supported Not Supported Supported Supported Supported 1 Redial Supported Remove Last Supported Supported Supported Not Supported Not Supported Participant Reset Phone Not Supported Not Supported Not Supported Not Supported Not Supported Not Supported Not Supported Not Supported 11 Not Supported 10 Not Supported 1 Services URL Speed Dial Not Supported Not Supported Not Supported Not Supported Not Supported Buttons Single Number Supported Supported Supported Not Supported Not Supported Reach Not Supported Supported Not Supported 1 Not Supported 1 Transfer Supported Transfer to VM Supported Supported Supported Not Supported Not Supported 9 This feature is available through a hard button. 10 This feature is available through the application button. 11 This feature is available through the Set button. Table 78: PLK Feature Availability on the Cisco Unified 6945, 8941, and 8945 SCCP IP Phones in Cisco Unified CME 8.8, on page 932 lists the PLK features available on the Cisco Unified 6945, 8941, and 8945 SCCP IP Phones in Cisco Unified CME 8.8. Cisco Unified Communications Manager Express System Administrator Guide 931 Customize Softkeys Programmable Line Keys ( PLK) Table 78: PLK Feature Availability on the Cisco Unified 6945, 8941, and 8945 SCCP IP Phones in Cisco Unified CME 8.8 Softkeys Supported as Programmable Line Keys Cisco Unified 6945, 8941, and 8945 SCCP IP Phones Acct Supported Call Back Supported Cancel Call Waiting Supported Conference List Supported Customized URL Supported Do Not Disturb Supported End Call Supported Extension Mobility Supported Forward All Supported Group Pickup Supported Hook Flash Supported Hunt Group Login (HLog) Supported Live Record Supported Login Supported Meet Me Supported Mobility Supported My Phone Apps Supported New Call Supported Night Service Supported Park Supported Personal Speed Dial Not Supported Pickup Supported Privacy Supported Redial Supported Cisco Unified Communications Manager Express System Administrator Guide 932 Customize Softkeys Programmable Line Keys ( PLK) Softkeys Supported as Programmable Line Keys Cisco Unified 6945, 8941, and 8945 SCCP IP Phones Remove Last Participant Supported Reset Phone Not Supported Services URL Not Supported Speed Dial Buttons Supported Single Number Reach Supported Transfer to VM Supported Table 79: PLK Feature Availability on the Cisco Unified 6911, 6921, 6941, 6945, 6961, 8941, and 8945 SIP IPPhones in Cisco Unified CME 9.0, on page 933 lists thePLK features available on the Cisco Unified 6911, 6921, 6941, 6945, 6961, 8941, and 8945 SIP IP Phones in Cisco Unified CME 9.0. Table 79: PLK Feature Availability on the Cisco Unified 6911, 6921, 6941, 6945, 6961, 8941, and 8945 SIP IP Phones in Cisco Unified CME 9.0 Cisco Unified 8941 and 8945 SIP IP Phone Cisco Unified 6921, 6941, 6945, and 6961 SIP IP Phones Cisco Unified 6911 SIP IP Phones Softkeys Supported as Programmable Line Keys Acct Not Supported Not Supported Not Supported Call Back Not Supported Not Supported Not Supported Not Applicable1 Not Applicable12 Conference Not Supported Conference List Not Supported Supported Supported Customized URL Not Supported Supported Not Supported Do Not Disturb Not Supported Supported Supported End Call Not Supported Supported Supported Extension Mobility Not Supported Supported Supported Forward All Supported Supported Supported Group Pickup Supported Supported Supported Hold Supported Supported Supported Hook Flash Not Supported Not Supported Not Supported Cisco Unified Communications Manager Express System Administrator Guide 933 Customize Softkeys Programmable Line Keys ( PLK) Cisco Unified 8941 and 8945 SIP IP Phone Cisco Unified 6921, 6941, 6945, and 6961 SIP IP Phones Cisco Unified 6911 SIP IP Phones Softkeys Supported as Programmable Line Keys Hunt Group Not Supported Not Supported Not Supported Live Record Not Supported Not Supported Not Supported Login Not Supported Not Supported Not Supported Meet Me Supported Supported Supported Mobility Not Supported Supported Supported My Phone Apps Not Supported Supported Supported New Call Not Supported Supported Supported Night Service Not Supported Not Supported Not Supported Park Not Supported Supported Supported Personal Speed Dial Not Supported Not Supported Not Supported Pickup Supported Supported Supported Privacy Supported Supported Supported Redial Supported Supported Supported Remove Last Participant Not Supported Not Supported Not Supported Reset Phone Not Supported Not Supported Not Supported Services URL Not Supported Not Supported Not Supported Single Number Reach Not Supported Supported Not Supported Speed Dial Supported Supported Supported Not Applicable2 Not Applicable13 Transfer Not Supported Transfer to VM Not Supported Not Supported Not Supported 12 These phones are equipped with “conference” hard keys. 13 These phones are equipped with “transfer” hard keys. Cisco Unified IP Phones 7902, 7905, 7906, 7910, 7911, 7912, 7935, 7936, 7937, 7940, 7960, and 7985 do not support the PLK feature. The services URL button is not supported on the following Cisco Unified IP phones: 7920, 7921, 7925 (supports DnD and Privacy only), 3911, and 3951. Cisco Unified Communications Manager Express System Administrator Guide 934 Customize Softkeys Programmable Line Keys ( PLK) Table 80:PLK Feature Availability on the Cisco Unified 7800, 8800SeriesSIPIPPhones from Cisco Unified CME 11.0 Onwards, on page 935 lists the PLK features available on the Cisco Unified 7800 and 8800 series SIP IP Phones from Cisco Unified CME Release 11.0 onwards. As part of Unified CME Release 11.7, new phone support for Cisco IPPhones 8821, 8845, 8865 wasintroduced. With this addition, Unified CME supports all phone models in Cisco IP Phone 7800 Series and Cisco IP Phone 8800 Series. Table 80: PLK Feature Availability on the Cisco Unified 7800, 8800 Series SIP IP Phones from Cisco Unified CME 11.0 Onwards Cisco Unified 8800 Series SIP IP Phones Cisco Unified 7800 Series SIP IP Phones Softkeys Supported as Programmable Line Keys Acct Not Supported Not Supported Call Back Not Supported Not Supported Conference Not Supported Not Supported Conference List Supported Supported Customized URL Not Supported Not Supported Do Not Disturb Supported Supported End Call Supported Supported Extension Mobility Supported Supported Forward All Supported Supported Group Pickup Supported Supported Hold Supported Supported Hook Flash Not Supported Not Supported HLog (From Unified CME Release Supported Supported 11.6 onwards) Live Record Not Supported Not Supported Login Not Supported Not Supported Meet Me Supported Supported Mobility Supported Supported My Phone Apps Supported Supported New Call Supported Supported Cisco Unified Communications Manager Express System Administrator Guide 935 Customize Softkeys Programmable Line Keys ( PLK) Cisco Unified 8800 Series SIP IP Phones Cisco Unified 7800 Series SIP IP Phones Softkeys Supported as Programmable Line Keys Park Supported Supported Personal Speed Dial Not Supported Not Supported Pickup Supported Supported Privacy Supported Supported Redial Supported Supported Remove Last Participant Not Supported Not Supported Reset Phone Not Supported Not Supported Services URL Not Supported Not Supported Single Number Reach Not Supported Not Supported Speed Dial Supported Supported Transfer Not Supported Not Supported Transfer to VM Not Supported Not Supported Table 81: LED Behavior, on page 936 lists the feature buttons and their corresponding LED behavior. Only features with radio icons will indicate their state via LED. Table 81: LED Behavior Label/Extended Icon LED Behavior Tagged ID Feature Label/Tagged ID Redial/SkRedialTag — Default — 0x01 Redial Hold/SkHoldTag — Hold — 0x03 Hold Transfer/SkTrnsferTag — Transfer — 0x04 Transfer Forward All Forward All/0x2D Default — MeetMe/ — Default — SkMeetMeConfrn Tag 0x10 MeetMe Cisco Unified Communications Manager Express System Administrator Guide 936 Customize Softkeys Programmable Line Keys ( PLK) Label/Extended Icon LED Behavior Tagged ID Feature Label/Tagged ID Conference/SkConfrnTag — Conference — 0x34 Conference Park/SkParkTag — Default — 0x0E Park PickUp/SkCallPickUpTag — Default — 0x11 PickUp GPickUp — GroupPickUp/0x2F Default — Mobility — Mobility/0x2B Mobility — On—active Off—inactive Do Not Radio Button Disturb/0x0f Do Not Disturb — Conference Default — List/0x34 Conference List — Remove Last Default — Participant/0x30 Remove Last — Participant CallBack/SkCallBackTag — Default — 0x41 CallBack NewCall/SkNewCallTag — Default — 0x02 New Call End Call — End Call/0x33 Default — Cancel Call Waiting CW Off — Default — On—hlog in Off—hlog out Blink—call in queue at Hlogout state HLog — Hunt Group/0x36 Default On—active Off—inactive Private/ SkPrivacy — Radio Button 0x36 Privacy Acct/ — Default — TAGS_ACCT_ 40 TAGS_Acct[] Acct Cisco Unified Communications Manager Express System Administrator Guide 937 Customize Softkeys Programmable Line Keys ( PLK) Label/Extended Icon LED Behavior Tagged ID Feature Label/Tagged ID Flash/ — Default — TAGS_FLASH_ 41 TAGS_Flash[] Flash Login/ — Default — TAGS_LOGIN_ 42 TAGS_Login[] Login TrnsfVM/SkTrnsfVMTag — Default — 0x3e TrnsfVM LiveRcd LiveRcd — Default — On—active Off—inactive Night Service/ — Radio Button TAGS_Night_Service[] Night Service Myphoneapp URL My Phone Apps — URL service — service EM URL service Extension Mobility — URL service — Single Number — URL service — Reach SN URL service The configured — URL service — name Customized URL Configure Softkeys Modify Softkey Display on SCCP Phone To modify the display of softkeys, perform the following steps. Cisco Unified Communications Manager Express System Administrator Guide 938 Customize Softkeys Configure Softkeys Restriction • Enable the ConfList and MeetMe softkeys only if you have hardware conferencing configured. For information,see Meet-Me Conferencing in Cisco Unified CME 4.1 and Later versions, on page 1373 . • The third softkey button on the Cisco Unified IP Phone 7905G and Cisco Unified IP Phone 7912G is reserved for the Message softkey. For these phones’ templates, the third softkey button defaults to the Message softkey.For example, the softkeysidle Redial Dnd Pickup Login Gpickupcommand configuration displays, in order, the Redial, DND, Message, PickUp, Login, and GPickUp softkeys. • The NewCall softkey cannot be disabled on the Cisco Unified IP Phone 7905G or Cisco Unified IP Phone 7912G. Before You Begin • Cisco CME 3.2 or a later version. • Cisco Unified CME 4.2 or a later version to enable softkeys during the ringing call state. • Cisco Unified CME 4.3 or a later version to enable softkeys during the remote-in-use state. • The HLog softkey must be enabled with the hunt-group logout HLog command before it will be displayed.For more information, see Configure Ephone-Hunt Groups onSCCPPhones, on page 1291 . • The Flash softkey must be enabled with the fxo hook-flash command before it will be displayed. For configuration information, see Enable Flash Softkey, on page 945 . SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-template template-tag 4. softkeys alerting {[Acct] [Callback] [Endcall]} 5. softkeys connected {[Acct] [ConfList] [Confrn] [Endcall] [Flash] [Hlog] [Hold] [Join] [LiveRcd] [Park] [RmLstC] [Select] [TrnsfVM] [Trnsfer]} 6. softkeys hold {[Join] [Newcall] [Resume] [Select]} 7. softkeysidle {[Cfwdall] [ConfList] [Dnd] [Gpickup] [Hlog] [Join] [Login] [Newcall] [Pickup] [Redial] [RmLstC]} 8. softkeys remote-in-use {[CBarge] [Newcall]} 9. softkeys ringing {[Answer] [Dnd] [HLog]} 10. softkeys seized {[CallBack] [Cfwdall] [Endcall] [Gpickup] [Hlog] [MeetMe] [Pickup] [Redial]} 11. exit 12. ephone phone-tag 13. ephone-template template-tag 14. end Cisco Unified Communications Manager Express System Administrator Guide 939 Customize Softkeys Modify Softkey Display on SCCP Phone DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters ephone-template configuration mode to create an ephone template. ephone-template template-tag Example: Router(config)# ephone-template 15 Step 3 • template-tag—Unique identifier for the ephone template that is being created. Range is 1 to 20. (Optional) Configures an ephone template for softkey display during the alerting call state. softkeys alerting {[Acct] [Callback] [Endcall]} Example: Router(config-ephone-template)# softkeys alerting Callback Endcall Step 4 • You can enter any of the keywords in any order. • Default is all softkeys are displayed in alphabetical order. • Any softkey that is not explicitly defined is disabled. (Optional) Configures an ephone template for softkey display during the call-connected state. softkeys connected {[Acct] [ConfList] [Confrn] [Endcall] [Flash] [Hlog] [Hold] [Join] [LiveRcd] [Park] [RmLstC] [Select] [TrnsfVM] [Trnsfer]} Step 5 • You can enter any of the keywords in any order. Example: Router(config-ephone-template)# softkeys connected Endcall Hold Transfer Hlog • Default is all softkeys are displayed in alphabetical order. • Any softkey that is not explicitly defined is disabled. (Optional) Configures an ephone template for softkey display during the call-hold state. softkeyshold{[Join] [Newcall] [Resume] [Select]} Example: Router(config-ephone-template)# softkeys hold Resume Step 6 • You can enter any of the keywords in any order. • Default is all softkeys are displayed in alphabetical order. • Any softkey that is not explicitly defined is disabled. (Optional) Configures an ephone template for softkey display during the idle state. softkeys idle {[Cfwdall] [ConfList] [Dnd] [Gpickup] [Hlog] [Join] [Login] [Newcall] [Pickup] [Redial] [RmLstC]} Step 7 • You can enter any of the keywords in any order. Example: Router(config-ephone-template)# softkeys idle Newcall Redial Pickup Cfwdall Hlog • Default is all softkeys are displayed in alphabetical order. • Any softkey that is not explicitly defined is disabled. Cisco Unified Communications Manager Express System Administrator Guide 940 Customize Softkeys Modify Softkey Display on SCCP Phone Command or Action Purpose Modifies the order and type of softkeys that display on an IP phone during the remote-in-use call state. softkeys remote-in-use {[CBarge] [Newcall]} Example: Router(config-ephone-template)# softkeys remote-in-use CBarge Newcall Step 8 (Optional) Configures an ephone template for softkey display during the ringing state. softkeys ringing {[Answer] [Dnd] [HLog]} Example: Router(config-ephone-template)# softkeys ringing Answer Dnd Hlog Step 9 • You can enter any of the keywords in any order. • Default is all softkeys are displayed in alphabetical order. • Any softkey that is not explicitly defined is disabled. (Optional) Configures an ephone template for softkey display during the seized state. softkeys seized {[CallBack] [Cfwdall] [Endcall] [Gpickup] [Hlog] [MeetMe] [Pickup] [Redial]} Step 10 Example: Router(config-ephone-template)# softkeys seized Endcall Redial Pickup Cfwdall Hlog • You can enter any of the keywords in any order. • Default is all softkeys are displayed in alphabetical order. • Any softkey that is not explicitly defined is disabled. exit Exits ephone-template configuration mode. Example: Router(config-ephone-template)# exit Step 11 Step 12 ephone phone-tag Enters ephone configuration mode. Example: Router(config)# ephone 36 • phone-tag—Unique sequence number that identifies this ephone during configuration tasks. ephone-template template-tag Applies an ephone template to the ephone that is being configured. Example: Router(config-ephone)# ephone-template 15 Step 13 end Returns to privileged EXEC mode. Example: Router(config-ephone)# end Step 14 What to Do Next If you are done modifying the parameters for phones in Cisco Unified CME, generate a new configuration file and restart the phones. See Generate Configuration Files for SCCP Phones, on page 388. Cisco Unified Communications Manager Express System Administrator Guide 941 Customize Softkeys Modify Softkey Display on SCCP Phone Modify Softkey Display on SIP Phone Restriction • Thisfeature issupported only for Cisco Unified IPPhones 7911G, 7941G, 7941GE, 7961G, 7961GE, 7970G, and 7971GE. • You can download a custom softkey XML file from a TFTP server. However, if the softkey XML file contains an error, the softkeys might not work properly on the phone. We recommend the following procedure for creating a softkey template in Cisco Unified CME. • HLog softkey is supported only on Cisco Unified IP Phones 7800 and 8800 series. Before You Begin Cisco Unified CME 4.1 or a later version. From Cisco Unified CME Release 11.6 onwards, HLog softkey is supported. SUMMARY STEPS 1. enable 2. configure terminal 3. voice register template template-tag 4. softkeys connected {[Confrn] [Endcall] [Hold] [Trnsfer] [HLog] } 5. softkeys hold {[Newcall] {Resume]} 6. softkeys idle {[Cfwdall] [Newcall] [Redial] [HLog] } 7. softkeys seized {[Cfwdall] [Endcall] [Redial]} 8. exit 9. voice register pool pool-tag 10. template template-tag 11. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Cisco Unified Communications Manager Express System Administrator Guide 942 Customize Softkeys Modify Softkey Display on SIP Phone Command or Action Purpose Enters voice register template configuration mode to create a SIP phone template. voice register template template-tag Example: Router(config)# voice register template 9 Step 3 • template-tag—Range: 1 to 10. (Optional) Configures a SIP phone template for softkey display during the call-connected state. softkeys connected {[Confrn] [Endcall] [Hold] [Trnsfer] [HLog] } Step 4 Example: Router(config-register-template)# softkeys connected Endcall Hold Transfer HLog • You can enter the keywords in any order. • Default is all softkeys are displayed in alphabetical order. • Any softkey that is not explicitly defined is disabled. (Optional) Configures a phone template for softkey display during the call-hold state. softkeys hold {[Newcall] {Resume]} Example: Router(config-register-template)# softkeys hold Resume Step 5 • Default is that the NewCall and Resume softkeys are displayed in alphabetical order. • Any softkey that is not explicitly defined is disabled. (Optional) Configures a phone template for softkey display during the idle state. softkeys idle {[Cfwdall] [Newcall] [Redial] [HLog] } Step 6 Example: Router(config-register-template)# softkeys idle Newcall Redial Cfwdall HLog • You can enter the keywords in any order. • Default is all softkeys are displayed in alphabetical order. • Any softkey that is not explicitly defined is disabled. (Optional) Configures a phone template for softkey display during the seized state. softkeys seized {[Cfwdall] [Endcall] [Redial]} Example: Router(config-register-template)# softkeys seized Endcall Redial Cfwdall Step 7 • You can enter the keywords in any order. • Default is all softkeys are displayed in alphabetical order. • Any softkey that is not explicitly defined is disabled. exit Exits voice register template configuration mode. Example: Router(config-register-template)# exit Step 8 Enters voice register pool configuration mode to set phone-specific parameters for a SIP phone. voice register pool pool-tag Example: Router(config)# voice register pool 36 Step 9 Step 10 template template-tag Applies a SIP phone template to the phone you are configuring. Cisco Unified Communications Manager Express System Administrator Guide 943 Customize Softkeys Modify Softkey Display on SIP Phone Command or Action Purpose Example: Router(config-register-pool)# template 9 • template-tag— Template tag that was created with the voice register template command in Step 3 . end Exits to privileged EXEC mode. Example: Router(config-register-pool)# end Step 11 What to Do Next If you are done modifying the parameters for phones in Cisco Unified CME, generate a new configuration file and restart the phones. See Generate Configuration Profiles for SIP Phones, on page 391 . Verify Softkey Configuration Step 1 show running-config Use this command to verify your configuration. In the following example, the softkey display is modified in phone template 7 and the template is applied to SIP phone 2. All other phones use the default arrangement of softkeys. Example: Router# show running-config ! voice register dn 1 dual-line ring feature secondary number 126 secondary 1261 description Sales name Smith call-forward busy 500 secondary call-forward noan 500 timeout 10 huntstop channel no huntstop no forward local-calls ! ! voice register template 7 session-transport tcp softkeys hold Resume Newcall softkeys idle Newcall Redial Cfwdall HLog softkeys connected Endcall Trnsfer Confrn Hold Hlog voicemail 52001 timeout 30 . . . voice register pool 2 id mac 0030.94C2.A22A number 1 dn 4 template 7 Cisco Unified Communications Manager Express System Administrator Guide 944 Customize Softkeys Verify Softkey Configuration dialplan 3 ! Step 2 show telephony-service ephone-template or show voice register template template-tag Example: These commands display the contents of individual templates. Router# show telephony-service ephone-template ephone-template 1 softkey ringing Answer Dnd conference drop-mode never conference add-mode all conference admin: No Always send media packets to this router: No Preferred codec: g711ulaw User Locale: US Network Locale: US or Router# show voice register template 7 Temp Tag 7 Config: Attended Transfer is enabled Blind Transfer is enabled Semi-attended Transfer is enabled Conference is enabled Caller-ID block is disabled DnD control is enabled Anonymous call block is disabled Voicemail is 52001, timeout 30 KPML is disabled Transport type is tcp softkey connected Endcall Trnsfer Confrn Hold HLog softkey hold Resume Newcall softkey idle Newcall Redial Cfwdall HLog Enable Flash Softkey Restriction The IP phone must support softkey display. Before You Begin To enable the Flash softkey, perform the following steps SUMMARY STEPS 1. enable 2. configure terminal 3. telephony-service 4. fxo hook-flash 5. restart all 6. end Cisco Unified Communications Manager Express System Administrator Guide 945 Customize Softkeys Enable Flash Softkey DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 telephony-service Enters telephony-service configuration mode. Example: Router(config)# telephony-service Step 3 Enables the Flash softkey on phones that support softkey display on PSTN calls using an FXO port. fxo hook-flash Example: Router(config-telephony)# fxo hook-flash Step 4 The Flash softkey display is automatically disabled for local IP-phone-to-IP-phone calls. Note Performs a fast reboot of all phones associated with this Cisco Unified CME router. Does not contact the DHCP or TFTP server for updated information. restart all Example: Router(config-telephony)# restart all Step 5 end Returns to privileged EXEC mode. Example: Router(config-telephony)# end Step 6 Verify Flash Softkey Configuration Step 1 Use the show running-config command to display an entire configuration, including Flash softkey, which is listed in the telephony-service portion of the output. Example: Router# show running-config telephony-service fxo hook-flash load 7960-7940 P00305000600 load 7914 S00103020002 max-ephones 100 max-dn 500 Step 2 Use the show telephony-service command to show only the telephony-service portion of the configuration. Cisco Unified Communications Manager Express System Administrator Guide 946 Customize Softkeys Verify Flash Softkey Configuration Configure Feature Blocking To configure feature blocking for SCCP phones, perform the following steps. Before You Begin Cisco Unified CME 4.0 or a later version. SUMMARY STEPS 1. enable 2. configure terminal 3. ephone-template template-tag 4. features blocked [CFwdAll] [Confrn] [GpickUp] [Park] [PickUp] [Trnsfer] 5. exit 6. ephone phone-tag 7. ephone-template template-tag 8. restart 9. Repeat Step 5 to Step 8 for each phone to which the template should be applied. 10. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Step 3 ephone-template template-tag Enters ephone-template configuration mode. Example: Router(config)# ephone-template 1 • template-tag—Unique sequence number that identifies this template during configuration tasks. Range is 1 to 20. features blocked [CFwdAll] [Confrn] Prevents the specified softkey from invoking its feature. [GpickUp] [Park] [PickUp] [Trnsfer] Step 4 • CFwdAll—Call forward all calls. Example: Router(config-ephone-template)# features blocked Park Trnsfer • Confrn—Conference. • GpickUp—Group call pickup. Cisco Unified Communications Manager Express System Administrator Guide 947 Customize Softkeys Configure Feature Blocking Command or Action Purpose • Park—Call park. • PickUp—Directed or local call pickup. This includes pickup last-parked call and pickup from another extension or park slot. • Trnsfer—Call transfer. exit Exits ephone-template configuration mode. Example: Router(config-ephone-template)# exit Step 5 Step 6 ephone phone-tag Enters ephone configuration mode. Example: Router(config)# ephone 25 • phone-tag—Unique sequence number that identifies this ephone during configuration tasks. The maximum number of ephonesfor a particular Cisco Unified CME system is version- and platform-specific. For the range of values, see the CLI help. Step 7 ephone-template template-tag Applies an ephone template to an ephone. Example: Router(config-ephone)# ephone-template 1 • template-tag—Template number that you want to apply to this ephone. To view your ephone-template configurations, use the show telephony-service ephone-template command. Note Performs a fast reboot of this ephone. Does not contact the DHCP or TFTP server for updated information. restart Example: Router(config-ephone)# restart Step 8 If you are applying the template to more than one ephone, you can use the restart all command in telephony-service configuration mode to reboot all the phones so they have the new template information. Note Repeat Step 5 to Step 8 for each phone to — which the template should be applied. Step 9 end Returns to privileged EXEC mode. Example: Router(config-ephone)# end Step 10 Cisco Unified Communications Manager Express System Administrator Guide 948 Customize Softkeys Configure Feature Blocking Verify Block Softkey Configuration Step 1 Use the show running-config command to display the running configuration, including ephone templates and ephone configurations. Step 2 Use the show telephony-service ephone-template command and the show telephony-service ephone command to display only the contents of ephone templates and the ephone configurations, respectively. Configure Immediate Divert (iDivert) Softkey on SIP Phone To configure iDivert softkey (in connected state) on Cisco UnifiedSIPIPphones, perform the following step. When one participant in a conference (Meetme, Ad Hoc, cBarge, or Join) presses the iDivert softkey, all remaining participants receive an outgoing greeting of the participant who pressed iDivert softkey. Note Restriction • iDivert feature is disabled when call-forward all is activated for a phone. • iDivert feature is not activated for the second call when call-forward busy is activated for a phone and the phone is busy with the first call. • If iDivertsoftkey is pressed before call forward no answer (CFNA) timeout, then the call isforwarded to voice mail. • The calling and called parties can divert the call to their voice messaging mailboxesif both the parties press the iDivert softkey at the same time. The voice messaging mailbox of the calling party will receive a portion of the outgoing greeting of the called party.Similarly, the voice messaging mailbox of the called party will receive a portion of the outgoing greeting of the calling party. • iDivert softkey is not supported when SIP phones fall back to SRST mode in Cisco Unified CME. • iDivert after connect towards the voicemail with transcoding is not supported. Cisco Unified Communications Manager Express System Administrator Guide 949 Customize Softkeys Verify Block Softkey Configuration SUMMARY STEPS 1. enable 2. configure terminal 3. voice register template template-tag 4. softkeys connected [Confrn] [Endcall] [Hold] [Trnsfer] [iDivert] 5. softkeys hold [Newcall] {Resume] [ iDivert] 6. softkeys ringing [Answer] [DND] [iDivert] 7. exit 8. voice register pool pool-tag 9. template template-tag 10. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register template configuration mode to create a SIP phone template. voice register template template-tag Example: Router(config)# voice register template 9 Step 3 • template-tag—Range: 1 to 10. (Optional) Configures a SIP phone template for softkey display during the call-connected state. softkeys connected [Confrn] [Endcall] [Hold] [Trnsfer] [iDivert] Step 4 Example: Router(config-register-template)# softkeys connected Endcall Hold Transfer iDivert • You can enter the keywords in any order. • Default is all softkeys are displayed in alphabetical order. • Any softkey that is not explicitly defined is disabled. (Optional) Configures a phone template for softkey display during the call-hold state. softkeys hold [Newcall] {Resume] [ iDivert] Example: Router(config-register-template)# softkeys hold Newcall Resume Step 5 • Default is that the NewCall and Resume softkeys are displayed in alphabetical order. • Any softkey that is not explicitly defined is disabled. Cisco Unified Communications Manager Express System Administrator Guide 950 Customize Softkeys Configure Immediate Divert (iDivert) Softkey on SIP Phone Command or Action Purpose Modifies the order and type of softkeys that display on a SIP phone during the ringing call state. softkeys ringing [Answer] [DND] [iDivert] Example: Router(config-register-temp)# softkeys ringin dnd answer idivert Step 6 exit Exits voice register template configuration mode. Example: Router(config-register-template)# exit Step 7 Enters voice register pool configuration mode to set phone-specific parameters for a SIP phone. voice register pool pool-tag Example: Router(config)# voice register pool 36 Step 8 Step 9 template template-tag Applies a SIP phone template to the phone you are configuring. Example: Router(config-register-pool)# template 9 • template-tag— Template tag that was created with the voice register template command in Step 3 . end Exits configuration mode. Example: Router(config-register-pool)# end Step 10 Configure Service URL Line Key Button on SCCP Phone SUMMARY STEPS 1. enable 2. configure terminal 3. ephone template template-tag 4. url-button index type | url [name] 5. exit 6. ephone phone-tag 7. ephone-template template-tag 8. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Cisco Unified Communications Manager Express System Administrator Guide 951 Customize Softkeys Configure Service URL Line Key Button on SCCP Phone Command or Action Purpose Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters ephone-template configuration mode to create an ephone template. ephone template template-tag Example: Router(config)# ephone template 5 Step 3 • template-tag—Unique identifier for the ephone template that is being created. Range: 1 to 10. Step 4 url-button index type | url [name] Configures a service URL button on a line key. Example: Router#(config-ephone-template)#url-button 1 myphoneapp Router(config-ephone-template)#url-button 2 em Router(config-ephone-template)#url-button 3 snr Router (config-ephone-template)#url-button 4 http://www.cisco.com • index—Unique index number. Range: 1 to 8. • type—Type of service URL button. The following types of service URL buttons are available: ◦myphoneapp: My phone application configured under phone user interface. ◦em: Extension Mobility. ◦snr: Single Number Reach. • url name—Service URL with maximum length of 31 characters. exit Exits ephone-template configuration mode. Example: Router(config-ephone-template)# exit Step 5 Step 6 ephone phone-tag Enters ephone configuration mode. Example: Router(config)#ephone 36 • phone-tag—Unique sequence number that identifies this ephone during configuration tasks. ephone-template template-tag Applies an ephone template to the ephone that is being configured. Example: Router(config-ephone)# ephone-template 5 Step 7 end Returns to privileged EXEC mode. Example: Router(config-ephone)# end Step 8 Cisco Unified Communications Manager Express System Administrator Guide 952 Customize Softkeys Configure Service URL Line Key Button on SCCP Phone What to Do Next If you are done configuring the URL buttons for phones in Cisco Unified CME, restart the phones. Configure Service URL Line Key Button on SIP Phone SUMMARY STEPS 1. enable 2. configure terminal 3. voice register template template-tag 4. url-button [index number] [url location] [url name] 5. exit 6. voice register pool phone-tag 7. template template-tag 8. end DETAILED STEPS Command or Action Purpose Step 1 enable Enables privileged EXEC mode. Example: Router> enable • Enter your password if prompted. configure terminal Enters global configuration mode. Example: Router# configure terminal Step 2 Enters voice register template configuration mode to create aSIP phone template. voice register template template-tag Example: Router(config)# voice register template 5 Step 3 • template-tag—Unique identifier for the template that is being created. Range: 1 to 10. url-button [index number] [url location] [url Configures a service URL button on a line key. name] Step 4 • index number—Unique index number. Range: 1 to 8. Example: Router(config-register-temp)url-button 1 http:// www.cisco.com • url location—Location of the URL. • url name—Service URL with maximum length of 31 characters. Cisco Unified Communications Manager Express System Administrator Guide 953 Customize Softkeys Configure Service URL Line Key Button on SIP Phone Command or Action Purpose exit Exits voice register template configuration mode. Example: Router(config-register-temp)# exit Step 5 Step 6 voice register pool phone-tag Enters voice register pool configuration mode. Example: Router(config)# voice register pool 12 • phone-tag—Unique number that identifiesthis voice register pool during configuration tasks. Step 7 template template-tag Applies the SIP phone template to the phone. Example: Router(config-register-pool)# template 5 • template-tag—Unique identifier of the template that you created in Step 3. end Returns to privileged EXEC mode. Example: Router(config-register-pool)# end Step 8 What to Do Next If you are done configuring the URL buttons for phones in Cisco Unified CME, generate a new configuration file and restart the phones. See Generate Configuration Profiles for SIP Phones, on page 391. Cisco Unified Communications Manager Express System Administrator Guide 954 Customize Softkeys Configure Service URL Line Key Button on SIP Phone Configure Feature Buttons on SCCP Phone Line Key Restriction • Answer, Select, cBarge, Join, and Resume features are not supported as PLKs. • Feature buttons are only supported on Cisco Unified IPPhones 6911, 7941, 7942, 7945, 7961, 7962, 7965. 7970, 7971, and 7975 with SCCP v12 or later versions. • Any features available through hard buttons are not provisioned. Use the show ephone register detail command to verify why the features buttons are not provisioned. • Not all feature buttons are supported on Cisco Unified IP Phone 6911 phone. Call Forward, Pickup, Group Pickup, and MeetMe are the only feature buttons supported on the Cisco Unified IP Phone 6911. • The privacy-button command is available on Cisco Unified IP phones running a SCCP Version 8 or later versions. Theprivacy-butttoncommand is overridden by any other available feature buttons. • Locales are not supported on Cisco Unified IP Phone 7914. • Locales are not supported for Cancel Call Waiting or Live Recording feature buttons. • The feature state for DnD, Hlog, Privacy, Login, and Night Service feature buttons are indicated by an LED. For a list of LED behavior for PLK, see Table 81: LED Behavior, on page 936 SUMMARY STEPS 1. enable 2. configure terminal 3. ephone template template-tag 4. feature-button index [label