Cisco Unity Tools

3.x Tools

Home General Tools Documents 3.x Tools CUC 2.x/7.x Tools 4.x/5.x/7.x Tools CUC 1.x Tools All Downloads Code Samples Links

 

The tools on this page are written and tested for versions of Unity 3.0(1) and later.  Head to the other tools pages to get the appropriate version tool for your system.

NOTE: Unity 3.1.x versions of Unity are no longer TAC supported.  You must upgrade to 4.1(x) or later to receive active support.  The existing 3.x tools will remain available for download, however updates/fixes to tools specific to 3.x and earlier versions of Unity will no longer be done.

Each tool is noted as being TAC supported or not.  Any tool not supported by TAC I will do my best to help you with personally if you post to the Unity Forum. It should be understood, however, that these are "use at your own risk" tools.  Regardless of if you're using a supported tool or a "use at your own risk" tool, please be sure to try these out on a test system until you're comfortable with how they work before using them on a "live" system... let's be safe out there, people.

If you have suggestions for modifications for any of these applications or have ideas for additional tools you think would be handy, please post to the Unity Forum and let me know about it.  Most of these tools have been developed based on suggestions from the field.

Installable Applications

These are all installable applications, most of  which are designed to be run directly on the server where Unity is installed, some can run off box.  Most are also designed to be run while logged in as the same account that installed Unity as well.   Those applications that can run off box usually have a larger setup since they'll require some additional runtime libraries that are included in the Unity setup.

Check back for updates often as I keep these updated fairly regularly.  The home page has a running list of all the changes/updates to the site.

Here's a list of all downloads in alphabetical order

Directory Walker

Utility to check for errors and missing links in the directory.  Performs the same checks that SysCheck does (plus a few additional ones) and generates log output file for you.  It also gives you the option to automatically fix some of the more common errors encountered.

NOTE: This version is updated and goes straight to SQL and, as such, will not work on 2.x versions of Unity.  The older version of dbWalker available on the Unity 2.x tools page should be used.

BulkEdit

 

Tool that lets you change just about any setting on large groups of subscribers or call handlers quickly.

NOTE: This version of BulkEdit does work with both 3.0 and 2.x versions of Unity, however I have only tested it with 3.0 and 2.4.6.  If you're running an older version of Unity you should use the BulkEdit utility off the "2.x Tools" page.

BulkUserLogout

This tool allows administrators tolog Unity out of large numbers of subscriber's mailboxes so they can then move their Exchange mailboxes without having to shut down Unity or log them out one at a time using DOHPropTest.  After the move is complete you can then use this same utility to force Unity to log back into these mailboxes so MWIs and notifications will work for these users properly.

NOTE: You only need to use this tool if your back end is Exchange 5.5.  Exchange 2000 handles moving users "on the fly" and there's no need to log Unity out of those mailboxes first.

Subscriber Information Dump

A little utility to generate CSV files using subscriber data.  This is intended to provide a way to get at directory information that's not available in the current set of Unity reports.  Items such as fax IDs, first time enrollment status, Exchange home server name etc... are available for selection.  This version also includes options for dumping out alternate extension and MWI information specific to Unity 3.0.

NOTE: This version does not work with 2.x versions of Unity any longer, you will need to use the version on the 2.x tools page

Uninstall Utility

 

 

This tool will remove all Unity related files from the hard drive, registry and Exchange directory.  After running this you should be able to reboot and install a clean version of Unity with no worries about any conflicts with existing files.  It will not touch items in the Exchange directory associated with other Unity servers that may be installed into the same Exchange site. 

 

NOTE: There are a couple of manual steps involved here, be sure to read the help and follow the on screen instructions.

Public Distribution List Builder

 

Handy application that will let you quickly add subscribers to a new or an existing Public Distribution List.  You can select all users associated with a COS, an extension range, pull users by alias and/or extension from a CSV file, cherry pick them from a grid or all of the above.

NOTE: This version works with both 2.x and 3.0 versions of Unity.

Disaster Recovery Tools (DiRT) These tools allow you to back up and restore Unity specific data including SQL databases, registry settings, greetings/voice names, switch file configuration, routing rules, subscriber passwords etc... and then restore that information onto a clean Unity box.  This is handy for basic disaster recovery or if you want to change the server Unity is running on etc... This updated version includes an option to backup subscriber messages as well.

There are two tools, one for backup and one for restore.  The backup is integrated with the windows scheduler and will write status/warning/error information messages to the event log such that you can do regular backups at off hours as regularly as you like.

Restores can be done onto a server of a different name, different install paths/partition configuration, domains etc...

NOTE: PLEASE read the ENTIRE help file before using these tools.

Global Subscriber Manager The Global Subscriber Manager (GSM) allows you to see all Unity subscribers in your organization regardless of how many Unity servers, dialing domains etc... you have deployed in your organization.  If they are in the same directory you can see them here.

