Migrating and Changing Agent Guidance System Configurations

There is a standard reconfiguration process that allows the migration or alteration of a Agent Guidance System while maintaining all Users, Workflows, and core Agent Guidance configuration details. This process is functionally equivalent to an additional website being added to the existing Agent Guidance System.

This reconfiguration process enables the following actions:

The Agent Guidance Website Instance(s) can be relocated.
The Agent Guidance SQL Database can be moved to alternative SQL nodes or servers.
The Agent Guidance Licence Key and/or Licence System Name can be changed. Note that if this is the only desired change, a simpler process is also possible.
The Agent Guidance Authentication scheme can be changed between Windows Authentication and Forms Authentication.

If you wish to alter any part of the Agent Guidance System configuration that isn't offered within the Agent Guidance website's GUI, then please consult your Agent Guidance vendor.

Process

Preparation steps to be carried out prior to reconfiguration

Carry out a Agent Guidance System Backup of the Agent Guidance database and Agent Guidance IIS websites instances before making any changes.
Make a note of the Agent Guidance Website IIS bindings, and any customisations you have made to this system outside of the Agent Guidance application.
Record the configuration of the Agent Guidance Services and Plugins in use, as these are each tied to a specific Website Instance

Reconfiguration steps to implement desired changes
Carry out one or more of the below desired system changes (in the stated order):
If migrating one or more Agent Guidance Website Instance(s):
Uninstall the relevant Agent Guidance Website Instance(s) for this Agent Guidance System, leaving the database.
If you wish to migrate to a new SQL server/node:
Uninstall all Agent Guidance Website Instance(s) for this Agent Guidance System, leaving the database.
Move the Agent Guidance database and any SQL users to the new database server/node. The SQL users must be assigned the IA_APP role on the Agent Guidance database.
If you wish to migrate to a new Licence System name:
Uninstall all Agent Guidance Website Instance(s) for this Agent Guidance System, leaving the database.
Update the Agent Guidance SQL database manually via SSMS (SQL Server Management Studio), and replace the ConfigKeyValue column with a blank string for the LicenceFile key found in the table tbl_AppConfig (leaving the key otherwise unaltered).
If you wish to swap the Agent Guidance Authentication scheme:
Uninstall all Agent Guidance Website Instance(s) for this Agent Guidance System, leaving the database.
Update the Agent Guidance SQL database manually via SSMS (SQL Server Management Studio) to add the SQL users and roles as appropriate:
If transitioning to a Forms Authentication system, ensure an appropriate SQL user has been added to the database and been assigned the IA_APP role. This user will need to be reused during the subsequent installation.
If transitioning to a Windows Authentication system, ensure an appropriate Active Directory group has been added to the database as well as the account for the intended IIS Application Pool identity to be used (default of the ApplicationPoolIdentity virtual account, see this article for details on how to configure this access), with both having been assigned the IA_APP role. This group will need to be reused during the subsequent installation.
Optionally, the previously-configured details for the defunct authentication scheme can be removed from the SQL users on the database: the Forms Authentication user or Windows Authentication group and previously configured IIS Application Pool identity.
Install the required Agent Guidance Website Instance(s) against the Agent Guidance Database to recreate the Agent Guidance System. During the installation process, use the updated details in combination with the current settings:
Licence Key: use the new/current Licence key.
Licence System Name: use the new/current Licence System name.
Database Location/Name: enter the database location details, as well as the existing database's name. This will connect the new website to the old database.
All other settings should be appropriate for each Agent Guidance Website Instance being deployed.

Post reconfiguration steps
Apply any Agent Guidance Website IIS bindings and customisations to the Agent Guidance Website Instance(s).
Reinstall and configure Agent Guidance Services and Plugins via the Agent Guidance Website Instance(s).
If swapping the Agent Guidance Authentication scheme between Windows and Forms Authentication, use the following SQL query to generate the new master administrator user account:

--If swapping to Windows Authentication, this should be the Windows User that will be running the installer

--If swapping to Forms Authentication, this would typically be 'Admin'

DECLARE @username NVARCHAR(50) = 'Username'

-- The displayed first and last name for the user

DECLARE @forename NVARCHAR(50) = 'Forename'

DECLARE @surname NVARCHAR(50) = 'Surname'

--If swapping to Forms Authentication, this should be set to 1

DECLARE @forms BIT = 0

INSERT INTO tbl_Users (username, firstname, surname, enabled, password, createdAt, passwordChangeRequired)

VALUES (@username, @forename, @surname, 1, '', GETDATE(), @forms)

DECLARE @userID INT = @@IDENTITY

INSERT INTO tbl_ug_join (user_id, group_id)

VALUES (@userID, 1)

INSERT INTO tbl_user_licences (userID, partNumber)

VALUES (@userID, 'SYSTEM-MANAGER')

The contents of Migrating and Changing Agent Guidance System Configurations

Changing Licence Key or System Name

Agent Guidance Core User Guide

Migrating and Changing Agent Guidance System Configurations

Process

The contents of Migrating and Changing Agent Guidance System Configurations