akkadian Provisioning Manager Express

Transcription

1 akkadian Provisioning Manager Express Version Release Notes July 11 th, 2017 Copyright and Trademarks: I. Copyright: This website and its content is copyright 2017 Akkadian Labs, LLC. All rights reserved. Except with the prior written permission of Akkadian Labs, 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 Labs, the Akkadian Labs logo and other trademark or service marks used on this website, whether registered or not, are the property of Akkadian Labs, LLC and may not be used or reproduced without the prior written permission of Akkadian Labs, LLC. apme RN 1/15/

2 Table of Contents Upgrade Notes New and Changed Features Resolved Caveats Upgrade Notes New and Changed Features Resolved Caveats Upgrade Notes New and Changed Features Cisco Spark Provisioning Cisco UCCE Packaged Provisioning Phone Control End User Self Service Single Sign-on Unity Connection Support for Multiple Alternate Extensions Unity Connection Scheduled Voice Mail Box Deletion System Global Variables Feature Enhancements Visual Phone Editor Enhancements Mobility User ID Field Disable End User Device Association Unity Connection Templates Unified Messaging Support Product Specific Cisco Support Field Product Specific Proximity Site Templates End User Department Field Site Templates Rerouting Calling Search Space WebEx Templates Callback Support akkadian Provisioning Manager Express Version Release Notes 7/11/2017 2

3 DN Pool Support for +E.164 Alternate Number Mask Edit Line Template Set Unassigned Line as Active Edit Line Template DN Aging Resolved Caveats Upgrade Notes New and Changed Features Visual Phone Editor Enhancement Resolved Caveats New and Changed Features Visual Phone Editor Enhancement Resolved Caveats New and Changed Features Visual Phone Editor Additional Swap Support Device Swap Feature User Swap Feature DN Synchronization to Microsoft Active Directory Device Overwrite Enhancement Personal Audit Report Cisco VG300 Series Gateway Support Global Variable List Enhancement Unity Application Server Synchronization Application Server Synchronization Scheduling Enhancement DN Pool Reporting Job Templates Device Groups Resolved Caveats New and Changed Features Resolved Caveats akkadian Provisioning Manager Express Version Release Notes 7/11/2017 3

4 Upgrade Notes New and Changed Features CUCM End User Database - LDAP Status Monitoring Client Matter & Forced Authorization Code Support Provisioning Enhancements Bulk Phone Swap Automatically Generate Dummy MAC address View and Provision Results Overwrite Device Option Extension Mobility Auto-logout feature on Delete Site Template Enhancements New Provisioning Options Site Template Bulk Import Provisioning User Interface Enhancements Job Template Export and Import Resolved Caveats akkadian Provisioning Manager Express Version Release Notes 7/11/2017 4

5 Upgrade Notes Akkadian Labs does extensive testing on all our upgrades, but we suggest you take the following precautions before upgrading. 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 a safe location Take a VMWare Snapshot (Optional): This step is optional, but it will allow you to easily roll back to the previous version without having to redeploy the apme OVA. 1. Power down the apme Virtual Machine 2. Right click on the Virtual Machine and select > Snapshot > Take Snapshot. 3. Type a name for the snapshot. 4. Type a description for the snapshot. Please note starting with version , apme is no longer available for the Microsoft Windows platform. apme for Windows can easily be migrated to Linux using the backup and restore process. All clusters, including Unity Connection must be synchronized after performing the upgrade or provisioning will not function properly akkadian Provisioning Manager Express Version Release Notes 7/11/2017 5

6 Support for Upgrading from Previous Versions of apme From To Supported Method and above Direct Upgrade , , & Apply upgrade patch and then perform direct upgrade. Prior to upgrading from any release requiring the pre-upgrade patch, please download the patch here: apme for Linux- Download Patch akkadian Provisioning Manager Express Version Release Notes 7/11/2017 6

7 New and Changed Features There are no new features in this release. akkadian Provisioning Manager Express Version Release Notes 7/11/2017 7

8 Resolved Caveats Tracking Number PME-3710 PME-3711 PME-3699 PME-3715 PME-3700 Description Optimized database query to pull application server information, improving performance. Optimized performance when access application server page for CUCM. Self-service portal timeout page is displaying the wrong message. Edit Template In some cases, Unity Alternate Extension table was not displaying. Unity Alternate Extension description field should be required. akkadian Provisioning Manager Express Version Release Notes 7/11/2017 8

9 Upgrade Notes Akkadian Labs does extensive testing on all our upgrades, but we suggest you take the following precautions before upgrading. Perform a Manual Backup: 4. Log in as PMEAdmin or as an Administrator 5. Select Backup and Restore from the System menu 6. Click Backup and save the file to a safe location Take a VMWare Snapshot (Optional): This step is optional, but it will allow you to easily roll back to the previous version without having to redeploy the apme OVA. 5. Power down the apme Virtual Machine 6. Right click on the Virtual Machine and select > Snapshot > Take Snapshot. 7. Type a name for the snapshot. 8. Type a description for the snapshot. Please note starting with version , apme is no longer available for the Microsoft Windows platform. apme for Windows can easily be migrated to Linux using the backup and restore process. All clusters, including Unity Connection must be synchronized after performing the upgrade or provisioning will not function properly akkadian Provisioning Manager Express Version Release Notes 7/11/2017 9

10 Support for Upgrading from Previous Versions of apme From To Supported Method and above Direct Upgrade , , & Apply upgrade patch and then perform direct upgrade. Prior to upgrading from any release requiring the pre-upgrade patch, please download the patch here: apme for Linux- Download Patch akkadian Provisioning Manager Express Version Release Notes 7/11/

