This documentation supports the 22.1 version of BMC Helix Digital Workplace Basic and BMC Helix Digital Workplace Advanced. Icons distinguish capabilities available only for the Advanced and External license levels. For more information, see License-types-and-features.

Enabling and configuring the enhanced catalog


As an administrator, you can enable an enhanced catalog and configure a connection to a Catalog server. The enhanced catalog provides rich profiles and categories for catalog items, bundles, and promotional banners. To learn more, see Enhanced-catalog.

Before you begin

Make sure you have a Catalog user with standard user permissions. This account should be used only for running background tasks such as sending notifications to end users when requests are being processed. For instructions about how to create the background process or system notification user, see Setting-up-user-accounts-and-granting-access-to-BMC-Helix-Digital-Workplace-Catalog

Information required for the enhanced catalog configuration

The following information is required to configure a connection between BMC Helix Digital Workplace and BMC Helix Digital Workplace Catalog:

Note

If you are using BMC Helix Digital Workplace Catalog, BMC configures the enhanced catalog for you.

If you are running BMC Helix Digital Workplace Advanced on-premises, ask your system administrator to provide the Catalog server configuration information for you to enable the enhanced catalog.

Web address of the catalog source

Example

dwp-catalog-server-url.png

The web address to the API endpoint  includes:

URL segment

Examples

Comment

Context

http (standard)

https (SSL-configured)

Identifies whether an SSL connection is required to access the enhanced catalog source.

Server URL

your-myit-service-broker-url.com

Contains the fully qualified domain name or IP address of the server, or the load balancer of the server cluster.

Port number

8008 (standard)

8443 or 443 (SSL-configured)

Specifies the application server port number. Your system administrator can provide the assigned port number, or tell you if your system is configured to not require a port number.

API endpoint

/api/myit-sb

Points to the API endpoint used by the application scripts.

Tenant domain name

If you are connecting to BMC Helix Digital Workplace Catalog version 20.08 or earlier, then a single instance of BMC Helix Digital Workplace Catalog can display the enhanced catalog of a single tenant, identified by a domain name. Otherwise, leave this blank.

Parameter

Example

Comment

Domain

calbroservices.com

Tenant domain identifier.

Credentials used by the notification system

These credentials can be used for any valid user account with the Administrator role in BMC Helix Digital Workplace Catalog. Specify a user account that is used only for background services.

Parameter

Example

Comment

User

sys_notification

Do not add the tenant domain in the enhanced catalog configuration.

Password

5Y5_n0tification!

Password for the system notification user.

Enabling an enhanced catalog

To enable an enhanced catalog the administrator must perform the following tasks:

To enable support for the enhanced catalog

  1. Log in to the Admin console.
  2. Select Configuration > Application Features.
  3. Select Enhanced Catalog to enable the feature.

    Enhanced_catalog_19.11.png

To configure a connection between BMC Helix Digital Workplace and BMC Helix Digital Workplace Catalog

Important

BMC Helix Digital Workplace can be connected to a single BMC Helix Digital Workplace Catalog server. For information about configuration details required to enable the connection, see Information required for the enhanced catalog configuration.

  1. Log in to the Admin console.
  2. Select Configuration > Configuration > Enhanced Catalog.
  3. Complete the following fields to configure the enhanced catalog:

    Field

    Description

    URL

    URL of the catalog server that you are using.

    Domain

    Tenant domain name. 

    System User

    User name of the service notification user that handles background tasks such as pushing notifications to end users when catalog requests are being processed. 

    System User Password

    Password for the service notification user.

    Configuring_a_connection_between_DWP_and_Catalog_21.02.png

  4. Click Save.
    Self-service users who are currently logged in will see the enhanced catalog the next time they log in.

When the enhanced catalog is enabled and configured, end users with Read license type in the enhanced catalog server database can view and request services and bundles they are entitled to access. For more details about service entitlements, see Entitling-end-users-to-services-bundles-and-banners.

Where to go from here

Setting-up-sections-in-the-Catalog