Versions Compared

Old Version 4

changes.mady.by.user sneha.tripathi

Saved on

compared with

New Version 5

changes.mady.by.user sneha.tripathi

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This article deals with the following topics:

...

  • 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

...

To access the Tenant Management page:

  • You must log in into 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 Tenant is the Tenant Management list that lists existing Tenants available on your platform. 

...

  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, an a unique id  id is auto-generated  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, 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.    

      Info
      titleAWS 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 to navigate to Automation Integration, to enable automation for the tenant. Luma supports Flint automation.


    To configure automation with Flint, follow the below steps:
    1. Select Provision Automation
    2. Add the required details to connect to the Flint
      1. Domain: Represents your tenant, as in Flint tenant
      2. Organization: Represents your organization, as in Flint tenant
      3. Email Address: Email address, as in Flint tenant
      4. User Name:  Username, as in Flint tenant
      5. Password: Username, as in Flint tenant
      6. Token: This is the secret key generated for your Flint tenant

      7. Flint UserID: This is the flintUserUuid generated for your Flint tenant

        Info

        The above information is added or generated in Flint while creating tenant for your organization. Contact the Serviceaide support team to create your tenant in Flint and obtain the details required to enable automation for your tenant in Luma.


  6. Click Next to navigate to the Subscription tab.

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

...

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

...

Info
  1. A MSP Organisation, 
    1. can create a new Tenant only within available Tenant limits. The system will not allow Tenant creation if the allowed Tenant limit is reached. 
    2. can purchase a hybrid license which means a combination of User-based Licenses and Sessions. Super Administrator  can create multiple Tenants and allocate these Licenses as per internal contracts. System The system will not allow license allocation over and above the Permissible limit. 
  2. For the only User-based Licensing, Sessions Session information will be 0/0.
  3. For the only Session-based Licensing, Users' information will be 0/0.


Subscription details

...

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' as License Type.
    • Add Sessions to be allocated to the Tenant. 
    • Session 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.
Info
  • A super admin can assign any one of the license types for a Tenant and assign Licenses accordingly.
  • User Licenses or Sessions allocated for the tenant cannot be greater than the available Users or Sessions in License Availability.
  • Contract The contract start date and Contract End date are evaluated against Contract dates in the License file. The dates should be within the dates in the License Information section.

...

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 login to the Bot Builder with the given credentials.  



Info
Please ensure that the correct Subscription type is selected while Tenant creation. Once Tenant is created  License Type and Contract duration cannot be updated

.

View Tenant Details

To view the tenant details, select one of the tenants from the Tenant Management list. 

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 requirement 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.

...

  • Environment: Luma Environment on which Tenant is created
  • License Type: License or subscription type of the selected tenant
  • Sessions: Number  The number of sessions allocated to the Tenant. The field is available only for License type: Sessions. 
  • Session duration: Pre defined Predefined duration of a session for the selected Tenant. The field is available only for License type: Sessions. 
  • Users: Number 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% 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

...

  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. The screen is used by Super admins to add or remove allocated Licenses for a Tenant.

...

  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.  Subscription
      1.  Allocated Licenses.
        1. For License Type:  Users
          1. To allocate licenses, add the number of licenses in Users. License count cannot be more than the available 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. Session count cannot be more than the available Sessions in the License Availability section.

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

            Info

            If there are 60 Licenses available and the total number of licenses requirement required is 100,  then enter  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.


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

...