EasyUC
4.8.7

EasyUC for Cisco

Copying, replacing, moving and deleting users

Quick tasks for staff changes, and the lists of new and deleted users.

EasyUC · Version 4.8.7

In EasyUC: EasyUC Cisco → Dashboard → Quick Tasks

What it is for

A staff change affects many objects in the CUCM: phones, lines, remote destinations, groups and the mailbox. The four quick tasks on the dashboard combine this work. Copy Enduser creates equivalent objects for a second user. Replace Enduser reassigns the objects of a user to the successor. Move Enduser hands phones over to another user. Delete Enduser removes the user together with the user's objects.

Each quick task first loads all objects of the user, lets you make a selection and, before the start, shows a review overview with action, object and side effect. The run processes the steps one after another and stops at the first error. You can retry or skip a failed step individually. The dialog stays open until the run has finished.

Two lists in the Users menu accompany this work. Users from Last Sync shows who the user scan has newly found in the CUCM. Users deleted in cucm shows deleted users, lets you clean up the devices and numbers they left behind, and restores users with their assignments.

Prerequisites

  • License module cucm.
  • Dashboard: ROLE_APP_DASHBOARD. Quick tasks: ROLE_APP_QUICK_TASKS. The role includes the required rights for users, devices, remote destinations, numbers and voicemail.
  • New users: ROLE_APP_VIEW_NEW_ENDUSER_PAGE.
  • Viewing deleted users: ROLE_APP_VIEW_DELETED_USER_PAGE. Cleaning up and marking as processed: ROLE_APP_UPDATE_DELETED_USER. Restoring: ROLE_APP_RESTORE_DELETED_USER. Only an administrator may start the LDAP sync from the restore dialog (ROLE_APP_LDAP_SYNC).
  • The source user and the target user are known. For a new target user you need location, template, user ID and phone number.
  • For desk phones that are copied or left behind, you have the new MAC address. For analog ports, the gateway and a free port are known.
  • The lists Users from Last Sync and Users deleted in cucm require a running user scan of the connection.

Step by step: copying a user

  1. Open EasyUC Cisco → Dashboard and click Copy Enduser in the Quick Tasks tile.
  2. On the left, under Select the Enduser that will be copied, select the source user. EasyUC loads the user's phones, analog ports, remote destinations, groups and mailbox.
  3. On the right, select Existing Enduser who will copy or Create new Enduser who will copy.
  4. For an existing target, select the user and check the Phone Number to add devices field. For a new target, fill in the creation form.
  5. On the left, tick the objects that are to be copied. The selection is enabled as soon as the target user is selected and loaded.
  6. For each desk phone enter the New Mac Address, for each virtual device the Forward Number, for each analog port Gateway and Port, and for each remote destination the New Mobile Number / Destination.
  7. Tick the question whether EasyUC should copy even if the phone number is already used by another user only if a shared line is intended.
  8. Click Start Copy.
  9. Read the review overview Copy from … to … and confirm with Start Copy.
  10. Follow the run. The status appears below each row. At the end, Result of the run shows the outcome.

Step by step: replacing a user

  1. On the dashboard, click Replace Enduser.
  2. On the left, under Select the Enduser that will be replaced, select the previous user.
  3. Decide between Keep the old line and Create a new line. For a new number, use Should EasyUC delete the old line too? to define whether the old line is removed.
  4. On the right, select Existing Enduser who will replace or Create new Enduser who will replace. The selection lists only users without controlled devices.
  5. For a new number, fill in the Phone Number to add devices field.
  6. Tick the objects that go to the successor: phones, analog ports, remote destinations, pickup groups, hunt groups and mailbox. Objects that are not selected stay with the old user.
  7. For each remote destination enter the New Mobile Number / Destination. For virtual devices with a new line you can specify a New forward destination (optional).
  8. Click Start Replace.
  9. Read the review overview. Tick I have checked the side effects marked in red. if it is required, and confirm with Start Replace.
  10. After the run, check both user profiles.