11 New and Changed Features There are no new features in this release. akkadian Provisioning Manager Express Version Release Notes 7/11/

12 Resolved Caveats Tracking Number PME-3695 PME-3657 PME-3692 PME-3691 PME-3694 PME-3696 PME-3690 PME-3697 Description Phone Control using wrong application user which results in IP not found error. Phone Service parameter field data missing from phone config file after provision. Invalid argument supplied for foreach() error when using User Defined Variables for service parameters. Using Edit Line causes Enterprise Alternate Number and E164 Alternate Number to be cleared. UCCE not displaying Global Attributes and Skill Groups during edit. Unable to access configuration page after de-activating SSO Service. Jobs Templates cleared when creating with duplicate name. Application server page refresh does not work in Firefox. akkadian Provisioning Manager Express Version Release Notes 7/11/

13 Upgrade Notes Akkadian Labs does extensive testing on all our upgrades, but we suggest you take the following precautions before upgrading. Perform a Manual Backup: 7. Log in as PMEAdmin or as an Administrator 8. Select Backup and Restore from the System menu 9. Click Backup and save the file to a safe location Take a VMWare Snapshot (Optional): This step is optional, but it will allow you to easily roll back to the previous version without having to redeploy the apme OVA. 9. Power down the apme Virtual Machine 10. Right click on the Virtual Machine and select > Snapshot > Take Snapshot. 11. Type a name for the snapshot. 12. Type a description for the snapshot. Please note starting with version , apme is no longer available for the Microsoft Windows platform. apme for Windows can easily be migrated to Linux using the backup and restore process. All clusters, including Unity Connection must be synchronized after performing the upgrade or provisioning will not function properly akkadian Provisioning Manager Express Version Release Notes 7/11/

14 Support for Upgrading from Previous Versions of apme From To Supported Method and above Direct Upgrade , , & Apply upgrade patch and then perform direct upgrade. Prior to upgrading from any release requiring the pre-upgrade patch, please download the patch here: apme for Linux- Download Patch akkadian Provisioning Manager Express Version Release Notes 7/11/

15 New and Changed Features There are no new features in this release. akkadian Provisioning Manager Express Version Release Notes 7/11/

16 Resolved Caveats Tracking Number PME-3681 Description Unable to save a Global Variable containing Default or List as type if no System Global Variable has been configured. akkadian Provisioning Manager Express Version Release Notes 7/11/

17 Upgrade Notes Akkadian Labs does extensive testing on all our upgrades, but we suggest you take the following precautions before upgrading. Perform a Manual Backup: 10. Log in as PMEAdmin or as an Administrator 11. Select Backup and Restore from the System menu 12. Click Backup and save the file to a safe location Take a VMWare Snapshot (Optional): This step is optional, but it will allow you to easily roll back to the previous version without having to redeploy the apme OVA. 13. Power down the apme Virtual Machine 14. Right click on the Virtual Machine and select > Snapshot > Take Snapshot. 15. Type a name for the snapshot. 16. Type a description for the snapshot. Please note starting with version , apme is no longer available for the Microsoft Windows platform. apme for Windows can easily be migrated to Linux using the backup and restore process. All clusters, including Unity Connection must be synchronized after performing the upgrade or provisioning will not function properly akkadian Provisioning Manager Express Version Release Notes 7/11/

18 Support for Upgrading from Previous Versions of apme From To Supported Method and above Direct Upgrade , , & Apply upgrade patch and then perform direct upgrade. Prior to upgrading from any release requiring the pre-upgrade patch, please download the patch here: apme for Linux- Download Patch akkadian Provisioning Manager Express Version Release Notes 7/11/

19 New and Changed Features Cisco Spark Provisioning apme 4.10 adds supports for provisioning Cisco Spark users. This version provides the ability to: Add, edit and delete Cisco Spark users Assign Spark Roles Assign Spark licensing Add & remove users from Spark Rooms & Teams Requirements: 1) Spark account with full administrator privileges 2) Same account should be used to create a Cisco Spark developer account at 3) Once the account is created, record the access token which will be used in conjunction with the username for API access. 4) apme must have access to the Cisco Spark site. Adding Cisco Spark Application Server Before adding Spark configuration templates, you must connect apme to your Cisco Spark site. Using the Spark API user described in the requirements section, configure the Cisco Spark Application Server in apme. 1. Select Application Servers from the System menu. 2. Select the Spark Tab. 3. Configure the required fields. Field Spark Site Name Spark Site URL Username Access Token Description Enter a name to identify the Spark site. Enter the spark URL. This is usually api.ciscospark.com. Enter the username for the Spark API user. Enter the access token from the Spark Developer site. akkadian Provisioning Manager Express Version Release Notes 7/11/

20 4. Click Verify Spark to test connectivity. 5. When finished, click Save. Adding Cisco Spark to a Service Group Once the application server configuration is complete, the Cisco Spark integration must be assigned to a Service Group. 1. Select Service Group from the System menu. 2. Select the appropriate Service Group from the list. 3. Select the Spark application server from the drop-down list. 4. Click Save to apply the changes. akkadian Provisioning Manager Express Version Release Notes 7/11/

21 Creating Cisco Spark Templates Cisco Spark User Templates provide the ability to add users to your Cisco Spark site. Users can be assigned licenses, roles and even be added to existing rooms or teams. Please note that due to a limitation with the Cisco Spark API, only rooms created by the Cisco Spark API can be assigned to users by apme. 1. Select Spark User from the Templates menu. 2. Select the appropriate Service Group from the list. 3. Configure the template with the appropriate values. 4. When complete, click Save. Please note due to a caveat with the Cisco Spark API, the Is Moderator function does not work properly. Once Cisco fixes this issue, it will be supported by apme. akkadian Provisioning Manager Express Version Release Notes 7/11/

