› System › System settings › Logon and authentication › User sessions › Change the session IDs

Change the session IDs

You can change the system session ID and limited system session ID of TotalAgility.

See User sessions.

Change the system session ID

You can regenerate the session ID if there is a security breach or set this value. For example, regenerate the session ID if someone has used the session ID to access the system without approval, or set the value if moving from development to production environment and you want to use the same session ID for both environments.

  1. Navigate to System > System settings > Logon and authentication > User sessions.
    The User sessions dialog box is displayed.
  2. Do one of the following for System session ID:

    • To set the session ID value, enter or paste the value in the field. This value must be a GUID.

    • To regenerate the session ID, click Generate next to the field and click OK to confirm.

  3. Click Save.
  4. The changes in Session ID impact the following TotalAgility configuration files: Export Service, Export Connector, and Core Worker Service.
    Once a new session ID is generated, you must manually update the application setting values with the newly generated session ID under the <appSettings> section in the following configuration files:

    • ...\\<installation folder>\Kofax\TotalAgility\CoreWorkerService\Agility.Server.Core.ExportService.exe.config 

      <add key="SystemSessionId" value="="
<replace with the regenerated session id>"/>

    • ...\\<installation folder>\Kofax\TotalAgility\ExportConnectors\bin\RegAscSc.exe.config 

      <add key="DefaultSessionId" value="
<replace with the regenerated session id>"/>

    • ...\\<installation folder>\Kofax\TotalAgility\CoreWorkerService\Agility.Server.Core.WorkerService.exe.config 

      <add key="SystemSessionId" value="="
<replace with the regenerated session id>"/>

Change the limited user session ID

The limited user session ID is a mandatory field and is editable.

  1. Navigate to System > System settings > Logon and authentication > User sessions.
    The User sessions dialog box is displayed.
  2. Click Generate next to the Limited user session ID field.
  3. On the prompt, click OK to confirm.
  4. Click Save.

Change the recovery mode session ID

Use the recovery mode session ID for federated security recovery to enable the TotalAgility Designer logon when you have an issue to resolve in the federated security. To log on to TotalAgility in recovery mode, you must have full control or read/write permissions. The recovery mode session ID is unique. With each installation, a new ID is generated. However, you can regenerate the session ID as needed. For instance, if the administrator login cannot be authenticated using federated security or when a license server is changed, and the database is still pointing to the old license server.

  1. Navigate to System > System settings > Logon and authentication > User sessions.
    The User sessions dialog box is displayed. By default, the key has a session ID that can be used to log on. You can change the session ID as required by generating a new ID.
  2. Click Generate next to the Recovery mode session ID field.
  3. On the prompt, click OK to confirm.
  4. Click Save.