› 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).

  1. On the Tenant Management System page, click Create.

    The Create Tenant page appears.

  2. Click the General tab.
  3. 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 user ID to logon to TotalAgility and Workspace, such as JoeB.
    4. A password to logon to TotalAgility and Workspace.

      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 same password.
    6. Database server.
    7. Storage account.
    8. Data center.
    9. The company name, such as Kofax.
    10. Address of the company.
    11. Contact number.
    12. The email ID to send the URL details of TotalAgility and Workspace.
    13. Country name.

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

  4. Optionally, enter additional information for the tenant in the Notes box.
  5. In the Reporting group,
    1. For Run Daily, specify the time when the ETL agent (extract/transform/load) handles system tasks for the tenant (each 5 minutes) and transforms data from staging to warehouse.

      To improve access to the Warehouse DB for customers, run the transformation during the tenant's off hours, for example, at night.

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

    When the system executes a task:

    • Reporting data is uploaded to intermediate (staging) database from On-Premise Queue.

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

  6. In the Production Environment group:
    1. For Designer Access, click Yes to allow access to TotalAgility from the production environment. (Default: No)
    2. If needed, change the maximum number of Station and Volume licenses to allocate to the tenant.

      • The Station Licenses and Volume Licenses sections display the license types and the maximum number of licenses that you can allocate to a tenant.

      • If you change the number of licenses allocated to the tenant, the number is decremented from the overall BPO licenses.

      • Tenants can view the number of allocated and available license types. See Manage license statistics.

      • Allocating more than the number of licenses available to a tenant generates a warning.

  7. In the Development Environment group:

    The Development Environment group only appears if you set the Designer Access option in the Production Environment to Yes.

    1. By default, the Dev Environment Access is set to Yes. If this option is set to No, Station and Volume license details are not visible. See Manage License statistics for station and volume details.
    2. If needed, change the maximum number of Station and Volume licenses to allocate to the tenant:

      • The Station Licenses and Volume Licenses sections display the available license types and maximum number of licenses that you can allocate to the tenant.

      • If you change the number of licenses for a tenant, the number is decremented from the overall number of BPO licenses (A BPO license is the license the customer will purchase to install on-premise multi-tenancy system.

      • The Tenant Management System sends an email to the tenant with the URLs for Workspace, Designer and Quick Start Designer for the Development environment.

      • If you remove access to the development environment, the Tenant Management System sends an email to the tenant informing them of the change. The number of licenses allocated to the tenant is credited back to the BPO license, except for the Page Volume license that has already been used.

  8. Click Save.

    A message appears when the tenant is saved.

  9. 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 Quick Start Designer.

    • 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 production and development environments.

    • The Session ID is automatically generated for the new tenant. However, you can also 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 Session ID field of the System Settings in TotalAgility (Home > System Settings > Settings > General). The Session ID value must be a GUID.

To access the TotalAgility and Workspace from the tenant’s mail, click the respective URL.