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.

Integrating BMC Helix Digital Workplace Catalog with BMC Helix Virtual Agent

As a BMC Helix Digital Workplace administrator, you can embed BMC Helix Virtual Agent in BMC Helix Digital Workplace Advanced. BMC Helix Digital Workplace Advanced uses an HTML Inline Frame (iframe) element to load the BMC Helix Virtual Agent UI.


Embedding the BMC Helix Virtual Agent UI provides the following benefits:  

  • Leverages BMC Helix Virtual Agent capabilities within BMC Helix Digital Workplace
  • Seamless access to BMC Helix Virtual Agent
  • If both BMC Helix Digital Workplace Advanced and BMC Helix Virtual Agent are using the
    BMC Helix Single Sign-On
    (BMC Helix SSO) cloud native authentication application, BMC Helix Digital Workplace Catalog administrators can access BMC Helix Virtual Agent from BMC Helix Digital Workplace Catalog without providing the login credentials. 
  • Consistent user experience
    You can style and format the BMC Helix Virtual Agent button and UI to make it consistent with your application's corporate design.

For more information about BMC Helix Virtual Agent, see Orientation Open link .

Before you begin

Ensure that the following items are available:

  1. You have a valid BMC Helix Digital Workplace Advanced license and IBM Watson license. 

  2. You have an account in BMC Helix Virtual Agent with the same login ID as your BMC Helix Digital Workplace Catalog administrator account. 
  3. You have configured

    BMC Helix Single Sign-On
    OAuth 2.0 authentication for BMC Helix Virtual Agent and BMC Helix Digital Workplace Advanced, so the external application's users are automatically authenticated and do not need to log in separately to access the embedded view. 

Workflow to embed BMC Helix Virtual Agent in BMC Helix Digital Workplace Advanced

The following illustration describes the sequence of actions for embedding BMC Helix Virtual Agent:

The following table describes the actions that the administrator must perform to embed BMC Helix Virtual Agent in BMC Helix Digital Workplace Advanced:

Task

Product

Action

Reference

1

BMC Helix Virtual Agent

Register the URL of the BMC Helix Digital Workplace Advanced application in which you want to embed the BMC Helix Virtual Agent UI. 

Embedding BMC Helix Virtual Agent in external applications Open link

2

BMC Helix Digital Workplace

Register the trusted URL of the BMC Helix Virtual Agent application that you want to embed in BMC Helix Digital Workplace Advanced.

To register the application URL in BMC Helix Digital Workplace Advanced
3

BMC Helix Single Sign-On

If BMC Helix Virtual Agent and BMC Helix Digital Workplace Advanced are on different

BMC Helix Single Sign-On
 servers, configure them to enable the cross launch.

Configuring preauthentication Open link

Enabling cross launch for applications integrated with different BMC Helix SSO servers Open link

To register the trusted URL of BMC Helix Virtual Agent

  1. Log in to BMC Helix Digital Workplace as the administrator.

  2. Click the Settings icon  and from Application Settings, select Chatbot.
  3. In the Chatbot URL field, specify the BMC Helix Virtual Agent server base URL.

  4. (Optional) Provide the following information for

    BMC Helix Single Sign-On
    :

    Important

    Perform the following tasks only if BMC Helix Virtual Agent and BMC Helix Digital Workplace Advanced are under different

    BMC Helix Single Sign-On
    realms. If they are under the same
    BMC Helix Single Sign-On
     realm, leave the fields blank.

    1. Enter the base URL of the

      BMC Helix Single Sign-On
      server of BMC Helix Virtual Agent.

    2. Copy the text of the private key.

    3. Enter the passphrase of the private key.

  5. Click Save.

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

Comments