Bulk User Disable / Package Cancel Tool

Owned by Mahnoor Khan (Deactivated)
Last updated: Jul 23, 2021 by Greg Walsh
3 min read

 

This article describes the bulk user disable tool that is available from LogiSense upon request.

Alert: Ensure that this utility is tested in a development environment before proceeding to use it on a production system

To Disable Users In Bulk:

  1. Request latest utility for LogiSense Customer Care - support@logisense.com.

  2. Extract the zip file to the EngageIP billing folder, i.e.: C\:Program Files\EngageIP\BulkUserCancelUtility. See file attached at bottom of article.

  3. Copy all files from EngageIP/Adminportal/bin folder, paste them into / overtop of the BulkUserCancel files and folder - The dlls from your current release of EngageIP are required for the EXE itself to use. NOTE: This will need to be updated if EngageIP is upgraded.

  4. Update the config file

    1. with the connection string, you can find the encrypted string in the registry located here: [HKEY_LOCAL_MACHINESOFTWAREEngageIPParameters] . Double click the entry called 'BOSS', copy the encrypted string and paste into the config file overtop the existing string (between the quotes)

    2. Update the keys (options) as required. Options defaults for 'CancelUserWithCreditBack' (Yes or No), CancelStatus (this should be the label assigned to your cancel status on the Setup tab), and 'IgnorePackages' (Yes or NO)

  5. Enter list of users into the 'UsersToDisable.txt' file in the same directory. See txt file for the format. Its simply a list of users vertically

  6. Backup database  - BOSS

  7. Double click BulkCancelUser.exe               - the below screen will come up

     

  8. Click Browse button, select the UsersToDelete.txt file

  9. Select the cancel option 'Immediately With No Transaction' (no need to select date, that setting is for the final option)

  10. Select the check box for the cancelation of packages or credit back as required

  11. Click Run

  12. Wait for the EXE to pop up a message that the process is complete

To Disable / Cancel Services:

  1. Check the check box at the bottom to only cancel packages related to the users in your list (this check box does not appear in the above image as of the writing of this article)

  2. Update text file with list of parent accounts (note that sub account packages will be cancelled as well when parent accounts are listed)

  3. Select cancel option

  4. Click Run (this process assumes the bulk cancel tool was installed as per the first process outline with the update of dlls, etc.)

If there are any errors, they will be displayed in a log file in a 'Log' folder in the same directory as the EXE: BulkCancelUserErrors.log . The errors may look like below, in which case you should confirm that the name is accurate.

Couldn't find username: user1
Couldn't find username: user2
Couldn't find username: user3

Its best to confirm the users are cancelled by using the accounts report in EngageIP or reviewing some known accounts. They may not immediately show as disabled however, as the process may take a little time as well. Depending on the number of users, the Event Manager will need to process them one by one as in the case where you are disabling as of a date. It may take from 1 minute to 30+ minutes depending on that number.