22 Creating Jobs with Spark Templates To provision using a Spark Template, it must be included in a Job. Because Cisco Spark has no dependencies, it can exist by itself or coexist with other templates in a Job. 1. Select Jobs from the Templates menu. 2. Select the appropriate Service Group from the list. 3. Input the Job name. 4. Add the Cisco Spark Template along with any other required Templates. 5. Add one or more access groups. 6. When complete, click Save. Cisco UCCE Packaged Provisioning apme 4.10 adds supports for provisioning agents in Packaged Contact Center Enterprise. This version provides the ability to add, edit and delete contact center agents. 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. akkadian Provisioning Manager Express Version Release Notes 7/11/

23 Adding UCCE Application Server 1. Select Application Servers from the System menu. 2. Select the UCCE Tab. 3. Configure the required fields. 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 4. When complete, click Save. Adding UCCE to the Service Group Once the application server configuration is complete, the UCCE integration must be assigned to a Service Group. 1. Select Service Group from the System menu. 2. Select the appropriate Service Group from the list. 3. Select the UCCE application server from the drop-down menu. 4. When complete, click Save. akkadian Provisioning Manager Express Version Release Notes 7/11/

24 Creating UCCE Agent Templates Cisco UCCE Templates provide the ability to add agents to your Cisco Packaged UCCE system. Agents can be provisioned and at the same time assigned to Skill Groups, Team and assigned Attributes. 1. Select UCCE Agent from the Templates menu. 2. Select the appropriate Service Group from the list. 3. Configure the template with the appropriate values. 4. When complete, click Save. akkadian Provisioning Manager Express Version Release Notes 7/11/

25 Creating Jobs with UCCE Agent Templates To provision using a UCCE Agent Template, it must be included in an apme Job. Because UCCE has no configuration dependencies on any other application, it can exist by itself or coexist with other Templates in apme Job. 1. Select Jobs from the Templates menu. 2. Select the appropriate Service Group from the list. 3. Input the Job name. 4. Add the UCCE Agent Template along with any other required Templates. akkadian Provisioning Manager Express Version Release Notes 7/11/

26 5. Add the appropriate access groups. 6. When complete, click Save. Phone Control apme 4.10 introduces Phone Control, which 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 CCM Server Monitoring and Standard TabSync User groups. 3. Web access enabled on the Cisco IP Phone (apme will automatically enable web access if currently disabled) 4. Assign Phone Control role to appropriate apme 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 akkadian Provisioning Manager Express Version Release Notes 7/11/

27 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. Using Phone Control 1. Select Phone Control from the Actions menu. 2. Select the appropriate Service Group from the list. 3. Select the Phone from the list. apme 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 akkadian Provisioning Manager Express Version Release Notes 7/11/

28 If either of these requirements are not met, apme 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 Express Version Release Notes 7/11/

29 End User Self Service apme 4.10 introduces the End User Self-Service portal, which 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 apme, reducing administrative overhead. Enabling End User Self-Service Before end users can access the apme 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, apme provides the ability to customize the self-service features available to end users. akkadian Provisioning Manager Express Version Release Notes 7/11/

30 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. akkadian Provisioning Manager Express Version Release Notes 7/11/

31 Single Sign-on apme 4.10 now supports Secure Assertion Markup Language (SAML), which allows you to provide single sign-on (SSO) for apme using enterprise identity providers such as Active Directory and OneLogin. Configuring Single Sign-on Single Sign-on must be enabled and configured before user can access apme using SSO. Only one SSO sources can be configured for apme and it only provides SSO access for apme application, not the user portal. To Configure Single Sign-on: 1. Login to apme as PMEAdmin 2. Select Configuration from System menu 3. Select the Single Sign-on tab 4. Check the box to activate the SSO service 5. Configure the appropriate settings for your Identity Provider 6. When finished, click Save Field IDP Name (Label) Configure Using IDP Entity ID Single Sign-on Endpoint (IDP URL) Single Log-out Endpoint X509 Certificate (public key) Description Display name for your SSO service. This label will appear on the apme login page. apme supports the ability to configure SSO using a Metadata URL, Metadata file or using manual configuration settings. Name of your IDP IDP URL If the IDP support SLO, enter the URL here Certificate from IDP akkadian Provisioning Manager Express Version Release Notes 7/11/

32 Unity Connection Support for Multiple Alternate Extensions apme 4.10 introduces support for adding and editing multiple alternate extensions in Cisco Unity Connection. The Alternate Extension section in Unity Templates has been updated with the ability to add multiple alternate extensions. The Alternate Extension section in Unity Edit Templates has been updated with the ability to edit multiple alternate extensions. akkadian Provisioning Manager Express Version Release Notes 7/11/

33 Unity Connection Scheduled Voice Mail Box Deletion Many organizations have a policy to maintain voice mail accounts for a period after a user s departure. apme 4.10 adds support for scheduling or delaying voice mail deletion for a configurable number of days. The feature is optional and must be enabled. To Enable Scheduled Voice Mail Box Deletion: 1. Select Service Groups from the System menu. 2. Select the appropriate Service Group. 3. Navigate to the CUCM Voice Mailbox Scheduled Delete Service section. 4. Check the Enable CUC Voice Mailbox Schedule Delete. 5. Enable/Disable the appropriate security options. 6. Specify the number of days to maintain the voice mail account. 7. Check the Send Notification box and provide an address to receive notifications when voice mail accounts deletes are processed akkadian Provisioning Manager Express Version Release Notes 7/11/

