The Appearition platform has been designed as a multi-tenanted system. Essentially a tenant is an isolated part of the platform where content is stored in its own data store. Users of the platform are allocated to one or many tenants.
How you treat a tenant depends on your organisational needs. A tenant can represent anything from a business unit (e.g. HR, IT, Finance) to a faculty in a university (e.g. Faculty of Marketing, Faculty of Medicine).
Creating a Tenant#
There are two ways a tenant can be created on the Appearition Platform:
- Manually by System Admin; or
- By provisioning via the Package Manager
Manually by System Admin#
The creation of tenants is restricted to System Admin role. Furthermore, the total number of tenants that can be created on the Appearition Platform is restricted only by the server infrastructure that the platform has been deployed on. In particular, the limit is related to the database server hosting each tenant and the file system where tenant content will be stored and served from
Each tenant is provisioned a dedicated database
The Appearition Platform requires a Microsoft SQL Server 2014 or above database server to host the master database and each tenant database
Login to the Appearition Platform Portal and navigate to the Manage Tenants screen
Click “Add Tenant”
Type in the Tenant name and key
Next choose the available option in the DB Server field
More about DB Server
Depending on the deployed instance, there may be different options to choose from. For further assistance please contact us for support.
Click “Save” button and the tenant will be created.
Next, click into the new Tenant
Activate and Initialise User and Persona modules#
Navigate to Settings screen
Click on Activate Module
Find the User Management module and click “Activate” and accept all prompts.
Select the “User Management” module
Click on “Import Missing Settings” button and accept the prompt
Select the “Persona Management” module and also click on “Import Missing Settings” button
Click on the “Flush Cache” button and accept.
By provisioning via the Package Manager#
The Package Manager can only be access by System Admin and represents a set of instructions that the Appearition Platform will use when provisioning a new account.
When a package has been created, System Admin is able to assign it when creating a new customer user account on the system.
Managing a Tenant#
Once a tenant has been create, System Admin is able to modify the tenant. For each tenant, there is an “Actions” button with menu items in it
You can modify the tenant name and key. However once the tenant has been created, the DB Server cannot be changed.
The Tenant Key is a critical identifier for the tenancy. If there are existing solutions built off the tenant, changing the key will cause those solutions will stop being able to communicate to the APIs of that tenant. All API request URLs contain the tenant key. Click here for more inforation
This action will navigate you to the User Management screen inside the tenant. Click here for more information
This feature is important when building XR solutions that require projecting media against a specific target image. This action will navigate you to the management screen where you can configure the provider of computer vision services that will be used as part of the solution.
More about this
This is a complicated and lengthy topic. You can read more about it here.
This action will navigate you to the screen within the tenant where you activate modules and configure their properties. Read more here
The flexibility of the Appearition Platform is in the ability to dynamically configure the types of media that can be supported by connected solutions. A Media Type is an abstract construct that prescribes the rules for each type of binary or text based content that can be added to immersive experiences and served and viewed by front end solutions. Read more here
Developers can integrate their own apps and solutions with the immersive experience features and services offered by the Appearition Platform. This is achieved by registering their apps against the tenant, allocating API token(s) and granting the correct level of permissions for accessing modules and features. Read more here
Once you have spent time configuring the tenant to serve a particular type of solution, you may wish to be able to spawn new tenants with the same setup. This action will create a new package based on the current setup of your tenant so that you can launch new tenants that have the same setup as this one.
You can suspend all activity to this tenant with this Action. Once deactivated no API requests or portal actions will work.
The only action now available is to reactivate it.
Update DB Schema#
This action is redundant and obsolete. During platform updates any database schema changes are automatically applied hence this action is not required.
This also applies to the top level Actions button which has the Update DB Schema on All Tenants action.