Step by step: moving phones to another user

  1. On the dashboard, click Move Enduser.
  2. On the left, in the field Select the Enduser that will be moved, select the user whose phones are handed over.
  3. Decide between Keep the old line and Create a new line.
  4. Tick the phones that are handed over. Only phones are handed over. Device profiles, remote destinations, voicemail, and analog and virtual devices stay with the previous user.
  5. If a desk phone is to remain at the old desk, set Spare Device and enter the MAC address of the new phone in the field Mac Address For Moved Device. The old phone is left behind without an owner.
  6. If required, define Change Description, Change Number and Change Namings for the spare device and fill in the associated fields New Description For Spare, New Number For Spare and New Line Naming For Spare.
  7. On the right, select Existing Enduser who will be moved to or Create new Enduser who will be moved to. For a new line, enter the number in the field Phone Number to move devices.
  8. Click Move selected devices or Create enduser and move devices. If the button is disabled, the note to its left names the missing step.
  9. Read the review overview Move devices from … to … and confirm.
  10. After the run, check the device list of both users and the call forwarding settings of the target user.

Step by step: deleting a user

  1. On the dashboard, click Delete Enduser.
  2. Under Select Enduser, select the user. EasyUC loads the user's objects into the sections Enduser, Lines, Devices, Remote Destinations and Voicemail.
  3. Check the notes above the list. If not everything could be loaded, missing objects are neither checked nor deleted.
  4. Decide for each object via the Delete checkbox. Devices that are also assigned to other users are not selected by default.
  5. Note the lock on lines: a line can only be deleted if all devices it is attached to are deleted in the same run.
  6. Leave Delete enduser … ticked if the user itself is to be removed as well.
  7. Click Delete.
  8. Read the review overview, tick I have checked the objects and the side effects. if it is required, and confirm with Delete.
  9. Before the first delete step, EasyUC backs up the user with its associations, then deletes the objects and finally the user, provided that no line is assigned to the user any more.
  10. Alternatively, you delete a local user without remaining configuration in the user profile via Delete and Yes, delete it.

Step by step: checking new users

  1. Open EasyUC Cisco → Users → Users from Last Sync. A red number at the menu item states the entries that have not been seen yet and disappears after the page has been opened.
  2. Read the note next to the date field. Without a date range, the page shows the users of the last scan together with its time.
  3. If required, select a period via the date field.
  4. Click Sync with CUCM now if you do not want to wait for the next scheduled scan. The sync reads all users of the active connection and updates new and deleted users.
  5. For each row, check origin, phone number, location and the columns Phone, Video, PC, iPhone, Android, Tablet and DP.
  6. If a user carries the Returning user badge, the user was deleted before. Click Restore instead of setting the user up again.

Step by step: cleaning up or restoring deleted users

  1. Open EasyUC Cisco → Users → Users deleted in cucm. The page is called Manage deleted users and has four tabs.
  2. Deleted in CUCM tab: it lists users that were removed directly in the CUCM or by the LDAP clean-up. The Where the number still lives column shows lines and devices that still exist.
  3. To clean up, click Delete in the row, or select several rows and click Delete at the top. In the Delete phones and numbers of deleted users dialog, select devices, device profiles and lines for each user.
  4. If required, set Also delete the voicemail box of the user ID (Unity Connection), if there is one and leave Move to "Processed" when nothing failed active. Start with Delete now.
  5. If nothing is to be deleted, click Processed in the row or Mark as processed at the top. The user moves to the Processed tab; nothing changes in the CUCM.
  6. Deleted in EasyUC tab: it lists users that were deleted via the user profile, a quick task or the API, with deletion time, administrator and backup. Select Restore or Do not restore.
  7. In the Restore user dialog, EasyUC creates a plan. In the sections Devices, Lines & primary extension, Profiles, Voicemail and Settings, select what is reassigned or created anew.
  8. If a local user is missing in the CUCM, set Create the user locally in the CUCM (from the backup) and define under Credentials how password and PIN are assigned. If an LDAP user is missing, first start Start LDAP sync.
  9. Click Restore. The dialog shows generated credentials once only. With Open report you read the result.
  10. Processed and Deletion log tabs: here you can review the history per user and every run with all details.

