Creating or modifying custom record definitions


As a developer or an application business analyst, use a custom record definition to fetch record data from multiple record definitions and display them in a single record view.

For example, a service desk agent can view the data from multiple record definitions such as incident, task, problem, and change tickets in a single record view by using this custom record definition.

The following image displays an example of a custom record definition:

22_1_Custom_record_definition_concept.png

Important

  • A custom record does not update the database or combine data from two or more records based on a common field between them. It simply selects all the record data from one or more record definitions and displays them in a single grid view. 
  • You cannot use data from a custom record definition to create a report by using BMC Helix Dashboards.

You can create and also update an existing custom record definition. 

Important

Application business analysts can customize the objects developed in their own applications and that are marked customizable by the administrator, but cannot customize the objects developed in com.bmc.arsys in Best Practice Customization mode. For example, objects in core BMC applications such as, Foundation, Approval, and Assignment cannot be customized in Best Practice Customization mode. For more information, see Customization-layer.

Before you begin

Make sure you complete the following tasks:

To create a custom record definition

  1. Log in to BMC Helix Innovation Studioand navigate to the Workspace tab. 
  2. Select the application for which you want to create the custom record.
  3. On the Records tab, select New > Custom record.
  4. In the Create new custom record dialog box, complete the fields as described in the following table:

    Field

    Description

    Name

    Enter the name for the custom record definition.

    Data source name

    From the list, select the name of the data source that you have configured. For more information, see Configuring-a-data-source

    Important: All the data sources that you have configured for custom records are displayed in the list.

    22_1_Create custom record.png

  5. Click Create.
    A custom record definition is created with the following out-of-the-box fields:
    • Display ID
    • ID
    • Data Provider ID
  6. To add multiple record definitions, click Add Source Record Definition.
  7. In Add Record Definition dialog box, from the Record Definition Name list, select your source record definitions. 
  8. In the FIELD MAPPINGS section, click Add/Remove Field Mappings, and map the Display ID and ID fields with the fields from the source record definition.
    The Add/Remove Field Mappings window displays sections for each of the source record definitions you have selected. 
  9. In the Add/Remove Field Mappings window select the source record definition, and from the Source Field list, select the source field that you want to map with the selected field.
  10. Click Save.
  11. (Optional) To add new fields to the custom record, click New Field, and select the required datatype for the field.
  12. In the Details section provide the following details for the field:

    Field

    Description

    Name

    Enter the name of the record field.

    Description

    Enter the description for the record field.

    Field ID

    Enter the field ID for the field.  

    (Optional) Named List

    Select the named list that you want to associate with the record field.

  13. In the FIELD MAPPINGS section, click Add/Remove Field Mappingsselect the source record definition, and from the Source Field list select the source field that you want to map the newly added field.
    At runtime, the newly added field will display the data from the field that you selected from the Source Field list.
  14. Click Save

To add field mapping for selection fields

Selection fields provide users with a group of choices from a list. A selection field can be for a single selection or for multiple selections. 

  1. Log in to BMC Helix Innovation Studioand navigate to the Workspace tab. 
  2. Select the application to which you have added the custom record.
  3. Select the custom record, select New Field > Selection, and provide the following details:

    Field

    Description

    Name

    Enter the name of the record field.

    Description

    Enter the description for the record field.

    Field ID

    Enter the field ID for the new selection field.

  4. To add multiple options to the selection field, from the Options field, click Edit.
  5. In the Add/Remove Selection Options window, click Add option, and provide the following details:

    Field

    Description

    Example

    Name

    Enter the name for the new selection option.

    22_1_Add_option_for_selection_field.png

    Integer Value

    Enter the value for the selection option that will be stored in the database as an integer.

  6. Click Save.
  7. In the FIELD MAPPINGS section, click Add/Remove Field Mappings, and map the selection field with the relevant fields from the source record definition.
  8. In the Add/Remove Field Mappings window, select the source record definition, and from the Source Field list, select the source field that you want to map with the selection field.
    For example, in the following image, the Status selection field is mapped to the Status field from the Issue and Problem record definition.
    22_1_Map_selection_field.png
  9. Click Save.
  10. To map the values of the selection field with the values from the source record definition field, from the Options field, click Edit.

    Important

    It is important to map the values of the selection field with the values from the source record definition field so that the appropriate values are displayed for the field in the custom record definition.

  11. To map the source field values for the selected option, in the Add/Remove Selection Options window, for every selection option, click Map values.
  12. In the Map Values window, from the Options list, select options from the source selection field to map with the value of the selection field.
    For example, in the following image, the In progress selection option is mapped to the Assigned option from the Status field of the Issue and Problem record definitions. 
    22_1_Map_values_for_selection_field.png
    Make sure you map all the values of the selection field with the values from the source record definition field.
  1. Click Save.


 

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