This documentation supports the 20.02 version of BMC Helix Platform. 
To view an earlier version, select 19.11 from the Product version menu.

Creating or modifying view definitions

You use BMC Helix Innovation Studio to create a view definition for designing the user interface for applications. You can create a view definition by arranging the data items in a specific order or by showing only specific data items. For example, a view definition called Tracking Item can be used to create and update Tracking Item records.

Before you begin

Before you create and manage view definitions, ensure that you have created a project and deployed it in BMC Helix Innovation Studio. For more information, see Creating a Project using Maven and the Archetype .

Note

Application business analysts can customize the objects developed in their own applications and that are marked customizable by the developers, but cannot customize the objects developed in com.bmc.arsys. For example, objects in core BMC applications like Foundation, Approval, and Assignment cannot be customized.

Creating a view definition

  1. Log in to BMC Helix Innovation Studio and navigate to thWorkspace tab. 
  2. Select the application for which you want to create a view.
  3. Select  Views > New.
  4. Select the layout template that you want to use.

    The New View page is displayed.

  5. In the Properties panel, enter a name and description for the view definition, and click Save.
    The view definition name must start with an alphanumeric character. Only alphanumeric characters, hyphens, dashes and spaces are allowed in the view definition name.
  6.   Select Scope/Customization Options to define the scope for a view definition. This option further contains the following options:
    • Application/Library (default)—To limit the use of the definition within the same Digital Service application or library. 
    • Public—To enable the definition to be used by all the applications or library and allow customizations for this definition.
  7. (Optional) Add permissions for a view or a specific view component

    Note

    You can add permissions to a view or view component while creating the view definition, or after the view definition is created.

  8. Specify either of the following runtime parameters:

    • To specify that the user must provide some information at runtime before the view definition opens, from the INPUT PARAMETERS list, click Add and specify the input field name.

    • To specify that the user must provide some information after the view definition closes, from the from the OUTPUT PARAMETERS list, click Add and specify the output field name. Click Click to build an expression for specifying the data allowed for the expression.
  9. From the Palette, drag and drop the components or form fields to the canvas in the order that you want them to appear on the user interface.
    For more information about components that are available within BMC Helix Innovation Studio, see Defining the user interface through view definitions.

  10. From the Properties pane, on the Validation tab , check and resolve any validation errors for the view definition before you proceed.

  11. Save the view definition.


To add permission for a view definition

  1. In the Details section, click Edit beside the Permissions field. 
  2. Click Add Permission.
  3. From the Type list, select whether you want to provide permission to a specific group or to a specific role.
  4. From the Group list, select the group to which you want to provide permission.

    The view will be displayed only to those users who belong to the group.

  5. Click Save.

To add permission for a view component

  1. Select the view component to which you want to add permission.
  2. From the Details section, click Edit beside the Permissions field.
  3. Click Add Permission.
  4. From the Type list, select whether you want to provide permission to a specific group or to a specific role.
  5. From the Group list, select the group to which you want to provide permission.

    The view will be displayed only to those users who belong to that group. 

  6. Perform one of the following actions:
    1. To assign view-only permission, select the View check box.

    2. To assign edit permission, select the Change check box.

  7. Click Save.

To create complex view layouts compared with simple view layouts

  1. Log in to BMC Helix Innovation Studio and navigate to the Workspace tab.
  2. Select the application for which you want to create complex view layouts.
  3. Select Views > New
  4. Select the layout template that you want to use.

    The selected layout is added to the canvas.

  5. Drag and drop one more container into a column in the canvas.
  6. Select the number of columns that you want to add in the container. You can choose up to a maximum of 6 columns.
  7. (Optional) To add nested containers, drag and drop another container into the container in the canvas.
  8. Select each container individually and specify its properties.
  9. (Optional) Add the required form fields and basic components to the view definition.
  10. Click Save.

Copying a view definition

You can copy a view definition and create a view that is based on an existing view definition. This will save time taken to design a new view definition.

To copy a view definition

  1. Log in to BMC Helix Innovation Studio and navigate to the Workspace tab. 
  2. Select the application that contains the view you want to copy.
  3. Click the Views tab.
  4. From the list of views, select the view and click Copy, as shown in the following image:

The view definition is copied as a new view.

