Tenant Provisioning

This article deals with the following topics:

The Luma Virtual Agent platform is a multi-tenancy application. Each tenant's data is inaccessible to the other tenants that are running in the same environment. The Super Administrator (Superadmin) can create and manage tenants in the system. The Superadmin has the access rights to create tenants as well as create bot and administrator credentials for those tenants. Superadmin users login to the Superadmin console which is separate from the Bot Builder interface.

Access Superadmin Console

To access Luma as a Superadmin, ensure the following:

• Ensure that you have the Superadmin credentials available such as the Username, Password, and Tenant. These details are accessible from Serviceaide Support.
• Ensure that you have a valid email account. This email account is the communication channel between Serviceaide and the Administrator with regards to queries such as any notification, alert messages, licensing, password regeneration, and so on.

Tenant Management

This page provides the list of tenants available in Luma. 

To access the Tenant Management page:

• You must log in to Luma as a Superadmin using the URL provided by Serviceaide.
• Click the  icon to navigate to Tenant Management. The following page appears

This is the Tenant Management list that lists existing Tenants available on your platform. 

Create Tenant

To create a new tenant, do the following.

1. Click Create Tenant on the Tenant Management page.
   
   
2. On the Tenant details section, specify the following information:        
   
   1. Tenant name.
   2. The tenant which is used when logging into the Bot Builder.
   3. The tenant ID which must fall in the range from 1000 to 999999999. If you do not specify the tenant id, a unique id is auto-generated after the tenant is created.
   4. Specify the symbol. This symbol is used internally to identify the tenant in the database. The maximum number of characters is limited to 6. The allowed characters are A-Z, a-z, 0-9,_. Values must start with a letter and must not end with _(underscore).
3. Click on Next to add Default Bot & Domain Details. By default, the data is automatically populated based on the Tenant Details section. However, you can configure the bot and domain details, if required.
   
                                                     
   
   1. The bot name. This is used to identify the bot easily in the Bot Builder.
   2. Select the language that the bot can communicate with the user. Currently, the bot supports the following languages:
      • English
      • Chinese
      • Japanese
      • Spanish
      • Portuguese
   3. Build and Publish Service: The Service assigned to the Tenant is required to build and publish the training data to the bot. It could be AWS Sagemaker or RASA Adapter.
   4. The bot symbol. This symbol is used internally to identify the bot in the database. The maximum number of characters is limited to 6. The allowed characters are A-Z, a-z, 0-9,_. Values must start with a letter and must not end with _(underscore).
   5. The domain name. The skills and attributes are associated with a domain.

   6. The unique identifier for the domain.    

      AWS Sagemaker

      • RASA adapter runs the Build and Publish process on the Local infrastructure.
      • Run time performance is better on AWS SageMaker.
      • Customers must subscribe to AWS services and configure AWS SageMaker for On-Premise implementations.
4.  Click Next to navigate to Tenant Administrator Details to define the tenant administrator information:
                   
                 
   1. The username of the tenant administrator.
   2. The email id of the tenant administrator.
   3. The password using which the tenant administrator can log in to the Bot Builder.
   4. Select the language from English or Chinese. This is the language to be used across the Bot Builder UI.
   5. The first name of the tenant administrator.
   6. The last name of the tenant administrator.    
      
      
5. Click Next and select the additional capabilities for your Luma tenant.
    
   1. Select Provision Dashboard (Superset) to provision the Superset dashboard for your tenant. this is currently a BETA release.
   2. Select Provision Knowledge Management to provide Luma Knowledge to your Luma tenant. The Luma Knowledge Tenant will be provisioned automatically with the provided details. This also eliminates the need for a separate set of users and user sync between Luma and Luma Knowledge.
   3. Add any domain to be added to Luma Knowledge.
