System Administration Guide

Transcription

1 Akkadian Provisioning Manager 4.12 System Administration Guide Updated November 9 th, 2017 Copyright and Trademarks: I. Copyright: This website and its content is copyright 2017 Akkadian, LLC. All rights reserved. Except with the prior written permission of Akkadian, LLC, any redistribution or reproduction of part or all of the contents of this website, including the redistribution or reproduction of any documentation or other materials downloaded from this website, in any form and in any media, is prohibited. II. Trademarks: Akkadian, the Akkadian logo and other trademark or service marks used on this website, whether registered or not, are the property of Akkadian, LLC and may not be used or reproduced without the prior written permission of Akkadian, LLC. apme UG 1/8/

2 Table of Contents Task List for Installing and Configuring Akkadian Provisioning Manager Section 1.0 System Requirements for Akkadian Provisioning Manager Provisioning Manager 4.12 Server Requirements Cisco Unified Communications Application Requirements SMTP Requirements Web Browser Requirements Firewall Ports... 9 Section 2.0 Preparing Cisco Unified Communications Manager for Provisioning Manager Express Activate the AXL Web Service Create Provisioning Manager CUCM Application User Section 3.0 Preparing Cisco Unified Contact Center Express for Provisioning Manager Express Assigning a user Cisco Unified CCX Administrator capability Section 4.0 Preparing Cisco Unity Connection for Provisioning Manager Express Creating a Cisco Unity Connection System Administration Account Section 5.0 Akkadian Provisioning Manager for Windows Section 6.0 Deploying the Akkadian Provisioning Manager Virtual Appliance Section 7.0 Akkadian Provisioning Manager Initial Configuration Logging into Akkadian Provisioning Manager Configuration Single Sign-on Configuration Akkadian Provisioning Manger 4.12 SSL Configuration Generating an SSL Certificate Signing Request (CSR) Uploading SSL Certificates LDAP Agreement Configuration Installing a Provisioning Manager Express License Integrating Application Servers with Provisioning Manager Express Integrating CUCM Application Servers Integrating CUC Application Servers Integrating Cisco UCCX Application Servers Integrating Cisco Packaged UCCE Servers Integrating Cisco WebEx Application Servers Configuring Service Groups Enable the Self-Service Portal Branding the Self-Service Portal Adding Security Groups and Permissions Assigning Access to Service Groups Configuring Users Akkadian Provisioning Manager 4.12 System Administration Guide 2

3 7.11 Configuring Filter Templates Configuring DN Pools Configuring License Pools Configuring Global Variables Configuring Device Pools Groups Log Archive Configuration Configuring Templates Section Getting Started with Templates in Akkadian Provisioning Manager Section 8.1 Using Provisioning Variables Section 8.2 Creating Add Templates Section Creating Add Speed Dial Templates Section Creating Add Voice Mail Profile Templates Section Creating Add User Templates Section Creating Add Line Templates Section Creating Add Device Templates Section Creating Add CUC Voice Mail Templates Section Creating Add WebEx Templates Section Creating Site Templates Section 8.3 Editing Templates in Akkadian Provisioning Manager Section 9.0 Getting Started with Jobs Templates in Akkadian Provisioning Manager Section 10.0 Getting Started with Provisioning in Akkadian Provisioning Manager Section 10.1 Bulk Provisioning Section 10.2 Scheduled Bulk Provisioning Section 10.3 Using the Extension Mobility Tool Section 10.4 Using the Swap Feature Section Using the Device Swap Feature Section Using the User Swap Feature Section 10.5 Using Bulk Swap Section 10.6 Using the CMC/FAC Editor Section 10.7 Using the Visual Phone Editor Section 10.8 Using Phone Control Section 10.9 CUC Voice Mailbox Scheduled Delete Service Section 11.0 FTP Server Configuration Section 12.0 Configuring Backup and Restore Section 13.0 Performing System Updates Section 14.0 Reporting Section 15.0 Updating the Default PMEAdmin Password Section 16.0 Getting Started with the REST API in Akkadian Provisioning Manager Akkadian Provisioning Manager 4.12 System Administration Guide 3

4 Section 17.0 Configuring the Self-Provisioning Service in Akkadian Provisioning Manager Section 17.1 Configuring Device Default Template Mappings for the Self-Provisioning Service Section 17.2 Method 1 - Deploying Self-Provisioning using an IP Phone Service Section 17.3 Method 2 - Deploying Self-Provisioning with Auto-registration Section 18.0 Configuring Active Directory Auto Provisioning in Akkadian Provisioning Manager Akkadian Provisioning Manager 4.12 System Administration Guide 4

5 Task List for Installing and Configuring Akkadian Provisioning Manager 4.12 To install and configure Akkadian Provisioning Manager 4.12 complete the following tasks in the order presented: 1. Review the requirements for deploying Akkadian Provisioning Manager 4.12 in Section 1 System Requirement for Akkadian Provisioning Manager Configure Cisco Unified Communications Manager for AXL API access. See Section 2.0 Preparing Cisco Unified Communications Manager for Provisioning Manager Optional Configure Cisco Contact Center Express for REST API access. See Section 3.0 Preparing Cisco Unified Contact Center Express for Provisioning Manager If you are not using Unity Connection, please proceed to step Optional Configure Cisco Unity Connection for REST API access. See Section 4.0 Preparing Cisco Unity Connection for Provisioning Manager If you are not using Unity Connection, please proceed to step Install Akkadian Provisioning Manger Section 6.0 Deploying the Akkadian Provisioning Manager 4.12 Virtual Appliance. 6. Log in to Provisioning Manager 4.12 to perform the initial configuration See Section 7.0 Akkadian Provisioning Manager 4.12 Initial Configuration. 7. Configure the SMTP Host for password recovery and notifications. See Section 7.1 Akkadian Provisioning Manager Configuration. 8. Optional Upload SSL Certificate and Key. See Section 7.3 Akkadian Provisioning Manger 4.12 SSL Configuration. 9. Optional Configure LDAP authentication. See Section 7.4 Akkadian Provisioning Manger 4.12 LDAP Configuration. This is only required if you wish to utilize LDAP authentication to access Provisioning Manager 4.12; otherwise proceed to the next step. 10. Upload the license file. See Section 7.5 Akkadian Provisioning Manger 4.12 Licensing. If you are trialing Akkadian Provisioning Manager, this step is optional.

6 11. Add Applications Servers such as Cisco Unified Communications Manager and Cisco Unity Connection. See Section 7.6 Adding Application Servers to Akkadian Provisioning Manger Configure Service Groups to provide provision access to your Application Servers. See Section 7.7 Configuring Service Groups in Akkadian Provisioning Manger Optional Add Groups and Permissions. See Section 7.8 Adding Groups and Permissions in Akkadian Provisioning Manager The built-in groups can be used to provide access to Provisioning Manager Custom Groups should be used for greater flexibility and security. 14. Associate Service Groups to User Groups to provide access to provision in Application Servers. See Section 7.9 Assigning Access to Service Groups in Akkadian Provisioning Manager Create Users and assign them to Groups. See Section 7.10 Configuring Users in Akkadian Provisioning Manager The PMEAdmin user has no provisioning rights and should not be used for daily system administration. At least one user with System Administrator permissions will be required to complete the Provisioning Manager 4.12 configuration. Please note the username and password for this user, as it will be required for Step Log out of Provisioning Manager 4.12 as PMEAdmin and log back in using the user with Administrator privileges created in Step Optional Create Filter Templates to limit device and data for Provisioners. See Section 7.11 Configuring Filter Templates in Akkadian Provisioning Manager Optional Create DN Pools to streamline Directory Number assignment during provisioning. See Section 7.12 DN Pool Management in Akkadian Provisioning Manager Optional Create Global Variables to simplify the provisioning process. See Section 7.13 Configuring Global Variables in Akkadian Provisioning Manager Global Variables are optional, though they are necessary to streamline the provisioning process. 20. Configure Provisioning Manager 4.12 Templates. See Section Getting Started with Templates in Akkadian Provisioning Manager Templates are the core of Akkadian Provisioning Manager 4.12 System Administration Guide 6

7 Provisioning Manager 4.12 and the number and types of Templates will differ depending on the environment. Section 7.0 will help you understand how to best utilize Templates in Provisioning Manager Express. 21. Create provision Actions. See Section 9.0 Getting Started with Jobs in Akkadian Provisioning Manager Actions Templates combine one or more Provisioning Templates to create a single template. 22. Start Provisioning. Use Action Templates to start provisioning in your environment. See Section 10.0 Getting Started with Provisioning in Akkadian Provisioning Manger Optional - Updating the PMEAdmin password. For security purposes, it is best practice to change the PMEAdmin password. See Section 15.0 Updating the PMEAdmin Password in Akkadian Provisioning Manager. 24. Backup the system. It is recommended to backup the system when your configuration is complete as described in Section 12.0 Backup and Restore in Akkadian Provisioning Manager Akkadian Provisioning Manager 4.12 System Administration Guide 7

8 Section 1.0 System Requirements for Akkadian Provisioning Manager Provisioning Manager 4.12 Server Requirements Akkadian Provisioning Manager 4.12 is available for as a Linux Virtual Appliance. It was developed to run in a virtual environment on VMware ESXi 4.x and above. The recommended server requirements for Akkadian Provisioning Manager 4.12 are based on several variables. To assist with allocating the proper resources for Provisioning Manager 4.12, use the Table to determine the appropriate system resources. Table System Requirements Guideline System Requirements Guideline Devices (Phones or Device Profiles) Application Servers* vcpu* vram vdisk (Thick) vnic SRG GB 1x 110 GB 1 SRG , GB 1x 110 GB 1 SRG , GB 1x 110 GB 1 SRG , GB 1x 110 GB 1 * Applications servers are defined as configured applications servers in Provisioning Manager and is not related to the number of servers with a cluster. * Minimum of 2000 MHz reserved 1.2 Cisco Unified Communications Application Requirements Table Application Supported Versions Cisco Unified Communications Manager 9.x 11.x Cisco Unified Contact Center Express 10.x 11.x Cisco Unity Connection 9.x - 11.x Akkadian Provisioning Manager 4.12 System Administration Guide 8

9 1.3 SMTP Requirements Akkadian Provisioning Manager 4.12 requires an SMTP server to send users their initial password as well as important notifications. Ensure Provisioning Manager Express is authorized to send mail via the configured SMTP server. 1.4 Web Browser Requirements Microsoft Internet Explorer 10+ Microsoft Edge 39+ Mozilla Firefox 53+ Chrome 50+ ** Previous browser versions may function, but are not officially supported. 1.5 Firewall Ports If Akkadian Provisioning Manager 4.12 is located behind a firewall, the ports in Table are required for proper communication. Table Traffic Port Direction Application Web Access Inbound --> Provisioning Manager Communication to Cisco Communications Manager via AXL/SOAP API Communication to Cisco Unity Connection via REST API Outbound Provisioning Manager --> CUCM Outbound Provisioning Manager --> CUC Communication to WebEx Outbound Provisioning Manager --> WebEx Communication to UCCE / TCP 1443 Outbound Provisioning Manager --> UCCE FTP between application and Outbound Provisioning Manager --> SFTP TCP Port 21 backup server Server Secure FTP between Outbound Provisioning Manager --> SFTP TCP Port 22 application and backup server Server SMTP mail to mail server TCP Port 25 LDAP authentication TCP/UDP Ports 389 or Secure 636 / 3268 & 3269 for AD Global Catalog Server SSO (SAML) TCP Port 443 Network Time Protocol (NTP) UDP Port 123 Outbound Provisioning Manager --> SMTP Server Outbound Provisioning Manager --> LDAP Server Outbound Provisioning Manager --> SSO Server Outbound Provisioning Manager --> NTP Server Akkadian Provisioning Manager 4.12 System Administration Guide 9