Modifying view definitions

You can modify existing view definitions by adding permissions to a view definition or a view component, adding or removing components, and so on. 

You can modify a non customizable view definition. Ensure that you do not modify the required INPUT PARAMETERS and OUTPUT PARAMETERS.

To update the permissions for a view definition

By default, a view definition is visible only to the administrator users. To make a record available for other users, you must provide the permissions to a specific group or a role to access the view. You can also restrict any component in a view by assigning permissions to the component.

  1. Log in to BMC Helix Innovation Studio and navigate to the Workspace tab. 
  2. Select the application for which you want to add permissions for a view definition.
  3. Navigate to Records and select the view to which you want to add permissions.

    The view and the associated components are displayed.

    Note

    By default, the view is displayed only to the administrators.

  4. In the Details section, click Edit beside the Permissions field.
  5. Click Add Permission.
  6. From the Type list, select whether you want to provide permission to a specific group or to a specific role.
  7. From the Group list, select the group to which you want to provide permission.

    The view will be displayed only to those users who belong to that group.

  8. Click Save to save the permission settings.
  9. Save the view definition.

To update the permissions for a view component

  1. Log in to BMC Helix Innovation Studio and navigate to the Workspace tab.
  2. Select the application for which you want to add permissions for a view definition.
  3. Navigate to Records and select the view to which you want to add permissions.

    The view and the associated components are displayed. 

    Note

    By default, the view is displayed only to the administrators.

  4. Select the view component for which you want to add permission.
  5. From the Details section, click Edit beside the Permissions field.
  6. Click Add Permission.
  7. From the Type list, select whether you want to provide permission to a specific group or to a specific role.
  8. From the Group list, select the group to which you want to provide permission. The field will be displayed only to those users who belong to that group. 
  9. Perform one of the following actions:
    1. To assign view-only permission, select the View check box.

    2. To assign edit permission, select the Change check box.

  10. Click Save to save the permission settings.
  11. Save the view definition.

To delete view components

  1. Log in to BMC Helix Innovation Studio and navigate to  the Workspace tab.
  2. Select the application for which you want to update the view definition.
  3. Navigate to Records and select the view to which you want to update.

    The view and the associated components are displayed. 

    Note

    By default, the view is displayed only to the administrators.

  4. From the canvas, select the view component that you want to delete.
  5. Click the cross sign  beside the selected view component.

    The view component is deleted from the view definition.

Using the Expression Editor

The Expression Editor is a dialog box that appears in the View designer in BMC Helix Innovation Studio whenever you click the option Click to build an expression for a setting that requires an expression. It presents the data allowed for the expression, such as the fields in the record grid and record editor, the fields in the associated record definitions, view component properties, keywords, view input parameters, or static values. The Expression Editor includes a key pad that consists of the most commonly used operators. Expressions can contain any valid sequence of operators, wildcards, and keywords.

 To build an expression, you select the available values in the Expression Editor. The following are the available values in the Expression Editor for a Record Grid:

  • Filter By—all fields in the record definition and associations selected for the record grid.
  • Selected Row Count—number of rows that are selected.
  • Selected Rows—record grid rows (record instances) that you select.
  • First Selected Row—record grid row (record instance) that you select. Displays the columns selected to be displayed on the record grid.
  • Clickable row—displays the selected columns that should be displayed on the record grid.
  • Total row count—number of rows in the record grid.
  • Keywords—available keywords

 The following are the available values in the Expression Editor for a record editor:

  • Record definition name—name of the record definition selected for the record editor
  • Record instance Id—record instance ID value
  • Record instance—all fields in the record definition selected for the record editor

For example, the following image shows an expression to assign the value of Task name field to the Description field in a record editor (To assign the value, select the field in the record editor and on the Value field click Edit): 

 You can use the Next button to set the expression for the next field in the record editor without exit from the Expression Editor.

 You can build the expressions using Expression Editor to perform the following actions: 

  • Hide or disable a field in a record editor on specific conditions
  • Hide or disable action buttons on specific conditions
  • Assign value to field in record editor
  • Specify the record instance for a record editor
  • Specify filter conditions for a record grid
  • Associated record ID for a record grid
  • Specify URL in action buttons 
Was this page helpful? Yes No Submitting... Thank you

Comments