› Manage tenants › Create a tenant

Create a tenant

Create a new tenant that can access TotalAgility from an on-premise multi-tenant installation of TotalAgility.

By default, a tenant can access the Workspace in the Production environment; access to the Designer is optional as is access to the development environment (Designer and workspace).

A tenant must have access to at least one dev environment and on Azure, multiple dev environments are supported. These environments use the same version of TotalAgility. All development environments run on the same deployment of TotalAgility, so updating the development deployment will update all the development environments. `

  1. On the header bar of your Tenant Management System page, click Tenants > Create new.

    The Create Tenant page appears.

  2. On the General tab, enter the following details for your tenant:
    1. A unique name, such as Joe Bloggs.
    2. A description for your tenant, such as Operations Manager.
    3. A name for the Administrator user for the tenant.
    4. A password for the Administrator user.

      The password should match the regular expression pattern "^(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.*[!@#\$%\^&\*])(?=.{10,})", that is, a combination of lower and upper case characters, numeric and special characters and 10 characters long.

    5. Re-enter the Administrator password for confirmation.
    6. Data center.
    7. The company name, such as Kofax.
    8. Address of the company.
    9. Contact number.
    10. The email ID to send the URL details of TotalAgility Designer and Workspace.
    11. Country name.

      The number of tenants currently existing for the selected database server is displayed.

  3. Optional. Enter the additional information for the tenant in the Notes box.
  4. In the Reporting group,
    1. For Run Daily, specify the time when the ETL agent (extract/transform/load) handles system tasks for the tenant (every 5 minutes) and transforms data from the Staging to the Warehouse database.

      To improve access to the Warehouse database for customers, run the transformation during the tenants' off hours, for example, at night.

    2. For Purge Interval, specify the number of days the ETL agent waits before deleting field detail data from the data warehouse. (Default: 5)

    When the system executes a task:

    • The reporting data is uploaded to the intermediate (Staging) database from on-premise queue.

    • If the task is executed in the specified transformation time interval (default: nightly hours), the intermediate database (Staging) is transformed and uploaded to the production database (Data Warehouse).

  5. Click Save.

    A message appears when the tenant is saved.

  6. Click OK.

    The system does the following:

    • Adds the new tenant to the selected database server.

    • Sends an email to the tenant’s email address with login credentials, and links to TotalAgility, Workspace, and TotalAgility Apps. To access the TotalAgility and Workspace from the tenant’s email, click the respective URL.

    • Sends an email to the tenant’s email address with login credentials.

    • Based on the tenant's permissions, links are sent for the TotalAgility Designer, Workspace and Quick Capture Designer for the production environment.

    • The session ID is automatically generated for the new tenant. However, you can set the session ID manually, for example, if you want to use the same session ID when moving from development to production. Enter a value or copy and paste the value in the System session ID field of the System settings in TotalAgility Designer (System > System settings > User sessions > System session ID). The session ID value must be a GUID.

  7. Add additional environments for a tenant,
    1. Click the Additional Environments tab.
    2. On the Environment list, select an environment for the tenant.
    3. Select either option for Separate Database:

      • Yes: Creates a database for the tenant with the same name as environment.

      • No (default): Select an existing tenant database on the Database Name list to add the schema.

    4. Select either option for the License to use:

      • New: Enter the Serial Number and Product Code for the new license.

      • Existing: On the License list, select a license.

    5. Click Add.

      The system adds the environment and displays the following details: environment name, separate database, database location, and license to use.

    6. Add multiple environments as needed.
    7. Click Save.
  8. View the license statistics used by a tenant and reactivate a license if needed.
    1. Click the License Statistics tab.

      A list of licenses associated with the environments used by the tenant is displayed in a table with the following information: license name, serial number, product code, and reactivate. The production license which is configured on the General tab is also displayed.

    2. Select a licence to display its statistics.

      The System Licenses, Station Licenses and Volume Licenses sections display the license information such as license names, number of licenses available for allocation, the maximum number of licenses that you can allocate to a tenant, and the license expiration date. If you change the number of licenses allocated to the tenant, the number is decremented from the overall licenses. Allocating more than the number of licenses available to a tenant generates a warning.

    3. To reactivate a license, click Reactivate.

      The license is reactivated, and the statistics is updated accordingly.

    4. Click Save.

View additional environments associated with a tenant

You can view the additional environments used by a tenant.

  1. Logon to the Tenant Management System.
    The Tenant Management System appears to display the list of available tenants if any.
  2. Click to expand the tenant.

    The following information about additional environments associated with the selected tenant is displayed: environment name, deployment name, database location, status, upgrade status, action status message (hyperlink), and the delete option.

    You cannot delete an additional environment if it is associated with other environments.