Adding custom fields to views


As a case business analyst, you can customize views by adding custom fields to case views and task views.

You must first add the field in the record definition that is used by the view and then add the field in the view. For information about how to add a field to a record definition, see Adding-custom-fields-to-record-definitions.

For example, an employee requests for an employment verification report. Due to project requirements, the employee has two managers, a primary manager and functional manager. While creating a case for the employee, the case agent wants to add the functional manager details. To enable the case agent to specify these details, a case business analyst performs the following actions:

  1. Adds custom fields to the Case record definition.
  2. Adds custom fields to the Case Create view by using an extension container so that the fields are displayed while creating a case.

The case agent then adds details about the functional manager in the custom fields.

Warning

If you have added custom fields to a view, after an upgrade, you cannot view the new out-of-the box fields in the latest version of BMC Helix Business Workflows.

To view the out-of-the-box fields, revert your customization and add your custom fields again.

Types of fields that you can add to a view

You can add the following types of fields to a view:

  • Attachment
  • Boolean
  • Date
  • Date/Time
  • Decimal
  • Floating
  • Integer
  • Selection
  • Text
  • Time

Methods for adding a custom field to a view

You can add fields to a view by using the following methods:

Method

Description

Use this method to add fields to views that cannot be customized directly. You can extend such views to add custom fields.

Use this method to add fields to views that can be customized and consists of a record grid element. You can update the record grid of such views to display columns.


To add a field to a view by using an extension container

By using an extension container, you can add custom fields only to the following views:

Application

Bundle

View

Case Management Service







com.bmc.dsm.case-lib

Case Create

Case Edit

Configure Case Assignments - Create

Configure Case Assignments - Edit

Configure Case Approvals - Create

Configure Case Approvals - Edit

Case Preview

Person Profile

Task Management Service

com.bmc.dsm.task-lib

Task Create

com.bmc.dsm.case-lib

Task Edit

Task Preview

Best Practice
To add new fields in views, we recommend that you do not add fields directly to the views. You must create extension views so that you do not lose your customization after an upgrade.

To add a field to a view by using an extension container, perform the following steps:

  1. Log in to BMC Helix Innovation Studio and navigate to the Workspace tab.
  1. Select the application for which you want to update a view, such as Case Management Service.
  2. Select View > New > Flexible > Container
  3. On the Properties tab, click Edit Edit icon.png, and complete the following fields:

    Field

    Description

    Name

    Enter a name for the view.

    View to Extend

    Select the view that you want to extend.
    For example, if you want to extend the Case Create view, select Case Create from the list.

    Extension Container

    Select the extension container in which the view must appear.
    The following figure shows an example of extension containers that are available for the Case Create view:
    20.02_Extension Container.png

  4. From the palette, drag the Record Editor element to the canvas.
  5. On the Properties tab, click the Settings icon Settings icon.png, and complete the following fields:

    Field

    Description

    Name

    Enter a unique name for the record editor.

    Label

    Enter the label to be displayed in the application.Note: If you do not provide a label, the bundle name is displayed in the extended view.

    For example, if you extend the Case Create view, the bundle name Case Management Service is displayed in the view.

    Record Definition Name

    The record definition is auto-populated in the field based on the view you extended, you can select the existing custom and out-of-the-box fields from the same record definition.

    Association to Use

    If there is only one association, the name of the association is auto-populated. If there are multiple associations, select the association that you created earlier.
    Note: If you extend a view that uses the Case record definition, you do not need to specify an association.

    Mode

    The mode of the record editor is automatically set to match the mode of the record editor in the view you extended.Note: Do not change the mode. If you select a mode that is different from the mode of the record editor in the view you extended, the extension view is not displayed in the application.

    CSS classes

    Enter the custom CSS classes that you need to apply to the view.

    Form Contents

    To include specific record fields to appear in the view, click Quick Add/Remove fields, and select the custom fields that you require.

    (Optional) Click to build an expression

    If you want to hide or display these fields when specific conditions are met, in the Expression Editor, build an expression on the fields in the record editor. For information about how to build expressions in view definitions, see Creating or modifying view definitions.

  6. Click Save.
  7. (Optional) To confirm whether the custom fields are added correctly, click Preview.
  8. (Optional) To check whether these fields are working correctly, as a case agent, log in to BMC Helix Business Workflows and create or edit a case or task to check the new fields.


Important

  • After you add or edit new fields in a view, the changes are applied to both new and existing cases.
    Custom fields are displayed in cases that are created by using templates and in cases that are created without using templates.
  • If you add a field in the edit view mode, the field is displayed without any values in an existing case.

To add a field to a view by updating the record grid

By updating the record grid, you can add custom fields only to the following views:

Application

Bundle

View

Case Management Service




com.bmc.dsm.case-lib

Cases

Configure Case Assignments

Configure Case Approvals

Case Watchlist

Task Management Service

com.bmc.dsm.case-lib

Tasks

Knowledge Management

com.bmc.dsm.case-lib

Knowledge Articles

To add a field to a view by updating the record grid, perform the following steps:

  1. Log in to BMC Helix Innovation Studio and navigate to the Workspace tab.
  2. Select the application for which you want to update a view, such as Case Management Service.
  3. On the Views tab, click the view that you want to update, such as Cases.
  4. In the view, select Record Grid.
  5. Click Add/Remove Grid Columns.
  6. From the Available Columns section, select the field that you added in the record definition.
    For example, select the Follow-up date field.
  7. Click Save.
  8. (Optional) To confirm whether the custom fields are added correctly, click Preview.
  9. (Optional) To check whether these fields are working correctly, as a case agent, log in to BMC Helix Business Workflows and create or edit a case to check the new fields.

Related topics

View definition components

Tailoring the application skin and brand

 

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