This documentation supports the 19.08 version of BMC Digital Workplace Advanced.

To view the latest version, select the version from the Product Version menu.

BMC Digital Workplace Catalog installation parameter reference

This topic is a reference for every parameter that you might encounter when you install BMC Digital Workplace Catalog. You do not need to provide a value for every parameter when you create an installation options file.



List of all BMC Digital Workplace Catalog installation parameters

The following table lists the parameters and the step in the process when the parameters apply. Use the filter options to search for specific parameters by name, or limit the view to the parameters by their function. For example, select one of the following views by using the dropdown selector:

  • Show parameters that are used for database creation.
  • Show parameters that are used for tenant creation.
  • Show parameters for which you must provide a value in the minimal options file.
  • Show parameters that you can choose to edit in the advanced options file.

To view more details about a specific parameter, click the parameter name.

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...


Parameter nameDatabase creationTenant creationMinimal options fileAdvanced options file
<BMC_ADD_LOCALE_UPGRADE>    X
<BMC_ALLOWED_CROSS_ORIGIN_SOURCES>


X
<BMC_ATRIUM_PLUGIN_PORT_NUMBER>
<BMC_NE_PLUGIN_PORT_NUMBER>
<BMC_DBONLY_UPGRADE_CONFIRM>
   X
<BMC_DATABASE_ADMIN_ROLE> X   
<BMC_DATABASE_CASE_INSENSITIVE>    X
<BMC_DATABASE_DBA_DATAFILE_NAME> X  X
<BMC_DATABASE_DBA_DATAFILE_SIZE> X  X
<BMC_DATABASE_DBA_LOGFILE_NAME> X  X
<BMC_DATABASE_DBA_LOGFILE_SIZE> X  X
<BMC_DATABASE_DBA_LOGIN>
<BMC_DATABASE_DBA_PASSWORD>
X XX
<BMC_DATABASE_DBA_TABLESPACE_NAME> X XX
<BMC_DATABASE_HOST> X XX
<BMC_DATABASE_INSTANCE> X XX
<BMC_DATABASE_LOGIN>
<BMC_DATABASE_PASSWORD>
<BMC_DATABASE_CONFIRM_PASSWORD>
X XX
<BMC_DATABASE_OPTION>    X
<BMC_DATABASE_ORACLE_SID_OR_SERVICE> X XX
<BMC_DATABASE_PORT> X XX
<BMC_DATABASE_TENANT_TABLESPACE> XX  
<BMC_DATABASE_TENANT_USER>
<BMC_DATABASE_TENANT_PASSWORD>
XX  
<BMC_DATABASE_TYPE> X XX
<BMC_DATABASE_UTF>    X
<BMC_DWPSERVER_SAMPLE_DATA>    X
<BMC_DWP_APPLICATION_PASSWORD>    X
<BMC_DWP_DSO_PASSWORD>    X
<BMC_DWP_PLUGIN_PORT>    X
<BMC_DWP_PORT>    X
<BMC_DWP_SERVER_HOST_NAME>  XXX
<BMC_DWP_SERVER_NAME>   XX
<BMC_DWP_USER>
<BMC_DWP_PASSWORD>
<BMC_DWP_CONFIRM_PASSWORD>
 XXX
<BMC_IGNORE_PRECHECK_ERROR>    X
<BMC_JAVA_DWP_SERVER_SELECTED_FOR_32BIT>    X
<BMC_JAVA_DWP_SERVER_SELECTED_FOR_32BIT>    X
<BMC_JAVA_EMAIL_ENGINE_SELECTED_FOR_32BIT>    X
<BMC_JAVA_JRE_64_BIT_HOME_PATH>   XX
<BMC_JAVA_PLUGIN_PORT>    X
<BMC_MIDTIER_PASSWORD>   XX
<BMC_SMTP_ADDRESS>
<BMC_SMTP_PORT>
<BMC_SMTP_USER_NAME>
<BMC_SMTP_PASSWORD>
   X
