Skip to main content

🔹 Tenant User

Changelog​

VersionAuthorUpdate DateComment
1.0.0ITsung.Shen2023-11-30First Version
1.0.3ITsung.Shen2024-07-10Update description of Chapter 3.1~3.4
2.0.0ITsung.Shen2025-06-26Add Chapter 3.5 / 3.6Update Chapter 3 with Direct Access scopesUpdate 3.1 Home page with direct access

1. Introduction​

Tenant user is used to define who can enter the tenant space and use various functions in the tenant. For each added Tenant user, role can be set to limit the user's access to each function.Tenant admin can use the function User Management -> Tenant Users to add or edit Tenant User and User's Role.

2. Add / Edit tenant user​

  1. Click Add button of Tenant users page Tenant-User-1-01.png

  2. Fill up the basic information of this user Tenant-User-1-02.png

  3. If the user is already existed in EdgeHub platform, the portal will automatically fill up the basic information. Tenant-User-1-03.png

  4. Set the tenant role of this user. EdgeHub provide five default roles

    • Admin
    • Editor
    • Engineer
    • Operator
    • Viewer

We will discuss about the relationship between role and EdgeHub function in next section. Tenant-User-1-04.png

  1. Click Next to set Group permission Tenant-User-1-05.png

  2. Set this user's group role in each group. In this example, we add this user into all group and give the user a group role as Admin for each group. Tenant-User-1-06.png

  3. Click submit to add this user
    Tenant-User-1-07.png

  4. Create user successfully. Tenant-User-1-08.png

  5. In Tenant user list, you can click edit button to edit a user Tenant-User-1-09.png

  6. In Edit tenant user page, you can change role of this user Tenant-User-1-10.png

  7. Same as step 6, you can change group role of this user. In this example, we change some group's role as Editor for this user. Tenant-User-1-11.png

  8. Click Submit to modify this user. Tenant-User-1-12.png

3. Tenant Role & EdgeHub Functionalities​

For the five default roles provided by EdgeHub, each role will have corresponding Permission Scopes configuration, which include:

CategoryScope Display NameDescription
Common functionsAlarm and EventAlarm related operation
Device managementDevice managementDevice management operation
Object managementGroup, Object, and ParameterGroup/object/parameter related operation
Object managementProfile ManagementOperation of Profile Management
Object managementPluginData plugin operation
Object managementMachine StatusOperation of Machine Status (iFactory Pivot environment only)
Object managementRule ManagementOperation of Rule Management (iFactory Pivot environment only)
Object managementOthers (Data Hub)(System usage)
Object managementOthers (Rule Engine)(System usage)
User managemntUser ListUser related operation in User management
User managemntClient List(System usage)
User managemntRole ListRole related operation in User management
Command CenterCommand Center SettingsCommand Center operation
Command CenterDashboard & Menu ListDashboard & Menu operation in Command center
Advanced settingsLicenseLicense setting in Advance Settings
Advanced settingsGeneralGeneral setting in Advance Settings
WISE-IoTSuite/DashboardValue and AlarmOperate value & alarm in Dashboard (Not yet available)
WISE-IoTSuite/DashboardOperation LogOperation Log in Dashboard (Not yet available)
Direct Access - EPNServer ManagementEPN Server related operation
Direct Access - EPNDevice ConfigurationEPN Device related operation
Direct Access - EPNTerminal ConfigurationEPN Terminal related operation
Direct Access - EPN(Utility) EpnClient operationEpnClient related operation on EdgeHub utility
Direct Access - EPN(Cloud) EpnClient managementEpnClient related operation on Direct Access portal

The value of the scope affect the usability of the corresponding EdgeHub functions.

  • The value of the scope include:
    • Manage (CRUD)
    • View (View only)
    • None (No permission)

Tenant-User-2-01.png

In this section, we talk about the relationship between tenant role and EdgeHub functionalities

3.1 Home Page & header functions​