34 8. When finished, click Save 9. On the appropriate Unity Edit Templates, check the Enable CUC Voice Mailbox Scheduled Delete box to activate the feature for all Jobs using the Template. The schedule voic box delete feature is now active. When you execute any Job using a Unity Delete Template with the feature enabled, a confirmation message will appear after the Job is processed. akkadian Provisioning Manager Express Version Release Notes 7/11/

35 Administrator may view the status of scheduled voice mail deletions by going to the System menu and then selecting Voice Mail Schedule. Administrator can also cancel scheduled voice mail deletions, but once they are cancelled, they can only be rescheduled by rerunning the Job. System Global Variables apme 4.10 introduces System Global Variables (SGV), which expand upon the functionality provided by Global Variables. The purpose of SGVs is to leverage dynamic provisioning data in multiple fields without having to input the data multiples times. With apme 4.10, SGVs initially support the Directory Number field, providing the ability to use the Directory Number as a variable in any template. To Enable System Global Variables: 1. Select Global Variables from the System menu 2. Click Add. 3. Select System from the Global Variable Type drop-down. 4. Configure the System Global Variables settings: Field Directory Number System Global Variable Name Directory Number System Global Variable Instances Enable System Global Variables Service Groups Description This is the name that will be displayed for the Global Variable. This is the number of instances. This should typically correlate to the number of lines you typically provision. In most environments, 5 instances should be more than sufficient. This enables System Global Variables. Select the Service Groups for which System Global Variables should be activated. By default, all service groups are selected. akkadian Provisioning Manager Express Version Release Notes 7/11/

36 5. When finished, click Save to apply the changes. akkadian Provisioning Manager Express Version Release Notes 7/11/

37 Feature Enhancements Visual Phone Editor Enhancements Visual Phone Editor now supports Device Profiles in addition to Cisco Hard Phones. Using Visual Phone Editor: 6. Select Visual Phone Editor from the Actions menu 7. Select the appropriate Service Group 8. Search for and select the device to edit 9. Perform the desired edit actions using Visual Phone Editor 10. When finished, click to apply the changes akkadian Provisioning Manager Express Version Release Notes 7/11/

38 Mobility User ID Field Added option to assign the Mobility User ID to applicable device templates. The options functions similarly to the Assign Owner User Id option. Disable End User Device Association Added the option to prevent a device from being associated to an end user even if a user is included in the provisioning Job. Unity Connection Templates Unified Messaging Support Added support for enabling and configuring Unified Messaging Account settings in Unity Templates. akkadian Provisioning Manager Express Version Release Notes 7/11/

39 Unity Edit Template Unified Messaging Account Settings Unity Edit Template Unified Messaging Account Settings Product Specific Cisco Support Field Added the Cisco Support Field to Product Specific Settings for applicable devices. akkadian Provisioning Manager Express Version Release Notes 7/11/

40 Product Specific Proximity Added Proximity settings to Product Specific Settings for applicable devices. Site Templates End User Department Field Added the Department Field to the End User section of Site Templates. Site Templates Rerouting Calling Search Space Added Rerouting Calling Search Space field for devices in Site Templates. WebEx Templates Callback Support Added support for callback settings in the WebEx Template. Requires WebEx service version WBS 32+. DN Pool Support for +E.164 Alternate Number Mask Added ability to us the DN Pool External Phone Number Mask to auto-populate the +E.164 Alternate Number Mask in CUCM. akkadian Provisioning Manager Express Version Release Notes 7/11/

41 Edit Line Template Set Unassigned Line as Active Added support in Edit Line Template to mark unassigned lines as active. When this option is enabled, if a line is removed from all devices, the line will be set as active in CUCM. Edit Line Template DN Aging Added support for DN Aging for Edit Line Templates. When this feature is enabled on an Edit Line Template used in a provision Job and the line is removed from all devices, the DN will be included in the DN aging process. akkadian Provisioning Manager Express Version Release Notes 7/11/

42 Resolved Caveats Tracking Number PME-3610 PME-3634 PME-3578 PME-3639 PME-3644 PME-3645 PME-3655 PME-3661 PME-3555 PME-3566 PME-3586 PME-3602 PME-3603 PME-3605 PME-3640 PME-3604 PME-3637 PME-3572 PME-3615 PME-3396 PME-3594 PME-3564 Description Unable to access Webex Server due to string could not be parsed as XML Error DN Pool Error when Provisioning due to DN Auto Assignment with E164 Prefix and Exceptions List Enabled Jobs intermittently stuck on searching for DN when using DN Pools Self-service not copying all settings for same phone models Calling Party Transformation CSS field(s) in Edit Phone template not working Unable to see Global Variables for Speed Dial settings when Adding Device Profile Product Specific Configuration Layout settings do not work on 8800 series phones Edit User Template/Job Clears the Self-Service User ID field Unable to provision RD with just numbers MAC templates Intercom showing wrong CSS for Intercom Updated page permission to prevent unauthorized access Switching phone button template in Visual Phone Editor leaves traces of previous button template Logs showing multiple calls to function get Server MAC Error in Visual Phone Editor when editing BLF Overwrite existing Unassigned DN does not work when Partition is blank in Line Template and using Site Template with Line Partition Visual Phone Editor - Unable to disassociate BLF Speed Dial from device Visual Phone Editor Can disassociate Intercom Visual Phone Editor will not load devices using non-device specific phone button templates Error when removing Edit Line Templates from provision job Job will not complete when Job contains only add LDAP User Template Adding a phone when the primary line is shared fails Jobs status details are not being logged in certain cases akkadian Provisioning Manager Express Version Release Notes 7/11/