<BMC_SQLSERVER_WINDOWSAUTH_OR_SQLAUTH>    X
<BMC_TEMP_TABLESPACE> X   
<BMC_TENANT_INSTALL_MODE>    X
<BMC_USER_SELECTED_DATA_LANGUAGE>    X
<BMC_USER_SELECTED_VIEW_LANGUAGES>    X
<SKIP_HEALTH_CHECK>    X
<TENANT_DOMAIN_NAME>  X  
<featureDWPSystemServers>    X
<installLocation>    X

BMC Digital Workplace Catalog installation parameter reference

The following table describes the BMC Digital Workplace Catalog installation parameters and examples.

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...


Parameter name and descriptionParametersExample value

Application database administrator user credentials

Specify the name of a user account that can create objects inside the application database or tablespace. You must grant this account full administration rights to the database or tablespace named in <BMC_DATABASE_DBA_TABLESPACE>.

 

<BMC_DATABASE_LOGIN>
<BMC_DATABASE_PASSWORD>
<BMC_DATABASE_CONFIRM_PASSWORD>

 

dwp_admin_app
Passw0rd!
Passw0rd!

Application database data file name

Specify the name or full path to the BMC Digital Workplace Catalog application database file.

 

<BMC_DATABASE_DBA_DATAFILE_NAME>

 

dwp_db_app.dbf

Application database data file size

Specify the maximum size of the BMC Digital Workplace Catalog application database file.

 

<BMC_DATABASE_DBA_DATAFILE_SIZE>

 

2000

Application database log file name

Specify the name or full path to the BMC Digital Workplace Catalog application database log file.

 

<BMC_DATABASE_DBA_LOGFILE_NAME>

 

dwp_db_app.log

Application database log file size

Specify the maximum size of the BMC Digital Workplace Catalog application database log file.

 

<BMC_DATABASE_DBA_LOGFILE_SIZE>

 

1000

Application database or tablespace name

Specify the name of your SQL Server database or Oracle tablespace where you will store the BMC Digital Workplace Catalog application data.

 

<BMC_DATABASE_DBA_TABLESPACE_NAME>

 

dwp_db_app

Application database overwrite existing data

