How to migrate ADSelfService Plus with a Microsoft SQL backend database

Last updated on:

In this article

Objective

This article explains how to migrate the ADSelfService Plus application server to a new machine while retaining the existing external Microsoft SQL server database. This ensures minimal downtime, preserves custom configurations, and maintains data integrity.

Prerequisites

  • Required access: Administrator access to the old and new application servers and the Microsoft SQL server (preferably via SQL Server Management Studio).
  • Software requirements:
    • The same build version of ADSelfService Plus must be used on both servers. It is highly recommended that the software be updated to the latest build on the old server before starting the migration.
    • The new server must have the BCP files in the bin folder and the appropriate MS SQL Native Client or ODBC/JDBC drivers installed to communicate with your database.
  • Backups: Back up the existing Microsoft SQL database.
  • Network configuration: Ensure any firewall rules on the new server are configured to allow communication with the Microsoft SQL server (typically on port 1433).

Steps to migrate ADSelfService Plus

Step 1: Prepare and back up your old server

On your old server, perform the following steps to gather all necessary custom files.

  1. Stop the ManageEngine ADSelfService Plus service via services.msc.
  2. Copy the following files and folders to a safe, external location. These contain your unique customizations.
Customization File(s) / Folder(s) to back up Default location
SSL certificate server.p12 (or your keystore file), server.xml, web.xml ..\ADSelfService Plus\conf
Branding/themes html, images, resources, styles folders ..\ADSelfService Plus\webapps\adssp
Custom language resources folder ..\ADSelfService Plus
Applied patches patch folder ..\ADSelfService Plus
Mobile app configuration MPM folder ..\ADSelfService Plus
BCP utilities bcp.exe and bcp.rll ..\ADSelfService Plus\bin
Important

If these custom files are not restored, customizations like language changes, SSL configuration, login page design, and login agent behavior will not work correctly on the new server.

Step 2: Installation and configuration on the new server

  1. The same build version of ADSelfService Plus must be used on both servers. It is highly recommended that you update the latest build on the old server before starting the migration. Run the ADSelfService application to complete the installation.
  2. Install the MSSQL Native Client or relevant ODBC/JDBC drivers on the new server.
  3. Restore custom files:
    • Paste the backed-up patch, resources, and MPM folders into the new ADSelfService Plus installation directory, overwriting the existing ones.
    • Paste the backed-up html, images, resources, and styles folders into the <ADSSP_Install_Dir>\webapps\adssp\directory.
    • Paste the backed-up server.p12, server.xml, and web.xml files into the <ADSSP_Install_Dir>\conf\directory.
  4. Paste the bcp.exe and bcp.rll files into the <ADSSP_Install_Dir>\bin\directory.
  5. Open Command Prompt as an administrator.
  6. Navigate to the bin directory using the cd command. The default path is C:\Program Files\ManageEngine\ADSelfService Plus\bin.
  7. Run the database configuration script. 
    changeDB.bat

  8. For ADSelfService Plus build 6527 and later


    A) In the Database Setup Wizard that appears:

    • Select MSSQL Server as the Server Type.
    • Enter the connection details for your existing SQL server and provide the credentials.
    • To migrate your existing data to the new database server, check the Migrate Data From Existing Server checkbox. Leave it unchecked if you are setting up a fresh database with no data to migrate.
    • Click Save.

    For ADSelfService Plus builds prior to 6527


    B) In the Database Setup Wizard that appears:

    • Select MSSQL Server as the Server Type.
    • Enter the connection details for your existing SQL server and provide the credentials.
    • Click Save.
Note:

The Migrate Data From Existing Server checkbox is not available in builds prior to 6527. Data migration must be performed manually using standard SQL migration procedures before or after reconfiguring the database connection.

Validation and confirmation

  • Start the ManageEngine ADSelfService Plus service on the new server.
  • Log in to the admin portal and verify that all your settings, reports, and license details are correct.
  • Confirm that your SSL certificate is working and that any login page customizations have been applied.
  • Perform a test password reset and other self-service actions to ensure full functionality.
  • Once you have confirmed the new server is fully operational, you can decommission the old server.