Creating A Tenant - OMNIALowCode/omnia2 GitHub Wiki
Each subscription of the platform has a section that allows users with administrative privileges to perform a large set of operations on it. Essentially, this area allows for account creation and management, as well as user creation and management.
You can access it by logging in with a user with enough privileges and pressing the Subscription Management option in the menu.
One of the core principles of the platform is that data is isolated. A user can only access data he has privileges to access. This mechanic is ensured by dividing each solution in the platform in Tenants. This wiki article describes tenants and their creation - skip to the last section if you just want to create a tenant to execute the tutorials.
Each tenant has its own definition, and can be an application with a different model. An user can have access to multiple Tenants, and its privileges are defined in the context of each one.
Each tenant corresponds to an account/application in the platform, and can be seen as the instantiation of a model for a specific end user.
There are multiple types of tenant, explained below, which allow for differentiation between different kinds of accounts:
- Template: Model developed in order to respond to a specific problem. Other tenants can be created based on tenants marked as templates – when a template is used to create a new tenant, all of its data is copied to the new structure.
- Full: Created from a template, containing the data from it, as well as possible additional developments. Cannot be deleted unless its type is changed.
- Demo: Similar to a Full tenant, but it can be deleted.
A tenant can have its type changed at any moment.
Tenant creation has a set of parameters that can be configured:
-
Account short code: Code of the tenant. Shows up in URLs.
-
Code: Globally unique identifier (GUID) that identifies the tenant.
-
Name: Name of the account to create, visible on all screens of the application.
-
Type: Tenant type (see What types of tenant are there?)
-
Description: Auxiliary text to describe the tenant’s function.
-
Max No. of users: Maximum number of users that can be created.
-
Image: Image to associate to the account, visible on all screens of the application and in the tenant selection menu.
-
Email: Login email for the tenant's administration user.
-
Contact email: Contact email for the tenant's administration user. Can be the same as the login email.
-
Password: Password for the tenant's administration user. If they already exist in the platform, value is ignored unless needed for a script execution.
If you have a SendGrid configuration, it is possible to create new users without passwords, and the password will be sent to them. If SendGrid configuration is invalid, the user will still be created, which will force a user with administrative privileges to have to manually set their password.
- Language: Default application language for the tenant's administration user.
-
Group and Subgroup: Used for organization purposes in the platform.
-
OEM: Configuration element in the platform, which can be used to determine various graphical settings (login page logos, etc.). Also visible in the URL.
- Parameters: If the template the account is being created from has a script set to execute on “Account Creation”, you can use this option to pass parameters to the script – for example, if you want to load different demonstration data onto the account depending on the country it is being used in.
If you want to try one of the tutorials, these are the steps you should follow:
-
Open the user menu (click in the user name, placed in the top-right corner), and access the Subscription Management area.
-
Through the menu, access Tenant Accounts > Create.
-
Fill the tenant in with the information you need. It should have the Modeling Template as the template it's based on, and be of Demonstration type. We recommend to create the tenant with a new administrator user (different from the subscription manager).
The administration user of the tenant will be created if they do not exist yet. In this case, they must be edited if you want them to have modeling access to this new tenant.
-
Through the menu, access Users > List.
-
Edit the user you want, mark the system role Modeler and select the new tenant in the list.
When the tenant is created, access it with the platform's administration account or the new administration user, if you gave them modeling permissions. You are now ready to begin the tutorials! We suggest you begin with the modeling tutorial.