10 Section 2.0 Preparing Cisco Unified Communications Manager for Provisioning Manager Express Akkadian Provisioning Manager 4.12 communicates with Cisco Unified Communications Manager using the AXL/SOAP API. Two items are required on Cisco Unified Communications Manager to allow access via the AXL API: 1. The Cisco AXL Web Service must be activated and started 2. An Application user with AXL API access If CUCM is already configured for AXL API access, proceed to Section Activate the AXL Web Service The Cisco AXL Web Service is disabled by default on some versions of Cisco Unified Communications Manager. The service must be activated to enable AXL API access. 1. Browse to the CUCM Serviceability page on 2. Tools > Service Activation 3. Select the Publisher node 4. Scroll down to Database and Admin Services 5. Check the box for Cisco AXL Web Service and click Save Figure CUCM AXL Service Activation 2.2 Create Provisioning Manager CUCM Application User To configure a new Application user: 1. From the Cisco Unified Communications Manager Administration Web page, select Application User from the User Management menu, and then click Add New. 2. In the User ID field, type PMEAXL. 3. In the Password and Confirm Password fields, type a password for the new user and then click Save. Akkadian Provisioning Manager 4.12 System Administration Guide 10

11 4. Navigate down the page to Permissions Information. 5. Click Add to Access Control Group (User Group in some versions of CUCM) and then click Find. 6. Select Standard TabSync User and then click Add Selected. 7. Select Standard EM Authentication Proxy Rights and then click Add Selected. 8. Select Standard CCM Server Monitoring and then click Add Selected. 9. On the Cisco Unified Communications Manager Administration Web page, confirm the Standard AXL API Access group is listed under Roles. Figure CUCM Application User Groups Assignment Akkadian Provisioning Manager 4.12 System Administration Guide 11

12 Section 3.0 Preparing Cisco Unified Contact Center Express for Provisioning Manager Express Akkadian Provisioning Manager 4.12 communicates with Unified Contact Center Express (UCCX) using the REST API. Two items are required on Cisco Unified Communications Manager to allow access via the AXL API: 1. The Cisco Unified CCX Configuration API service must be started 2. User with Cisco Unified CCX Administrator capability The default UCCX application administrator account created during the UCCX installation can be used for access, but for security purposes it is best practice to create a separate account. If the existing account will be used, proceed to next section. Otherwise, follow the steps in Section Assigning a user Cisco Unified CCX Administrator capability UCCX imports all user accounts from CUCM. Before you begin this process, ensure the end user is created in CUCM and synchronized to UCCX. 1. From the Cisco Unified CCX Administration web interface, select Tools User Management Administrator Capability View. 2. Locate the user from the Available Users list or using the Search tool. 3. Move the user from Available Users to Cisco Unified CCX Administrators 4. Click Update to save the changes Akkadian Provisioning Manager 4.12 System Administration Guide 12

13 Section 4.0 Preparing Cisco Unity Connection for Provisioning Manager Express Akkadian Provisioning Manager 4.12 communicates with Cisco Unified Connection using the REST API. The built-in Cisco Unity Connection application administrator account can be used for access, but for security purposes a separate account should be created. If the built-in application administrator account will be used for access, proceed to Section 5.0. Otherwise, follow the steps in Section 4.5 for instructions on creating an account. 4.1 Creating a Cisco Unity Connection System Administration Account To configure a new user: 5. From the Cisco Unity Connection Web page, select Users from the User section, and then click Add New. 6. In the User Type dropdown menu, select User Without Mailbox. 7. In the Based-on Template dropdown menu, select administratortemplate. 8. In the Alias field, type a username (Example - PME-REST) and click Save. 9. From the Edit Menu select Password Settings and uncheck User Must Change at Next Sign-In and click Save. 10. From the Edit Menu select Change Password. 11. In the Password and Confirm Password fields, type a password for the user and click Save. 12. From the Edit Menu select Roles. 13. Verify the user has the System Administrator under Assigned Roles. Akkadian Provisioning Manager 4.12 System Administration Guide 13

14 Section 5.0 Akkadian Provisioning Manager for Windows As of version 4.10, Akkadian Provisioning Manager can only be deployed as a virtual Linux appliance and is no longer supported on Windows Server. Provisioning Manager can easily be migrated from Windows to Linux by using the Backup and Restore process. Backup the Windows system and upgrade to a supported version of Provisioning Manager for Linux. Akkadian Provisioning Manager 4.12 System Administration Guide 14

15 Section 6.0 Deploying the Akkadian Provisioning Manager Virtual Appliance Akkadian Provisioning Manager 4.12 can be deployed as a virtual appliance on VMware ESXi versions 5.x and above. The steps below will help guide you through the process of deploying the virtual appliance; however, you should understand VMware or contact your VMware administrator for assistance. Step 1 - Download the latest akkadian Provisioning Manage Express 4.11 OVA to a location accessible by the vsphere client. Step 2 - From the vsphere client select Deploy OVF Template from the File menu. Figure Deploy OVF Template Step 3 - Select the OVA from computer or network location and click Next to continue. Figure OVA File Location Akkadian Provisioning Manager 4.12 System Administration Guide 15

16 Step 4 - Review the License Agreement and click Next to continue. Figure License Agreement Step 5 - Specify the name and location for the VMware machine and click Next to continue. Figure Specify name and location Akkadian Provisioning Manager 4.12 System Administration Guide 16

17 Step 6 - Specify the VMware Host / Cluster and click Next to continue. Figure Host/Cluster location Step 7 - Specify a host within the cluster and click Next to continue. Figure Specify host Akkadian Provisioning Manager 4.12 System Administration Guide 17

18 Step 8 - Specify the storage location for the virtual machine and click Next to continue. Figure Storage location Step 9 - Select Thick Provision Lazy Zeroed and click Next to continue. Figure Disk format Step 10 - Select the Destination Network for the virtual machine and click Next to continue. Akkadian Provisioning Manager 4.12 System Administration Guide 18

19 Figure Network Mapping Step 11 - Verify the virtual machine settings. The initial OVA deploys based on System Requirements Guideline #1 with 1 vcpu and 4GB Memory. Depending on your system requirements, you may need to adjust the virtual CPU and Memory settings. Please refer to Table System Requirements Guideline to determine the system requirement applicable to your environment. If the default settings are adequate, please proceed to step 15; otherwise, please follow steps to adjust the virtual CPU and Memory. Step 12 - Click OK to complete the deployment. To adjust the virtual machine CPU and Memory, locate the newly deployed virtual machine in vcenter, right click on the virtual machine and select Edit Settings. Step 13 - On the Hardware tab, select CPU and adjust the setting to provide the required number of cores for your environment. Step 14 - After adjusting the CPU, click on Memory and adjust the settings to provide the required resources for your environment. When completed, click OK to commit the changes. Akkadian Provisioning Manager 4.12 System Administration Guide 19

20 Step 15 - Power on the virtual machine and proceed to Step 18. Figure Review deployment Step 16 - Select Power on after deployment and click Finish to deploy the OVA. Step 17 - When the deployment is complete, click Close. In some cases, you may receive a message from VMWare The OVF package is valid but consider the following warnings. These typically can be ignored and are caused by deploying the Provisioning Manager OVA on VMWare ESXi versions prior to 5.5. Akkadian Provisioning Manager 4.12 System Administration Guide 20

21 Figure Deployment status Step 18 - Locate the virtual machine in vsphere and open a console. Step 19 - When the server boot process is complete, the system will arrive at a login prompt. Login using: Username akkadianuser Password akkadianpassword Figure Configure Network Step 20 - From the Akkadian Appliance Manager main menu, select option 1 to Configure Network. Akkadian Provisioning Manager 4.12 System Administration Guide 21

22 Step 21 - Select option 1 to configure the network setting. Akkadian Provisioning Manager 4.12 System Administration Guide 22

23 Step 22 - Follow the prompt to configure the network settings for your environment. Step 23 - Select option 7 from the network configuration menu to configure the hostname. It is recommended the hostname is entered using the fully qualified domain name. Example Provisioning Manager.yourdomain.com Akkadian Provisioning Manager 4.12 System Administration Guide 23

24 Step 24 - Optionally you may configure the server time by selecting option 2 form the configure network menu. Step 25 - It is recommended you change the default Akkadian Appliance Manager password by selecting option 4 (Web Server Configuration Menu) from the main menu and then selecting p (Change Current AAM Password ). Step 26 - When all configurations are complete, select s from the network configuration menu to save the configuration and restart the network. Step 27 - From the main menu, select Reboot Server to finalize the configuration. Step 28 - When the system returns to the login prompt, the Akkadian Provisioning Manager virtual appliance deployment is complete and can be accessed by going to IP or Name}/pme. Step 29 - Proceed to Section 7.0 Akkadian Provisioning Manager 4.12 Initial Configuration to begin the configuration process. Akkadian Provisioning Manager 4.12 System Administration Guide 24

25 Section 7.0 Akkadian Provisioning Manager Initial Configuration After completing the installation, Akkadian Provisioning Manager 4.12 requires some basic configuration before you can begin provisioning. This section will guide you through the configuration process Logging into Akkadian Provisioning Manager 1. Akkadian Provisioning Manager can be accessed using the following URL: IP or NAME}/pme 2. Log in using the default credentials: Username PMEAdmin Password PMEAdmin (Case sensitive) Figure Login Screen 3. After logging in, use the button to expand the navigation bar as shown in Figure By default, the navigation bar will auto-hide. Lock the navigation bar in the expanded view by toggling the button to the position. Figure Akkadian Provisioning Manager 4.12 System Administration Guide 25

26 7.1 Configuration 1. Expand System menu from the navigation bar as how in Figure Figure Navigation Bar System Menu 2. Select Configuration from the System menu 3. Click the Configuration Tab 4. Enter the information for your SMTP server. Ensure Provisioning Manager 4.12 is authorized to send mail via your SMTP server 5. When complete, click Save. Figure SMTP Configuration Akkadian Provisioning Manager 4.12 System Administration Guide 26

27 7.2 Single Sign-on Configuration Akkadian Provisioning Manager 4.12 support Single Sign-on using SAML The system only supports on SSO provider. 1. Expand System menu from the navigation bar as how in Figure Figure Navigation Bar System Menu 2. Select Configuration from the System menu 3. Click the Single Sign-on Tab 4. Enter the appropriate information for your SSO Identity Provider. 5. When complete, click Save. Akkadian Provisioning Manager 4.12 System Administration Guide 27

28 7.3 Akkadian Provisioning Manger 4.12 SSL Configuration The default SSL certificate included with Akkadian Provisioning Manager 4.12 will not be trusted by most Web Browsers. Optionally, you can upload a public certificate trusted by your organization. Uploading a certificate in Provisioning Manager 4.12, requires three steps: Step 1 Generate a Certificate Signing Request (CSR) Step 2 Use the CSR to generate a certificate with a Certificate Authority Step 3 Upload the certificate to Provisioning Manager 4.12and restart the server See Sections for more detail Generating an SSL Certificate Signing Request (CSR) A CSR is an encoded file that provides you with a standardized way to submit your public key along with some information that identifies your company and domain name. 1. Log in as PMEAdmin 2. Select Configuration from the System menu 3. Click the Generate CSR Tab 4. Enter the information for the certificate request as demonstrated in Table When complete, click Generate and choose a location to save the CSR file. Figure Generate CSR Field Common Name Country State City Organization Organizational Unit Description This is fully qualified domain name that you wish to secure e.g. ' or 'provisiong.example.com'. The two-letter ISO code for the country where your organization is located e.g. GB, FR, US etc.. This should not be abbreviated e.g. Sussex, Normandy, New Jersey e.g. London, Waterford, Paris, New York, Dhaka, Kochi Usually the legal incorporated name of a company and should include any suffixes such as Ltd., Inc., or Corp. e.g. HR, Finance, IT An address to contact the organization. Usually the address of the certificate administrator or IT department Figure Generate CSR Akkadian Provisioning Manager 4.12 System Administration Guide 28