43 Upgrade Notes Akkadian Labs does extensive testing on all our upgrades, but we suggest you take the following precautions before upgrading. 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 a safe location Take a VMWare Snapshot (Optional): This step is optional, but it will allow you to easily roll back to the previous version without having to redeploy the apme OVA. 17. Power down the apme Virtual Machine 18. Right click on the Virtual Machine and select > Snapshot > Take Snapshot. 19. Type a name for the snapshot. 20. Type a description for the snapshot. Please note starting with version , apme is no longer supported on Windows. apme for Windows can easily be migrated to Linux using the backup and restore process. All clusters, including Unity Connection must be synchronized after performing the upgrade or provisioning will not function properly Support for Upgrading from Previous Versions of apme apme supports direct upgrades from the following version of apme: apme and above akkadian Provisioning Manager Express Version Release Notes 7/11/

44 apme supports upgrades from the following version of apme with the addition of a pre-upgrade patch: apme apme apme , , & Prior to upgrading from any release requiring the pre-upgrade patch, please download the respective patch here: apme for Windows - Download Patch here apme for Linux- Download Patch here akkadian Provisioning Manager Express Version Release Notes 7/11/

45 New and Changed Features Visual Phone Editor Enhancement Visual Phone Editor has been updated to support moving Line 1. Using Visual Phone Editor: 11. Select Visual Phone Editor from the Actions menu 12. Select the appropriate Service Group 13. Search for and select the device to edit 14. Perform the desired edit actions using Visual Phone Editor 15. When finished, click to apply the changes akkadian Provisioning Manager Express Version Release Notes 7/11/

46 Resolved Caveats Tracking Number PME-3541 PME-3519 Description Existing Line on Device settings not populating for bridged appearances Unable to login to apme using Internet Explorer Adding new device when using Edit User Template as parent fails PME-3547 to associate device to CUCM end user Delete source end-user after swap causes LDAP User to be PME-3522 Inactive PME-3512 Unable to Add Local Unity User on CUC version 11.5 GVs are not displaying on for Edit Templates when using Line PME-3544 Group in job New line not available as primary extension option when using PME-3545 Line Group in job Unable to import Site Templates with the same name across Service PME-3546 PME-3529 PME-3559 Groups Add individual security options for Device Swap and End User Swap Visual Phone Editor can move certain lines when Intercoms are present akkadian Provisioning Manager Express Version Release Notes 7/11/

47 New and Changed Features Visual Phone Editor Enhancement Visual Phone Editor has been updated to support editing Speed Dials. Visual Phone Editor Features: Changing the phone button template for device Associating existing lines to the device Editing Speed Dial and BLF Speed Dials Editing the Line on Device settings Modifying line positions using drag and drop Modifying speed dial positions using drag and drop Using Visual Phone Editor: 16. Select Visual Phone Editor from the Actions menu 17. Select the appropriate Service Group 18. Search for and select the device to edit 19. Perform the desired edit actions using Visual Phone Editor 20. When finished, click to apply the changes akkadian Provisioning Manager Express Version Release Notes 7/11/

48 Resolved Caveats Tracking Number PME-3500 PME-3535 PME-3537 PME-3316 Description Display and log error when unable to find Importable Unity User. Global Variable - Input Validation is currently not saving Self-provisioning service is not functioning Cannot log into apme after deleting default LDAP agreement akkadian Provisioning Manager Express Version Release Notes 7/11/

49 New and Changed Features Visual Phone Editor Visual Phone Editor provides the ability to visually edit a device. This tool can be very useful when editing phones with add-on modules containing bridged line appearances. Visual Phone Editor supports the following functions: Changing the phone button template for device Associating existing lines to the device Editing the Line on Device settings Modifying line positions using drag and drop Modifying speed dial positions using drag and drop Using Visual Phone Editor: 21. Select Visual Phone Editor from the Actions menu 22. Select the appropriate Service Group 23. Search for and select the device to edit 24. Perform the desired edit actions using Visual Phone Editor 25. When finished, click to apply the changes Figure akkadian Provisioning Manager Express Version Release Notes 7/11/

50 Additional Swap Support The Phone Swap feature has been renamed to Swap and expanded to support, phones, device profiles and end users. The Swap feature migrates configurations between: Devices swap phones or device profiles of the same or different model Users migrate device associations and ownership to a new user 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. Performing a Device Swap: 1. Select Swap from the Actions menu. 2. Select the appropriate Service Group. akkadian Provisioning Manager Express Version Release Notes 7/11/

51 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. 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 User Swap Feature The End User Swap tool provides the ability to migrate all line and device associations from one user to another. akkadian Provisioning Manager Express Version Release Notes 7/11/

52 Performing a User Swap: 7. Select Swap from the Actions menu. 8. Select the End-User Swap Form Tab. 9. Select the appropriate Service Group. 10. Select the Source End User. 11. If you wish to delete the source user upon successful completion of the swap, select the Delete source end-user after swap checkbox. 12. 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. 13. Click Perform to complete the swap. Figure Device Profile Swap akkadian Provisioning Manager Express Version Release Notes 7/11/

