IdExchange 1.9.1
IdExchange 1.9.1
Breadcrumbs

IDMS Upgrade Procedures

IDMS System Upgrade Procedure

Purpose

This procedure upgrades the Identity Management System (IDMS) to the latest version. The upgrade updates the application files, database schema, and web interface while preserving existing configuration and data.

Estimated Time: 15-20 minutes
System Downtime: 20-30 minutes (during steps 2-9)
Permission Required: Local Administrator

Before Getting Started

Prerequisites Checklist

Ensure the following items are in place before beginning the upgrade:

  • [ ] IDMS is operational: Log into the IDMS portal using your system administrator credentials and verify you can access the main dashboard. If login fails, resolve connectivity issues before proceeding.

  • [ ] Database permissions verified: The IDMS service account must have ADD TABLE and ALTER TABLE permissions on the IDMS database.

  • [ ] Local administrator rights: You must have local administrator privileges on the IDMS application server (the server where IDMS is installed, typically the web server hosting the application).

    • To verify: Right-click Command Prompt and confirm you see "Run as administrator" option

  • [ ] Installation package available: The IDMS upgrade package has been downloaded and extracted to a known location on the IDMS server

  • [ ] Chrome or Edge browser available: You have access to Google Chrome or Microsoft Edge browser for post-upgrade verification

  • [ ] Backup storage identified: You have identified a secure location with at least 500 MB free space for the IDMS backup

What You'll Need

  • IDMS system administrator credentials

  • Access to the IDMS application server

  • IDMS upgrade installation package (typically named HIDPIVIDMS_X.X.X.zip)

  • Approximately 45-60 minutes of uninterrupted time

Step 1: Document Current System Version