29 7.3.2 Uploading SSL Certificates With the CSR generated, the next step is to generate a certificate using your designated Certificate Authority. Provisioning Manager 4.12 supports certificates from any valid public certificate authority such as DigiCert or Verisign as well as self-signed certificates authorities. Using the CSR generated from Provisioning Manager 4.12, follow the instructions provided by your certificate authority to generate a certificate. Download the certificate bundle most appropriate for Apache Web Server, which is typically a ZIP file containing the individual certificate files. The Certificate should have a.crt extension and will need to be renamed to server.crt before being uploaded to Provisioning Manager The next step is to upload the certificate into Provisioning Manager Please ensure the certificate is renamed to server.crt before proceeding. 1. Log in as PMEAdmin 2. Click the Upload Certificate Tab 3. Select Choose File and locate the server.crt file, and click Upload Certificate 4. Restart Provisioning Manager 4.12 for the change to take affect Akkadian Provisioning Manager 4.12 System Administration Guide 29

30 7.4 LDAP Agreement Configuration Akkadian Provisioning Manager 4.12 supports both local and LDAP configuration. Using LDAP authentication is optional. If you would like to use LDAP authentication, follow the steps below: 1. Log into Provisioning Manager as PMEAdmin 2. Select LDAP from the System menu 3. Click on Default to update the default LDAP agreement 4. Update the LDAP settings for your environment and click Save Table LDAP Configuration Field Description LDAP Config Name Enter a name to identify this specific LDAP configuration Base Enter the LDAP search base Server The LDAP server IP address or DNS name Port* Enter the LDAP server port number Username Enter the LDAP Username used to authenticate to the LDAP server Password Enter the LDAP Password used to authenticate to the LDAP server Username Bind Attribute Enter LDAP Attribute to bind to Username during authentication * Typical port number is 389 for LDAP. 5. To add another LDAP agreement, click Add or continue to the next section Figure LDAP Authentication Akkadian Provisioning Manager 4.12 System Administration Guide 30

31 7.5 Installing a Provisioning Manager Express License Akkadian Provisioning Manager 4.12 integrates tightly with CUCM licensing. In CUCM version 9.x and above, it supports both User and Device Based licensing as described in Table License Type User Based License (UBL) Device Based License (DBL) Description Applies to a CUCM end user with 2 or more associated devices Applies to a single phone or CUCM end user with one associated device This means end users with two or more associated devices can take advantage of reduced licensing costs but using UBLs. When integrating with a CUCM 8.x, only DBLs are supported due to limitation in CUCM. Provisioning Manager 4.12 comes with a fully functional 30-day trial license containing 25,000 UBLs and DBLs, but requires the system has access to the Internet to request the trial license. If your system cannot reach the Internet, you may contact Akkadian Labs to request a license file. If you have purchased a license, the information to obtain your license file will be sent in an . To request a license file for offline activation: 1. Select Licensing from the System menu 2. Copy the Server MAC Address 3. Contact your reseller or sales@akkadianlabs.com and include the Server MAC Address and copy of the Purchase Order 4. The license will be sent via within 24 hours To install the license file: 1. Select Licensing from the System menu 2. Select Choose File from the Upload License File section 3. Click Upload to upload the license file 4. Refresh the browser to view the updated license information Akkadian Provisioning Manager 4.12 System Administration Guide 31

32 7.6 Integrating Application Servers with Provisioning Manager Express Application servers provide the necessary integration between Provisioning Manager and the applications to perform provisioning actions. Akkadian Provisioning Manager 4.12 supports the following Cisco applications: Cisco Unified Communications Manager (CUCM) Cisco Unified Contact Center Express (UCCX) Cisco Unity Connection (CUC) Cisco WebEx Akkadian Provisioning Manager 4.12 supports multiple CUCM, CUC, UCCX and WebEx systems Integrating CUCM Application Servers To add a Cisco Unified Communications Manager Application Server: 1. Select Application Servers from the System menu 2. Select the Communications Manager tab to add a Cisco Communications Manager server 3. On the menu, click Figure Application Server Configuration 4. Enter the server configuration for your Cisco Unified Communications Manager as shown in Table Akkadian Provisioning Manager 4.12 System Administration Guide 32

33 Table CUCM Application Server Configuration Field Name Communications Manager Name Publisher Versions AXL Username AXL Password Confirm Password Phone Control Username Phone Control Password Confirm Phone Control Password Description Name or description for CUCM cluster CUCM AXL server DNS name or IP address. This is typically the CUCM Publisher server Populated when AXL credentials are verified (Read-Only) CUCM application username with AXL rights Password for CUCM application account Confirm Password for CUCM application account Confirm Password for Phone Control application account. This can be the same account as the CUCM application user account. Confirm Password for Phone Control application account Confirm Password for Phone Control application account password 5. Click Verify. When complete, the Version field will populate with your CUCM version. 6. Click Save. 7. Click Back to return to the CUCM application server list. 8. Repeat the process to add any additional CUCM servers. 9. When finished select all the CUCM servers and click. This process may take several minutes. Figure CUCM Application Server Configuration Example Akkadian Provisioning Manager 4.12 System Administration Guide 33

34 7.6.2 Integrating CUC Application Servers To add a Cisco Unity Connection Application Server: 1. Select Application Servers from the System menu 2. Select the Unity Connection tab to add a Cisco Unity Connection server 3. On the menu, click Add Figure CUC Application Servers 4. Enter the server configuration for your CUC. Table CUC Application Server Configuration Field Name Description UC Server Name Name or description for CUC cluster Server TCP/IP CUC Publisher DNS name or IP address. Versions Populated when System Administrator credentials are verified (Read-Only) Username CUC user alias with the System Administrator role Password Password for CUC alias Confirm Password Confirm Password for the CUC Alias 5. Click Verify. When complete, the Version field will populate with your CUC version. Akkadian Provisioning Manager 4.12 System Administration Guide 34

35 Figure CUC Application Server Configuration Integrating Cisco UCCX Application Servers To add a Cisco Unified Contact Center Express (UCCX) Application Server: 1. Select Application Servers from the System menu. 2. Select the UCCE Tab. 3. Configure the required fields as described in the table below. Table UCCX Application Server Configuration Field Name UCCX Server Name UCCX Server UCCX Username UCCX Password Confirm Password Description Name or description for CUCM cluster Name or IP Address of the UCCX server UCCX user with administrator privileges UCCX user s password Confirm UCCX user s password 1. Click Verify. 2. Click Save. 3. Click Back to return to the UCCX server list. 4. Repeat the process to add any additional UCCX servers. 5. When finished select all the UCCX servers and click. This process may take several minutes. Akkadian Provisioning Manager 4.12 System Administration Guide 35

36 7.6.4 Integrating Cisco Packaged UCCE Servers Requirements 1. Version of Cisco Packaged Contact Center Enterprise (PCCE). 2. PCCE account with the Administrator role. 3. SQL user account with read access to the AWDB database. This account is only used for database reads. Adding UCCE Application Server: 4. Select Application Servers from the System menu. 5. Select the UCCE Tab. 6. Configure the required fields as described in the table below. Field Application Server Name UCCE Server Username Password Confirm Password SQL Server Database Name SQL Server User SQL Server Password Description Enter a name to identify the PCCE server Enter the IP address of the PCCE server Enter the username of the PCCE administrator account. This account must be in the format of username@fqdn.com Enter the password of the PCCE administrator account Confirm the password of the PCCE administrator account The AWDB database name Enter the SQL Server database username Enter the SQL Server database password 1. Click Verify. 2. Click Save. 3. Click Back to return to the UCCE server list. 4. Repeat the process to add any additional UCCX servers. Akkadian Provisioning Manager 4.12 System Administration Guide 36

37 7.6.5 Integrating Cisco WebEx Application Servers To add a Cisco WebEx Application Server: 1. Select Application Servers from the System menu 2. Select the WebEx tab to add a Cisco WebEx site 3. On the menu, click Add Table WebEx Application Server Configuration Field Name WebEx Site Name WebEx Site URL Site ID Partner ID Username Password Confirm Password Description Name or description for WebEx site URL of the WebEx site. Example company.webex.com WebEx Site ID. This can be found in the Site Information section of your WebEx Administration site. WebEx Partner ID. This can be found in the Site Information section of your WebEx Administration site. Username of WebEx user with Admin privileges Password for WebEx admin Confirm Password WebEx admin Figure WebEx Application Server Configuration Akkadian Provisioning Manager 4.12 System Administration Guide 37

38 7.7 Configuring Service Groups Service Groups logically group Application Servers to create provisioning targets. Multiple Service Groups can contain the same applications servers, providing greater flexibility. For example, if an organization had the following Application Servers: Table Application Servers Example Application Servers Description CUCM-US-Cluster CUCM cluster for the US CUC-US-East-Cluster CUC Voic Cluster for the US East Region CUC-US-West-Cluster CUC Voic Cluster for the US West Region In this case, the organization has one CUCM cluster, but two Unity Connection clusters. Service Groups can be used to direct provision to the correct application servers. In this example, two Service Groups would be required: Table Service Group Example Service Group Name CUCM Application Server CUC Application Server US-EAST CUCM-US-Cluster CUC-US-East-Cluster US-WEST CUCM-US-Cluster CUC-US-West-Cluster To add a Service Group: 1. Select Service Groups from the System menu 2. On the menu, click to create a new Service Group 3. Configure the Service Group: Table Service Group Fields Field Name Group Name Group Description Communications Manager* Unity Connection Unified Contact Center Express Packaged Contact Center Enterprise WebEx DN Aging Period Enable Search Across Clusters Description Enter the service group name Enter a description for the service group Select a CUCM application server Select a CUC server Select a UCCX server Select a UCCE server Select WebEx Site Set the DN aging period. This is the number of days deleted DNs will be held before the can be provisioned using DN Pools. Enables service group for DN Pool search across cluster function Akkadian Provisioning Manager 4.12 System Administration Guide 38

39 Searchable Communication Managers Self-Provision URL Enable Site Templates Require Site Templates CUCM End User Database - LDAP Status Monitoring Enable LDAP Status Monitoring Frequency (Hour) Send Notification Deprovision User Client Matter Code Rule Enable Client Matter Code Rules Rule Delete with linked enduser Forced Authorization Code Rule Enable Forced Authorization Codes Rules Searchable CUCM clusters for cross-cluster DN search (4 Maximum) Displays URL used for Provisioning Manager self-provision service Enables Site Template selection at provision Requires Site Templates selection at provision. Where applicable, this will prevent provisioning without a Site Template selected. Check the box to enable CUCM LDAP Status monitoring. This feature monitors the CUCM end user database and will trigger actions if the end user is LDAP synched and their status changes to inactive. This is the frequency with which Provisioning Manager will poll the CUCM end user database for changes. Check this box to send an notification when a user status changes from active to inactive. Check this box to activate automatic deprovisioning when a user becomes inactive. Any combination of the following items can be automatically deprovisioned: Lines Hard Phones (Devices) Soft Phones (Devices) Mobility (RDP & RD) Device Profiles Webex accounts Voice Mail (Unity) Deprovisioned item details will be included in the notification Check this box to enable Client Matter Code Rules. CMC Rules provide a method of linking CMCs to an end user. This provides the option of having the CMC automatically deleted when the end user is deleted using Provisioning Manager. This will only take affect if the Client Matter Codes Creation is enabled on the End User Template. The rule is used to link the CMC to the end user in CUCM. For example, let s say your users are created using the following Global Variable {{LDAP User}}. If the Rule is configured to CMC_{{LDAP User}}, then for every End User Template with CMCs enabled, the CMC description would be crated as CMC_Username. Select this option to delete the CMC when the end user is deleted. Remember, the rule must contain the same GV used to create the end user id. Check this box to enable Forced Authorization Code Rules. FAC Rules provide a method of linking FACs to an end user. This provides the option of having the FAC automatically deleted when the end user is deleted using Provisioning Manager. This will only take affect Akkadian Provisioning Manager 4.12 System Administration Guide 39