53 DN Synchronization to Microsoft Active Directory apme now supports the ability to push a telephone number to Active Directory. apme uses LDAP to update the Active Directory attribute of the provisioned user s directory number. To configure apme to use this feature: Step 1 Configure an LDAP agreement with write access to an LDAP Base URL containing the users that will be updated. If there is already an LDAP agreement that meets these requirements, proceed to Step Log into apme as PMEAdmin 2. Select LDAP from the System menu 3. Click Add to add a new LDAP agreement 4. Configure the LDAP settings for your environment and click Save LDAP Configuration Field LDAP Config Name Base Server Port Username Password Username Bind Attribute Description Enter a name to identify this specific LDAP configuration Enter the LDAP search base. Ensure search base contains users that will be updated. The LDAP server IP address or DNS name Enter the LDAP server port number Enter the LDAP Username used to authenticate to the LDAP server Enter the LDAP Password used to authenticate to the LDAP server Enter LDAP Attribute to bind to Username during authentication Step 2 Enable the DN Synchronization to Active Directory feature on the Service Group. 1. Select Service Group from the System menu 2. Select the appropriate Service Group 3. Scroll down to the DN Synchronization to Active Directory section 4. Complete the fields as shown in the table below akkadian Provisioning Manager Express Version Release Notes 7/11/

54 DN Synchronization to Active Directory Enable DN synchronization to Active Directory LDAP server Username Bind Attribute LDAP Update Attribute Check this box to enable the feature Select the LDAP agreement to use for the sync. The user in the LDAP agreement must have write privileges. Specify the LDAP attribute used to bind or locate the user. This must match the username being provisioned by apme to function. This is the attribute in LDAP that will updated. This is typically telephonenumber or ipphone in Active Directory. Example configuration Step 3 The last step is to configure DN Synchronization to Active Directory on a Site Template. This feature can be enabled on as many Site Templates as necessary. When the feature is enabled on a Site Template, whenever the Site Template is used to provision it will attempt to update the matching user in Active Director. If the apme username cannot be matched to the LDAP bind username in Active Directory, the action will be ignored and the job will continue to process. To configure the Site Template: 1. Select Site Template from the Templates menu 2. Select the appropriate Site Template 3. Scroll down to the DN Synchronization to Active Directory section 4. Complete the fields as shown in the table below akkadian Provisioning Manager Express Version Release Notes 7/11/

55 DN synchronization to Active Directory Enable DN synchronization to Active Directory Enable Synchronization Rules DN Begins With Discard Digits Prefix 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 Matches DN in to apply the rule The number of digits to discard from left to right Digits to prefix. Applied after the digits are discarded. Device Overwrite Enhancement The device overwrite feature has been enhanced to overwrite the following fields: Phone Description Phone Load Name Packet Capture Duration Information Directory Messages Services Authentication Server Proxy Server Idle Idle Timer(seconds) Secure Authentication URL Secure Directory URL Secure Idle URL Secure Information URL Secure Messages URL Secure Services URL Secure Shell User Secure Shell password akkadian Provisioning Manager Express Version Release Notes 7/11/

56 Personal Audit Report Users are now presented with a personal audit trail upon login to apme. The audit trail contains all provisioning actions for the logged in user. The audit trail can be accessed anytime by click on the akkadian Provisioning Manager Express in the upper left-hand corner of the screen. akkadian Provisioning Manager Express Version Release Notes 7/11/

57 Cisco VG300 Series Gateway Support apme 4.9 adds support for provisioning VG300 series analog gateways. As with support for other analog gateways, the gateway must be fully configured in CUCM before apme can manage the ports. Support has been added for the following VG3XX models: VG310 VG320 VG350 Global Variable List Enhancement The Global Variable List feature has been enhanced to include a Display Name and Value field. The Display Name value will appear in the Global Variable drop-down page, but the Value will be applied to the provision. akkadian Provisioning Manager Express Version Release Notes 7/11/

58 Unity Application Server Synchronization Prior to apme 4.9, Unity Connection did not synchronize any data to the apme database. Starting with version 4.9, Unity Connection now synchronizes certain data to apme to support template import and export. Unity Connection end user data is not synchronized as part of this process. Application Server Synchronization Scheduling Enhancement The apme 4.9 application server synchronization scheduling feature has been enhanced to include the ability to set the time and day(s) to perform application server synchronization. An notification can now be sent upon a successful and or failed application server sync. akkadian Provisioning Manager Express Version Release Notes 7/11/

59 DN Pool Reporting apme 4.9 now includes DN Pool usage reporting. This feature provides the percentage of available directory numbers within a DN Pool. In addition to providing usage data, apme 4.9 provides the ability to send DN Usage Reports via and the ability to customize threshold color indicators. DN Usage reporting configuration settings must be configured at the Service Group level. To Configure DN Reporting Configuration options: 1. Select Service Groups from the System menu 2. Click on the Service Group 3. Scroll down to the DN Reporting Configuration section 4. Configure the options as shown in the table below DN Pool Reporting Configuration Specify what time the DN Pool usage Set Time information should be updated from CUCM. Select which days the DN Pool usage Set Days information from be updated from CUCM. Send Specify an address to which the system Notification will send usage warning. Set the respective thresholds for DN pool Usage Levels warning levels. akkadian Provisioning Manager Express Version Release Notes 7/11/

60 Job Templates Device Groups apme 4.9 adds support for Device Groups in Job Templates. Device Groups provide the ability to select one or more devices during the provisioning process. The Device Group alleviates the need to create one Job for each device type, instead allowing the provisioner to select the device(s) at provision time. Using Device Group: Jobs may only contain one Phone Device Group Jobs may only contain one Device Profile Device Group Device Profile and Phone Device Groups may be used simultaneously within a Job Device Groups may be used in conjunction with standard Device and Device Profile Groups. Configuring Device Groups: 1. Select Job Builder from the Templates menu 2. Create or select an existing job akkadian Provisioning Manager Express Version Release Notes 7/11/

61 3. If you selected an existing job, click the checkbox to enable the feature 4. If creating a new job, add at least one phone template and then click on the checkbox to active the feature 5. Drag additional phone templates into the group 6. When finished configuring the job, click Save akkadian Provisioning Manager Express Version Release Notes 7/11/