You'll be shown a "tree view"  you the option to view all subscribers, only subscriber in a dialing domain or subscriber on a specific Unity server.  This will provide an easy way to see your "Unity topology" at a glance.  Double click on a user in the grid and it'll launch the SA and take you to the profile page for that subscriber directly regardless of which server they reside on.

This tool is ideal for sites with multiple servers and/or dialing domains and is also very useful for just single server installations.  If your finding/editing subscribers you'll find this is an order of magnitude faster than using the SA directly.  This can run on or off the Unity server.

Audio Text Manager 3

 

This tool gives you a graphical way to manage your call handlers, interviewers and subscribers and link them together.  This is a more sophisticated "read/write" version of the "AT Viewer" application on the 2.x tools page that lets you record greetings, set one key links, create new call handlers etc... using a tree view control or a grid control, whatever you prefer.  This makes it much easier to see what you're doing and understanding how objects link together.

Check out the new 30 minute video training for the ATM utility!  You'll be seeing more of these types of training videos moving foward.

Port Usage Analyzer This is a much nicer version of the clunky report I put together for 2.x systems.  Unity 3.1(4) has proper logging to handle more specific breakdowns of use trending here so I can generate reports that show port usage based on dialouts for various reasons (MWI, notification, AMIS delivery, TRAP connections) and inbound traffic.  Indications of how many ports were available to take calls at any given time and the like will be graphed so you can easily see if you're in danger of running out of ports during peak times.
Remove Subscriber Properties

(formerly known as "BunnyKiller")

Steve Prentice from our CPR group makes his AnswerMonkey debut with this application to clean subscriber properties off mail users in Exchange 2000.  Since Ex2K does not have a "raw mode" built into it like Exchange 5.5. does you have to use ADSI edit to clean off subscriber properties from users left stranded by an improper uninstall of Unity or the like.  This tool allows you to easily navigate your AD containers, find users marked as subscriber and "clean" them so they can be imported into Unity again.

WARNING!  This tool will clean any mail user you point it at!  Make sure you know what you're doing... there is NO undo if you accidentally clean the wrong subscriber.

Set Volume Todd in the MIU group helped out making a utility to move the dB level of standing greetings and voice names to a target level.  

The default record level for Unity 3.1(1) is -26 dB with the snappy new AGC capability.  Greetings and voice names recorded prior to upgrading to 3.1(1) will likely sound a louder than that since AGC only works when recording new files.  This tool will allow you to set your old greetings and voice names to -26 dB as well without having to rerecord them. It's ok to run this on all your greetings, even if they're already recorded at -26 dB.  Files already at that volume level wont be changed.

NOTE: This tool will not run via WTS

External User Import This is a tool that ships with Unity 3.1(2) and later.  It's designed to allow you to import AMIS and Unity Bridge recipients from information in a CSV file.
Schedule Unity Restart  Tool that allows you to schedule the restart of the Unity services or reboot the entire server.  This updated version writes information to the application event log while shutting down and restarting, maintains it's own text history log, offers the option to just restart Unity and not bounce the server and includes a built in interface to the Windows scheduler.

NOTE: this tool will only work on Win2K but will work with any version of Unity back to 2.3.4 build 104.  If you need to schedule restarts of an NT 4.0 system, use the restart tool found on the 2.x tools page. 

Bulk Handler Create

This tool allow administrators to create large number of call handlers using extension ranges and/or importing data from CSV files.

Now supports importing WAV files as greetings for call handlers when you're importing via CSV.

Permissions Wizard (3.0(x)-3.1(5))

Permissions Wizard (3.1(6))

A very handy wizard from applications team member Ken Wiebe.  This guy will help you configure you installation, service and fail-over accounts to have the correct Windows and AD permissions (it replaces a very large chunk of the manual rights granting section of the install guide).  If you're having problems successfully running the configuration setup portion of the Unity install for any reason then run, don't walk, to use this tool.  This will eventually find it's way into the Unity setup itself but for now it's a separate download.

The help file contains detailed information about which rights/permissions each account needs which can also be helpful for talking with customers.

NOTE: The permissions wizard for 3.1(6) is the same as the one that ships with Unity 4.0(1) and later - it works differently than the permissions wizard that ships with earlier versions of 3.x.  If you are running 3.1(6) be sure to use the newer one.

Bulk Subscriber Delete I've had several requests to post a tool that can delete large numbers of subscribers quickly without removing the Exchange mailbox or AD/NT accounts.  While it's kind of an unusual thing to need to do, turns out some Universities, for instance, have a need for this with large turn overs of subscribers where they don't want to blow away the accounts, just the subscriber data in Unity.  

Ask and ye shall receive.  This tool lets you select groups of subscribers by extension range, COS association, DL membership, switch assignment or imported from CSV and then delete their subscriber data in one shot.  Be careful.  There no "un do" option for this.

Set WAV Format The MIU folks coughed up a command line tool that lets you change the format of standing WAV files between 711 and 729a.  I dropped it into the same skin I used for the Set Volume tool (above) such that folks can change the format of all the greetings and voice names in the system over from 711 to 729a or back.

