Product Documentation

Maintaining Multi-Tenant Console

Feb 24, 2013

You can maintain various function in the Multi-Tenant Console.

You can back up the Multi-Tenant Console by using the backup and restore functions in your SQL Server or PostGre database.

You can create administrative users who can configure all or some of the Multi-Tenant Console. You can add, edit, or delete administrative users.

You can restrict access to tenants by creating partners and then assigning the partner to the tenant.

You can create users in the Multi-Tenant Console and the assign users to role. When you assign users to the role, it restricts user access to specific functions in the Multi-Tenant Console. After you create a role, you can assign the user to the role by editing the membership of the role. For example, if you create the role "abcadmin" and you assign the privileges to the role, and then you add the ABC Partner, the role "abcadmin" can view the reports of ABC Partner.

When you configure partner association in Multi-Tenant Console, you allow the Multi-Tenant Console administrator to restrict access to specified tenants. When the administrators for the tenants log on to Multi-Tenant Console, on the home page, they see only the content they have privileges to view. For example, you may have configured privileges for XenMobile applications, tenant hosts, connectors, Tomcat servers, database servers, and tenants. These privileges correspond to tabs in Multi-Tenant Console. This topic describes a scenario in which the administrators have privileges to view reports. For example, they see only a Reports tab on the home page of Multi-Tenant Console where they can access a Customer Inventory or a Customer Usage report. The reports appear as a table with multiple columns of data listing information, such as:

  • ID
  • Hosting Region
  • Service Activation
  • Licensed Devices
  • Software Version
  • Service URL
  • Number of Users Provisioned

To back up your Multi-Tenant Console installation

Because all of the Multi-Tenant Console data is stored in the database, the main backup and restore procedure is a classic database procedure. A simple copy of the files or possibly the whole Zenprise_mtc directory, is enough to ensure a reliable backup of the console.

Two other files might have been modified during installation. They are located in <installation folder>\grails-app\conf:

  • BuildConfig.groovy. You can adjust the TCP port used by the interface in this file.
  • DataSource.groovy. You can set the database parameters used to store all Multi-Tenant Console data in this file.

To add or change administrators on Multi-Tenant Console

If you want to change the administration console access on Multi-Tenant Console, on the Home tab, click Users and then do the following:

  • To add an administrator, click New User, fill in the fields and then click Create.
  • To edit an existing administrator, in the User List, click the users' name and then click Edit.
  • To delete an administrator, in the User List, click the users' name and then click Delete.

To create a partner on Multi-Tenant Console

You should create a partner when you want to restrict customer tenant records to specific Multi-Tenant Console administrators. By associating tenants with a specified partner name, you can restrict certain users to access only the tenants that have a designated partner name.

  1. Log on to Multi-Tenant Console and then click Partner. A list of partners appears.
  2. Click New Partner.
  3. In Create Partner, complete the following fields:
    • Name. Enter a name for the partner.
    • Email. Enter the partner's email address.
    • Logo URL. Enter a Web address for the partner.
    • Support Email. Provide an email address for the support contact.
    • Product name.
    • Support Number. Enter the phone number for the support contact.
  4. Click Create. The partner appears on the Show Partner screen.

Next, you create a user on Multi-Tenant Console.

To create a user on Multi-Tenant Console

To access the Multi-Tenant Console and customer tenant data, you must create a user.

  1. On the Home screen, click User. A list of users appears.
  2. Click New User.
  3. Complete the following information:
    • Full name. The name of the user.
    • Login. The name the user enters to log on to Multi-Tenant Console.
    • Password. The user password.
    • Confirm password. The user password again.
    • Description. (Optional). Information about the user.
    • Email. The user's email address.
    • Enabled.
    • Partner.
  4. Click Create.
    Important: You cannot edit the partner information after you create the partner.
    The user appears in the User List.

Next, you must assign the user to a specific role in Multi-Tenant Console.

To create a role on Multi-Tenant Console

In order to restrict a the users' access to specific functions within Multi-Tenant Console; for example, allowing only reporting capabilities, you must create a role in Multi-Tenant Console with a designated list of privileges. After you create a role, you can assign the user to the role by editing the membership of the role. For example, if you create the role "abcadmin" and you assign the Reports privileges to the role, and then you add the ABC Partner, the role "abcadmin" can view the reports of ABC Partner.

  1. On the Home page, click Roles.
  2. Click New Role. A list of roles appears.
  3. Click Create.
  4. On the Privileges tab, in Authority, enter a role in the format ROLE_<your-defined-role> and in Description, enter a description of the privilege.
  5. To assign privileges to the role you create, click Privileges and then select one or more privileges that you want to assign to a particular role.
  6. To add a partner to particular role, clicking Partner.
  7. Click Create.

Next, you assign a user to a role.

To assign a user to a role on Multi-Tenant Console

After you create a role with the appropriate level of privileges and designated partner names, you can assign users to the role by editing the membership for the designated role.

  1. In the Role List, click a role.
  2. Click Edit Membership.
  3. To add a user to a particular role, in Select User, enter the name of the user or select from the list of users that exist in the database and then click the user icon.
  4. In the confirmation message that appears, click OK.

To assign a partner to a tenant on Multi-Tenant Console

  1. On the Multi-Tenant Console home page, click the Tenants tab.
  2. Click the tenant to which you want to assign a partner and then click Edit.
  3. In Partner, click the partner name and then click Update.

To view a customer inventory report

  1. Click Reports and then click Customer Inventory Report. A default customer inventory report appears.
  2. Click Search or Advanced Search to identify or filter on specific tenants. Search enables you to find a specific tenant based on an alphanumeric string identifier. Advanced Search allows for a finer level of filtering based on specific column values. For example, users can filter for Licensed Devices with a value greater than 2.