62 Resolved Caveats Tracking Number PME-3446 PME-3454 PME-3476 PME-3478 PME-3482 PME-3483 PME-3486 PME-3498 PME-3505 PME-3510 Description Search is throwing error if all service groups are selected and one of the CUCMs is not available. Removed add-on module option from device that do not support add-on modules Not validating SMTP Username and Password Bulk Delete for End-user is not working Intercom templates line templates should only show Intercom CSS types Remove Auto Answer Off as an option in Intercom Template WebEx - Call-in-teleconferencing Section - Add support for selecting Toll & Toll Free option License Pool - Should assign license user when no userid is selected Phone Template not saving Service URL under Configure Phone Buttons Bulk add for Device Profile is not working akkadian Provisioning Manager Express Version Release Notes 7/11/

63 New and Changed Features Provisioning Manager Express contains no new or changed features. akkadian Provisioning Manager Express Version Release Notes 7/11/

64 Resolved Caveats Tracking Number PME-3463 Description Cross-Server Transfer Extension(URI) field replaced with zero after 4.8 update akkadian Provisioning Manager Express Version Release Notes 7/11/

65 Upgrade Notes Make sure you have a backup of apme before running the upgrade. The apme upgrade process preserves all data and does not require a server reboot. All clusters must be synchronized after performing the upgrade Support for Upgrading from Previous Versions of apme apme supports direct upgrades from the following version of apme: apme and above apme supports upgrades from the following version of apme with the addition of a pre-upgrade patch: apme apme apme , , & Prior to upgrading from any release requiring the pre-upgrade patch, please download the respective patch here: apme for Windows - Download Patch here apme for Linux- Download Patch here akkadian Provisioning Manager Express Version Release Notes 7/11/

66 New and Changed Features CUCM End User Database - LDAP Status Monitoring Provisioning Manager Express now includes the ability to monitor the CUCM end user database for Disabled LDAP Synchronized Users and take one or both of the following actions: 1. Send an notification 2. Deprovision the user This feature is not active by default and is only applicable when apme is integrated to a CUCM cluster using LDAP synchronization. To activate the LDAP Status Monitoring feature: 7. Select Service Groups from the System menu 8. Navigate to the CUCM End User Database - LDAP Status Monitoring section 9. Click the Enable LDAP Status Monitor checkbox to enable the feature 10. Set the polling Frequency. This is the frequency in hours that apme will query the CUCM end user database to check for disabled LDAP synchronized users. 11. Check the Send Notification Checkbox and provide a valid address for apme to send a notification when disabled LDAP users are located. 12. Check the Deprovision User 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 akkadian Provisioning Manager Express Version Release Notes 7/11/

67 Webex accounts Voice Mail (Unity) Deprovisioned item details will be included in the notification Client Matter & Forced Authorization Code Support Provisioning Manager Express now includes the ability to create, edit and delete Client Matter Codes (CMC) and Forced Authorization Codes (FAC). Client Matter & Forced Authorization Code Rules In CUCM, CMC and FACs have no logical association to end users, but apme can create a logical association using CMC and FAC Rules. The rules are used to create a link by using a common apme Global Variable between the user and the code. For example, if a CUCM end user s ID is bsmith, you might want to create a rule that configures the Client Matter Code description as CMC_bsmith. Let s say the Global Variable in the End User Template is {{LDAP User}}. The rule would be CMC_{{LDAP User}}. To configure Client Matter Code Rule: 1. Select Service Groups from the System menu 2. Navigate to the Client Matter Code Rule section 3. Check the Enable Client Matter Code Rules checkbox 4. Enter the Rule. In the case of CMCs, the rule will be used to populate the CMC description field. In most cases, the rule should have a prefix followed by same Global Variable (GV) used in the User Template Username Field. Example CMC_{{LDAP User}} To configure Forced Authorization Code Rule: 1. Select Service Groups from the System menu 2. Navigate to the Forced Authorization Code Rule section akkadian Provisioning Manager Express Version Release Notes 7/11/

68 3. Check the Enable Client Matter Code Rules checkbox 4. Enter the Rule. In the case of FACs, the rule will be used to populate the FAC name field. In most cases, the rule should have a prefix followed by same Global Variable (GV) used in the User Template Username Field. Example FAC_{{LDAP User}} For Client Matter or Forced Authorization Code rules to have any effect, they need to be configured on one or more apme End User Template. To configure Client Matter Codes on End User Template: 1. Select End User from the Templates menu 2. Navigate to the Client Matter Code section 3. Check the Enable Client Matter Code Creation checkbox 4. Enter a code or Global Variable in the Code field. In most cases you should use a Global Variable as CMCs must be unique in CUCM. 5. When Client Matter Code Rules are enabled on the Service Group the Description Field will not be editable. 6. Click Save when complete. To configure Forced Authorization Codes on End User Template: akkadian Provisioning Manager Express Version Release Notes 7/11/

69 1. Select End User from the Templates menu 2. Navigate to the Forced Authorization Code section 3. Check the Enable Forced Authorization Code Creation checkbox 4. When Forced Authorization Code Rules are enabled on the Service Group the Name Field will not be editable. 5. Enter a code or Global Variable in the Code field. In most cases you should use a Global Variable as FACs must be unique in CUCM. akkadian Provisioning Manager Express Version Release Notes 7/11/

