Configuring multitenancy

To restrict access for BMC Digital Workplace users to the configuration of a specific company in Remedy ITSM, you can configure multitenancy in BMC Digital Workplace. As a system administrator, you prepare the tenant configuration utility, activate the master tenant, and then activate subtenants as needed.

The master tenant should be associated with a company in Remedy IT Service Management (BMC Remedy ITSM). Administrators who are members of the master tenant company can set and modify provider settings from the BMC Digital Workplace Admin console. Each subtenant is associated with a company in BMC Remedy ITSM. Subtenants use the provider settings from the master tenant.

Note

You cannot use the multitenancy feature and the External Users feature at the same time. If you configure multitenancy, the External Users menu is not available in the Admin console. If you have already configured an external company, you cannot use multitenancy as a managed service provider (MSP).

For more information about MSP, see Managing customers.

For more information about the External Users feature, see Portal for external users and Administering an external BMC Digital Workplace portal.

Before you begin

Configure multitenancy in BMC Remedy ITSM.
For information about multitenancy, see Multi-tenancy in the BMC Remedy ITSM documentation.
Locate the tenant configuration utility in DWP_HOME\DWP\tenant-config\scripts.

To prepare the tenant configuration utility

On the BMC Digital Workplace server, move the tenant-config.jar from DWP_HOME/tenant-config to a folder with scripts:
- (Linux) DWP_HOME/tenant-config/scripts/linux
- (Windows) DWP_HOME\tenant-config\scripts\win
(Optional) To run the tenant configuration utility on a server other than the BMC Digital Workplace server, copy the scripts/linux or scripts/win folders from the BMC Digital Workplace server to the server that will run the utility.

In a text editor, edit the set_env.bat (Windows) or set_env.sh (Linux) to set the following parameters:

Parameter	Value	Additional information
`java_home`	Path to your Java directory	Do not include the bin directory at the end of the path. Enclose the path in double quotes, as in the example provided in the file.
`myit_server_url`	A URL that has the following format: http://DigitalWorkplaceServer/dwp	DigitalWorkplaceServer must be the host name of the BMC Digital Workplace server. If you want to run the tenant configuration utility from the BMC Digital Workplace server, you can enter localhost, as in *http://localhost:port/dwp, where port* is the BMC Digital Workplace server Tomcat port.
`API_TOKEN`	API token value	Copy the `API_token` value from the connect-dwp.properties file in the TomcatHome/external_conf directory. Note: On fresh installation or upgrade, this value is automatically generated and populated in the file.
`API_SECRET`	API secret value	Copy the API_secret from the connect-dwp.properties file in the *TomcatHome/external_conf directory. Note:* This value is automatically generated and populated in the file after a fresh installation or upgrade.
`tenant_name`	Tenant identifier required for tenant operations	Default value: 000000000000001
`master_tenant_name`	Master tenant configuration details are copied during creation of a subtenant	Default value: 000000000000001
`company`	Company identifier of a subtenant	Not applicable
`SAML_authentication`	True or False	Must be set (to True or False) before a tenant or subtenant is added.

To test the utility, run the following command:
```
(Windows) list_tenants.bat
(Linux) list_tenants.sh
```
You should see a default tenant with the name 000000000000001.

To activate the master tenant

As a database administrator, run the following SQL statement:

UPDATE DWP_SYSTEM.Tenant SET HOSTNAME = 'localhost;@Company:<Master Tenant Company>' WHERE HOSTNAME='localhost';

Replace <Master Tenant Company> with the company name for the master tenant company, such as Calbro Services, for example:

UPDATE DWP_SYSTEM.Tenant SET HOSTNAME = 'localhost;@Company:Calbro Services' WHERE HOSTNAME='localhost';

Note

Do not activate the master tenant company as a subtenant.

To activate subtenants

In the tenant configuration utility directory, edit set_env.sh (Linux) or set_env.bat (Windows) with a text editor, and set the company to the name of the BMC Remedy ITSM operating or customer company that you are activating.
- (Linux) Find the line that says COMPANY="" and put the company name inside the quotes, for example, COMPANY="Acme".
- (Windows) Find the line set company= and add the company name to the end after the equals sign (=), for example, set company=Acme.
Run add_subtenant.sh (Linux) or add_subtenant.bat (Windows).
Repeat step 1 and 2 for each company you want to activate.
Note

Ensure that you activate subtenants for all required companies. Users from companies for which subtenants are not activated, will not be able to log in to BMC Digital Workplace.

Where to go from here

After the master tenant is configured and one or more subtenants are activated, as a BMC Digital Workplace super administrator or administrator of subtenant, log on to the BMC Digital Workplace Admin console to set up configuration data for a subtenant, as described in the Administering topics. You can also configure a different set of features for a subtenant as described in the Configuration example of replacing the Request Entry Console in BMC Service Request Management section.

If you are rebranding BMC Digital Workplace, you must rebrand it for each subtenant, as described in Rebranding BMC Digital Workplace.