6. Click Next to navigate to Generative AI Configuration to enable Azure Open AI for the tenant. The configuration should be enabled if you want to enable Generative AI capabilities for your tenant.
   
   
   To enable Generative AI, follow the below steps:
   
   1. Enable Generative AI
   2. Add the following configurations:
      1. Azure Resource Name.
         
      2. Endpoint
      3. Deployment name for gpt-35-turbo
      4. Deployment name for gpt-35-turbo-16k
      5. API Key to connect to your Generative AI instance.
   3. Enable the features required for Luma Virtual Agent and Luma Knowledge.
      

      1. Under ‘Features available in Virtual Agent’ you can view the Generative AI Features used in Virtual Agent. The skill developer uses these features to integrate Generative AI into skill building and execution seamlessly.

         1. Auto Phrase Generation for Skills enables the Skill developer to automatically generate user phrases that the end-user can use to request the skill.

         2. AI Task in Skill Conversation Flow enables the skill developer to add an AI Task as a step in a skill. The conversation step, AI Task, can be added to the canvas or is executed only if the feature is available for your tenant.

      2. Under ‘Features available in Knowledge,’ you can view the functionalities available in Luma Knowledge. Using these capabilities, Luma can adeptly curate and oversee your Knowledge Articles. For more information, refer to Integrating Advanced Language Models.

         1. Keyword and Keypharses generation allows Luma to automatically extract relevant keywords from documents and data, making information retrieval faster and more effective.

         2. Automatic Summarization allows the automatic summary generation based on the artifact content.

         3. Question and Answer generation(FAQ) generates Questions and corresponding answers, which can be quickly presented to the user, reducing the time spent on answering customer inquiries.

         4. Suggest Content on Knowledge Gap Resolution enables the curator to use Generative AI to build Knowledge to resolve unanswered user queries.

         5. Precise Answering enables Luma Knowledge to interpret and understand the user’s request and generate answers specific to the question.

7. Click Next to navigate to Automation Integration, to enable automation for the tenant.
   
   
   To configure automation, follow the below steps:
   
   1. Enable Provision Automation.
   2. Select ‘Automation Version’ as V2
   3. Add Automation Tenant Identifier and Access Token retrieved from ITAS Tenant Provisioning API in ‘Tenant Secret Key’ fields in VSA.

   4. Click Save.

      The above information is generated through ITAS Tenant Provisioning API. Contact the Serviceaide support team to create your tenant in ITAS and obtain the details required to enable automation for your tenant in Luma VA.

8. Click Next to navigate to the Subscription tab.

         The screen allows super admin to distribute licenses as per the organization's contract so that they can use the Luma application based on the license type.


License entitlement details

This section provides License entitlement details to Super Administrator.  New Tenant creation or License distribution is allowed based on the availability of licenses.  The information is populated from the License file registered for the Organisation and MSPs and is non-editable. 

License Information consists of

• Contract start date  
• Contract end date      
• Serviceaide Accounting email ID:  Serviceaide Account Manager's contact mail ID for all license-related communication/notifications

License Consumption

This section holds limited information regarding allocated vs available. 'Available limits' are populated from the License file, and 'allocated details' are calculated from the Tenants created and Licenses allocated.

• Tenants represent the number of Tenants created/Total Allowed Tenants.
• Users represent the number of Users allocated / Total number of User Licenses purchased 
• Sessions represent the number of Sessions Assigned / Total number of Sessions Licenses purchased 

Subscription details

This section covers subscription information for the new tenant. Super admin uses this screen to define licensing type and Licenses for the Tenant. 

To update Subscription information for the Tenant, the below details are to be entered:

1. License Type: Select the license type for the tenant based on the contract. 

   For User-Based Licensing:

   • Select 'Users' as License Type.
   • Add User Licenses to be allocated to the Tenant. 

   For Session-Based Licensing:

   • Select 'Sessions per month' as License Type.
   • Add Sessions to be allocated to the Tenant. 
   • The session duration will be populated based on the license file.
2. Contract: Add Contract start date and Contract End date. The dates should be within the contract start and end date as available in Licensing Information.
3. Technical Email:  License Consumption and Alerts will be sent to this mail ID.
4. Billing Email :  License Consumption and  Billing details  will be sent to this mail ID.

6.  Click Create. A new Tenant with the above-specified details will be created. Once the tenant is created, the new tenant is displayed in the Tenant Management list. The tenant administrator can now log in to the Bot Builder with the given credentials.  

View Tenant Details

Select one tenant from the Tenant Management list to view the tenant details. 

Tenant Details

Tenant Details the section on the page displays the following information:

• Name: The name of the tenant. 
• Tenant ID: This is the unique Tenant identifier, which is automatically generated after the tenant is successfully created. You can also specify the ID based on your requirements when creating the tenant. The Tenant ID must be in the range of 1000 to 999999999.
• Tenant: This is the name that is used when logging into the Bot Builder interface.
• Tenant External ID: This is the unique the the identifier used by external applications to communicate with this Tenant.
• Status: Status of the tenant, such as Active or Inactive.
• Tenant Description: Description of the tenant.

Generative AI Configuration

This section is used to present Generative AI features enabled for the tenant.

Subscription

Under Tenant page, click on Subscription section to view subscription information and License consumption information of the tenant:

• Environment: Luma Environment on which Tenant is created
• License Type: License or subscription type of the selected tenant
• Sessions: The number of sessions allocated to the Tenant. The field is available only for License type: Sessions. 
• Session duration: Predefined duration of a session for the selected Tenant. The field is available only for License type: Sessions. 
• Users: The number of User Licenses allocated to the Tenant. The field is available only for License type: Users. 
• Contract Start Date, End Date: This is the Licensing period set for the Tenant. The license seat or sessions can be used within this period.
• Technical Email and Billing Email: List of email ids to be notified when License Consumption reaches Thresholds i.e.  75%, 85%, 95%, and 100%.

• License Information: This is the contract information for the platform and is populated from the License file.

• License Consumption: This is the current consumption vs available limit information for the Super admin. Available limits are populated from the License file and allocated details are calculated from the Tenants created and Licenses allocated.

  • Tenants represent the number of Tenants created/Total Allowed Tenants.
  • Users represent the number of Users allocated / Total number of User Licenses purchased
  • Sessions represent the number of Sessions Assigned / Total number of Sessions Licenses purchased   

• License Consumption: This section gives information on user/session-based license usage for the tenant.

  • Total Purchased represents the number of User Licenses/Sessions allocated to the Tenant
  • Consumed represent the number of User Licenses/Sessions consumed 
  • Available represent the number of User Licenses/Sessions still available for usage

Search Tenant

You can search for a specific tenant in the Tenant Management list.

Do the following to search a tenant:

1. Specify the Tenant ID or Name or Tenant or Description in the Search box.
2. Press the Enter key.
   The tenant record that matches the details specified in the search text box appears.
3. To return to the previous list delete your search criteria and press Enter again.

Edit Tenant

On the Tenant details screen, click on Edit Tenant to update Tenant details or subscription information. Super admins use the screen to add or remove allocated Licenses for a Tenant. You can also provision Superset Dashboard and Luma Knowledge for existing tenants. 

Follow the below steps to edit Tenant information:

1. Search for a Tenant. Click on the record to open view Tenant details.
2. Click Edit Tenant
3. You can now update the below details:
   1. Tenant Details
      1. Tenant Name
      2. Description
      3. Status to mark the Tenant Active or Inactive
   2. Additional Capabilities: 
      1. Enable Dashboard (Superset) to provision Superset dashboard
      2. Enable Knowledge Management to provision Luma Knowledge automatically. (Note: This applies to Luma tenants provisioned after the unification of Luma and KM (Release 3.4). For tenants provisioned before the release, KM tenants should be created in the Luma Knowledge Superadmin portal.)
   3.  Subscription
      1.  Allocated Licenses.
         1. For License Type:  Users
            1. To allocate licenses, add the number of licenses in Users. The license count cannot exceed the licenses in the License Availability section. 
            2. To remove User Licenses, remove the number of Licenses in Users.  
         2.  For License Type:  Sessions
            1. To allocate licenses, add the number of Sessions in Sessions field. The session count cannot exceed the available Sessions in the License Availability section.

            2. To remove licenses, remove the number of Sessions allocated in Sessions field. 

               If there are 60 Licenses available and the total number of licenses required is 100,  then enter the number of licenses as '100' and not 40.

               If there are 400 Licenses and 50 licenses to be removed, then enter the number of licenses as '350' and not 50.

   4. Contract Start Date and End Date
   5. Technical Email
   6. Billing Email
4. Click Save. Tenant details will be updated.
5. Changes to License subscription data will be available in the Licensing Transaction history for the Tenant Administrator. Refer to the article (Tenant settings→Subscription) for more details.