Tenant-User-2-02.png Tenant role of a user affect that whether this user can access into the function on Home page or not. Affected functions includes:

  • [Home Page] Data Management
    • The user, whose tenant role has one of the following scope permissions (Manage or View), can access this funciton.
      • Group, Object, and Parameter
      • Alarm and Event
      • Profile Management
      • Plugin
      • Machine Status
      • Rule Management
  • [Home Page] User Management
    • The user, whose tenant role has one of the following scope permissions (Manage or View), can access this funciton.
      • User List
      • Client List
      • Role List
  • [Home Page] Command Center
    • The user, whose tenant role has one of the following scope permissions (Manage or View), can access this funciton.
      • Command Center Settings
      • Dashboard & Menu List
  • [Home Page] Device Management
    • In current version, this function is affected by Group user role. Please refer to the article of Group User
  • [Header Function] Advanced settings
    • The user, whose tenant role has one of the following scope permissions (Manage or View), can access this funciton.
      • License
      • General
  • [Header Function] Tenant management
    • The user who has the tenant role of Admin can access this funciton.
  • [Home Page] Direct Access
    • The user, whose tenant role has one of the following scope permissions (Manage or View), can access this funciton.
      • Server Management
      • Device Configuration
      • Terminal Configuration
      • (Cloud) EpnClient management

3.2 Data Management​

Some functions's accessability are affected by tenant role, includes:

FunctionRelated scopeAdminEngineerEditorOperatorViewer
Profile managementProfile managementManageManageManageNoneView
Alarm settingAlarm and EventManageManageManageNoneView
External blobGroup, object, and parameterManageManageManageNoneView
PluginPluginManageManageManageNoneView

Tenant-user-2-03-new.png

3.3 User Management​

Some functions's accessability are affected by tenant role, includes:

FunctionRelated scopeAdminEngineerEditorOperatorViewer
Tenant UsersUser ListManageNoneViewNoneView
RolesRole ListManageNoneViewNoneView

Tenant-User-2-04.png

Note: The Roles function currently only supports displaying the Role list. Other functions (add, edit, delete roles) are not yet supported.

3.4 Command Center​

Some functions's accessability are affected by tenant role, includes:

FunctionRelated scopeAdminEngineerEditorOperatorViewer
Command centerCommand Center SettingsManageManageManageNoneView
Dashboard (Access in)Dashboard & Menu ListManageManageManageNoneView
Menu listDashboard & Menu ListManageManageManageNoneView

Tenant-User-2-05-new.png Note: For Dashboard functionality, the tenant role only be used to determine whether this user can access into this function or not. The inner function of dashboard operation is affected by Group role of this user.

3.5 Direct Access​

Some functions's accessability are affected by tenant role, includes:

FunctionRelated scopeRequired scope permission
Server listServer ManagementManage, View
Add / Edit serverServer ManagementManage
Delete server (while delete tenant)-Root tenant Admin or parent tenant Admin
Device listDevice ConfigurationManage, View
Device syncDevice ConfigurationManage
Edit deviceDevice ConfigurationManage
Enable / disable device or Bandwidth saverDevice ConfigurationManage
Create / Delete device (from DPM)Device ConfigurationManage
Terminal listTerminal ConfigurationManage, View
Add / Edit / Delete terminalTerminal ConfigurationManage
EpnClient list(Cloud) EpnClient managementManage, View
Register / Edit / Delete EpnClient(Cloud) EpnClient managementManage
Enable / disable EpnClient or Bandwidth saver(Cloud) EpnClient managementManage

The following table shows how each scope mentioned above is configured under the default roles

ScopeAdminEngineerEditorOperatorViewer
Server ManagementManageManageManageViewView
Device ConfigurationManageManageManageViewView
Terminal ConfigurationManageManageManageViewView
(Cloud) EpnClient managementManageManageManageViewView

Tenant-User-3.5-01.png

3.6 EdgeHub utility​

Some functions's accessability are affected by tenant role, includes:

FunctionRelated scopeRequired scope permission
Device listDevice ConfigurationManage, View
Connect / Disconnect deviceDevice ConfigurationManage
Terminal listTerminal ConfigurationManage, View
Add / Edit / Delete terminalTerminal ConfigurationManage
EpnClient Connect / Disconnect (on main window)(Utility) EpnClient operationManage, View
Register EpnClient (on main window / tray menu)(Utility) EpnClient operationManage
Edit EpnClient (on main window)(Utility) EpnClient operationManage
Enable / Disable BandwidthSaver (on main window)(Utility) EpnClient operationManage

The following table shows how each scope mentioned above is configured under the default roles

ScopeAdminEngineerEditorOperatorViewer
Device ConfigurationManageManageManageViewView
Terminal ConfigurationManageManageManageViewView
(Utility) EpnClient operationManageManageManageViewView

Tenant-User-3.6-01.png