Configuring multitenancy

How multitenancy works in BMC Helix Digital Workplace

• Default subtenant—The first tenant that you create by running the (MSP) Config utility is the tenant. The default subtenant is associated with a company in BMC Helix ITSM. Administrators who are members of the default subtenant company can set and modify provider settings from the BMC Helix Digital Workplace Admin console.
• Subtenant—After creating the default subtenant, you run the utility again to create subtenants. If you want to create multiple subtenants, you run the utility each time you want to create a subtenant. A subtenant is also associated with a company in BMC Helix ITSM. Subtenants use the provider settings from the default subtenant. 

Before you begin

Make sure you complete the following tasks before running the MSP Config utility:

Task 1: To download the BMC Helix Digital Workplace MSP Config utility

1. In the Linux machine, run the following command to create a directory to unzip the utility folder:
   mkdir/opt/dwp-tool
2. Download the MSP Config utility to this directory.
3. Run the following command to extract the utility folder:
   unzip  dwp-msp-config-utility

The dwp-msp-config-utility folder has the following content: 

• rxscripts folder
• scripts folder
• README file

Task 2: To set the environment parameters

Set the environment parameters for the subtenant that you want to create. If you want to create multiple subtenants, you must run the script for each time by changing the values of export DWP_MSP_SUBTENANT_COMPANY_NAME and export DWP_MSP_SUBTENANT_COMPANY_USER_PASSWORD parameters. 

1. From the extracted dwp-msp-config-utility folder, in the rxscripts folder, open the setenv.sh file in a text editor. 

2. Set the following parameter values for logging in to the BMC Helix Innovation Studio instance: 

   Parameter	Value	Example value
   export IS_URL	BMC Helix Innovation Studio URL with protocol and port	https://apex.bmc.com/helix/index.html#/com.bmc.arsys.rx.innovationstudio
   export IS_ADMIN	BMC Helix Innovation Studio administrator user name	hannah_admin
   export IS_ADMIN_PASSWORD	BMC Helix Innovation Studio administrator password	Not applicable

3. Set the following parameter values to define the MSP configuration:
   
   

   Important

   For parameters that you do not want to configure, set the value to blank. 

   Example: <Parameter>=" "

   Parameter	Value	Example value
   export DWP_MSP_SUBTENANT_COMPANY_NAME	The subtenant company name Important: If you are running the utility for the first time, by default, this company will be the default subtenant.	Apex
   export DWP_MSP_SUBTENANT_COMPANY_USER_PASSWORD	Password for the subtenant company user	Not applicable
   export DWP_MSP_RUNMODE_VALUE	2031313—BMC Helix Digital Workplace Basic license 2169487—BMC Helix Digital Workplace Advanced license	2169487
   export DWP_MSP_CHAT_URL	Live Chat URL	https://apex.bmc.com/eschat
   export DWP_MSP_MYIT_BACKEND_URL	BMC Helix Digital Workplace URL	https://apex.bmc.com/dwp
   export DWP_MSP_SENDER_EMAIL	Sender's email address	dwp@apex.com
   export DWP_MSP_SBE_URL	BMC Helix Digital Workplace Catalog URL Note: Enter this value only if you have subscribed to the BMC Helix Digital Workplace Catalog, otherwise leave it blank.	https://apex.bmc.com/api/myit-sb
   export DWP_MSP_EXTERNAL_HOST_DOMAINS	BMC Helix Single Sign-On URL that is common for BMC Helix Digital Workplace and BMC Helix ITSM: Smart IT to allow questionnaires to be embedded in BMC Helix ITSM: Smart IT.	https://apex.bmc.com/rsso/admin/
   export DWP_MSP_SBE_SYSTEM_USER	BMC Helix Digital Workplace Catalog user name	hannah_admin
   export DWP_MSP_SBE_SYSTEM_USER_PASSWORD	BMC Helix Digital Workplace Catalog password	Not applicable

4. Save the file. 

Task 3: To run the BMC Helix Digital Workplace MSP Config utility

1. On the Linux machine, run the following command to navigate to the scripts directory:
   cd /opt/dwp-tool/scripts
   
   

2. Run the following command to onboard the subtenants:
   ./call_onboard_subtenant.sh
   The utility script starts executing and you can observe the progress in the console. The script includes a validation that displays whether the subtenant is successfully created or not. 

   The following image shows an example of the message after a subtenant is successfully created:

   

Task 4: To verify default subtenant creation from the BMC Helix Innovation Studio UI

1. As an administrator, log in to BMC Helix Innovation Studio.
2. On the Workspace tab, click Digital Workplace.
3. On the Record Definitions tab, select the check box for Subtenant and click Edit data. 
4. Click the record definition instance that is created when you run the script for the first time.

The fields in the record definition and populated automatically. Verify the following fields:

1. 
   
   1. Default is selected.
   2. Name contains the subtenant company name that you used in export DWP_MSP_SUBTENANT_COMPANY_NAME parameter. 

The following image is an example of the Subtenant record definition instance:

Troubleshooting

The following table describes common errors that can occur when you create subtenants and steps to resolve them:

Where to go from here