NOTE: This tool will not run via WTS

Codec Checker tool that reports the codec and sample rate for all greetings, voice names and prompts on your system.  Allows you to view in a sortable table format or export to CSV
IP Fax Config Wizard With the release of 12.2.8T from the IOS folks, it's now possible to do some simple gateway configuration to have all inbound faxes sent to a single mailbox with the DID and ANI information tucked nicely in the subject line.  We've written a service that watches a mailbox (i.e. the one you configure IOS to send faxes to) and will route inbound faxes to subscribers all fixed up with the appropriate message class and media flags to be picked up as a fax over the phone interface and from the desktop.

The IP Fax Configuration Wizard walks you through the options you need to configure to watch the right mailbox for faxes, decide where undeliverable faxes should go, how lookups by DID should work etc... 

Full Database Export/Import

These two utilities allow you to export the entire contents of a Unity installation as old as 2.3.4 build 104 and import that information into a clean install of Unity 3.x.  PLEASE read the help information closely and test them out on lab systems before deploying them in any kind of production environment.

NOTE: These are not the same export/import tools as are found on the 2.x tools page.  The import here will only import into a 3.x or 4.x system and the one on the 2.x tools page will only import into 2.4.6 systems.  TAC ONLY supports using Full DBImport/Export for migrating data from Unity 2.x to Unity 3.x/4.x systems.

NOTE: No, you cannot export data from a 3.x or a 4.x system with these tools.  See the DiRT utility above for that.

Alternate Extension Adder

Tool to add alternate extensions to subscribers via CSV

Migrate Subscriber Data

Tool that allows you to move subscriber information from one mail user in Exchange/AD onto another mail user.  This is useful for transitioning from VM only installs to UM installs and can also be used to "promote" AMIS, SMTP or Bridge users to full subscribers.

NEW.  New version supports moving subscriber messages from the old account to the new one as well as Unity properties

Cisco Unity Data Link Explorer (CUDLE) Read-only tool that lets you easily explore the UnityDB database in SQL.  Includes Data Dictionary information showing what all the columns and tables are used for.  Also includes automatic lookup functions for ObjectID values, allows jumps to those objects and a jump back feature to get back where you started quickly.

This now has a built in Query Builder tool similar to the SQL Query Analyzer tool that ships with SQL 2000.  Also included a view for stored procedures and lets you explore the Unity registry settings with explanations of what the keys mean.

Message Store Manager Tool that lets administrators manage their user's Exchange 5.5 or Exchange 2000 mail stores easily.  You can run scripts to move/delete messages based on easily configured rules, get robust report information about how storage spaces is being used and by whom etc... very handy application that ships with 4.0(1) but works with 3.1(1) and later.
Directory Access Diagnostics

Exchange 2000 only

Directory Access Diagnostics (DAD) is designed to help troubleshoot problems with adding new users or importing existing users from Exchange 2000.  DAD interrogates the rights of the directory facing accounts against the specific container (in the case of problems with a new add) or user (in the case of an import problem) in Active Directory and will give a complete report about which rights/permissions that account is coming up short on.

If you're having trouble adding or importing users in AD, this is definitely the first tool you want to reach for.

Set Subscriber Passwords Tool to force subscriber phone passwords based on a CSV file input.  This can be handy if you want to apply phone passwords in bulk after a large import or migration operation.  For instance you can use the last X digits of the user's SS number or part of an employee number or the like as their temporary password as opposed to leaving everyone at the "12345" default or having to email out randomly generated passwords.
Port Status Monitor This is an all new tool that's designed to replace the old StatusMonitor.exe tool.  This has a nicer interface, several new features and will work across WTS in all scenarios which causes the existing StatusMonitor.exe some trouble.

This tool will be shipping with 4.0(2) and will be in the Tools Depot.  The existing StatusMonitor.exe tool will continue shipping but will no longer be available in the tools depot.

Credentials Viewer This tool shows you all the mappings Unity keeps in the SIDHistory table (in 3.x) and the Credentials table (in 4.x) between accounts in NT/AD and subscribers in Unity.  It's a companion to GrantUnityAccess that will show ALL associations and allow you to remove any of them you wish (i.e. the ever-annoying second map to the installation account).  It also allows you to create a CSV file with all the current mapping information for you.
Event Monitoring Service This is a replacement for the old Error Notification Utility (ENU) that shipped with Unity in the past.  This tool is considerably more robust and reliable than the old ENU and it will replace the ENU in Unity 4.0(3) and later.  It is designed to work on any Unity system 3.1(1) and later and can be downloaded and installed on systems that are using ENU without causing a conflict.

Home | General Tools | Documents | 3.x Tools | 4.x/5.x/7.x Tools | CUC 1.x Tools |CUC 2.x/7.x Tools | All Downloads | Code Samples | Links

 

Questions or problems regarding this web site should be directed to lindborg@cisco.com
Copyright © 2007 Cisco Systems, Inc.  All rights reserved.

Last modified: 09/07/08.