70 Provisioning Enhancements Bulk Phone Swap apme now includes the ability to process Phone Swaps in bulk using a simple CSV template. To perform a Bulk Phone Swap: 5. Select Phone Swap from the Actions menu 6. Select the appropriate Service Group 7. 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. 8. Populate the Exported CSV Template and when complete, click the Import button to upload the template. 9. Upon uploading the Template, the system will process the phones swaps. Do no close your browser or navigate away from the page. 10. The process will complete and provide a summary of the processed items. Automatically Generate Dummy MAC address Support to automatically generate a unique dummy MAC address when provisioning. This feature will generate a dummy MAC using the Cisco supported BATXXXXXXXXXXXX MAC address format. This feature compliments the apme selfprovisioning service where users are provisioned with a Dummy MAC and can take ownership of a real device using our XML phone service. akkadian Provisioning Manager Express Version Release Notes 7/11/

71 View and Provision Results apme 4.8 now supports the ability to not only view the details of a provisioning action, but the ability to send those results with a summary or detail via . To view provisioning details: 1. After performing a provision, click on View Details 2. The Provision Detail window will open 3. Option 1 - Click on All Details to all the details of the provisioning action 4. Option 2 - Click on Summary to a summary of the provisioning action akkadian Provisioning Manager Express Version Release Notes 7/11/

72 5. Enter an address and optionally modify the content 6. When finished, click Send Overwrite Device Option When provisioning, apme now provides the option to overwrite an existing device. This means the same job can be used to add a user with a new device or akkadian Provisioning Manager Express Version Release Notes 7/11/

73 existing device of the same model and protocol, saving administrative overhead. If the device is not the same model and protocol, the overwrite existing device option will not appear. To overwrite and existing device: 1. Select a provision job with a template containing the same Model and Protocol as the target device 2. Enter the MAC address of the target device 3. The Existing Device warning will appear 4. Check the Overwrite existing data checkbox to overwrite the existing device 5. Check the Preserve current line associations checkbox to preserve the existing lines on the device Extension Mobility Auto-logout feature on Delete CUCM will not allow a Device Profile to be deleted when it is logged into a device. apme will now automatically logout the Device Profile from all devices before processing a delete. akkadian Provisioning Manager Express Version Release Notes 7/11/

74 Site Template Enhancements New Provisioning Options apme 4.8 adds several new provisioning options to Site Templates: Device Section Description Line Section Description This field provides the ability to configure the Device Description Field. This field does not support Global Variables. This field provides the ability to configure the Line Description Field. This field does not support Global Variables. External Phone Number Mask This field provides the ability to configure the External Phone Number Mask. This field does not support Global Variables. Line Groups This fields provides the ability to assign the line to one or multiple line groups. End User Section UC Service Profile This fields provides the ability to configure the end user UC Service Profile. Device Profile Section Extension Mobility This field provides the ability to configure the Device Cross Cluster CSS Profile Extension Mobility Cross Cluster CSS field. Unity Connection Section Alternate Extension This field provides the ability to configure the Alternate Partition Extension Partition field. akkadian Provisioning Manager Express Version Release Notes 7/11/

75 Site Template Bulk Import apme now provides the ability to import Site Templates in bulk using a CSV template. To bulk import Site Templates: 1. Select Site Templates from the Templates menu 2. Select the Site Template to use as the template 3. Click Export located in the upper right-hand corner to download the CSV template 4. Open the CSV template and populate with new site data 5. Save the CSV template to an accessible location 6. Return to Site Templates and click Import located in the upper righthand corner 7. Select the CSV file and click Upload to import. Select Overwrite Existing Templates to update existing Site Templates. akkadian Provisioning Manager Express Version Release Notes 7/11/

76 Provisioning User Interface Enhancements apme 4.8 adds several user interface enhancements. 1. The new Loading Modal provides enhanced status when apme is processing transactions. 2. The apply changes checkbox has been removed from all unnecessary provisioning actions. In certain actions, such as delete, the checkbox was unnecessary and was removed. 3. The Job description field adds the ability to provide an optional description to the Job and each template within the job. akkadian Provisioning Manager Express Version Release Notes 7/11/

77 Job Template Export and Import apme 4.8 adds support for exporting and importing Job Templates. Currently the Job export and import function uses the JSON format. JSON files can be manipulated using any standard text editor. The Job export/import function can be used to: Copy Jobs between different apme servers that share the same Template names Copy Jobs between Service Groups that share the same Template names Copy Jobs between different apme servers by modifying Template names Copy Jobs between Service Groups by modifying Template names Modifying existing Jobs by exporting the Job, modifying and importing with a different Job name To export Job Templates: 1. Select Jobs from the Templates menu 2. Select and open the Job to export 3. Click Export located in the upper right-hand corner to download the export file Editing Job Template Export File: 1. Open the Job Template export file 2. When the Job Template was exported, the Job name was removed to prevent the duplication attempts. To import the Job file, at minimum, the new Job Template name must be configured in the akkadian Provisioning Manager Express Version Release Notes 7/11/

78 export file. Populate the new Job name between the quotes after the name attribute as shown below. 3. Update any other desired attributes, such as template names, but ensure all values are valid or the import will fail. 4. Multiple Job Templates may be imported using the same file by creating an array. To create an array, the file must begin a [, end with a ] and each Job Template JSON string must be separated by a comma. Reference the examples below for details. Example of a one Job Template in a single JSON import file: {"name":"add Phone1","servicegroup_id":"US Cluster","job_access":"Administrator","job":[{"element":"phone","name":"Loc 7 - Common Area Phone","element_id":"device ","parent":null}]} Example of two Job Templates in a single JSON import file: 5. When finished, save the import file To import Job Templates: 1. Select Jobs from the Templates menu 2. Click Import located in the upper right-hand akkadian Provisioning Manager Express Version Release Notes 7/11/