This documentation supports the 25.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.To view an earlier version, select the version from the Product version menu.

(BETA) Embedding data from a custom application in the studio pages


As an administrator, you can populate data relevant to your line of business from record definitions of custom applications developed by usingBMC Helix Innovation Suite. You can configure how to display the data so that it is relevant and easily filterable for your end users, which ensures that they get the information they need with the option to drill down for more details. It improves the end-user experience by giving them the ability to: 

  • Sort and filter each column. 
  • View additional data from the View details button. 
  • View localized field labels. 

You cannot populate data from the following types of applications: 

  • BMC applications that are part of the  BMC Helix Innovation Studio bundle; for example, the Knowledge Management application.
  • Applications that have a developer ID starting with com.bmc or BMC Software; for example, the BMC Chatbot application. 
  • Custom applications developed by using Developer Studio in Action Request System


Scenario of embedding data from a custom application

As an administrator at Apex Global, you have used studio pages for your HR line of business. In one of the pages, you want to ensure that managers can view personal data of their employees such as date of joining, salary, date of birth, office location, and so on. 

The administrator decides to add the Record View component to automatically populate these employee details for the manager. The manager can refer to this information to check an upcoming work anniversary or to see how many employees are working from a particular office location. 

To make the data relevant, effective, and easily filterable, the administrator configures the following settings:

  • Selects important fields such as First name, Last name, Date of joining, and Location to be displayed in a grid.
  • Provides the option to drill down to view data from other fields such as Marital status, Age, Permanent residence, and so on.
  • Renames the Location field name to Office location for clarity. 
  • Enables sorting and filtering on each column of data. 


Before you begin

Make sure that end users have permissions to the following items:

  • The record definition from the custom application that you want to embed.
  • The fields in the record definition from which you want to populate data.

For more information, see Enabling row-level security by defining security labels


To embed data from a record definition

  1. Log in to the BMC Helix Digital Workplace  Administration Console, and select Configuration > Studio
  2. Create a new page or open an existing page. 
  3. Click Components Components icon in Studio.png.
  4. Either double-click or drag the Record View component to the page canvas. 
  5. Select Content options image2022-9-21_15-33-55.pngand then click Configure
  6. In the Configure Record View wizard > on the Select application & record tab, configure the following parameters:

    Parameter

    Description

    Example

    Application

    Select the custom application developed on BMC Helix Innovation Suite from which you want to select the record definition. 

    Wizard_select app and RD.png

    Record

    Select the record definition from which you want to populate data in the studio page. 

  7. Click Next
  8. On the Define grid fields tab, configure the following settings: 

    Setting 

    Description

    Example

    Fields

    Select the fields from which you want to populate data. 
    The fields are displayed as columns in the page. 


    Wizard_select fields and config settings.png


    Additional field settings


    • To change the sequence of the fields when they are displayed for the end users, click image-2023-7-4_10-8-45.pngand drag as required. 
    • To enable filtering on each field, click  Toggle filtering image-2023-7-4_10-21-51.pngnext to the field. 
    • To enable sorting on each field, click  Toggle sorting image-2023-7-4_10-24-7.pngnext to the field. 
    • To rename the field label, hover over the field and click  Edit image-2023-7-4_10-44-29.png .
    • To deselect a field, hover over the field and click Delete image-2023-7-25_9-55-23.png

    Languages

    Select the language in which you want to customize the field labels, so that the end user will see translated field labels in the column headers appropriate to their language setting.

  9. Click Save
  10. (Optional) To configure the View details button, click Component Properties Components icon in Studio.png.
    1. In the Actions section, click Modify next to View details and configure the following settings: 

      Setting

      Description

      Example

      View details

      Select the Select 'view details' grid action toggle to enable end users to see the View details button.

      Record grid_View details tab.png

      Fields

      Select the fields from which you want to display data when the end user is looking for more details. 

      You can reorder these fields and modify the field labels 

      Languages

      Select the language in which you want to customize the field labels, so that the end user will see translated field labels appropriate to their language setting.

    2. Click Save. 
  11. To configure the page size and other visual properties, in the click Component Properties Components icon in Studio.pngpane, and complete the following settings: 

    Setting

    Description

    Page size

    Specify the number of rows you want to display in the grid.
    Valid values: 1 to 20

    Bordered

    Select this parameter if you want to add a border to the grid. 

    Striped

    Select this parameter if you want to add a gray background to each odd row. 

    Toolbar

    Select this parameter if you want to display the following example message to let the end user know how many rows are displayed in the grid. 

    1 to 15 of 25

  12. Save and publish the page. 


Result

The following image is an example of how end users can view the data in the studio page:

 Record grid wizard result.png



Troubleshooting

The following table describes common errors that can occur when you embed data from a record definition and the steps to resolve them:

Error

Steps to resolve

Administrators are unable to view an application when they want to embed a record definition.

The application is part of the BMC Helix Innovation Studio bundle, or has developer ID starting with com.bmc or BMC Software

The following image shows an example of an application with a developer ID:

image2022-10-4_15-50-54.png

End users are unable to view the data

  • Confirm that end users have permission to view the record definition. 
  • Confirm that end users have permission to view data in the respective fields. 

For more information, see, Creating hierarchical groups through security label


Customer feedback

We thank you for your participating in the Beta program. We request that you share your feedback or concerns regarding this capability and its documentation on the DWP Beta validation page on BMC Community. 

 

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