Fields and options

Fields and options
Field / actionMeaning and use
Copying: scopePer device, only line 1 is taken over; speed dials and BLF are not. A mailbox is created anew with the default template. Messages, greetings and settings of the source are not taken over.
New Mac AddressMAC address of the new desk phone for the target user. For desk phones, the Activation Code checkbox appears next to it if the model supports activation by code.
Forward NumberDestination to which a copied virtual device forwards all calls.
Gateway / PortAnalog gateway and port for a copied analog line.
New Mobile Number / DestinationDestination of the new remote destination or mobile identity. When replacing, the previous destination remains and is not deleted.
Phone Number to add devicesNumber of the line that the devices of the target user receive.
Keep the old line / Create a new lineDefines whether the line goes to the new user together with the device or the new user receives a line of its own.
Spare DeviceOnly when moving desk phones. A new device with the specified MAC address is created for the target user. The previous device remains as a spare device without an owner and continues to ring as long as it is registered and keeps its line.
Softphone when movingIf the target user already has a softphone of the same model, the softphone is deleted instead of moved.
Review overviewTable with Action, Object and Side effect. Irreversible side effects are additionally shown in red above the table.
Status per rowPending, Running, Successful, Failed, Skipped, Not executed.
Skip / RetryAppear at a failed row after the run. A skipped step can leave an incomplete state behind.
Sync with CUCM nowStarts the user scan of the active connection immediately. The button is disabled during the run.
Origin of deleted usersDeleted via EasyUC, Deleted in CUCM, LDAP clean-up of the CUCM or Origin unknown.
BackupBackup of … means that devices, lines and profiles of the user are backed up. Without a backup, the restore finds objects only by phone number and device name.
Credentials when restoringCUCM policy (default), Generate or Enter. For the PIN of an existing user, additionally Do not change. The old password and the old PIN cannot be restored.
Deletion logFilters Search, Status, Source, From, To. Export CSV downloads the filtered list. Show details opens the deletion report.

Check the result and troubleshoot

  • Success: Result of the run reports All selected objects were processed. Then check the source and target user in the profile.
  • Not all selected objects were processed. The reasons are listed below.: read the status of each row. The run stopped at the first error. appears at all steps that no longer ran afterwards.
  • The target enduser has no phone number. Devices and analog ports can only be copied with a number.: enter the number or maintain it at the target user.
  • Please enter the forward number of every selected virtual device. and Please enter the mobile number / destination of every selected remote destination.: required entries for a selected object are missing.
  • This device has no line and cannot be copied.: devices without a line remain untouched when copying, replacing and moving.
  • The new enduser could not be created. Nothing has been changed yet. or The enduser could not be created. No device was moved.: correct the creation form and start again.
  • A list could not be loaded. Reload it before starting.: click Reload or Load again.
  • The enduser was not deleted because it is synchronised from LDAP.: the quick task never deletes LDAP users. Remove the user in the directory.
  • The enduser was not deleted because lines are still assigned.: a line that is attached to a retained device is still assigned to the user.
  • Analog ports are neither shown nor deleted here.: lines at an analog port are kept. Clean up the port via the gateway administration.
  • You are not permitted to perform this step. A role is missing., The session has expired. Please sign in again., The server did not respond in time.: general errors of a step. After fixing the cause, continue with Retry.
  • Last sync failed next to Sync with CUCM now: the tooltip states the cause. Check the connection and the background jobs.
  • Restore: A restore of this user is already running., The CUCM refused or could not be reached., The user ID belongs to an application user meanwhile – the plan was refreshed. Select Refresh plan and check the note above the plan.
  • Badge User ID is back – another person?: an account with the same user ID but a different ObjectGUID exists in the CUCM. Confirm that it is the same person only after checking.

Related chapters