Specify whether the installer should overwrite the existing data in the database, or use the existing data for the installation.

  • For a fresh installation, leave the comment marker (#).
  • To overwrite data, remove the comment marker (#) and specify the value overwrite.

 

<BMC_DATABASE_OPTION>

 

(commented out by default)

Application feature to install

This setting indicates only that BMC Digital Workplace Catalog will be installed.

 

<featureDWPSystemServers>

 

(value is not required)

BMC Digital Workplace Catalog Java plugin port

Specify the port on which the Java plugins on the application server will listen for connections.

 

<BMC_JAVA_PLUGIN_PORT>

 

9999

BMC Digital Workplace Catalog Mid Tier password

Specify an application service password that you can use to grant a Remedy Mid Tier with the ability to configure settings on the BMC Digital Workplace Catalog application server.

 

<BMC_MIDTIER_PASSWORD>

 

Passw0rd!

BMC Digital Workplace Catalog application installation location

Specify the directory in which BMC Digital Workplace Catalog will be installed. The user account that will be used to install the application must be able to create files and folders in this location.

 

<installLocation>

 

/opt/bmc/digitalworkplace

BMC Digital Workplace Catalog application server port

Specify the port on which the application server will listen for connections.

 

<BMC_DWP_PORT>

 

9988

BMC Digital Workplace Catalog email SMTP server settings

BMC Digital Workplace Catalog can send email notifications to catalog administrators for service-related actions such as being submitted for approval, published, or rejected. These parameters do not influence the configuration of any other system notifications.

Leave these parameters blank to disable the notifications. Otherwise, provide valid credentials to an SMTP server. The SMTP server configuration does not support SSL encryption.

 

<BMC_SMTP_ADDRESS>
<BMC_SMTP_PORT>
<BMC_SMTP_USER_NAME>
<BMC_SMTP_PASSWORD>

 

(empty value)

BMC Digital Workplace Catalog plugin port

Specify the port on which the application server will listen for calls to plugins.

 

<BMC_DWP_PLUGIN_PORT>

 

9977

BMC Digital Workplace Catalog server host name

Specify the fully qualified domain name or IP address of the computer on which you are installing BMC Digital Workplace Catalog. A network system administrator can provide the value assigned to this computer in the network DNS configuration.

 

<BMC_DWP_SERVER_HOST_NAME>

 

dwp-catalog-server.domain.com

BMC Digital Workplace Catalog server instance name

Specify the alias name of the computer on which you are installing BMC Digital Workplace Catalog.

 

<BMC_DWP_SERVER_NAME>

 

localhost
dwp-catalog-server

BMC Digital Workplace Catalog system administrator credentials

Specify the name of the account that will perform administrative functions, such as starting the BMC Digital Workplace Catalog application, configuring the application, and preparing the tenant workspace by loading the tenant data.

 

<BMC_DWP_USER>
<BMC_DWP_PASSWORD>
<BMC_DWP_CONFIRM_PASSWORD>

 

dwpadmin>
<Passw0rd!>
<Passw0rd!

Database reference by SID or service name

(Oracle only) The database server instance name parameter value type, which is represented by one of the following values:

  • true: To refer to the database server by its SID
  • false: To refer to the database server by its service name

 

<BMC_DATABASE_ORACLE_SID_OR_SERVICE>

 

true | false

Database server administrator user credentials

Specify the name of a user account that has full administrative control over the database server. If you are installing the application into databases that have already been created, specify the same credentials as the <BMC_DATABASE_LOGIN> account in the installation options file.

 

<BMC_DATABASE_DBA_LOGIN>
<BMC_DATABASE_DBA_PASSWORD>

 

dwp_admin_app
Passw0rd!

Database server authentication method

BMC Digital Workplace Catalog supports only SQLAUTH.

 

<BMC_SQLSERVER_WINDOWSAUTH_OR_SQLAUTH>

 

SQLAUTH

Database server case sensitivity selection

Specify whether your database is case insensitive.

The following values are supported:

  • T: The database is case-insensitive.
  • F: The database is case-sensitive.

 

<BMC_DATABASE_CASE_INSENSITIVE>

 

T

Database server character encoding method

Specify whether your database uses UTF character encoding. The following values are supported:

  • true
  • false

 

<BMC_DATABASE_UTF>

 

true

Database server engine type

Specify the database engine that you will use to store your data.

 

<BMC_DATABASE_TYPE>

 

SQL_SERVER | ORACLE

Database server hostname or IP address

Specify the fully qualified domain name or IP address that can be used to reach the database server over the network.

 

<BMC_DATABASE_HOST>

 

dwpcatalog-db.server.com | 172.22.192.54

Database server instance name

The name of the database engine instance, which can be one of the following values:

  • (SQL Server) database instance name
  • (Oracle) database service name
  • (Oracle) database service ID (SID)
    Note: The Oracle SID cannot be more than eight characters.

 

<BMC_DATABASE_INSTANCE>

 

database_name

Database server port

Specify the port number assigned to the database server.

 

<BMC_DATABASE_PORT>

 

(SQL Server) 1433 | (Oracle) 1521

Database server privilege role

(Oracle only) Specify the name of a role that defines the privileges to be granted to a database user account for the database assigned to that account.

 

<BMC_DATABASE_ADMIN_ROLE>

 

dwp_dbadmin_role

Database temporary tablespace name

(Oracle only) Best practice: BMC recommends that you define a temporary tablespace to improve system performance. When you create the application and tenant tablespaces, you will attach the same temporary tablespace to both tablespaces.

 

<BMC_TEMP_TABLESPACE>

 

dwp_db_temp

Tenant organization domain name

Specify the domain name to be used in the user login and the tenant settings when configuring BMC Remedy Single Sign-on.

 

<TENANT_DOMAIN_NAME>

 

calbroservices.com

Not applicable: Data language

BMC Digital Workplace Catalog supports only English.

 

<BMC_USER_SELECTED_DATA_LANGUAGE>

 

en

Not applicable: Enable BMC port mapper

BMC Digital Workplace Catalog communicates through assigned ports only and does not use the standard BMC port mapper.

 

<BMC_JAVA_DWP_SERVER_SELECTED_FOR_32BIT>

 

false

Not applicable: Ignore precheck installation warnings

The installation script monitors the installation and halts if there are any errors. You do not need to enable additional precheck error warnings.

 

<BMC_IGNORE_PRECHECK_ERROR>

 

true

Not applicable: Load sample data into the server

Sample data is not provided for BMC Digital Workplace Catalog.

 

<BMC_DWPSERVER_SAMPLE_DATA>

 

false

Not applicable: Skip startup health check

You do not need to enable the health check.

 

<SKIP_HEALTH_CHECK>

 

true

Not applicable: Upgrade language locale

BMC Digital Workplace Catalog does not support any language upgrades.

 

<BMC_ADD_LOCALE_UPGRADE>

 

false

Not applicable: Viewing language

BMC Digital Workplace Catalog supports only English.

 

<BMC_USER_SELECTED_VIEW_LANGUAGES>

 

en

Oracle JRE or OpenJDK home path

Specify the name of the Java home folder.

Best practice: BMC recommends that a user with system root administration permissions installs the latest version of Oracle Java or OpenJDK as described in Preparing a Linux server for BMC Digital Workplace Catalog installation.

 

<BMC_JAVA_JRE_64_BIT_HOME_PATH>

 

/usr/java/latest

Parameters to modify local server port settings if required

When installing BMC Digital Workplace Catalog in a cluster, these port settings might need to be set to unique values on each server to prevent conflicts. In most cases, these port settings can remain as their default values.

 

<BMC_ATRIUM_PLUGIN_PORT_NUMBER>
<BMC_NE_PLUGIN_PORT_NUMBER>
<BMC_DBONLY_UPGRADE_CONFIRM>

 

9556
9555
false

Server dependent: Java 32-bit email server support

Specify whether the 32-bit version of Java is enabled on the BMC Digital Workplace Catalog application server. The following values are supported:

  • true: For a 32-bit version
  • false: For a 64-bit version

 

<BMC_JAVA_EMAIL_ENGINE_SELECTED_FOR_32BIT>

 

false

Server dependent: Java 32-bit plugin support

Specify whether the 32-bit version of Java is enabled on the BMC Digital Workplace Catalog application server. The following values are supported:

  • true: For a 32-bit version
  • false: For a 64-bit version

 

<BMC_JAVA_DWP_SERVER_SELECTED_FOR_32BIT>

 

false

Tenant database administrator user credentials

(Oracle only) Specify the user account that can create objects in the tenant tablespace. Grant this account full administration rights to the tablespace indicated in <BMC_DATABASE_TENANT_TABLESPACE>.

 

<BMC_DATABASE_TENANT_USER>
<BMC_DATABASE_TENANT_PASSWORD>

 

dwp_admin_tenant
Passw0rd!

Tenant database or tablespace name

Specify the name of the database or tablespace in which to store catalog data for a specific tenant or organization.

 

<BMC_DATABASE_TENANT_TABLESPACE>

 

dwp_db_tenant

Tenant installation mode selection

By default, multitenancy is enabled.

 

<BMC_TENANT_INSTALL_MODE>

 

MULTI

Unused application service password

Create a secure password to lock out the application service. BMC Digital Workplace Catalog does not use this feature. The password cannot be longer than eight characters.

 

<BMC_DWP_APPLICATION_PASSWORD>

 

P@ssw0rd

Unused local Distributed Server Option (DSO) password

Create a secure password to lock out the legacy distributed server option for clusters. BMC Digital Workplace Catalog does not use this feature. The password cannot be longer than eight characters.

 

<BMC_DWP_DSO_PASSWORD>

 

P@ssw0rd

Allowed cross origin sources

Provide the URL to the Business Workflow application on the BMC Helix Platform server, from which cross-launch into BMC Digital Workplace Catalog will be seamlessly allowed.

<BMC_ALLOWED_CROSS_ORIGIN_SOURCES>http://innovation-suite-server.domain.com

Was this page helpful? Yes No Submitting... Thank you

Comments