Configuring Tenant

Owned by Enterprise IT
Apr 23, 2024
3 min read

A Tenant is a business unit, entity, or a department in an organizational hierarchy. You can create, modify, and specify configuration details of a Tenant. In the SummitAI application, you can select the label name for Tenant based on your usage, for example: Department/ Customer or by default Tenant (see: Tenant Department Customer). The defined label name is displayed for Tenants. Department can be used when the SummitAI application is used by multiple departments within the organization. Customer can be used when multiple customers are handled using the SummitAI application. You can use any other label name based on the requirement of the organization.


To configure Tenant:

  1. Select Admin> Basic > Infrastructure > Tenant.
  2. On the TENANT page, click ADD NEW on the ACTIONS panel.
  3. Select the Domain from the drop-down list and type in the new Tenant details. For more information about the fields on the TENANT page see, Field Description.
  4. Click SUBMIT. A new Tenant is added.

    Tenant page
    Figure: Tenant page

Field Description

The following table describes the fields on the TENANT page:

Field

Description

DETAILS

Domain

Select a Domain from the drop-down list under which you want to configure the Tenant.

Tenant Code

A unique code for the Tenant. This helps to identify Tenants. You can enter a maximum of six characters.

Display Name

Type in the name of a Tenant.

Group NameSelect a Group name under the drop-down if you want to add tenant with shorting order under the Group.
Sort Order

Specify a value to set the sorting position in the Tenant list section or Tenant drop-down inside the Group across the Application.

Note: The Sort Order field accepts values from 0 to 999.

The Tenants are displayed alphabetically on the pages when two or more Tenants are configured with the same Sort Order or without any sort order.

Example

On the TENANT page, if Tenant 1 (Information Technology) is configured with Sort Order value 1 and Tenant 2 (Operations) is also configured with Sort Order value 1, Tenant 1 (Information Technology) is placed on the top of the Tenant 2 (Operations) across the pages.

If both Group Tenant and Tenant List are configured for the same page, Group Tenant is placed on the top of the Tenant List across the pages. Group Tenant sorting is configured on the Common Master page. For more information on Group Tenant sorting, see Configuring Common Masters.

Description

Type in a brief description about a Tenant.

Active

Indicates the status set for the Tenant.

  • If selected, the Tenant is enabled to display on other pages of the application.
  • If not selected, the Tenant will be an inactive Tenant. The Tenant is disabled to display on other pages of the application. The newly created Tenant details are not appended with the existing Tenant list.

Modules

Lists all the modules for which the logged in user has access. Select the check mark over the Module icon to enable the Tenant for the respective module. By default, the check marks are displayed in grey color indicating that the Tenant is disabled for the selected module.

Color Codes

The color codes displayed for the check mark:

  • Grey: Indicates that the Tenant is disabled for the module.
  • Green: Indicates that all the associated components of the module are configured.
  • Yellow: Indicates that the associated components of the module are not configured.

ACTIONS

This section explains all the icons displayed on the ACTIONS panel of the TENANT page.

SHOW LIST

Click SHOW LIST to display the LIST table showing all the Tenants configured in the SummitAI application.


Figure:  TENANT page: List of Tenants configured

  • To edit a Tenant detail, click the configured Tenant Name. Make appropriate changes and click SUBMIT.
  • To display the inactive Tenant details, click the Include Inactive check box.
  • Tenant ID will help analysts with handy information, especially when managing the API calls during the integration of SummitAI with third-party application.

Note:

When the Tenant details are displayed under the LIST table, the ADD NEW and TENANT LABEL icons are displayed on the ACTIONS panel.

CONFIGURE DETAILS

Click CONFIGURE DETAILS to configure the various modules for the Tenant.

IMPORT CONFIGURATION

Click IMPORT CONFIGURATION to copy the configuration from an existing Tenant. You are redirected to IMPORT CONFIGURATIONS BY TEMPLATE page. For more information, see Importing Configurations by Template.