Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Search for | Example | Results |
---|---|---|
A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Search for | Operator | Example |
---|---|---|
Two or more words in the same topic |
|
|
Either word in a topic |
|
|
Topics that do not contain a specific word or phrase |
|
|
Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
A combination of search types | ( ) parentheses |
|
How to create and edit a tenant
Create a tenant
-
From the main menu, click Tenants.
-
Click New.
-
In the New tenant dialog box, provide all requested information. This dialog box requests values for the basic attributes.
Field Description Name Enter the tenant name.
Type Select the tenant type:
-
Production: This tenant is an official production environment. Only production licenses can be assigned to production tenants.
-
DEV: This tenant is used to make all configuration changes. Only trial licenses can be assigned to DEV tenants.
-
Internal: This tenant can be used for internal demo. Only evaluation licenses can be assigned to internal tenants.
-
Trial: This tenant is used for trial with limited duration and capacity. Only trial licenses can be assigned to Trial tenants.
For more information about licenses, see Licenses.
Shared service type Select the shared service type:
- Provider: Provider tenants can manage the business data of managed tenants.
- Managed: Managed tenants are client tenants hosted by shared service providers, the service cases are managed by shared service agents in provider tenant.
- Standard: Standard tenants are ordinary tenants and are irrelevant to shared service.
-
-
Click Save.
Edit a tenant
-
From the main menu, click Tenants.
-
Click the tenant in the ID column to display the selected tenant.
-
Click the tab you want to view or edit. See Tenant details below. The General tab is displayed by default.
-
Save the changes.
Tenant details
-
General tab
Field Description ID Tenant ID. Name Tenant name. URL The URL to access this tenant. Type Tenant type.
Environment Tenant environment:
- Prod
- Test
- Staging
- Poc
- RND
- Unknown
- DR
Account The account specified for this tenant. The users belong to this account can access this tenant. Public service Defines which users of the account can access this tenant.
-
If this switch is on, all users of the account can access the tenant.
-
If this switch is off, only specified users of the account can access the tenant. Go to Users tab to specify the users.
Note After you change this setting, make sure to click Hard sync user on the toolbar.
Tenant admin Tenant admin. Only tenant with a tenant admin specified can be deployed. The tenant admin receives an email notification after the tenant is deployed successfully.
The tenant admin is assigned the Tenant Admin role in Service Management automatically.
Owner Tenant owner. Created by
The user who created the tenant.
Description The description that captures the details of the tenant. Creation time The time that the tenant was created.
Activate date The date that the tenant was activated. Last update on The last time that the tenant was updated. -
This tab displays the users who are granted access to this tenant. If Public service is off, you need to specify the users that can access this tenant here.
-
Licenses tab
This tab displays the license assignments of this tenant. To add a license assignment to this tenant, click Add, specify the license pool, mode, edition, access type, and date, click Filter to get remaining capacity, then you can assign the available capacity to this tenant.
-
Shared service tab
This tab tenant's shared service type.
Shared service type Shared service tab Standard tenant This tab displays the shared service type Managed tenant This tab displays the shared service type and its provider tenant. Provider tenant This tab is used to managed the managed tenants and grant user permissions. For more information, see Suite Administration for shared service providers.
-
Operation history tab
This tab displays the history of the following operations on the tenant:
-
Create tenant
-
Deploy tenant
-
Delete tenant
-
Clone tenant
-
Import tenant
-
Export tenant
-
Update tenant
-
The failed jobs to sync updated managed tenants or managed accounts from Suite Administration to Service Management.
To get the latest status, click Refresh.
-
Deploy tenant
A tenant can be deployed if:
-
A tenant admin is specified
-
A license is assigned
To deploy a tenant, click Deploy.
The prompt message is asynchronous, go to Operation histories tab to view the actual status of this operation.
Change tenant type
The way to change the tenant type might vary slightly, depending on the tenant status.
To change the tenant type before tenant deployment:
-
(Optional) If license assignment is added to this tenant, go to Licenses tab, and then click Revoke to revoke the license.
-
On General tab, select the type from the drop-down list. Click Save.
To change the tenant type after tenant deployment:
-
In Licenses tab, click Revoke to revoke the license.
-
Click Change tenant type on the toolbar.
- Select the type from the drop-down list, click Change.
Tenant status
Status |
Description |
---|---|
New |
The tenant status is New after the tenant is created. |
Active |
|
Inactive |
|
Pending for removal | The tenant status becomes Pending for removal automatically if the tenant deployment fails. |
Clone tenant
You can clone a tenant within the same suite instance. When cloning a tenant, make sure there are no other tenant operations such as importing tenant, exporting tenant, or Dev2Prod in the suite instance.
To clone a tenant:
-
Prepare an active tenant as the target tenant.
-
Select a tenant in the ID column as the source tenant.
-
Click Clone tenant on the toolbar.
-
Select the target tenant, turn on the switch if you want to inherit the role and permission settings of the source tenant. Note that the data might be corrupted if you choose not to inherit the role and permission settings, you need to assign the roles using Manage Persons API, and then click Clone.
The prompt message is asynchronous, go to Operation histories tab to view the actual status of this operation.
Note
- The status of the target tenant needs to be Active.
- The source tenant and the target tenant must belong to the same account.
- After the tenant is cloned, all users of the target tenant are replaced by users of the source tenant.
-
If the suite is installed with Large size or you have added additional Smart Analytics content groups manually on the suite instance, you have to sync the data after the tenant is cloned. Log in to the master node of SMA cluster as a user who is privileged to run kubectl. Run the script sync_smart_analytics_content_data.sh that is included in the Operation Toolkit, which can be downloaded from the Micro Focus ITOM Marketplace, all data will be synced after a while.
Export and import tenant
You can move a tenant to other suite instances by exporting and importing the tenant. When exporting or importing a tenant, make sure there are no other tenant operations such as cloning tenant, importing/exporting tenant, or Dev2Prod in source and target suite instances.
To move a tenant:
-
Prepare a tenant as target tenant.
-
In source tenant details page, click Export tenant. The tenant data is exported to the NFS share ({nfs_global_volume}/tenant-export). The exported package name is data-<tenantid>-<YYYYMMDDhhmmss>.tar.gz.
-
Copy the exported package to the NFS share ({nfs_global_volume}/tenant-import) of target suite instance.
-
Create a new user belonging to the account that is assigned to target tenant, the Upn of this user must be identical to the tenant admin of source tenant, and specify this user as tenant admin of target tenant.
-
In target tenant details page, click Import tenant on the toolbar.
-
Select the data file, turn on the switch if you want to use the role and permission settings of source tenant, click Import. If you choose not to inherit the role and permission settings, you need to assign the roles using Manage Persons API.
The prompt message is asynchronous, go to Operation histories tab to view the actual status of this operation.
Note If you want to assign license to imported users in Service Management, complete the following tasks before assigning license:
- Get the Authentication type of these users in Suite Administration on previous suite instance.
- Create the same users in Suite Administration on current suite instance using Manage Persons API, make sure the authentication type property is included in the JSON.
Related topics