Loading the BMC Digital Workplace Catalog tenant setup data
Before you can use BMC Digital Workplace Catalog you must create the tenant by loading the required setup data, such as service categories, catalog profile templates, and the default service catalog administrator user.
Before you begin
- Refer to the tenant information that you collected in the Installation worksheets for BMC Digital Workplace Catalog.
- Ensure that the database administrator provided the credentials for the chosen database server:
Ensure that BMC Digital Workplace Catalog has been installed successfully and that you can see the login screen when you enter the URL in a web browser (for example:
If you set a custom port value for the BMC Digital Workplace Catalog application server port
(<BMC_DWP_PORT>) in your installation options file, update the value in /opt/bmc/digitalworkplace/sb/env/set_script_variables.sh before you create the tenant.
To provide access to the jq command-line JSON processor
To load the tenant data, the post_install.sh script invokes the jq command-line JSON processor to create the required data records from text files. Depending on your system configuration, you might have to copy the jq application to a location where the post_install.sh can find it.
To copy the jq application to the /usr/bin folder on the BMC Digital Workplace Catalog server, next to other utility programs, you must have the permissions to create files into the /usr/bin folder. For information about granting the required permissions to install as a non-root account, see Preparing a Linux server for BMC Digital Workplace Catalog installation.
From the Linux command line, issue the jq command to test that the application exists.
If you see the following response, then the jq command line JSON processor is installed successfully. You can proceed to the step: To create a text file for the post_install.sh script values.Example success message
jq - commandline JSON processor [version 1.4] Usage: jq [options] <jq filter> [file...] For a description of the command line options and how to write jq filters (and why you might want to) see the jq manpage, or the online documentation at http://stedolan.github.com/jq
If you see the following error message, proceed to step 2.Example error message
bash: jq: command not found...
From the list of files you extracted from the installation archive, find the jq file. For example, if you extracted the installation archive into the folder ~/Download/install, you would issue the following commands:Example
$ cd ~/Download/install $ ls -al install_files/jq -rw-rw-r-- 1 dwpuser dwpinstall 497799 Mar 31 18:03 install_files/jq
Copy the jq file from its location inside the ./install_files folder to the /usr/bin folder.Example
$ cp install_files/jq /usr/bin
Change the file mode to enable all users to run the jq command.Example
$ chmod +x /usr/bin/jq
Check the file mode.Example
$ ls -al /usr/bin/jq -rwxrwxr-x 1 dwpuser dwpinstall 497799 Aug 14 13:38 /usr/bin/jq
Issue the jq command again to verify that the command-line JSON processor can run successfully.Example success message
$ jq jq - commandline JSON processor [version 1.4] Usage: jq [options] <jq filter> [file...] For a description of the command line options and how to write jq filters (and why you might want to) see the jq manpage, or the online documentation at http://stedolan.github.com/jq
To create a text file for the post_install.sh script values
When you run the post_install.sh script to create the tenant, you are asked to provide values for specific parameters that are used to prepare the tenant database. When you run the command, you must provide the values for each prompt. Some of the prompts expect different values based on the database server type, as shown in the following table.
|Item||Prompt||Database server type||Expected response|
Enter the BMC Helix Digital Workplace Catalog administrator login name
BMC Helix Digital Workplace Catalog system administrator credentials
|2||Password for specified user name||Both||Example: password|
|3||Enter one of the following - (SQL Server) Tenant database name; (Oracle) Tenant database administrator user name||SQL Server|
Tenant database name
Tenant database administrator user name
|4||Enter a domain name to identify this tenant||Both|
Tenant domain name
Note: Do not use a local domain (for example, calbroservices.local). The tenant domain name must end with a standard domain such as .com or .net.
|5||Enter the server's virtual host name specified during the installation||Both|
BMC Helix Digital Workplace Catalog server instance name
|6||Enter the tenant database user name||SQL Server|
Application database administrator user name
Tenant database administrator user name
|7||Password for specified user name||Both|
Database user password
To reduce the risk of error when answering the prompts, such as complex account names or passwords, you can create a text file and direct the post_install.sh script to read the values from the text file.
Copy the text from one of the following simplified prompt templates into a text editor.
In the following examples, observe that prompts 3, 6, and 7 differ based on your selected database server type (SQL Server or Oracle).Simplified prompt template (SQL Server)
1. Admin login: 2. Admin password: 3. Tenant database NAME: 4. Domain name: 5. Virtual host name: 6. SYSTEM database user: 7. SYSTEM database Password:Simplified prompt template (Oracle)
1. Admin login: 2. Admin password: 3. Tenant database USER: 4. Domain name: 5. Virtual host name: 6. TENANT database user: 7. TENANT database password:
Complete the template by inserting values that match your environment.
NoteWhen you create a tenant, you can specify any unique value for the virtual host name parameter,
<BMC_DWP_SERVER_HOST_NAME>. The host name value must exist in the /etc/hosts file.Simplified prompt template with values (SQL Server)
1. Admin login: Demo 2. Admin password: password 3. Tenant database NAME: DWPCTenant 4. Domain name: calbroservices.com 5. Virtual host name: dwp-catalog-server 6. SYSTEM database user: DWPCAdmin 7. SYSTEM database Password: passwordSimplified prompt template with values (Oracle)
1. Admin login: Demo 2. Admin password: password 3. Tenant database USER: DWPCTenantAdmin 4. Domain name: calbroservices.com 5. Virtual host name: dwp-catalog-server 6. TENANT database user: DWPCTenantAdmin 7. TENANT database password: password
Delete the prompts and save the file with only your values.Simplified prompt template without prompts (SQL Server)
Demo password DWPCTenant calbroservices.com dwp-catalog-server DWPCAdmin passwordSimplified prompt template without prompts (Oracle)
Demo password DWPCTenantAdmin calbroservices.com dwp-catalog-server DWPCTenantAdmin password
- Copy this file to the application server where the post_install.sh script will be able to read it. For example, if your BMC Digital Workplace Catalog installation folder is /opt/bmc/digitalworkplace and you saved the command template values as calbroservices.txt , upload the file to the server and move it to the /opt/bmc/digitalworkplace/sb folder to be next to the post_install.sh script.
To load the initial tenant data
Perform the following steps in a terminal window while logged in to the BMC Digital Workplace Catalog application server. These examples refer to the BMC Digital Workplace Catalog installation folder as /opt/bmc/digitalworkplace.
To watch the tenant creation process after you run the post_install.sh script, open a second terminal window and log in to the same server. Then, enter the following command to watch the logs. (If you did not install BMC Digital Workplace Catalog in the default location, replace /opt/bmc/digitalworkplace with the location of your installation.)
tail -f /opt/bmc/digitalworkplace/db/post_install.log
For more information about this log file, see the Troubleshooting the tenant creation section .
On the application server, navigate to the /opt/bmc/digitalworkplace/sb folder.Example
Run the post_install.sh script in create tenant mode, and load the file that contains the tenant values (for example, calbroservices.txt). If you did not create a text file with the tenant creation values, remove
< calbroservices.txtfrom the command and follow the prompts.Example
./post_install.sh create_tenant < calbroservices.txt
Wait for the script to complete.
The post_install.sh script restarts the BMC Digital Workplace Catalog server in the background before you will see the terminal prompt.
To test the tenant catalog administrator login
After you have installed the BMC Digital Workplace Catalog and created the tenant by loading the initial tenant data, test the success of the operation by logging in to the application. The post_install.sh script creates an account for the first service catalog administrator user with the following credentials.
|email@example.com||The post_install.sh script will use your company’s domain (not calbroservices.com) for the email address.|
|Password||Passw0rd!||After you test the default login credentials and apply the license to the server, create user accounts specific to your organization, and then disable the default user account.|
Edit the placeholders in the following URL to match your server environment, and open the URL in a web browser to go to the BMC Digital Workplace Catalog login page.Example URL
Port 8008 is the default port number that the Jetty web server uses. If you changed the Jetty configuration to use a different port number, or if you enabled access without a port number, modify the port number value in the URL accordingly.
Log on with the tenant administrator account credentials, such as firstname.lastname@example.org.
If the application opens to the catalog administration dashboard, then your installation was a success!
Troubleshooting the tenant creation process
If you experience any issues while loading the tenant data to create the tenant, refer to the following log files. If you installed BMC Digital Workplace Catalog into a custom folder, then replace all occurrences of the /opt/bmc/digitalworkplace path name with your installation folder.
For more information about reviewing the log files for messages that can assist your troubleshooting, see Troubleshooting common BMC Digital Workplace Catalog issues by using log files.