40 Rule Delete with linked enduser if the Forced Authorization Codes Creation is enabled on the End User Template. The rule is used to link the FAC to the end user in CUCM. For example, let s say your users are created using the following Global Variable {{LDAP User}}. If you set the Rule to FAC_{{LDAP User}}, then for every End User Template with FACs enabled, the FAC description would be crated as CMC_Username. Select this option to delete the FAC when the end user is deleted. Remember, the rule must contain the same GV used to create the end user id. DN Pool Reporting Configuration Specify what time the DN Pool usage information should be updated Set Time from CUCM. Select which days the DN Pool usage information from be updated Set Days from CUCM. Specify an address to which the system will send usage Send Notification warning. Usage Levels Set the respective thresholds for DN pool warning levels. DN Synchronization to Active Directory Enable DN synchronization to Active Directory Check this box to enable the feature Select the LDAP agreement to use for the sync. The user in the LDAP LDAP server agreement must have write privileges. Specify the LDAP attribute used to bind or locate the user. This must match the username being provisioned by Provisioning Manager to Username Bind Attribute function. This is the attribute(s) in LDAP that will be updated with the directory number. This is typically telephonenumber and or ipphone in Active Directory. Additional fields can be added as required. LDAP Update Attribute(s) CUC Voice Mailbox Scheduled Delete Service Enable CUC Voice Mailbox Scheduled Delete Enables the CUC Voice Mailbox scheduled delete service. The number of days a voic box should be preserved before it Number of days (to delete) is deleted. Send Notification * CUCM server is required Send an notification when mailboxes are deleted. Akkadian Provisioning Manager 4.12 System Administration Guide 40

41 4. When finished, on the menu click 5. To add another Service Group, click or proceed to the next section Enable the Self-Service Portal Akkadian Provisioning Manager includes an optional user self-service portal. User can access the portal using their CUCM end user credentials to manage their Unified Communication devices and settings. By default, the self-service portal is disabled and must be enabled. The Provisioning Manager End User Self-Service portal, allows end users to manage: Lines, Intercoms Speed Dial & BLF Speed Dials Call Forwarding CUCM PIN & Password Unity PIN & Password The end User Self-Service portal is support with CUCM version 10.5 or above. The End User Self-Service portal authenticates users against Cisco Unified Communications Manager and supports both local and LDAP users. By leveraging CUCM for authentication, it is not necessary to create or import end users into Provisioning Manager, reducing administrative overhead. Enabling End User Self-Service Before end users can access the Provisioning Manager Self-Service portal, the feature must be enabled. The portal can be enabled for individual Service Groups, allowing administrators to control access by CUCM cluster. In addition to enabling the portal, Provisioning Manager provides the ability to customize the self-service features available to end users. Akkadian Provisioning Manager 4.12 System Administration Guide 41

42 To Enable the Self-Service Portal: 1. Select Service Groups from the System menu 2. Select the appropriate Service Group 3. Navigate to the Self-Service Configuration section 4. Check the Enable Self Service Portal checkbox 5. Enable/Disable the appropriate security options 6. When finished, click Save. 7. Note the Self-Service URL which will be used by end users to access the portal for this Service Group. 8. Repeat these steps for additional Service Groups Branding the Self-Service Portal Akkadian Provisioning Manager Self-Service Portal support custom branding. The portal can be branded with: 1) Custom Name 2) Custom Colors 3) Custom Logo To enable the Self-Service Portal Branding: Select Service Groups from the System menu and select the appropriate Service Group 1. Scroll down to the Self-Service Configuration section 2. Click the Enable Branding checkbox 3. Update the desired branding settings. 4. When finished, click Save. Akkadian Provisioning Manager 4.12 System Administration Guide 42

43 7.8 Adding Security Groups and Permissions Groups are used to provide a common class of users with permissions and access to items within Akkadian Provisioning Manager The system is configured with four default groups: Administrator Editor Provision Template Manager These groups cannot be changed or deleted, but additional groups may be added to provide additional security. To add a Group: 1. Select Security from the System menu 2. Select the Groups Permissions tab 3. On the menu, click to create a new Group 4. Enter the Name and configure the appropriate permissions 5. When finished, click Figure Security Group Configuration 6. To add another Group, click or proceed to the next section Akkadian Provisioning Manager 4.12 System Administration Guide 43

44 7.9 Assigning Access to Service Groups As covered in Section 7.7, Service Groups provide the ability to assemble Applications Servers into a logical container for provisioning. Service Groups provide the foundation for working with provisioning templates and actions in Provisioning Manager 4.12 as well as provide the first level of security. To begin using Service Groups, security permissions must be granted. To assigned access to a Service Groups: 1. Select Security from the System menu 2. Select the Service Group tab Method 1 Associating Multiple Groups to Service Groups 1. Select the Service Group 2. Click the Edit button 3. Select the Groups 4. Associate the Groups 5. When finished, click Figure Service Group Access Method 2 Associating Multiple Service Groups to Service Groups 1. Select the Group 2. Click the Edit button 3. Select one or more Service Groups 4. Associate the Service Groups 5. When finished, click Akkadian Provisioning Manager 4.12 System Administration Guide 44

45 Table Service Group Access If permissions to more than one service group are granted to a user, the default view will provide access to all Service Groups. If working with a single Service Group, the user can select the default Service Group from the menu showing in Figure Table Service Group View Akkadian Provisioning Manager 4.12 System Administration Guide 45

46 7.10 Configuring Users The PMEAdmin account is a built-in system administrator account and has no ability to provision. At least one user account must be created with System rights to complete the initial Provisioning Manager 4.12 configuration. To add a User: 1. Select Users from the System menu 2. On the menu, click to create a new User 3. Populate the required fields 4. For local authentication, the address is required 5. For LDAP authentication, set the User Type to LDAP and select the LDAP agreement 6. Add the Group Association to assign permissions. If no Groups are associated, the user will have no rights. 7. When finished, click 8. To add another User, click or proceed to the next section Table User Settings Akkadian Provisioning Manager 4.12 System Administration Guide 46

47 7.11 Configuring Filter Templates Filter Templates are an optional security component used to restrict user s access to objects and field data within a Service Group. Scenario: Help desk personnel at Company X are divided into groups: support for the New York and Atlanta offices. The challenge is help desk personnel should only see devices and field data specific to their location, but they share CUCM and CUC clusters. Filter templates overcome this challenge by providing a mechanism to filter views of devices and field data at a Service Group level. To add a Filter Template: 1. Select Filter Templates from the System menu 2. On the menu, click to create a new Filter Template 3. Enter the Filter Template Name and select a Service Group 4. Configure filter options as described in Figure Table Filter Template Fields Field Name Description Name Filter Template Name Service Group Name Select the Service Group The items below will determine the filtered view and only selected items will be available when the filter is applied. Calling Search Space Select the CUCM Calling Search Space(s) to filter Route Partitions Device Profile Filter Department Select a CUCM Route Partition(s) to filter Applies to the Device Profile Description Field. Enter full or partial match. Applies to the End User Department Field. Enter full or partial match. Unity Connection Filters Filter Field Choose to filter by department or extension Filter Starts With Enter data to match Search Permission Check the box next to the search options you would like to be accessible in the global search window. Akkadian Provisioning Manager 4.12 System Administration Guide 47

48 Figure Filter Template Example 5. When finished, click 6. To add another Filter Template, click or proceed to the next section Akkadian Provisioning Manager 4.12 System Administration Guide 48

49 7.12 Configuring DN Pools DN Pools help simplify the provisioning process by managing directory number assignment. DN pools are predefined number ranges between which Provisioning Manager Express can search for available DNs. To add a DN Pool: 1. Select DN Pool from the System menu 2. On the menu, click to create a new DN Pool 3. Select a Service Group 4. Configure DN Pool options as described in Figure Table DN Pool Fields Field Name Service Group Name DN Profile Name DN Profile Description Route Partition Search Across Clusters (Checkbox) Search All Partition (Checkbox) Include Unassigned DNs (Checkbox) Enable DN Aging External Phone Number Mask AAR Destination Mask DN Prefix Description Select the Service Group DN Pool Name DN Pool Description Directory Number Pool Ranges Limited to 6 digits From To Select the Route Partition for the DN Range Enables DN management to search across multiple CUCM clusters when DNs are disturbed across multiple clusters. Check this box to search all CUCM partitions when performing a DN lookup. Check this box to include unassigned CUCM DNs in the DN lookup. Check this box to enable DN aging on the DN Pool. Deleted DNs will be excluded from reassignment according the DN aging period configured on the Service Group. Enter a phone number mask to be applied when allocating a DN from this pool Enter a AAR destination mask to be applied when allocating a DN from this pool Enter as many common digits as possible for the DN Range. Example DN range = to , the prefix should be Note - DN Prefix is included in search and provision Enter start and end of the DN Range. The range must be contiguous. Using the example above, the range would be from 00 to 99. Akkadian Provisioning Manager 4.12 System Administration Guide 49

50 Figure DN Pool Example 5. When finished, click 6. To add another DN Pool, click or proceed to the next section Akkadian Provisioning Manager 4.12 System Administration Guide 50

51 7.13 Configuring License Pools License Pools simplify the provisioning process by helping manage the licensing process. In Cisco CUCM, it may be necessary to assign an Owner User ID to devices in order to effectively leverage Cisco User Workspace Licensing. When devices are not directly associated to user, this process can be challenging. License Pools help alleviate this challenge by automatically creating local end users and associated devices strictly for licensing purposes. To add a License Pool: 1. Select License Pool from the System menu 2. On the menu, click to create a new License Pool 3. Select a Service Group 4. Configure License Pool options as described in Figure Table DN Pool Fields Field Name Service Group Name License Pool Name License User Prefix Max Number of Devices per User End User Template Description Select the Service Group License Pool Name Username prefix for license user. Username format will be Prefix_Licensing_XXXX Maximum number of devices to which the license user will be assigned as the Owner User ID before the next license user will be created. Max = 2000 End User Template used to provision the license end user. Template should not contain any global variables and fields requiring unique values, such as Mail ID & Directory URI should not be configured. Figure DN Pool Example 5. When finished, click 6. To add another License Pool Template, click or proceed to the next section Akkadian Provisioning Manager 4.12 System Administration Guide 51

52 7. Once License Pools are created, they can be assigned in the License Pool Association section of Device Templates. Akkadian Provisioning Manager 4.12 System Administration Guide 52

53 7.14 Configuring Global Variables Global Variables are used to capture data required to provision. Global Variables can be repeated within templates, but only requires single input at provision. For example, first and last name may be required multiples times when provisioning an end user with multiple devices, lines and voic . Global Variables can reduce this input to a single entry. To add a Global Variable: 1. Select Global Variables from the System menu 2. On the menu, click to create a new Global Variable 3. Configure the options as described in Figure Table Global Variable Fields Field Name Global Variable Type Description Choose from: Default captures provisioning data using a validated input field List captures provisioning data using a drop-down list System Used to capture the provisioned Directory Number and apply it as a Global Variable. Variable Name Tooltip Description Optional (Checkbox) Input Validation Appearance Index Use Custom Regular Expression Enable Lookup (Checkbox) CUCM Validation CUCM Field Association Enable Product Type Prefix Mapping (Checkbox) Enter the variable name Enter a tooltip to help users understand the variable Enter a description By default, Global Variables are required fields. Check Optional to make these optional fields. Enter a validation method. Example, if you only want users to enter a numeric value, choose numeric. Set the appearance index value. This will determine in which order the Global Variable will be displayed on the provisioning screen As an alternative to choosing a validation method, a custom regular expression can be used Converts the field from input to lookup during provision. This is required when CUCM is LDAP integrated and Global Variable is created for enduser ID. Specifies the target validation field in CUCM Choose the filed from which Provisioning Manager will automatically pull data. This only applies to LDAP integrated endusers. For edit jobs, this allows Provisioning Manager to automatically apply the appropriate product prefix. For example, if you were running a name change job, Provisioning Manager can automatically apply the proper Device Name prefix. Figure Global Variable Example Akkadian Provisioning Manager 4.12 System Administration Guide 53

54 4. When finished, click 5. To add another Global Variable, click or proceed to the next section Akkadian Provisioning Manager 4.12 System Administration Guide 54

