System category — System-Tenant Management page — Overview, Create, Manage tabs
The Tenant Management landing page is visible when the Pega Platform instance has been enabled as a Multitenant system during installation. It is accessible only to the Multitenant Administrator and used to manage the tenants in the system.
Access this page by selecting Designer Studio > System > Tenant Management .
The Tenant Management landing page has three tabs:
- Overview
- Create
- Manage
Overview tab
The Multitenant Administrator uses this read-only tab to display a list of active system tenants and information about each of them.
| Column | Description |
|---|---|
| Tenant Name | The tenant identifier. |
| Description | A description of the tenant. |
| Contact Email |
The email address of the person who is the contact for this tenant.
This information is updated on the General tab of the tenant form. |
| Created On | The date and time that the tenant was created. |
| Last Sign-On | The date and time that a user last logged on to this tenant. |
To view additional details about a specific tenant, select a row and click the arrow next to the row number to expand the tenant. The following information is displayed:
- The Tenant Name
- The tenant Administrator
- The Login URL of the tenant
Create tab
This tab allows the Multitenant Administrator to add tenants and their proxy administrator to the system. When you create the tenant, it also automatically creates the tenant organization, division, and unit, as well as a Data-Admin-Tenant class instance for the tenant.
Enter the tenant information:
| Field | Description |
|---|---|
| Tenant Name | The name of the system tenant. |
| Description | A description of the system tenant. |
| Contact Full Name | The name of the contact for this tenant. |
| Contact Email | The email address of the contact. |
| Setup Activity |
The activity that is launched for the tenant when this record is created. The
default is to not select an activity.
Select the ImportRAPs value to launch a setup activity that imports a rule package when the tenant is created. |
| Administrator | The user ID of the tenant administrator. |
| Password | The password for the tenant administrator. |
| Confirm Password | Re-enter the tenant administrator password that was also entered in the Password field. |
Click Create Tenant to create the tenant and the organization. This also creates an instance of Data-Admin-Tenant.
Manage tab
This tab allows the Multitenant Administrator to manage existing tenants. From here you can:
- Update the password of a tenant's administrator
- Delete a tenant
Start by selecting the tenant that you want to manage in the Tenant Name field. Use the autocomplete control to enter starting text, then press the arrow key to see a list of existing tenants in the system.
Once a tenant is selected, the Configure Tenant menu and the tenant's URL display.
Update Proxy Administrator
In this section you can update the password of the administrator for the selected tenant.
- Click the arrow to expand this section. The administrator user ID of the tenant's proxy administrator displays.
- Enter a password in the corresponding fields.
- Click Update Administrator.
Delete Tenant
In this section you can delete the selected tenant. When you delete a tenant, its rules, data, work objects, users and configuration are permanently deleted from the application.
- Click the arrow to expand this section.
- Click Delete Tenant.
Optionally, you can enter the Post Delete Activity before deleting the tenant. This is the name of a custom activity that runs when you delete this tenant. For example: this allows you to remove customizations that are not included in the standard group of deleted items.