Brightlayer Portal
The Brightlayer Portal is the central platform for managing all your activities. Manage all your subscriptions, services and users in one single place.
Overview
The following sections will walk you through all functionalities of the Brightlayer Portal.
For your convenience find an overview on the content of this document below.
| Section | Content |
|---|---|
| Main elements of the portal home screen | Manage users and services in the main menu. Manage subscriptions and logout via the personal menu. |
| Subscriptions | Edit your company’s data and add or delete Brightlayer services for the company. |
| User management | Add, edit, delete users or manage their access to services and assign roles within those services. |
Main Elements of the Portal Home Screen
Home Portal
The Brightlayer portal home screen opens up the world of Brightlayer Industrial Machinery to you. From here you can access different applications (like e.g. user management) and services that you have signed (e.g. Dashboard Service).
Key Elements on Home Screen
The general structure of the Brightlayer Portal includes the following screen elements:
| Element | Description |
|---|---|
| Main Menu | Home On the left side of window you find the main menu. First button in the menu is “Home” that always brings you back to the Home window from wherever you are. User Management The user management application is part of every subscription. This application allows you to add users and manage their access rights. Services After the user mangement application the available services are listed. What you see in the menu depends on the services that have been signed in your subscription. It is also necessary that you have the correct user rights to get access to those services. In the above example only “Dashboard” services has been signed. User can close the drawer with the help of button on upper left side. This drawer contains the “home” button, the link to the user management and the link to other services the user may have booked. For the version 3.0 of the tool there is only the “Dashboard” service available. |
| User Menu | The user menu in the upper right corner contains the three sections: subscriptions, account and logout. |
Subscriptions
In Brightlayer IM a “Subscription” is generally a digital representation of an actual company. All users that are registered as a user for Brightlayer IM have to be part of at least one subscription. “Services” are stored within the subscription which can be assigned by an administrator. Examples of such services are “Dashboard service” or “Remote maintainance service”. With the help of user management users can get the access to these services.The subscription data like company name, address, country, ErP number etc. is used by Eaton to invoice digital services that have been used by the actual company that owns the subscription.
Administrators who can manage subscriptions have several options to add, delete or edit a subscription:
Editing subscriptions
The subscription data is used to transfer the billing information of the subscriber to the Eaton country organization. Therefore it is important that the subscription data is entered correctly. All fields are obligatory. A verification of the data will be done, once the subscription starts to sign services that generate costs.
Name: The subscription name should be identical to the company name so that it can be identified easily by every user or system admin. When a company has more than one subscription (e.g. for different sites) it is recommended that a site identification is added to the name.
ErP No. : The ErP number that should be used for invoicing the services used on the Brightlayer platform. The billing address and the ErP No. need to be the same that are registered in the Eaton ErP system.
Billing address: The same address as the one recorded in Eaton ErP system under the ErP number entered in the above field should be entered in these fields.
Services
Administrators can also add services to a subscription. To do that they need to click on “Services” in the subscription menu.
In the Services window the services that have been signed for this subscription are listed. Depending on the type of service the service may be deleted.
For Dashboard services the only options are adding or deleting a Dashboard service. To add a Dashbord service administrators need to click on the “+ Add Service” button. To delete a Dashboard Service administrators need to open the sub-menu of the Dashboard service and click on “Delete”.
Add service
To add a service to a subscription you need to have the role of a Subscription Admin for this subscription.
Open the user menu and click on “Subscription(s)”.
In the subscribtions, click on services of the subscribtion that you want to add the service via 3 dots on the right of the subscribtion
Click on the “+ Add Service” button to add Dashboard or Remote Maintenance Service
Add a Dashboard Service
Select a name
Select “Dashboard”
Click “Next”
Select tier
Dashboard Group Service: Start
Dashboard Tenant Service: Flex
Dashboard Tenant Service: Flexplus
Dashboard Tenant Service:Retail
Location. Only for Dashbaord Group Services the location needs to be selected. If the Subscription Admin has access to a Retail tenant the group services can either be opened on the Eaton Enterprise tenant or the Retail tenant. In case the Subscription Admin has access to several retail tenants the correct one has to be chosen from the drop down menu (only if applicable).
Click “Add”
Add Remote Maintenance Service
Select a name
Select Remote Maintenance Service
Click “Next”
Every Remote Maintenance service contains one (1) end-to-end connection by default. The number of connections can be increased to up to three (3) connections. For more information about how to use connection see chapter Remote Maintenance Service
Click “Save”
User Management
The user management allows administrators to create new users, delete users or edit user data and permissions.
Adding a user
New users can only be added by Admin Users that have the necessary rights to do so. After clicking the “+ Add User” button the Admin User has to enter the e-mail address of the new user into the right field. The Admin User should also assign a role to the new user. If no role is assigned to the new users he would not have access to any service on Brightlayer. Roles can also be edited by the Admin User once the user is verified.
Closing the new user creation process by clicking “create” would start the user verification process: The user will receive a verification email and must confirm their email address. The user will also be asked to add their first and last name to the user’s data.
Attention:
The new user will only appear in the user list after the verification process has been successfully completed by the user. If the user fails to complete the verification process within 24 hours, the user creation has to be repeated.
Editing a user
To edit a user’s data or role assignment click on “edit” in the users context menu.
Two tabs can be edited: “User info” and “User Roles”
User info is the user’s personal data. The E-Mail address of the user can not be changed. If the e-mail address of a user changes this user has to be deleted and created, again. The user’s first name and last name are obligatory fields that have to be filled in by the user during the verification process. The user phone number(s) are not obligatory.
User roles
In this window the access of the user to services and the role of this user within this subscription and service can be managed:
Subscription roles
Within a subscription there are 3 roles: None, Subscription User and Subscription Admin:
A user that is assigned to at least one service role would normally be assigned the role “None” within the subscription. In this case he would only be able to see the service he is assigned to.
Users with the Subscription User role would be able to see all services that are available in the subscription. It is not necessary that the user has been assigned a role in one of these services. This way the Subscription User role can work like a “parking lot” for users that have not yet been assigned to a role within a service. At any time the Subscription User can be assigned to roles within services.
Attention: If users are not assigned to any role within a service they have to be assigned to the Subscription User role. Otherwise they would be deleted from the user management as they have no access rights within the subscription.
The Subscription Admin can sign / unsign and edit services for the subscriber. He could also create and delete users and give them access to services. The Subscription Admin would also be responsible to create new devices that would create data traffic on the system. As these are very extensive rights that also have a high influence on the costs of the subscription it is recommended to only assign this role to a very limited number of users.
Service roles
Services may have individual roles that differ from service to service. Therefore, they are described in the service chapter. A common point across all service roles is the ‘None’ field. This field is used to deny the user from accessing a certain service.
User roles for the Dashboard Group Service
User roles in the Dashboard Group Service have to be assigned for every group or sub-group within the service. The roles are not automatically inherited to sub-groups. The following roles are possible:
Group User Standard
Within the selected Dashboard Group this role gives permission to open and read data from the dashboards. It is the most basic possible access.
Group User Alarms
Within the selected Dashboard Group this role has the same rights as the standard user but can set, modify and delete alarms additionally.
Group Write Admin
Within the selected Dashboard Group this role can create sub-groups and dashboards. It can also re-align, re-size, and configure widgets on dashboards.
User roles for the Dashboard Tenant Service
User roles in the Dashboard Tenant Service have to be assigned for every group or sub-group within the service. The roles are not automatically inherited to sub-groups. The following roles are possible:
Tenant User
Within the selected Dashboard Group this role gives permission to open and read data from the dashboards. It is the most basic possible access.
Tenant Account Admin
This admin role is only responsible within one group of the tenant. The admin could add or remove users and register new devices.
Tenant Operator
The tenant operator can create new and delete Groups, Dashboards, Devices and Users for the tenant. He has access up to the tenant root group which means he could be given access to all groups on the tenant.
Tenant Admin
This role has full admin rights on the tenant including deleting the tenant. This role would typically only be assigned to the Eaton Support team.
User roles for the Remote Maintenance Service
Remote Maintenance Admin (RM Admin)
The RM Admin can administrate an existing RM Service in a subscription:
Add an existing device
Delete the device
Get the configuration files of a device
Create; get configuration; delete a user device
Create and delete a connection.
The “Subscription Admin”
The Subscription Admin has quite extensive rights that also influence the costs of the subscription. Therefore, it is recommended to only assign this role to a very limited number of users:
Signing Dashboard service(s), which is a Cloud based Data visualization and analytics service.
Signing Remote Maintenance services, which allow to manage VPN connections between “User devices” and “Gateway devices”.
After adding the first RM Service to a Subscription, the Subscription Admin would automatically become the RM Admin of this service. These roles can be changed later on in the user management.
Create new devices that would be integrated into the Dashboards and Remote Maintenance service and that may create additional data traffic on the system.
Create and delete users and give them access to services.