55 7.15 Configuring Device Pools Groups Device Pools provide the ability to create a group of CUCM Device Pools across which Provisioning Manager will load balance devices. When the Device Pool features is used in a provision, Provisioning Manager will look at the number of devices in each CUCM Device Pool assigned to the group and provision the device in the Device Pool with the fewest number of devices and will always attempts the keep the number of devices distributed as evenly as possible across the CUCM Device Pools. Device Pools will override any Device Pool settings on Device Templates and Site Templates. To add a Device Pool: 1. Select Device Pools from the System menu 2. On the menu, click to create a new Device Pool group 3. Select a Service Group 4. Configure filter options as described in Figure Table Device Pools Field Name Service Group Template Name Device Pools(s) Description Select the Service Group Enter a name for the template Add 2 or more Device Pools to the group 5. When finished, click 6. To add another Device Pool, click 7. To use the Device Pool, it must be added to the Device Pool(s) section located at the bottom of the Device Template or Site Template. Akkadian Provisioning Manager 4.12 System Administration Guide 55

56 7.16 Log Archive Configuration akkadian Provisioning Manager by default will keep log data for 6 months before it is archived locally, which potentially can consume a large amount of disk space. It may be necessary to adjust the archiving setting and store the archived log files off box. The archiving settings can be adjusted in the Provisioning Manager Log Configuration section. Configuring a remote storage location requires an FTP location to be configured as described in the Configuring FTP in Akkadian Provisioning Manager 4.12 section. To modify the log archiving configuration: 1. Log into Provisioning Manager as PMEAdmin 2. Select Log Configuration from the System menu 3. Update the settings as described in Table When finished, click Table Log Configuration Field Enable Archiving Mode Frequency Storage Location FTP Account Description Check box used to enable and disable log archiving Select the archiving method of Time or Size based Set the desired archiving frequency Set the storage location to be Local or Remote If the storage location is set to Remote, choose the FTP account Akkadian Provisioning Manager 4.12 System Administration Guide 56

57 7.17 Configuring Templates Templates can be used to send automated notifications to end users upon the completion of a provision. Variables are used to gather data from the provision and populate the with information from the provisioning job. Please note, templates can only be used in conjunction with Site Templates. To add an Template: 1. Select Templates from the System menu 2. On the menu, click to create a new Template 3. Select a Service Group 4. Configure options as described in the table below. Field Template Name From To BCC Subject Content Description Name of the Template Source address from which the will be sent Target address. Supports Global Variables. BCC address. Supports Global Variables. subject. Supports Global Variables. body. Right-click to insert template variables. 5. When finished. Click Save. 6. Repeat the process for additional Templates. 7. Assign the Template to the appropriate Site Template(s) Akkadian Provisioning Manager 4.12 System Administration Guide 57

58 Section Getting Started with Templates in Akkadian Provisioning Manager 4.12 After completing the initial configuration in Section 6.0, it is time to start creating Provisioning Templates. This section will guide you through the process of creating templates in Akkadian Provisioning Manager This section covers settings specific to Akkadian Provisioning Manager 4.12, not fields or functions related to Cisco Unified Communications Applications. As a prerequisite to creating templates, you should have an understanding of provisioning in Cisco Unified Communication applications or review the Cisco Unified Communications Manager Administration Guide and System Administration Guide for Cisco Unity Connection relevant to your application version. Templates provide the ability to add, edit and delete in Cisco Unified Communications Manager and Unity Connection. Once the templates are created, they can be combined into a job or Action template, turning the most complex provisioning process into a single step. Table Template Types Add Templates Speed Dial Voice Mail Profile User Line Phone Device Profile CTI Route Point Remote Destination Profile Remote Destination CUC Voice Mail Edit/Delete Templates User Line Phone Device Profile CTI Route Point Remote Destination Profile Remote Destination CUC Voice Mail Akkadian Provisioning Manager 4.12 System Administration Guide 58

