This site will undergo a maintenance outage on Saturday, 13 September beginning at 2:30 AM Central/1 PM IST for a platform upgrade. The downtime will be ~three hours.

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.

Embedding custom pages from BMC Helix Innovation Studio or external sites


You can enable your users to view embedded custom pages. As custom pages, you can add BMC Helix Innovation Studio pages or links to external sites. The visibility of BMC Helix Innovation Studio pages depends on assigned permissions. A custom page is displayed as a separate tab in the end user console.

Scenario

Allen, an administrator at Apex Global, wants to manage hiring processes. He first develops an onboarding application in BMC Helix Innovation Studio, assigns permissions, and makes the application available to hiring managers through BMC Helix Digital Workplace. When hiring managers log in to the end user console, they can see the Onboarding page, raise onboarding requests, and track the hiring journey of candidates.


The following illustration shows a high-level overview of the end-to-end process of embedding custom pages:

Process overview of embedding custom pages


Before you begin

The integration with BMC Helix Innovation Studiois disabled by default. Your end users cannot see custom pages unless you perform the following steps:

  1. In the BMC Helix Digital Workplace Admin console, select Configuration.
  2. In the Features table, select the BMC Helix Innovation Studio check box.


To embed a BMC Helix Innovation Studio page

  1. In the Admin console, select Configuration.
  2. In the Application Features pane, select BMC Helix Innovation Studio.
  3. In the Create custom page section, click the Add page tab.
  4. In the URL to BMC Helix Innovation Studio field, specify a path to the integrated product.
  5. In the Page Title field, specify a custom title for the page (the length of the page title cannot exceed 35 characters).
  6. Save the changes.
  7. In the Navigation Manager, select your custom page so that it is displayed to end users; see Setting-up-navigation-for-your-workplace.
  8. Save your changes.

Custom_pages_entitlement.png

You can add the following query parameters to the BMC Helix Innovation Studio URL:

  • {loginId}—Passes the Username
  • {firstName}—Passes the First Name
  • {lastName}—Passes the Surname
  • {fullName}—Passes the First Name, the first letter of the Middle Name, and the Surname
    These parameters are read from the CTM:People form. 

(Version 22.1.04 and later) You can select the Use view entitlement rules check box to ensure that access permissions applied to the BMC Helix Innovation Studio page are enforced in the end user console. If the page is added to the navigation menu, only end users who are entitled to the page can see it in the menu and access its contents.


To embed an external page

  1. In the Admin console, select Configuration.
  2. In the Application Features pane, select BMC Helix Innovation Studio.
  3. In the Create custom page section, click the Add page tab.
  4. In the URL to BMC Helix Innovation Studio field, specify a path to the external site.
  5. In the Page Title field, specify a custom title for the page (the length of the page title cannot exceed 35 characters).
  6. Save the changes.
  7. In the Navigation Manager, select your custom page so that it is displayed to end users; see Setting-up-navigation-for-your-workplace.
  8. Save your changes.


To leverage a single sign-on experience for embedded BMC Helix Innovation Studio pages

Important

Connection settings need to be configured only if you have a hybrid deployment where some of your components are not under the same BMC Helix Single Sign-On.

You can enable end users to access embedded custom pages without providing credentials multiple times. To leverage a single sign-on experience, follow the steps:

  1. Make sure that BMC Helix SSO is integrated with the BMC Helix Innovation Studio; see Enabling BMC Helix Single Sign-On OAuth 2.0 authentication for your application.

  2. In the Admin console, select Configuration.
  3. In the Application Features pane, select BMC Helix Innovation Studio.
  4. In the Connection settings section, provide the BMC Helix SSO URL and upload your BMC Helix SSO pre-authentication certificate.
  5. (Optional) If your BMC Helix Innovation Studio application has a multitenant configuration, provide the domain name; otherwise, leave the Domain name field blank.
  6. Save your changes.

IS connection settings.png


To open a custom page in a new tab

A custom page is opened in an iframe in the end user console by default. You can enable opening custom pages in separate tabs in the browser by following the steps:

  1. In the Admin console, select Configuration.
  2. In the Application Features pane, select BMC Helix Innovation Studio.
  3. From the Open In list in the Create custom page section, select New tab.

The following image displays the example of a custom page opening in a new tab:

New tab.png

Important

If you want to set this custom page as the landing page, ensure that you select the Iframe in DWP option. To learn how to add pages to the navigation menu and set the home page, see Setting-up-navigation-for-your-workplace.


To create a different page title for a different locale

The default locale for a custom page is English, however, you can add values for other languages:

  1. Open a custom page for which you want to add a different locale.
  2. Click Select Name locale and select an appropriate locale. 
  3. In the Page Name field, specify a new value for the selected locale.

If different page titles are set for different locales, the page titles are displayed for end users according to the locale specified in their browser settings. For the full list of supported locales, see Supported-languages-and-locales


Troubleshooting

BMC only supports the behavior of BMC Helix Digital Workplace. If you have an issue with query parameters when opening external pages, see General-troubleshooting.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*