Before making any changes, record the current IDMS version for verification purposes.

  1. Open your web browser and navigate to the IDMS portal (example: https://idms.yourcompany.com:444/idms)

  2. Log in using your IDMS system administrator credentials

  3. Click System in the top navigation menu

  4. Click Connections in the submenu

  5. Locate the System Version Number field and write down the complete version number (example: 1.10.17.0)

    image-20211208-130020.png

Expected Result: You have documented the current version number and confirmed IDMS is accessible.

Step 2: Stop the IIS Web Server

Stop the web server to prevent users from accessing IDMS during the upgrade.

  1. Press the Windows key on your keyboard

  2. Type cmd

  3. Right-click Command Prompt in the search results

  4. Click Run as administrator

  5. If prompted by User Account Control, click Yes

  6. In the command prompt window, type the following command and press Enter:

    iisreset /stop

  7. Wait for the message "Internet services successfully stopped"

Expected Result: The command prompt displays "Internet services successfully stopped" and IDMS is no longer accessible through the web browser.

Important: Keep this command prompt window open for later use.

Step 3: Locate the IDMS Installation Directory

Find the IDMS application folder that needs to be backed up.

  1. In File Explorer, navigate to one of the following locations:

    • C:\Program Files (x86)\CyberArmed\

    • C:\Program Files (x86)\HID Global\

  2. Open the folder that exists on your server (only one of these will be present, depending on your IDMS installation type)

  3. Verify you can see the IDMS folder inside

  4. Make note of the complete path for the next step

Expected Result: You have located the IDMS installation folder and confirmed its location.

Note: If neither folder exists, contact IDMS support before proceeding as this indicates a non-standard installation.

Step 4: Backup the Current IDMS Installation

Create a backup of the existing IDMS installation to enable rollback if needed.

  1. In File Explorer, navigate to the IDMS installation directory identified in Step 3

  2. Right-click the IDMS folder

  3. Click Copy

  4. Navigate to your designated backup location (example: C:\Backups\IDMS\)

  5. Right-click in the empty space and click Paste

  6. Right-click the copied IDMS folder

  7. Click Rename

  8. Rename the folder to include the current date and version number:

    • Format: IDMS_Backup_YYYYMMDD_v[version]

    • Example: IDMS_Backup_20241216_v1.10.17.0

  9. Press Enter to save the new name

  10. Open the backup folder and verify it contains subfolders and files

Expected Result: You have created a complete backup of the IDMS folder with the date and version in the folder name, and verified it contains the application files.

⚠️ CRITICAL: Do not proceed until you have verified the backup is complete and accessible. This backup is required for rollback if the upgrade fails.

Step 5: Run the IDMS Installer

Execute the IDMS upgrade installation package.

  1. In File Explorer, navigate to the location where you extracted the IDMS upgrade package

  2. Open the IDMS Upgrade folder

  3. Open the Installer folder

  4. Locate the file named IdmsIis.msi

  5. Make note of the complete path to this file (example: C:\Temp\HIDPIVIDMS_x.x.x.x\IDMS Upgrade\Installer\IdmsIis.msi)

  6. Return to the administrative command prompt window from Step 2

  7. Type cd followed by the path to the Installer folder (example: cd C:\Temp\IDMS_Upgrade_v6.0\IDMS Upgrade\Installer\)

  8. Press Enter

  9. Type the following command and press Enter:

    IdmsIis.msi

  10. The IDMS installation wizard will open

  11. Follow the on-screen prompts and click Next through the installation wizard

Expected Result: The installation wizard completes successfully and displays "Installation Complete" with no error messages.

Step 6: Update IDMS Configuration

Run the configuration assistant to update the IDMS settings and database schema.

  1. Press the Windows key on your keyboard

  2. Type IDMS Configuration Assistant

  3. In the search results, locate IDMS Configuration Assistant

  4. Right-click IDMS Configuration Assistant

  5. Click Run as administrator

    image-20251216-141340.png

  6. If prompted by User Account Control, click Yes

  7. Wait for the IDMS Configuration Assistant window to open (5-10 seconds)

  8. In the Configuration Assistant window, click the Update IDMS Configuration button

    image-20251216-141549.png

  9. Wait while the configuration updates (typically 2-5 minutes)

    • You will see a progress indicator

    • Do not close the window during this process

  10. When the update completes, you will see a message "Configuration update completed successfully"

  11. Click OK to acknowledge the message

  12. Click the X button in the top-right corner to close the IDMS Configuration Assistant

Expected Result: The Configuration Assistant displays "Configuration update completed successfully" and closes without errors.

Step 7: Restart the IIS Web Server

Restart the web server to make IDMS available with the upgraded version.

  1. Return to the administrative command prompt window

  2. Type the following command and press Enter:

    iisreset /restart

  3. Wait for the message "Internet services successfully restarted"

Expected Result: The command prompt displays "Internet services successfully restarted" with no error messages.

Step 8: Verify the Upgrade

Confirm the IDMS upgrade was successful by checking the system version.

  1. Open a new Incognito window in Google Chrome (press Ctrl+Shift+N) or a new InPrivate window in Microsoft Edge (press Ctrl+Shift+P)

  2. Navigate to the IDMS portal (example: https://idms.yourcompany.com:444/IDMS)

  3. Log in using your IDMS system administrator credentials

  4. Click System in the top navigation menu

  5. Click Connections in the submenu

  6. Locate the System Version Number field

  7. Compare this version number to the version you documented in Step 1

  8. Verify the version number has changed to the new version (the version number should be higher than the previous version)

  9. Navigate to 2-3 different pages in IDMS to confirm the interface loads correctly

  10. Log out of IDMS

Expected Result: The System Version Number displays the new version number (higher than the version recorded in Step 1), and the IDMS interface loads without errors.

Why use Incognito/InPrivate mode? Private browsing mode forces the browser to download fresh copies of all web files, ensuring you see the upgraded interface rather than cached files from the previous version.

Validation Checklist

After completing all steps, verify the following:

  • [ ] The System Version Number in IDMS matches the expected upgrade version

  • [ ] You can successfully log into IDMS

  • [ ] The IDMS main dashboard loads without errors

  • [ ] You can navigate to multiple sections of IDMS (System, Connections, Users, etc.)

  • [ ] No error messages appear in the browser

  • [ ] The administrative command prompt showed no error messages during IIS restart

  • [ ] You have retained the backup folder from Step 4

If any items are not checked: Proceed to the Rollback Procedure section immediately.

Rollback Procedure

Use this procedure if the upgrade fails or IDMS does not function correctly after the upgrade.

When to Perform a Rollback

Perform a rollback if:

  • The System Version Number did not update

  • You cannot log into IDMS

  • IDMS displays error messages after the upgrade

  • Critical IDMS functions are not working

Rollback Steps

  1. Return to the administrative command prompt and stop IIS:

    iisreset /stop

  2. Navigate to the IDMS installation directory (from Step 3):

    • C:\Program Files (x86)\CyberArmed\ or

    • C:\Program Files (x86)\HID Global\

  3. Rename the current IDMS folder to IDMS.Failed.Upgrade:

  4. Navigate to your backup location (from Step 4)

  5. Copy the backup IDMS folder you created (example: IDMS_Backup_20241216_v5.2.1.3450)

  6. Navigate back to the installation directory

  7. Paste the backup folder

  8. Rename the backup folder to IDMS (remove the date and version suffix)

  9. Restart IIS:

    iisreset /restart

  10. Open a browser and verify you can access IDMS with the previous version number

  11. Contact IDMS support to report the failed upgrade and request assistance

Troubleshooting

Issue: "Internet services successfully stopped" message does not appear

Cause: IIS may already be stopped or the command was mistyped
Resolution:

  1. Verify you typed iisreset /stop exactly (note the space after iisreset)

  2. Check if IIS is already stopped by typing iisreset /status

  3. If IIS is already stopped, proceed to the next step

Issue: Cannot find the IDMS folder in Step 3

Cause: Non-standard installation location or incorrect folder path
Resolution:

  1. Search for "IDMS" in File Explorer

  2. Look for a folder containing "web.config" and application files

  3. If you cannot locate the folder, contact IDMS support before proceeding

Issue: IDMS loads but displays the old version number

Cause: Browser is loading cached files
Resolution:

  1. Close all browser windows

  2. Open a new Incognito/InPrivate window

  3. Clear your browser cache (Ctrl+Shift+Delete, select "Cached images and files")

  4. Navigate to IDMS again

  5. If the version still shows the old number, proceed to the Rollback Procedure

Issue: "Configuration update completed successfully" does not appear

Cause: Configuration update process timed out or encountered an error
Resolution:

  1. Wait an additional 5 minutes (some updates take longer on large databases)

  2. If still no message, close the Configuration Assistant

  3. Check the Windows Event Viewer for IDMS-related errors (Application logs)

  4. Perform a rollback following the Rollback Procedure section

  5. Contact IDMS support with Event Viewer error details