Create Organization
License
First, an organization lincese has to be created.
Log in to the License manager navigating the URL:
https://lm-management.azurewebsites.net/account/login
- The list of companies is opened.
Click the Create Company menu.
- The form Register company is opened.
Figure 1: License manager - Register company
Enter the company name and click Create Company button.
- The company ID has been created.
Click the Save button.
- The company with its ID appears in the list.
For created company click the Edit button to add a license.
Figure 2: License manager - Add company license
Click the Add new license button. Fill in data:
- Application – Industry4SME
- Users – max number of users in the company
- Organization items – the number of organization items
- Valid From – Valid To – license validity period
Click Save.
- The message for a successfully created license appears.
- The company license has been created successfully.
Notes: Open the companies list and copy the created company ID GUID. This is the organization License Key.
Add New Organization
There are two types of organizations:
- Service Company - these organizations are managed only by System Administrators. They manage their own Clients and can access their data and dashboards
- Client - these are the "children" of Service Companies. They can be managed by System Administrators or by Organization Administrators of their Service Company. By manual configuration one Client can be linked to multiple Service Companies. System Administrators can also create Clients as a top-level organizations
When a user logs in, he is automatically presented with the list of companies he has access to based on his role and organization affiliation.
The steps of creating an organization are identical for both types. For example, to create a new Client:
Log in with System Administator or with an Organization Administrator of the desired Service Company.
Select the menu Add/Client
Figure 3: Upkip Administration - Add client
- The Add new client form is opened
Figure 4: Upkip Administration - Add new client
Fill in data:
- Name – company name
- License Key – the created company ID from the license manager
- Azure group – select the Azure AD User Group. There is usually only one
- Logo – Upload a picture with company logo
- Language – Select the default organization language
Click the Add button.
At this point the system will automatically configure the following:
- Default configuration settings:
- Dedicated read-only QL user
- Organization user map
- Data servers
- Empty Factory element with a single empty Department element below it
- Machine statuses
- Downtime reasons
- Dedicated databases:
- Dedicated databases with retention policies
- Dedicated read-only and read-write users
- Visualization portal new organization with:
- Users (all passwords are set to “admin”. Thus the system prompts for a password change at each user login)
- Teams
- Folders
- Predefined list of dashboards
- Default permissions
- Home dashboard
- Data Sources (a provisioning template for back up and reference is saved in the environment storage account under container “tenant-provisioning”, folder “Grafana” with the name “dataSourcesTemplate_{organization name}.yaml”
- Service company data sources - in the case of creating a client its data sources are also created for its parent Service Company
Note: Most of these settings cound be customized based on Service Company level. The intention is that Clients of a specific Service Company can have different set of default dashboards, folders, etc.
Verify Created Organization
Administration Portal
Log in to the Upkip Administration multitenant https://administration.upkip.cloud.
Check if a new organization is created.
- There should be a visible new organization with its logo.
- The basic menus in the new organization should be visible – Devices, Data, Planning, and Server.
Figure 5: Upkip Administration - newly created company
Define Organization Structure
Select the menu Devices/Organization.
- There is possible to create the company organization structure with departments and machines (see Organization Structure documentation)
There is possible to add machines with their properties. (see Add Machine documentation)
There is possible to add the machine tags:
- To add machine tags follow the documentation Machine Tags.
- To add machine tags connected with external sensors follow the steps Add Tag with an external sensor.
When the organization structure with departments and machines has been added, there is possible to define the layout of the machines in the factory premises. (see Factory Layout definition).
Select the menu Devices/Gateways.
- There is possible to create gateways (Windows or Linus) (to Gateways documentation).
Select the menu Devices/External sources.
- There is possible to define external sources (to External sources documentation)
Visualization Portal
Log in to the Upkip Visualization multitenant https://app.upkip.cloud with the admin user.
Click on the user icon on the bottom left side and switch to the newly created organization.
Figure 6: Upkip Visualization - switch to a created organization
- The Upkip Visualization main menu for the created company is opened.
- The main menu buttons for all four roles are created – Operator, Team Leader, Supervisor, and Manager.
- There is a menu button – Factory Layout.
- The menu Administration goes to the Upkip Administration
- The menu Documentation opens the current site with Upkip online documentation.
Figure 7: Upkip Visualization – Main menu
Users
Click on the Configuration menu and select the menu Users.
Figure 8: Upkip Visualization – Users menu
- There should be created users with roles Admin, Editor, and Viewer.
Note: The password for all new users is “admin”. Grafana will prompt users to change it every time they log in.
Teams
Log in to the Upkip Visualization with created Admin user.
Click on the Configuration menu and select the menu Teams.
Figure 9: Upkip Visualization – Teams menu
- The following teams are created: Manager, Supervisor, Team leader, Operator, System Administrator, and Organization Administrator.
Figure 10: Upkip Visualization - created teams
Data Sources
Verify that all Data Sources are working:
Click on the Configuration menu and select the menu Data Sources.
Figure 11: Upkip Visualization - Data sources menu
- The following data sources are listed.
Figure 12: Upkip Visualization - created data sources
Click on the data source from the list (e.g. ConfigDB).
- The form with the Settings of the selected data source is opened.
At the bottom, there is a Save & Test button. Click on it.
- A test is executed. If passed, a green message for success is shown.
Execute connectivity test for each data source. All results should be successful.
If applicable the new data sources of the parent Service Company should also be tested.