Use the graphical user interface of yuuvis® management console to manage organizations and packages.
Table of Contents
Introduction
Host users logged in are enabled to manage organizations as instances for tenant management and to manage packages. The packages are sets of data storage limits that can be applied to tenants. To each tenant, exactly one package is assigned that defines the maximum number of documents and the maximum amount of storage. The selection of the package is up to the organization managing the tenant.
Dashboard
Header Area
In the header area, you will find the yuuvis® bar with icons for the most frequently used features, such as the yuuvis® icon on the left, and the settings menu icon on the right. Click the icons to go to the corresponding linked areas.
Whenever you left-click the yuuvis® icon, the dashboard will appear again.
If you left-click the yuuvis® icon while pressing Ctrl, a new tab will open with another yuuvis® management console dashboard in your browser.
On the bottom left, the name of your organization is displayed.
Middle Area
The middle of the dashboard is where you will find the number of managed organizations and the number of Packages, each of them displayed in a large figure with a button next to it.
Click Create new organization to open a form asking for Name and Abbreviation for a new organization. Click Save in order to create the organization.
Click Manage packages to open the packages view in order to customize the available packages, delete packages or create new packages.
Furthermore in the middle area, you can click Download to export the Metrics for all organizations. A file in CSV format will be downloaded containing the following information on all tenants of all organizations:
Created(creation date of the metrics entry)Tenant IDTenant nameOrganizationPackageAvailable objects(maximum number defined by the assigned package)Objects(number of objects already stored by the tenant)Available disk space(maximum amount defined by the assigned package)Disk space(already used by the tenant)
These data are a protocol of the use of resources by the individual tenants. Once per day, the current state of resource usage is determined for every user. You can select a date or a time range for the metrics download by clicking the field next to the Download button. A calendar will open where you can select your date(s) of interest. Per default, the Latest metrics entries are downloaded.
Organizations List
In the left-most area on the dashboard, the organizations managed by your host are listed and sorted alphabetically. Below the organization name, the corresponding abbreviation is displayed.
Click one of the organizations in the list to display it in the organization management view.
Settings Menu
Open the settings menu via the settings menu icon and Account. The Account view of the menu will be displayed. Switch to the members view by clicking the Members tab below below the yuuvis® bar.
Account view
Set the Language for your sessions in yuuvis® management console. You can choose German or English.
The Edit organization area contains a brief overview about the selected organization. In the displayed form, the organization Name that can be modified, but the Abbreviation cannot be modified since it is used internally as a unique identification of the organization. Changes can be applied via Save.
In the User profile area, you can change your user-specific data.
Members view
An overview of the organization members is provided in the area Members. They can log in for the organization view of yuuvis® management console and maintain their organization with their assigned tenants.
Delete a user by clicking the trash symbol in the corresponding line.
The area Invitation displays invitation processes. The invitations were sent to the specified e-mail on the specified date (Invited on). The invitees will be members of the organization as soon as they followed the registration link in their invitation e-mail and set up their login. This has to be done before the Expiration date. If the Status of an invitation is open, the invitation was already sent to the specified e-mail address at the specified date but the invitee did not yet register. If the Status is accepted, the invitee is registered and appears also in the Members area.
Click New invitation to create a new invitation. In the opened form, you have to enter a valid e-mail address of the person you want to invite. You may optionally set an Expiration date after which the initial registration of the invitee is not possible anymore. Select the language for the invitation e-mail from the Language catalog. Click Send to invite the new member.
Delete an invitation process by clicking the trash icon in the corresponding line. An initial registration is not possible anymore for an invitee with open invitation Status.
Packages View
The available packages are displayed as tiles sorted by the maximum number of objects, starting with the lowest limit.
The tiles are indicated by the package name and abbreviation. The limits for number of objects and amount of storage are displayed as well as the number of Tenants who use this package. A click on the last mentioned figure opens a list of all tenants using the package.
Edit the properties of a package by clicking the pencil symbol. The checkbox deprecated excludes the package from possible selections. Thus, the package cannot be chosen by assigned to tenants anymore.
Delete a package by clicking the trash icon on the corresponding tile. If the package is still used by one or more tenants, it cannot be deleted. Tick the checkbox deprecated instead.
Organization Management View
Below the header area, the name of the organization you want to manage is displayed. The button Delete organization on the right deletes the organization, but only if it does not contain tenants.
Edit Organization Area
The area Edit organization contains a brief overview about the selected organization. In the displayed form, the organization Name that can be modified, but the Abbreviation cannot be modified since it is used internally as a unique identification of the organization. Changes can be applied via Save.
Tenants Area
In the area Tenants, a list of all tenants of the organization is displayed, indicated by their names, IDs and packages. For each tenant, the buttons Metrics and transfer are available.
Via Metrics, the current status of resources used by the tenant can be displayed: the Number of objects that were created by users of the tenant, and Disk space used for storing those objects. The maximum for both figures is defined by the assigned package.
A tenant can be moved to a different organization via transfer. In the dialog, choose an existing target organization from the catalog new organization.
Via Import existing tenant, a tenant without an organization can be associated with the current organization. Tenants without an organization can be created and configured in the backend. Specify the corresponding Keycloak Realm Name of the tenant you want to add to the current organization. Choose the Package you want to apply to the tenant. Start the import via Import tenant.
Members Area
An overview of the organization members is provided in the area Members. They can log in for the organization view of yuuvis® management console and maintain their organization with their assigned tenants.
Invitation Area
The area Invitation displays invitation processes. The invitations were sent to the specified e-mail on the specified date (Invited on). The invitees will be members of the organization as soon as they followed the registration link in their invitation e-mail and set up their login. This has to be done before the Expiration date. If the Status of an invitation is open, the invitation was already sent to the specified e-mail address at the specified date but the invitee did not yet register. If the Status is accepted, the invitee is registered and appears also in the Members area.
Click New invitation to create a new invitation. In the opened form, you have to enter a valid e-mail address of the person you want to invite. You may optionally set an Expiration date after which the initial registration of the invitee is not possible anymore. Select the language for the invitation e-mail from the Language catalog. Click Send to invite the new member.
Summary
yuuvis® management console enables host users to manage organizations via a graphical user interface. Packages defining a tenant's resources limits can be customized and provided for the organizations that can assign them to their tenants. The consumption of resources by the individual tenants can be observed via metrics.