› Manage tenants › Manage tenant actions

Manage tenant actions

You can create, update, and delete a tenant asynchronously. Initiating a tenant action creates a background task to perform that action. You can continue to use the Tenant Management System even if these actions are in progress.

On the Tenant Management System, you can manage the following tenant actions:

  • Retry
  • Recover
  • Activate
  • Deactivate
  • Update database server

When a tenant action is in progress, it displays the following statuses depending on the action being performed:

  • Creating

  • Updating

  • Deleting

On completion of creating or updating action, the tenant becomes active.

When an action is in progress for a tenant, another action cannot be performed.

If a tenant action fails, the system does the following:

  • Displays the following statuses depending on the action that failed:

    • Create Failed

    • Update Failed

    • Delete Failed

  • Displays an error message in the Action Status Message column.

  1. On the header bar of your Tenant Management System page, click Tenant Actions > Retry.
  2. To recover an action, click Tenant Actions > Recover.

    Recover tenant action deletes the tenant data for the Create Failed action.

Retry the action

If a tenant action fails, you can retry the action.

On the header bar, click Tenant Actions > Retry.

Recover an action

If a retry fails, you can recover the tenant with the previous working configuration.

On the header bar, click Tenant Actions > Recover.

The recover tenant action deletes the tenant data for the Create Failed action.

Activate and deactivate a tenant

You can activate the development or production status of a specific tenant, and de-activate an active tenant.

When there are multiple inactive and active tenants, you can activate and deactivate all these tenants in one go.

The "Activate All Tenants" and "Deactivate All Tenants" options are enabled when there is at least one tenant available.

Activate/Deactivate the production status of an individual tenant

  1. On the Tenants page, click Tenant Actions > Activate All Tenants.

    The Activate/Deactivate Tenant page appears.

  2. On the Tenant list, select a tenant.

    The current production or development status of the selected tenant appears.

  3. To activate the production status, click Activate for Production Status.

    Once the status is active, click Deactivate for the specific status to deactivate the production status for an active tenant.

Activate/Deactivate all inactive tenants

On the Tenants page, click Tenant Actions > Activate All Tenants. All inactive tenants are activated.

On the Tenants page, click Tenant Actions > Activate All Tenants. All active tenants are deactivated.

Update the tenant database server

Deactivate the tenant before updating the database server. IT must copy and restore the tenant database to the new database server.

  1. On the Tenant Management System page, click Tenant Actions > Update Tenant Database Server.

    The Update Tenant Database Server page appears.

  2. On the Tenant list, select the tenant.

    The current database server name of the selected tenant appears.

  3. On the New Database Server list, select the new database server for the tenant.
  4. Click Update.

    The database server for the tenant gets updated. A message appears to confirm.

  5. Click OK.
    The tenant database server is updated.

Separate the tenant environment databases

In TotalAgility, there are several databases that were initially designed with multiple environments/schemas in one database (Live, Dev1, and Dev2). However, to enhance environment resilience and gain the ability to roll back an individual environment without affecting every environment associated with that database, you can separate TotalAgility databases with multiple environment schemas.

  1. On the Tenant Management System page, click Tenant Actions > Separate Tenant Environment Databases.

    The Separate Tenant Environment Databases page appears.

  2. On the Tenant list, select the tenant for which you want to separate the environment database.

    The environments associated with the tenant appear.

  3. Before separating out the tenant environment databases, you must do the following:
    1. Backup the tenant database.
    2. Create a new database for the environment to be separated and name it as TotalAgility_<tenantCode>_<EnvironmentName>.
    3. Restore the tenant database from Step a into the newly created environment database.
    4. Manually execute a SQL script on the new database.

      Running the script removes all objects from the new database schemas, except for the environment you are moving, and then removes all objects of the moved environment from the main tenant database.

    5. Repeat the Steps a, b, c, and d for all the tenant environments that need to be moved or separated out.
  4. On the Environment list, select the environment you want to separate.

    When you are prompted to confirm the separation of the databases, click OK.

  5. Repeat Step 4 for each tenant environment you want to separate.
  6. Click Update.

    The selected tenant environment is separated and it does not appear on the Environment list.