59 Section 8.1 Using Provisioning Variables Section 7.14 discussed how Global Variables can simplify the provisioning process in Akkadian Provisioning Manager This section will further discuss the use of Variables in Templates. There are two types of Variables in Provisioning Manager 4.12: Global Variables User Defined Variables Both Variable types can be used within any template input field, but Global Variables are used to consolidate data entry across multiple templates. User Defined Variables are used to consolidate data entry for a single template and provisioning item. To use Global Variables in Templates: 1. Select any template input field 2. Type {{ to invoke the Global Variable drop-down list as demonstrated in figure Figure Invoke Global Variables 3. Select the Global Variable from the list as demonstrated in figure Figure Global Variable Example 4. Repeat Steps 2-3 to add additional Global Variables. Spaces or text can be entered before, between or after Global Variables. In this example, we want the Description field to be populated with a First and Last Name, so a space will be added as demonstrated in figure Figure Example of combining Global Variables 5. This process can be repeated for additional fields within the same or other Templates as demonstrated in figure Figure Example of Global Variables in multiple fields Akkadian Provisioning Manager 4.12 System Administration Guide 59

60 6. Each Global Variable will appear once during Provisioning as shown in Figure Figure Example of Global Variables during provisioning To use User Defined Variables in Templates: 1. Select any template input field 2. Input the User Defined Variable using the following format {variable name} as demonstrated in Figure Figure Invoke Global Variables 3. Repeat Step 2 to add additional User Defined Variables. Spaces or text can be entered before, between or after User Defined Variables. In this example, we want the Description field to be populated with First and Last Name, so a space will be added as demonstrated in Figure Figure Example of combining User Defined Variables 4. This process can be repeated for additional fields within the same or other Templates as demonstrated in Figure Figure Example of User Defined Variables in multiple fields 5. Each User Defined Variable will appear once per Template during Provisioning as shown in Figure Akkadian Provisioning Manager 4.12 System Administration Guide 60

61 Figure Example of User Defined Variables during provisioning Akkadian Provisioning Manager 4.12 System Administration Guide 61

62 Section 8.2 Creating Add Templates Add templates are used to add new components in Cisco Unified Communications applications. This section will guide you through the process of creating Add Templates for all the template types shown in Figure Table Add Template Types Add Templates Speed Dial Voice Mail Profile User Line Phone Device Profile CTI Route Point Remote Destination Profile Remote Destination CUC Voice Mail Section Creating Add Speed Dial Templates Add Speed Dial Templates are used to provision speed dials in Cisco Unified Communications Manager. These templates will later be referenced by Device Templates and should be created first. To add a Speed Dial Template: 1. Select Speed Dial from the Templates menu 2. On the menu, click to create a new Speed Dial Template 3. If required, select a Service Group 4. Configure the Template Name. This field is only applicable to Provisioning Manager Express and will be used to reference this template throughout the system. 5. Configure the remaining fields according your Cisco Unified Communications Manager requirements. Note Global or User Defined Variables may be used in any input field. 6. When finished, click 7. To add another template, click or proceed to the next section Akkadian Provisioning Manager 4.12 System Administration Guide 62

63 Figure Speed Dial Template Example Section Creating Add Voice Mail Profile Templates Add Voice Mail Profile Templates are used to provision Voice Mail Profiles in Cisco Unified Communications Manager. These templates are not used in most provisioning scenarios as the required Voice Mail Profiles typically are provisioned in Cisco Unified Communications Manager as part of the deployment. To add a Voice Mail Profile Template: Method 1 Manual Configuration 1. Select Voice Mail Profile from the Templates menu 2. On the menu, click to create a new Voice Mail Profile 3. If required, select a Service Group 4. Configure the Template Name. This field is only applicable to Provisioning Manager Express and will be used to reference this template throughout the system. 5. Configure the remaining fields according the Cisco Unified Communications Manager requirements. Note Global or User Defined Variables may be used in any input field. 6. When finished, click 7. To add another template, click or proceed to the next section Akkadian Provisioning Manager 4.12 System Administration Guide 63

64 Figure Voice Mail Profile Template Manual Configuration Example Method 2 Configuration Import 1. Select Voice Mail Profile from the Templates menu 2. On the menu, click to create a new Voice Mail Profile 3. If required, select a Service Group 4. Select the Import Data option 5. Select the Voice Mail Profile to import from the Voice Mail Import drop-down menu and the remaining fields will be updated from Cisco Communications Manager 6. Update the Template Name. This field is only applicable to Provisioning Manager Express and will be used to reference this template throughout the system. 7. Modify the remaining fields according the Cisco Unified Communications Manager requirements. 8. When finished, click 9. To add another template, click or proceed to the next section Akkadian Provisioning Manager 4.12 System Administration Guide 64

65 Figure Voice Mail Profile Template Import Configuration Example Section Creating Add User Templates Add User Templates are used to provision End Users in Cisco Unified Communications Manager. Templates can be created to support both Local and LDAP integrated users in Cisco Unified Communications Manager. To add an End User Template: Method 1 Manual Configuration 1. Select User from the Templates menu 2. On the menu, click to create a new User Template 3. If required, select a Service Group 4. Configure the Template Name. This field is only applicable to Provisioning Manager Express and will be used to reference this template throughout the system 5. Select the User Type from the drop-down menu 6. Configure the remaining fields according to your Cisco Unified Communications Manager requirements. Global or User Defined Variables may be used in any input field 7. When finished, click 8. To add another template, click or proceed to the next section Method 2 Import Configuration Akkadian Provisioning Manager 4.12 System Administration Guide 65

66 1. Select User from the Templates menu 2. On the menu, click to create a new User Template 3. If required, select a Service Group 4. Select the Import Data option 5. Select the End User to import from the User Type drop-down menu and the remaining fields will be updated from Cisco Communications Manager. 6. Update the Template Name. This field is only applicable to Provisioning Manager Express and will be used to reference this template throughout the system. 7. Select the User Type from the drop-down menu 8. Update the remaining fields according to your Cisco Unified Communications Manager requirements. Note Global or User Defined Variables may be used in any input field. 9. When finished, click 10. To add another template, click or proceed to the next section Section Creating Add Line Templates Add Line Templates are used to provision Lines in Cisco Unified Communications Manager. To add a Line Template: Method 1 Manual Configuration 1. Select Line from the Templates menu 2. On the menu, click to create a new Line Template 3. If required, select a Service Group 4. Configure the Template Name. This field is only applicable to Provisioning Manager Express and will be used to reference this template throughout the system. 5. Configure the remaining fields according to your Cisco Unified Communications Manager requirements. Global or User Defined Variables may be used in any input field. 6. Optional Navigate to the bottom of the page and select DN Pool(s) as shown in Figure By default, a list of available DNs will be presented during provisioning. Select Auto Assign to have the next available DN automatically selected. Figure DN Pool Association Akkadian Provisioning Manager 4.12 System Administration Guide 66

67 7. When finished, click 8. To add another template, click or proceed to the next section Method 2 Import Configuration 1. Select Line from the Templates menu 2. On the menu, click to create a new Line Template 3. If required, select a Service Group 4. Select the Import Data option 5. Select the line number to import from the Line for Import drop-down menu and the remaining fields will be updated from Cisco Communications Manager. Enter data in the import field to narrow the search 6. Update the Template Name. This field is only applicable to Provisioning Manager Express and will be used to reference this template throughout the system. 7. Update the remaining fields according to your Cisco Unified Communications Manager requirements. Note Global or User Defined Variables may be used in any input field. 8. Optional Navigate to the bottom of the page and select DN Pool(s) as shown in Figure By default, a list of available DNs will be presented during provisioning. Select Auto Assign to have the next available DN automatically selected. Figure DN Pool Association 9. When finished, click 10. To add another template, click or proceed to the next section Akkadian Provisioning Manager 4.12 System Administration Guide 67

68 Section Creating Add Device Templates Add Device Templates are used to provision devices in Cisco Unified Communications Manager. Akkadian Provisioning Manager 4.12 supports five types of Device Templates: 1. Phones 2. Device Profiles 3. CTI Route Points 4. Remote Destination Profiles 5. Remote Destinations Follow the steps below for each required device type: To add a Device Template: Method 1 Manual Configuration 1. Select Device from the Templates menu 2. Select the appropriate Device type tab Figure Device Template Types 3. On the menu, click to create a new Template 4. If required, select a Service Group 5. Configure the Template Name. This field is only applicable to Provisioning Manager Express and will be used to reference this template throughout the system 6. Configure the remaining fields according to your Cisco Unified Communications Manager requirements Global or User Defined Variables may be used in any input field 7. When finished, click 8. To add another template, click or proceed to the next section Method 2 Import Configuration 1. Select Device from the Templates menu 2. Select the appropriate Device type tab Akkadian Provisioning Manager 4.12 System Administration Guide 68

69 Figure Device Template Types 3. On the menu, click to create a new Template 4. If required, select a Service Group 5. Select the Import Data option 6. Select the device to import from the Device for Import drop-down menu and the remaining fields will be updated from Cisco Communications Manager. Enter data in the import field to narrow the search 7. Update the Template Name. This field is only applicable to Provisioning Manager Express and will be used to reference this template throughout the system. 8. Update the remaining imported fields according to your requirements. Global or User Defined Variables may be used in any input field. 9. When finished, click 10. To add another template, click or proceed to the next section Section Creating Add CUC Voice Mail Templates Add CUC Voice Mail Templates are used to provision Users in Cisco Unity Connection. Templates support both Local and LDAP integrated users in Cisco Unity Connection. To add a CUC Voic Template: Method 1 Manual Configuration 1. Select CUC Voice Mail from the Templates menu 2. On the menu, click to create a new Template 3. If required, select a Service Group 4. Configure the Template Name. This field is only applicable to Provisioning Manager Express and will be used to reference this template throughout the system 5. Select the User Type from the drop-down menu 6. Configure the remaining fields according to your Cisco Unity Connection requirements Akkadian Provisioning Manager 4.12 System Administration Guide 69

70 Global or User Defined Variables may be used in any input field. 7. When finished, click 8. To add another template, click or proceed to the next section Method 2 Import Configuration 1. Select Unity Connection from the Templates menu 2. On the menu, click to create a new Template 3. If required, select a Service Group 4. Select the Import Data option 5. Select the account to import from the UC Users for Import drop-down menu and the remaining fields will be updated from Unity Connection. Enter data in the import field to search for the account. 6. Update the Template Name. This field is only applicable to Provisioning Manager Express and will be used to reference this template throughout the system. 7. Update the remaining imported fields according to your requirements. Global or User Defined Variables may be used in any input field. 8. When finished, click 9. To add another template, click or proceed to the next section Section Creating Add WebEx Templates Add WebEx User Templates are used to provision Users in your WebEx Meetings site. The WebEx site must be configured under applications servers and added to the appropriate Service Group before proceeding. To add a WebEx Voic Template: Method 1 Manual Configuration 1. Select WebEx User from the Templates menu 2. On the menu, click to create a new Template 3. If required, select a Service Group 4. Configure the Template Name. This field is only applicable to Provisioning Manager Express and will be used to reference this template throughout the system Akkadian Provisioning Manager 4.12 System Administration Guide 70

71 5. Configure the remaining fields according to your user WebEx provisioning requirements Global or User Defined Variables may be used in any input field. 6. When finished, click 7. To add another template, click or proceed to the next section Method 2 Import Configuration 10. Select WebEx User from the Templates menu 11. On the menu, click to create a new Template 12. If required, select a Service Group 13. Select the Import Data option 14. Select the account to import from the WebEx Users for Import drop-down menu and the remaining fields will be updated from WebEx. Enter data in the import field to search from the account. 15. Update the Template Name. This field is only applicable to Provisioning Manager Express and will be used to reference this template throughout the system. 16. Update the remaining imported fields according to your requirements. Global or User Defined Variables may be used in any input field. 17. When finished, click 18. To add another template, click or proceed to the next section Section Creating Site Templates Site Templates are optional templates and are referred to as overlap templates. They are used to apply common site based settings at provision time, allowing Jobs to be more generic. Site Templates have the following limitations: No support for DN Pool Auto-Assignment To add a Site Template: 1. Select Site Templates from the Templates menu Akkadian Provisioning Manager 4.12 System Administration Guide 71

72 2. On the menu, click to create a new Template 3. If required, select a Service Group 4. Configure the Template Name. This field is only applicable to Provisioning Manager Express and will be used to reference this template throughout the system 5. Configure the remaining fields according to your site requirements Table Provisioning Manager Specific Features Field Line(s) Line Settings specific settings may be applied by selecting the corresponding Line Tab. Description DN Pool Association DN Pools Use DN Pool AAR Destination Mask Use DN Pool External Phone Number Mask Device Pool Association Device Pool(s) DN synchronization to Active Directory Enable DN synchronization to Active Directory Enable Synchronization Rules Select the DN Pools to associate with the Site Template Select this option to use the AAR Mask from the DN Pool Select this option to use the External Phone Number Mask from the DN Pool Enter the Device Pool list to be associated with the Site Template Select this option to enable pushing the Directory Number to Active Directory Select this option to enable synchronization rules, which allow manipulation of the Directory Number before it is pushed to Active Directory. Akkadian Provisioning Manager 4.12 System Administration Guide 72

73 DN Begins With Discard Digits Prefix Matches the DN to apply the rule The number of digits to discard from left to right Digits to prefix. Applied after the digits are discarded. When Site Templates are applied to a provisioning job, they will overwrite the settings supplied in the Device Template. Akkadian Provisioning Manager 4.12 System Administration Guide 73

74 Section 8.3 Editing Templates in Akkadian Provisioning Manager 4.12 Edit templates are used to update or delete existing data in Cisco Unified Communications applications. There are three types of Edit Templates: Table Editing Template Types Template Type Description Edit Used to edit existing items Delete Used to delete existing items Edit / Delete Used to edit and or delete existing items Editing Templates also support the use of User Defined and Global Variables as described in Section 8.1. This section will guide you through the process of creating Edit Templates for each template type in Table Table Editing Templates Edit/Delete Templates User Line Phone Device Profile CTI Route Point Remote Destination Profile Remote Destination CUC Voice Mail Edit Templates contain three field types, input, drop-downs and checkbox list as described in Figure Each field also has the option to Display at Provision, which makes the field available to be configured at the time of provisioning. If Global or User Defined Variables are used, the Display at Provision option will be not be available as Variables are automatically displayed during provisioning. Table Editing Field Types Field Type Field Options Action Input Drop-down List Checkbox Drop-down List Use Existing Settings Global Variable User Defined Variable Static input Use Existing Settings Select Option Use Existing Settings Select Check or Unchecked No changes applied Global Variable will be displayed at provision User Defined Variable will be displayed at provision Static input will be applied during provision No change Selected option will be applied during provision No change Will apply checked or unchecked option during provision Figure Edit Templates Input Field Examples Akkadian Provisioning Manager 4.12 System Administration Guide 74

75 Figure Edit Templates Drop-down List Field Examples Figure Edit Templates Checkbox Drop-down List Field Examples To add an Edit Template: 1. Select Editing Templates from the Templates menu 2. On the menu, click to create a new Template 3. If required, select a Service Group 4. Configure the Template Name. This field is only applicable to Provisioning Manager Express and will be used to reference this template throughout the system. 5. Select the Template Type from the drop-down menu 6. Select the Editing Item Type. If Delete is selected proceed to Step 8 7. Update the fields to be edited 8. When finished, click 9. To add another template, click or proceed to the next section Akkadian Provisioning Manager 4.12 System Administration Guide 75

76 Section 9.0 Getting Started with Jobs Templates in Akkadian Provisioning Manager 4.12 Job Templates are used to combine one or more templates together to create a single provisioning job. Job Templates are created in Akkadian Provisioning Manager 4.12 using a simple yet flexible drag-and-drop interface. The interface can be used to create hundreds of provisioning jobs, but two major guidelines must be followed: 1. Job Templates are limited to three levels: PARENT FIRST LEVEL CHILD SECOND LEVEL CHILD 2. Levels are limited by the Job Template Matrix as show in Figure Figure Job Template Matrix Example If a Phone Template was selected as the Parent, the First Level Child options would be Line & User Template. If Line Template was chosen as the First Level Child, the Second Level Child options would be Phone, Device Profile, CTI Route Point, RDP, RD, & User. Akkadian Provisioning Manager 4.12 System Administration Guide 76

77 To add a Job Template: 1. Select Job Builder from the Templates menu 2. On the menu, click to create a new Template 3. Enter the template Name 4. If required, select a Service Group 5. Select the Parent Template Type from the Template Menu shown in Figure Figure Template Type Menu The Template List will populate with templates matching the selected Template Type 6. Select the Template from the Template List. Search can be used to narrow the results. Figure Template List 7. Drag the selected template left into the job builder pane as demonstrated in Figure Figure Template List 8. Based on the selected Parent Template, the Job Builder Set Placeholders window will open. 9. Choose one or more options as the First Level Children as demonstrated in Figure Akkadian Provisioning Manager 4.12 System Administration Guide 77

78 Figure Job Builder Set Placeholders 10. Click Continue and the Placeholders will appear in the Job Builder window as demonstrated in Figure Figure Job Builder Placeholders for First Level 11. From the Templates Menu, select the Template type matching the placeholder, then select the Template from the list and drag it over to the appropriate Placeholder as demonstrated in Figure Figure Job Builder Placeholders The system will only allow the appropriate Template type to be dropped onto the appropriate Placeholder 12. Based on the selected First Level Child Template, the Job Builder Set Placeholders window will open. Akkadian Provisioning Manager 4.12 System Administration Guide 78

79 13. Choose the one or more options as the Second Level Children as demonstrated in Figure Figure Job Builder Set Placeholders 14. Click Continue and the Placeholders will appear in the Job Builder window as demonstrated in Figure Figure Job Builder Placeholders for Second Level 15. Repeat Step 11, populating the Placeholders with the appropriate Templates until all Placeholders are fully populated as demonstrated in Figure Akkadian Provisioning Manager 4.12 System Administration Guide 79

80 Figure Populated Job Template 16. Add Template access by selecting the appropriate groups Figure Template Access 17. When finished, click 18. Repeat Steps 1 17 to add additional Job Templates Akkadian Provisioning Manager 4.12 System Administration Guide 80

81 Section 10.0 Getting Started with Provisioning in Akkadian Provisioning Manager 4.12 After building Job Templates as described in Section 9.0, Provisioning Manager 4.12 is ready to provision. To Provision: 1. Select Provision from the Actions menu 2. If required, select a Service Group 3. Select the desired Template from the Jobs Templates List. Search to narrow the list as demonstrated in Figure Figure Jobs Template List 4. Drag the Action Template into the Provisioning pane as demonstrated in Figure Figure Drag & Drop Action Template to Provisioning Pane 5. The Job Template will expand in the Provisioning Pane 6. If desired, drag additional Actions Templates to the Provisioning Pane and they will be added to the Queue 7. Complete the Job Template(s) as demonstrated in Figure Akkadian Provisioning Manager 4.12 System Administration Guide 81

82 Figure Populated Job Template Example 8. Click to begin provision and the system will process all jobs in the Queue 9. When the job has completed, the status will be displayed in the Provisioning Queue as demonstrated in figure Figure Provisioning Queue 10. When provisioning is complete, click Clear at the bottom of the Queue Akkadian Provisioning Manager 4.12 System Administration Guide 82

83 Section 10.1 Bulk Provisioning Bulk provision provides the ability to provision many devices. Bulk provision supports Add and Delete Jobs and will not display any Job Template containing Edit functions. To Bulk Provision: 1. Select Bulk Provision from the Jobs menu 2. If required, select a Service Group 3. Select the desired Template from the Jobs Templates List. Search to narrow the list as demonstrated in Figure Figure Jobs Template List 4. Drag the selected template to the Bulk Provisioning Jobs pane as demonstrated in Figure Figure Job Template List 5. Click Download to download and save the CSV Template to your computer 6. Fill out the CSV Template and save the changes, but do not modify the CSV Headers or Metadata 7. Click Browse and select the CSV from your local computer and click Upload to place the file in the Queue 8. With the file in the Queue, click Schedule to have the provision processed at a later time & date or Perform to immediately process the provision Akkadian Provisioning Manager 4.12 System Administration Guide 83

84 Section 10.2 Scheduled Bulk Provisioning Scheduling provides the ability to view, edit, add and delete scheduled provisioning actions directly from the scheduling window. To use scheduling: 1. Select Schedule from the Actions menu 2. On the menu, click to schedule a new bulk provision 3. Select the bulk provision CSV file from your local computer 4. Set the Date and Time to perform the provision 5. Click Add to create the job in the Queue The schedule for any job can be edited by clicking on the File Name or the job can be deleted by checking the box next to the scheduled job you wish to delete and clicking the Delete button. Akkadian Provisioning Manager 4.12 System Administration Guide 84

85 Section 10.3 Using the Extension Mobility Tool The Extension Mobility tool provides the ability to log users in or out of devices using the Cisco CUCM Extension Mobility service. Extension Mobility Tool Requirements: The Provisioning Manager Application user must have Authentication by Proxy rights The CUCM Extension Mobility service must be activated and running The user and phone must be properly configured to support Extension Mobility To use the Extension Mobility Tool: 1. Select Extension Mobility from the Actions menu 2. Select the appropriate Service Group 3. If you wish to Search by End User select the check box 4. If you chose to Search by End User, locate the end user you wish to log in or out of a device 5. If the user is already logged into a device, the device will appear in the device list. The user can be logged out of the current device by selecting the Log Out button 6. If the user is not logged into a device, you can search for a device and log the user in by selecting the Login button Figure Extension Mobility Tool Akkadian Provisioning Manager 4.12 System Administration Guide 85

86 Section 10.4 Using the Swap Feature The Swap feature provides the ability copy configurations between various user components in CUCM. This Swap Tool can swap or copy configuration between: Devices swap phones or device profiles of the same or different model Users migrate device associations and ownership to a new user The Swap feature can help perform common tasks without building a job. Section Using the Device Swap Feature The Device Swap tool provides the ability swap configurations between most phone and device profile models. This tool is very useful when you need to replace a user s phone or profile with the same or different model. Device swap will provision the new device, copy all applicable settings, apply device ownership and associated the new device with the user. The tool also provides the option to delete the old device upon successful completion of the swap. This feature can be equally as useful when adding a new device to a user as it will copy over pertinent settings and perform all proper associations. Swapping some newer phone models to older phone models may result in errors due to model incompatibility between the Max Call & Busy Trigger. Phone Swap supports Intercom lines, but the Intercom Line will always be removed from the source phone prior to the swap due to CUCM inability to support shared Intercom Lines. If the target device does not support the same number of lines or speed dials, they will show up as unassociated. Using Device Swap: 1. Select Swap from the Actions menu. 2. Select the appropriate Service Group. 3. Select the Source Device Type: Phone or Device Profile 4. Locate the Source Device. This is the device you want to copy. 5. If you wish to delete the source device upon successful completion of the swap, select the Delete source device after swap checkbox 6. Select the Target Device Type. This is the model of the target device. 7. Select the Target Device Protocol. This may vary depending on the model. 8. Select the Target Device Template. The Template is used to configure required settings which are not available to be copied from the source device. For example, if you are going from a SCCP phone to SIP phone, the SIP profile will be configured using the Template. 9. Click Perform to complete the swap. Templates used for Swap should not contain GVs. Akkadian Provisioning Manager 4.12 System Administration Guide 86

87 If the device is the same model and protocol, a template is not required. 10. Enter the device name or MAC address. 11. Click to complete the process. Figure Phone Swap Section Using the User Swap Feature The End User Swap tool provides the ability to migrate all line and device associations from one user to another. Using User Swap: 1. Select Swap from the Actions menu. 2. Select the End-User Swap Form Tab. 3. Select the appropriate Service Group. 4. Select the Source End User. 5. If you wish to delete the source user upon successful completion of the swap, select the Delete source end-user after swap checkbox. 6. Select New User Account to create and new user during the process or selecting and existing user as the target. Note - all existing associations will be removed from target user. 7. Click Perform to complete the swap. Akkadian Provisioning Manager 4.12 System Administration Guide 87

88 Section 10.5 Using Bulk Swap The Swap feature can also be used in bulk to migrate multiple phones or devices profiles. There are two methods to perform device swaps in bulk. Method 1 Bulk Swap using CSV Template: 1. Select Swap from the Actions menu 2. Select the appropriate Service Group 3. Select the Device Swap or End-User Swap tab 4. At this point, you can download the CSV template by clicking Export located at the top right corner of the page. Optionally you can proceed to populate the remaining fields and Export the template with all the settings prepopulated. 5. Populate the Exported CSV Template and when complete, click the Import button to upload the template. 6. Upon uploading the Template, the system will process the swaps. Do no close your browser or navigate away from the page. 7. The process will complete and provide a summary of the processed items. Method 2 Bulk Swap using Advanced Search: 1. Select Swap from the Actions menu 2. Select the appropriate Service Group 3. Select the Bulk Swap Tab 4. Click the Search Devices button 5. Search for the phones to be swapped using the Search Phones section. 6. As devices are located, you may click Add to List and repeat the search for more devices to be added to the list. Alternatively, click the Add to List and Close button to complete adding to the list and return to the Bulk Swap page. Akkadian Provisioning Manager 4.12 System Administration Guide 88

89 7. On the Bulk Swap page, click Run Bulk Swap to process the swap for all devices in the list. Alternatively, you can select Export to CSV to process the job later. Akkadian Provisioning Manager 4.12 System Administration Guide 89

90 Section 10.6 Using the CMC/FAC Editor The Provisioning Manager CMC/FAC Editor can be used to edit existing Client Matter and Forced Authorization Codes. Using the CMC/FAC Editor: 1. Select CMC/FAC Editor from the Actions menu 2. Select the appropriate Service Group 3. Select the Code Type. 4. Edit the appropriate fields 5. When finished, click If CMC or FAC Rules are enabled, please remember that editing the Description field for CMCs and the Name field for FACs may break the link between the user and the code. Akkadian Provisioning Manager 4.12 System Administration Guide 90

91 Section 10.7 Using the Visual Phone Editor Visual Phone Editor provides the ability to visually edit a phone or device profile. Visual Phone Editor support the following functions: Change phone button template for device Associating existing lines to the device Edit Line on Device settings for lines on the device Rearrange lines using drag and drop Rearrange speed dials using drag and drop Using Visual Phone Editor: 9. Select Visual Phone Editor from the Actions menu 10. Select the appropriate Service Group 11. Search for and select the device to edit 12. Perform the desired edit actions using Visual Phone Editor 13. When finished, click to apply the changes Figure Akkadian Provisioning Manager 4.12 System Administration Guide 91

92 Section 10.8 Using Phone Control Provisioning Manager Phone Control provides the ability to remotely validate Cisco phone functionality, view remote Cisco phone displays, navigate softkeys or place test calls, without the need for physical presence. Requirements 1. IP connectivity on TCP port 80 to target Cisco IP Phone 2. CUCM Application user who is a member of the Standard Server Monitoring and Standard TabSync User groups. 3. Web access enabled on the Cisco IP Phone (Provisioning Manager will automatically enable web access if currently disabled) 4. Assign Phone Control role to appropriate Provisioning Manager Security Groups 5. One of the following phone models: 6921, 6941, 6945, 6961, 7821, 7841, 7861, 7905, 7906, 7911, 7912, 7925, 7926, 7937, 7940, 7941, 7942, 7945, 7960, 7961, 7962, 7965, 7970, 7971, 7975, 8811, 8831, 8841, 8845, 8851, 8861, 8865, 8941, 8945, 8961, 9951, 9971 Configuring Phone Control: 1. Select Application Servers from the System menu. 2. Select the Communications Manager Tab. 3. Select the CUCM application server on which to configure Phone Control. 4. Configure the following fields in the Phone Control Information section Field Phone Control Username Phone Control Password Confirm Phone Control Password Description Phone Control CUCM application username Phone Control CUCM application user s password Confirm Phone Control CUCM application user s password 5. When finished, click Save. Akkadian Provisioning Manager 4.12 System Administration Guide 92

93 Using Phone Control: 1. Select Phone Control from the Actions menu. 2. Select the appropriate Service Group from the list. 3. Locate the Phone using search. Provisioning Manager will check if the phone meets the following requirements: 1. The phone has Web Access 2. The phone is associated to the Phone Control application user If either of these requirements are not met, Provisioning Manager will prompt to automatically enable on or both options. 3. Once the phone is prepared for connection, Phone Control will automatically connect to the device. 4. When connected, use the Phone Control buttons to control the device. Please note the screen refresh is not real-time and by default refreshes every 5 seconds. Akkadian Provisioning Manager 4.12 System Administration Guide 93

94 Akkadian Provisioning Manager 4.12 System Administration Guide 94

95 Section 10.9 CUC Voice Mailbox Scheduled Delete Service Provisioning Manager Express provides the ability to preserve a user s Cisco Unity voice mailbox for a schedule number of days when offboarding a user. This feature should be enabled on the Service Group before it is applied to a provisioning job. Once the feature is enabled on the Service Group, here is how it can be used in a provisioning job. 1. Create a Delete Voice Mail Template with the Enable CUC Voice Mail Scheduled Delete enabled. 2. Add the Delete Voice Mail Template to a provisioning job. The template can be used alone or with other templates in the job. Akkadian Provisioning Manager 4.12 System Administration Guide 95

96 3. Run the provisioning job and the voice mail will be scheduled for deletion. Akkadian Provisioning Manager 4.12 System Administration Guide 96

97 Section 11.0 FTP Server Configuration The FTP menu provides the ability to create multiple FTP locations in Provisioning Manger Express Currently the configuration of at least one FTP location is required for Scheduled Backups. To create a FTP location: 1. Select FTP from the System menu 2. On the menu, click to create an FTP location 3. Configure fields as described in Table Table FTP Authentication Field Name Name Hostname Username Password Path Secure FTP Description Enter the FTP location Name Enter the hostname or IP address of the FTP server Enter the username Enter a validation method. Example, if you only want users to enter a numeric value, choose numeric. As an alternative to choosing a validation method, a custom regular expression can be entered By default, Global Variables are required fields. Check Optional to make these optional fields. Akkadian Provisioning Manager 4.12 System Administration Guide 97

98 Section 12.0 Configuring Backup and Restore Backup and Restore provides the ability to: Manually backup Provisioning Manager 4.12 Schedule automatic Provisioning Manager 4.12 backups Restore Provisioning Manager 4.12 To Perform a Manual Backup: 1. Log in as PMEAdmin or as an administrator 2. Select Backup and Restore from the System menu 3. Click Backup and save the file to the desired location To Perform a Manual Backup: 1. Log in as PMEAdmin or Administrator 2. Select Backup and Restore from the System menu 3. Select the Schedule Backup tab 4. On the menu, click to create a new backup schedule 5. Configure fields as described in Table Table Add New Schedule Field Name Location Frequency Starting Date Time Notification Description Select FTP location. FTP location must be configured prior as documented in Section 11. Select Daily, Weekly or Monthly Select the starting date Select the time of day the backup should run Enter notification to receive To Perform a System Restore: 1. Log in as PMEAdmin 2. Select Backup and Restore from the System menu 3. Click Browse and select the backup file 4. Click Restore to process the system restore Akkadian Provisioning Manager 4.12 System Administration Guide 98

99 Section 13.0 Performing System Updates System Update provides the ability for Provisioning Manager 4.12 to be updated through the Web interface. To Perform a System Update: 1. Log in as PMEAdmin 2. Select System Update from the System menu 3. If an update is available, click the Update Available! link to download the file 4. After downloading the update click Choose File and select the file from the download location 5. Select Run Update, once the update is complete, select OK Notes on Running an Update: Occasionally, an update will be released as an executable rather than a zip file. In these cases, special instructions may apply. Please be sure to read any associated instructions as part of that update. Previous updates can be obtained using the same link and browsing to "archives". It is always recommended to perform a backup prior to running any updates. If your server does not have access to the internet, you can also access the latest updates using the following link: Akkadian Provisioning Manager 4.12 System Administration Guide 99

100 Section 14.0 Reporting The Reporting sections provides the ability to view the following information: Audit Trail provides a record of all provisioning transactions that have occurred within the application DN Aging provides a list of Directory Numbers that have been deleted with the corresponding DN aging period. To View Audit Trail: 1. Log in as a user with System access 2. Select Reporting from the System menu 3. Use the search options to locate a specific reporting item. Global Search will search all data, including the Action details. 4. Click on the Status link to view Action details To View DN Aging: 1. Log in as a user with System access 2. Select Reporting from the System menu 3. Select the DN Aging Tab 4. Use the search options to locate a specific DN Aging item. Global Search will search all fields. 5. To manually release a DN, click on Locked text in the Status column and confirm the action. Akkadian Provisioning Manager 4.12 System Administration Guide 100

101 Akkadian Provisioning Manager 4.12 System Administration Guide 101

102 Section 15.0 Updating the Default PMEAdmin Password To update the PMEAdmin Password: 1. Log in as PMEAdmin 2. Click on Hi Default to access the PMEAdmin profile as demonstrated in Figure Figure Accessing PMEAdmin profile 3. On the PMEAdmin profile page, update the PMEAdmin Address with a valid address in the event a password recovery is required. 4. Enter the current PMEAdmin password (Default is PMEAdmin) and then enter and confirm a new password as demonstrated in Figure Figure Updating PMEAdmin profile The password strength indicator will show red for weak, yellow for medium and green for strong password. Akkadian Provisioning Manager 4.12 System Administration Guide 102

103 Section 16.0 Getting Started with the REST API in Akkadian Provisioning Manager 4.12 Akkadian Labs Provisioning Manager 4.12 configuration APIs offer REST APIs for configuration of Provisioning Manager. Each object supports four methods (except where documented otherwise) that can be invoked on the URL that is associated with the object. The structure of the URL is: Manager-server>/pme/index.php/api/<object>/<instanceId>?apikey=<API-Key>. Description Routable address (name or IP address) of the Provisioning Manager server. One of the supported objects. Optional components needed for GET, DELETE, PUT methods referring to a specific instance of the object. Supported Operations Operation HTTP Method URL Description Input Output URL Structure <Provisioning Managerserver> <object> <instanceid> LIST GET Manager-server>/ pme/index.php/api/<object>?apikey=<api- Key> GET GET Manager-server>/ pme/index.php/api/<object><instanceid>? apikey=<api-key> PROVISION POST Manager-server>/ pme/index.php/api/<object>?apikey=<api- Key> DELETE DELETE Manager-server>/ pme/index.php/api/<object><instanceid>? apikey=<api-key> List all the instance of this object None List of objects Get details of the None Single instance specified object by instance ID. instance Execute a Provisioning Result provisioning action. data Success / Failure Execute a delete Deletion Result action. data Success / Failure To Generate a User API Key: API keys are automatically generated for users who are member of the built-in Administrators group. Users who are not members of the Administrators group cannot access the API. 1. Log in as PMEAdmin or a member of the Administrators group. 2. Select Users from the System menu 3. Select the desired user from the list 4. Scroll down to the API section to locate the API Key Akkadian Provisioning Manager 4.12 System Administration Guide 103

104 API Operations: Get servicegroups Retrieves a list of the Provisioning Manager Service Groups with their Name and ID. Get servicegroup Retrieves a list of the Provisioning Manager provisioning templates (jobs) within a Service Group. Akkadian Provisioning Manager 4.12 System Administration Guide 104

105 Get template Retrieves details of Provisioning Manager provisioning template (job), including the required fields to execute a provisioning action. POST provision Performs a provision using data received from GET template. Akkadian Provisioning Manager 4.12 System Administration Guide 105

106 POST DELETE Performs a delete using data retrieved from GET template. Get reports Retrieves a list of the Provisioning Manager reports. Akkadian Provisioning Manager 4.12 System Administration Guide 106

107 Get report Retrieves the details of an Provisioning Manager report. Akkadian Provisioning Manager 4.12 System Administration Guide 107

108 Get dnpools Retrieves the list of DN pools. Get dnpool Retrieves DN Pool details. Options available to get or lock next available number from pool. Akkadian Provisioning Manager 4.12 System Administration Guide 108

109 Akkadian Provisioning Manager 4.12 System Administration Guide 109

110 Section 17.0 Configuring the Self-Provisioning Service in Akkadian Provisioning Manager 4.12 The Provisioning Manager self-provisioning feature allows organizations to provision users without having to know the MAC address of the destination phone. Instead, a user or technician can complete the provision process by going to the target device and using the Provisioning Manager Self-Provision IP Phone service to assign the phone. How does Provisioning Manager Self-Provisioning work? The process is simple and is very similar to the standard provisioning process in Provisioning Manager with a few additional requirements: This process is only supported on CUCM 10.x and above The CUCM end user must be provisioned with a self-service ID The phone must have Web Access enabled The CUCM end user must be provisioned with an associated phone containing a Dummy MAC addresses in the following format: BATXXXXXXXXXXXX where X represents any 12-character, hexadecimal (0-9 and A-F) number. The user can be provisioned with multiple devices, but can only have one associated BATXXXXXXXXXXXX device. The destination phone must have access to the Provisioning Manager Self-Provisioning IP Phone service. This can be achieved by either creating and IP Phone service and subscribing the phone or using the IDLE URL. In order for the service to be available, the phones in the Cisco Unified Communications Manger cluster must have network connectivity to the Provisioning Manager serve Section 17.1 Configuring Device Default Template Mappings for the Self- Provisioning Service Before the Self-Provisioning service can be used, a default template must be associated to each device type. The default template provides the settings that are not available to be copied between different phone models and or protocols. Default templates also do not support Global Variables, so it is recommended to create separate templates to be used for this function. These templates only require minimal configuration as many of the settings will be copied from the virtual BAT device. Akkadian Provisioning Manager 4.12 System Administration Guide 110

111 To Configure Default Template Mappings: 1. Select Service Groups from the System menu 2. Click on the Device Default Template Mapping tab 3. Select the Device Type, Protocol and Default Template 4. Click Associate to add the device template mapping 5. Select and existing association and click Disassociate to remove an association 6. When complete, continue to configuring the Self-Provisioning service There are typically two common approaches to providing phones access to the Provisioning Manager Self- Provisioning IP Phone service. Method 1 As an IP Phone Service using Enterprise Subscription Method 2 Using the Idle URL with auto-registration Section 17.2 Method 1 - Deploying Self-Provisioning using an IP Phone Service This section will cover configuring access to the Provisioning Manager Self-Provisioning Service using a Cisco IP Phone service in CUCM. To configure the Provisioning Manager Self-Provision Cisco IP Phone Service: 1. Log into Provisioning Manager as PMEAdmin or an Administrator Akkadian Provisioning Manager 4.12 System Administration Guide 111

112 2. Go to System Service Groups 3. Click on the desired Service Group 4. Copy the Self-provision URL 5. Log into Cisco Unified Communications Manager Administration page 6. From the Cisco Unified Communications Manager Administration page, choose Device > Device Settings > Phone Services. This will open the Find and List IP Phone Services window. 7. Click the Add New button. The IP phone Services Configuration window appears. 8. Enter the Service Name as Self-Provision Service. This is the name that will display on the menu of available services in the Cisco Unified IP Phone User Options application. 9. Enter the Service Description as Provisioning Manager Self-Provision Service. This is service description. 10. In the Service URL field, input or paste in the URL from the Provisioning Manager Service Group Selfprovision URL field. 11. In the Secure-Service URL field, input or paste in the URL from the Provisioning Manager Service Group Self-provision URL field. (HTTPS is not supported) 12. Set the Service Category to XML Service 13. Set the Service Type to Standard IP Phone Service 14. Optional Configure the Service Vendor to Akkadian Labs 15. Optional Configure the Service Version as Check the Enable checkbox 17. Check the Enterprise Subscription checkbox 18. Click Save Figure Provisioning Manager Self-Provisioning IP Phone Service Akkadian Provisioning Manager 4.12 System Administration Guide 112

113 Section 17.3 Method 2 - Deploying Self-Provisioning with Auto-registration This section will cover configuring access to the Provisioning Manager Self-Provisioning Service using CUCM auto-registration and the Idle URL. To configure the Provisioning Manager Self-Provision Service with Auto-registration: 1. Log into Provisioning Manager as PMEAdmin or an Administrator 2. Go to System Service Groups 3. Click on the desired Service Group 4. Copy the Self-provision URL 5. Log into Cisco Unified Communications Manager Administration page 6. From the Cisco Unified Communications Manager Administration page, select User Management > User Phone/Add > Universal Device Template 7. Click Add New to create a Universal Device Template (UDT) 8. Configure the required UDT settings applicable for your environment 9. In the UDT Service Configuration Settings configure the following fields to enable access to the Provisioning Manager Self-Provisioning Service: Field Name Idle Idle Timer (seconds) Field Drop-down Setting Override Override Field Value Manager Server-name or IP}/pme/swapsrvc?sg={ID} Manager Server-name or IP}/pme/swapsrvc?sg={ID} 10. From the Cisco Unified Communications Manager Administration page, select System > Cisco Unified CM. 11. Select the node on which to enable Auto-registration 12. Enter the appropriate information to enable Auto-registration for your cluster and select the Universal Device Template created in previous steps Figure Provisioning Manager Self-Provisioning IP Phone Service Akkadian Provisioning Manager 4.12 System Administration Guide 113

