Skip to main content

Work with Tenants 

AutomationEdge is a multi-tenant system, that can host automation services for multiple tenants (customers) on one server. Users, workflows, and other objects created for one Tenant are not visible to another tenant. In the chapter, you will learn about adding and deleting tenants and various tenant statusstatuses. The chapter includes the following topics:

  • Add new tenant
  • Tenant status
  • Delete a tenant

Add New Tenant​

You need to add tenants under which you can create users.

To add a new tenant:

  1. In the menu, click Tenants. The Tenants page appears. 

    IMG_256

Figure: Tenant

  1. On the page, click Add New. The Add New Tenant dialog appears.

    alt text Figure: Add New Tenant

  2. Enter the following field details: 

Field Name Description 
Tenant Name* Enter a unique tenant name. Only alphanumeric characters and space is/are allowed
Description* Enter a description of the tenant. 
Organization Code* Specify unique organization code to a tenant.  
File Based License The check box is selected by default. 

*: indicates a mandatory field. 

  1. Click Create. The created tenant appears on the Tenant page. 
tip
  • To modify the tenant details, click Edit (IMG_256) and update the description of the tenant.
  • You cannot modify the default, System Admin Tenant, whose org code is SYSADMIN.

View tenant details​

After adding the new tenant, you can view the details on the Tenant page.

To view tenant details:

  1. In the menu, click Tenants. The Tenants page appears.

  2. View the following tenant details:

Field nameDescription
Tenant NameDisplays the name of the tenant.
Org CodeDisplays the unique organization code.
DescriptionDisplays the description of the tenant.
CreatedDisplays the date when the tenant was created.
License StatusDisplays the status of the license.
StatusToggle switch to enable or disable the tenant. For details, see Tenant status.
ActionsYou can edit or delete the tenant.

View license details​

You can view license details such as customer ID, license ID, start date, end date, and so on.

To view license details:

  1. In the menu, click Tenants. The Tenants page appears.

alt text

Figure: Tenants page

  1. In the License Status column, click the status, for example, Valid. The License Details dialog appears.

alt text

Figure: License Details dialog

You can view the following field details:

  • Customer Id: Displays the unique customer ID of the tenant.
  • License Id: Displays the license ID used by the tenant.
  • License Type: Displays the type of license used. For example, UAT, Development, and so on.
  • Start Date: Displays the start date of the license.
  • Expiry Date: Displays the expiry date of the license.
  • Grace Period: Displays the additional number of days that the license can be used before renewal.
  • Agent Threads in use: Displays the agent thread in use.
  • Assisted Agents: Displays the number of assisted agents in use.
  • Consumed Process Studios: Displays the number of Process Studios in use.
  • Step Units Consumed: Displays the total number of step units consumed.
  • Classification Pages Consumed: Displays the number of pages consumed to classify a document.
  • Extraction Pages Consumed: Displays data extraction based on the number of pages.
  • Advanced Pages Consumed: Displays advanced pages that use AI to process documents.
  • License Expiry Notification: Toggle the switch to enable or disable the license expiry notification for any tenant.
Important

System Admin can turn off or turn on License Expiry Notification for any tenant.

  • If license expiry notifications are on and the license expires within 30 days:
    → Expiry notification email will be sent.

  • If license expiry notifications are off and the license expires within 30 days:
    → No email.

  • If the license expires in more than 30 days (regardless of notification setting):
    → No email.

  • If the license is expired and not renewed:
    → The system checks the license expiry notification setting and decides whether to send an email.

  • If the license is renewed:
    → License expiry notifications are enabled if they were previously disabled.
    → No email is sent (expiry is now more than 30 days).

Tenant Status ​

You can enable or disable the status of a tenant. The system administrator can manage the status with a toggle switch. To enable or disable a tenant, slide the toggle switch (IMG_256 ). A message asking for confirmation to enable or disable the tenant appears.

When the toggle switch appears: 

  • Blue (IMG_256 ): indicates the tenant is enabled. 

  • Grey (IMG_257 ): indicates the tenant is disabled. 

When you disable a tenant, the following features are also disabled for the users, that is, the tenant user is unable to:

  • Sign in to AutomationEdge.

  • Register new Process Studio or sign in to Process Studio.

  • Trigger tenant user’s schedules.

  • Raise new workflow requests.

  • Sign in to connected apps.

  • Use the Agent as it is shut down.

  • Continue with the Credential expiry job.

  • Trigger workflow schedules.

  • Trigger notification schedules.

  • Trigger email report schedules.

tip

When you enable the tenant again, you need to enable all the disabled features manually.

Delete a Tenant​

You can delete a tenant, if required.

Important

Disable the tenant before deleting it.

To delete a tenant:

  1. In the menu, click Tenants. The Tenants page appears.
  2. In the Status column, toggle the status switch and disable the tenant. The delete option becomes available.
  3. In the Actions column, click IMG_256 . The Confirm Tenant Deletion dialog appears.

alt text

Figure: Confirm Tenant Deletion dialog

  1. Enter the name of the tenant and click Delete. The tenant details are deleted.
Last updated on