Skip to main content

  • Tenant management

    Changelog​

    VersionAuthorUpdate dateComment
    2.1.0ITsung.Shen2024/07/02First Version
    2.2.0ITsung.Shen2024/07/29First released
    2.3.0ITsung.Shen2025/02/11Add chapter 9~11
    2.5.0ITsung.Shen2025/08/19Update chapter 5, allow to edit tenant ownerand expiration date of trial subtenant

    1. Introduction​

    EdgeHub provides a tenant management interface that allows users to manage tenant-related functions. Currently, EdgeHub supports the following methods to generate tenants:

    • Purchasing an EdgeHub license key
    • Applying for an EdgeHub trial
    • Manually created by the EdgeHub system administrator
    • Creation via the SI Console

    Through this interface, system administrators or general users can use the following tenant management functions:

    • Display the tenant list
    • Add sub-tenants
    • Update tenants
    • Activate license keys
    • Allocate quotas
    • Retry deductions

    Next, we will provide a detailed explanation of each sub-function.

    2. Display Tenant List (Tenant List)​

    2.1 General Tenants​

    • For general EdgeHub users, after entering a tenant, they can access the tenant list through the tenant management menu in the top right corner of the screen.

      Tenant-management-2.1-01-tenant-list.png

    • Upon entering the tenant list page, users can see their own tenant and a list of directly managed sub-tenants (the root node is the current tenant).

      Tenant-management-2.1-02-tenant-list.png

      The displayed columns are explained as follows:

      Column NameDescription
      Tenant NameThe name of the tenant
      LabelsLabels indicating the tenant type, including:- Subscribed- Trial- Custom- SI Console- Licensed Subtenant- Custom Subtenant
      DescriptionDescription of the tenant
      License Quota (used/quota)Displays the tenant's contract quota and current usage. Currently, it mainly shows two types:- Parameter quantity- Device quantity
      StatusDisplays the current status of the tenant- Enabled- Disabled
      Date CreatedThe creation date of the tenant
      Expiration DateThe expiration date of the tenant
      LogOperation log of the tenant (This feature is not available in EdgeHub version 2.2)
      ActionsOperations menu for the tenant, including:- Allocate license quota- Switch status- Edit tenant

    2.2 Root Tenant​

    • For EdgeHub system administrators, the tenant management interface can be used to manage all tenants on the entire site. First, enter the Root tenant.

      Tenant-management-2.2-01-Root-tenant.png

    • After entering, you can access the tenant list through the tenant management menu in the top right corner of the screen.

      Tenant-management-2.2-02-Root-tenant-management.png

    • Upon entering the tenant list page, you can see a list of all tenants on the entire site (the root node is the Root tenant).

      Tenant-management-2.2-03-Root-tenant-list.png

    3. Add Sub-Tenant (Add Subtenant)​

    3.1 General Tenants​

    • Users of general tenants (excluding SI Console type) can use the tenant management interface to add sub-tenants. Click the Add button on the screen and select Add subtenant.

      Tenant-management-3.1-01-Add.png

    • Enter the add subtenant page and fill in the subtenant information.

      Tenant-management-3.1-02-Add-subtenant.png

      Column NameDescription
      Subtenant NameName of the subtenant to be added
      DescriptionDescription of the subtenant
      Parent TenantName of the parent tenant, which is fixed as the current tenant and cannot be changed
      Expiration DateExpiration date of the subtenant. Whether this field can be set depends on the type of parent tenant:- Subscribed, SI Console, Licensed Subtenant: Cannot be modified, date is the same as the parent tenant- Others: Can be modified, but cannot exceed the parent tenant's date
      EmailEmail account of the subtenant owner
      First NameFirst name of the subtenant owner (if the email is of an existing user, it will be auto-filled)
      Last NameLast name of the subtenant owner (if the email is of an existing user, it will be auto-filled)

      In addition to the above fields, you also need to set the subtenant's quota (License quota), including Device Qty and Parameter Qty. The UI will restrict the amount of quota that can be allocated to the subtenant, which cannot exceed the available quota of the parent tenant.

      Tenant-management-3.1-03-quota-allocation.png

    • After entering all information, click Submit to complete adding the subtenant.

      Tenant-management-3.1-04-submit.png

    • After adding, return to the tenant list to view the newly added subtenant.

      Tenant-management-3.1-05-add-complete-list.png

    3.2 Root Tenant​

    • Similar to general tenants, the root tenant can click the Add button on the screen and select Add subtenant.

      Tenant-management-3.2-01-add-subtenant.png

    • After entering the add subtenant page, the fields to be filled are the same as in section 3.1. The only difference is that the root tenant can add subtenants for any tenant on the entire site (excluding SI Console type). Click the + button in the Parent Tenant field, and the tenant list of the entire site will be displayed on the right side of the screen. Select one as the parent tenant.

      Tenant-management-3.2-02-select-parent-tenant.png

    • After selection, the other filling logic is the same as in section 3.1. After filling in all information, click Submit to complete adding the subtenant.

      Tenant-management-3.2-03-submit.png

    • After adding, return to the tenant list to see the newly added subtenant.

      Tenant-management-3.2-04-tenant-list.png

    • Note, the types of subtenants added using this feature from the root tenant will include:

      • Custom - When the specified parent tenant at the time of addition is the Root tenant
      • Licensed Subtenant - When the parent tenant type specified during addition is Subscribed, Trial, or Licensed Subtenant
      • Custom Subtenant - When the parent tenant type specified during addition is Custom or Custom Subtenant

    4. Activate License Key​

    If your tenant type is one of the following, you can use this feature:

    • Subscribed - Use this feature to increase the tenant's quota.
    • Trial - Use this feature to convert the tenant to a subscribed tenant.
    • Custom - Use this feature to convert the tenant to a subscribed tenant.

    Here are the detailed steps:

    • First, refer to the Get License Keys From WISE-Marketplace section in the SOP document to purchase a license key.

    • After obtaining the license key, return to this interface, click + Add -> Enter license key.

      Tenant-management-4-02-enter-license-key.png

    • A dialog box for activating the license key will appear in the center of the screen. Enter the license key you purchased and click the Verification button.

      Tenant-management-4-03-enter-and-verification.png

    • If the key is valid, the screen will indicate that the key is Valid. Then, click the Activate license keys button.

      Tenant-management-4-04-activate-key.png

    • After activation, the screen will return to the tenant list. You will see that the tenant type has changed to Subscribed, and the quota has been updated to the purchased amount.

      Tenant-management-4-05-tenant-list.png

    • Regarding quota changes after activation, please note the following:

      • If the original tenant type was Subscribed - After activation, the total quota will be the original subscribed quota plus the activated quota.
      • If the original tenant type was Trial - After activation, the total quota will be the original trial quota plus the activated quota. However, the original trial quota will expire and be automatically returned after 90 days.
      • If the original tenant type was Custom - After activation, the total quota will be the activated quota. The original quota allocated to the tenant will be immediately returned, leaving only the activated quota.

    5. Edit Tenant​

    Users can use this feature to edit the settings of the current tenant or subtenant. The editable items are as follows:

    • Current Tenant

      • Tenant Name
      • Description
      • Tenant Owner
        • Note: Once edited, the original tenant owner will be reassigned as the tenant admin.

    • Subtenant

      • Tenant Name
      • Description
      • Expiration Date: Can be changed, but the new date cannot exceed the expiration date of the current tenant.
        • Note: Expiration date can only be edited for two types of subtenants: Trial subtenants and Custom subtenants.
      • Tenant Owner
        • Note: Once edited, the original tenant owner will be reassigned as the tenant admin.
      • Quota - Device Quantity: Can increase or decrease the subtenant’s quota.
      • Quota - Parameter Quantity: Can increase or decrease the subtenant’s quota.

    Follow these steps to update the tenant:

    • Click the Actions button on the right side of the tenant list and select Edit tenant.

      Tenant-management-5-01-action-edit-tenant.png

    • If editing the current tenant, quota cannot be modified.

      Tenant-management-5-02-edit-self-new.png

    • If editing a subtenant, you can additionally modify the expiration date and quota.

      Tenant-management-5-03-edit-sub-tenant-new.png

    • After making changes, click Submit to complete the tenant editing.

      Tenant-management-5-04-submit-new.png

    6. Allocate License Quota​

    As described in section 5, users can edit subtenants, including modifying quotas. For subtenants where quotas can be adjusted, the tenant management interface provides a separate option to directly allocate quotas.

    • Click the Actions button on the right side of the tenant list and select Allocate license quota.

      Tenant-management-6-01-allocate-quota.png

    • Enter the allocation screen, which is similar to the tenant editing interface, and adjust the quota directly.

      Tenant-management-6-02-quota-change.png

    • After making the changes, click Submit to complete the quota modification.

      Tenant-management-6-03-submit.png

    7. Switch Status​

    For subtenants under the current tenant, users can use this feature to switch the subtenant’s status between enabled and disabled.

    • Enabled: Users of the tenant can use EdgeHub functions normally.
    • Disabled: Users of the tenant cannot access EdgeHub functions.

    Here's how to perform this action:

    • Go to the tenant list, find the subtenant you want to modify, click the Actions button on the right side of the tenant, and select Switch status.

      Tenant-management-7-01-actions.png

    • A dialog box will appear for switching the status. Click the toggle to change the status to enabled or disabled, then click the Confirm button to submit.

      Tenant-management-7-02-switch-status.png

    • Return to the tenant list to see that the subtenant's status has been successfully updated.

      Tenant-management-7-03-switched.png

    8. Retry Deduction​

    This feature is only applicable to subscription-type tenants. For these tenants, the expiration date is the 1st of each month. EdgeHub will attempt to deduct the corresponding amount from the Advantech Marketplace based on the purchased license key on that day. If the customer’s Marketplace account balance is insufficient, the deduction will fail, and the tenant will immediately enter a Disabled state, preventing the tenant's users from continuing to use EdgeHub services.

    Within the next 30 days, users must promptly top up their Advantech Marketplace account. After recharging, you can use this feature to retry the deduction. If successful, the tenant will return to an Enabled state, and the tenant's expiration date will be updated to the 1st of the following month.

    Here are the steps to retry a failed deduction:

    • Go to the subscription tenant with the failed deduction. At the top of the tenant management interface, you will see a notification indicating the deduction failure.

      Tenant-management-8-01-alert.png

    • Click the button next to the notification to start the retry deduction process. Note that you must first top up your account on Advantech Marketplace before performing this action.

      Tenant-management-8-02-retry-button.png

    • A verification dialog will appear. Enter your username and password to authenticate. Note that the account entered here must be the Tenant owner account to allow the deduction action.

      Tenant-management-8-03-retry-dialog.png

    • After verification, click Confirm, and the EdgeHub backend will retry the deduction.

      Tenant-management-8-04-dialog-submit.png

    • If the entered account is not the tenant owner, you will receive an error message, and retrying the deduction will not be allowed.

      Tenant-management-8-06-retry-fail.png

    • If the deduction is successful, the tenant’s status will revert to Enabled, restoring its original state.

      Tenant-management-8-05-tenant-enabled.png

    9. Search / Filter​

    Starting from EdgeHub version 2.3, the Tenant List feature supports Search and Filter functionalities.

    The tenant list supports a search function, currently available for the following field:

    • Tenant Name

    Users can enter keywords in the search input field to perform a fuzzy search on tenant names. The detailed steps are as follows:

    • In the tenant list interface, click the search input field and enter the keyword you want to search for.

      Tenant-management-9-01-search-input.png

    • Click the Apply button to execute the search.

      Tenant-management-9-02-apply.png

    • The tenant list will display tenants whose names contain the keyword, highlighting the keyword in yellow.

      Tenant-management-9-03-search-result.png

    9.2 Filter​

    The tenant list supports filtering by the following fields:

    • Tenant Labels
    • Tenant Status

    For details on these fields, please refer to Section 2.1. The usage instructions are as follows:

    • In the tenant list interface, click the label filter box to display a dropdown list of all available labels.

      Tenant-management-9-04-filter-label.png

    • Select the labels you want to display, then click Apply.

      Tenant-management-9-05-filter-label-apply.png

    • The tenant list will display tenants matching the selected labels.

      Tenant-management-9-06-filter-label-result.png

    • The tenant status filter works the same way. Click the status filter box to display a dropdown list of all available statuses.

      Tenant-management-9-07-filter-status.png

    • Select the status you want to display and click Apply.

      Tenant-management-9-08-filter-status-apply.png

    • The tenant list will display tenants matching the selected status.

      Tenant-management-9-09-filter-status-result.png

    • Finally, if you want to clear the search/filter results, click the Clear all button to reset the list to its original state.

      Tenant-management-9-10-clear-all.png

    10. Log​

    Starting from EdgeHub version 2.3, the tenant list feature includes a tenant log functionality. It records tenant-related operations such as actions, subscriptions, and quota changes. The detailed log action types are listed below:

    Action TypeDescription
    CreatedThe tenant was created
    Create tenantA subtenant was created under this tenant
    EditedThe tenant was edited
    Edit tenantA subtenant was edited under this tenant
    Status changedThe tenant's status was changed
    Change statusA subtenant's status was changed
    Delete tenantA subtenant was deleted under this tenant
    Activate licenseThe tenant activated a license
    Unsubscribe licenseThe tenant unsubscribed from a license
    Dispatch quotaThe tenant allocated a quota to a subtenant
    Revoke quotaThe tenant revoked a subtenant's quota
    Quota increaseThe tenant's quota was increased
    Quota decreaseThe tenant's quota was decreased
    BillingThe system successfully/unsuccessfully billed a subscribed tenant
    Request renewalThe tenant requested a renewal payment
    RenewThe tenant successfully/unsuccessfully renewed
    Expiration updatedThe tenant's expiration date was updated
    Update expirationA subtenant's expiration date was updated

    Whenever any of the above actions are performed, the system records a log. You can view the logs as follows:

    • Click the Log icon next to a tenant in the tenant list.

      Tenant-management-10-01-log-icon.png

    • After clicking, you will enter the log page where you can view the log details.

      Tenant-management-10-02-log-list.png

    • Users can also use the search function to perform a fuzzy search on the Description field. Entering a keyword will return matching logs.

      Tenant-management-10-03-log-search.png

    11. Delete Tenant​

    Starting from EdgeHub version 2.3, the following types of subtenants can be deleted:

    • Subscribed
    • Trial
    • Custom
    • Licensed Subtenant
    • Custom Subtenant

    Note that you cannot delete the currently active tenant. You can only delete subtenants under the current tenant.

    Steps to delete a subtenant:

    • In the tenant list, click the Action icon next to the subtenant you want to delete. The dropdown menu will include the Delete tenant option.

      Tenant-management-11-01-delete-tenant-menu.png

    • Selecting this option will open a dialog showing any prerequisites that must be met before deletion:

      • The tenant's quota must be returned and reset to 0.
      • The tenant status must be set to Disabled.

      Tenant-management-11-02-cannot-delete.png

    • Return to the tenant list -> Edit tenant -> Set the tenant's quota to 0.

      Tenant-management-11-03-decrease-quota.png

    • Then go back to the tenant list -> Switch status -> Set the status to Disable.

      Tenant-management-11-04-disable-tenant.png

    • Return to the tenant list and confirm that the subtenant has a quota of 0 and is in a Disabled state.

      Tenant-management-11-05-tenant-can-be-delete.png

    • Select the Delete tenant option again. The confirmation dialog will now show that conditions are met. Enter the tenant name and click Delete.

      Tenant-management-11-06-delete-submit.png

    • After clicking, you will return to the tenant list, and the deleted tenant will no longer appear.

      Tenant-management-11-07-tenant-deleted.png

On this page ...

Is this helpful?