114 Akkadian Provisioning Manager 4.12 System Administration Guide 114

115 Section 18.0 Configuring Active Directory Auto Provisioning in Akkadian Provisioning Manager 4.12 Provisioning Manager provides the ability to integrate with Active Directory and provision accounts based on Active Directory groups. Configuring auto provisioning with Active Directory requires three steps: 1) Configure LDAP agreements the LDAP agreement is used to access Active Directory. Multiple LDAP agreements may be used with auto provisioning. 2) Configure Auto Provisioning tasks Auto Provisioning tasks are used to map Active Directory attributes to Provisioning Manager data. Multiple Auto Provisioning tasks may be configured to provide flexibility. 3) Schedule Auto Provisioning tasks Auto Provisioning tasks must be scheduled to process provisioning tasks. Step 1 Configure LDAP Agreements: 1. Log into Provisioning Manager as PMEAdmin 2. Select LDAP from the System menu 3. Click on Add to add an LDAP agreement. Alternatively, you may update the default agreement. 4. Configure the LDAP settings for your environment and click Save Table LDAP Configuration Field Description LDAP Config Name Enter a name to identify this specific LDAP configuration Base Enter the LDAP search base Server The LDAP server IP address or DNS name Port* Enter the LDAP server port number Username Enter the LDAP Username used to authenticate to the LDAP server Password Enter the LDAP Password used to authenticate to the LDAP server Username Bind Attribute Enter LDAP Attribute to bind to Username during authentication * Typical port number is 3268 for Active Directory. Akkadian Provisioning Manager 4.12 System Administration Guide 115

116 5. To add another LDAP agreement, click Add or continue to the next section Step 2 Configure Auto Provisioning Tasks: 1. Log into Provisioning Manager with an Administrator account. 2. Select Auto Provision from the System menu. 3. Click on Add to add a new Auto Provision Task. Field Service Group Name Enable LDAP Connection Settings LDAP Server User Bind Attribute Attribute Mapping select a job to be used for auto provisioning by dragging a job from the list to the Attribute Mapping section. Description If required, select a Service Group Enter a name for the auto provisioning task Check this box to enable the task Select the appropriate LDAP agreement Specify the bind attribute used to locate the user in Active Directory. Example - samaccountname Akkadian Provisioning Manager 4.12 System Administration Guide 116