Information
This documentation supports the 23.3 version of BMC Helix ITSM.To view an earlier version, select the version from the Product version menu.

Adding a column to the Overview console


After you determine which field or value to include on the Overview console, use the procedures in this section to add a corresponding column to the Overview console.

You can map different fields or values into the same column, but the data types of the fields must be the same as the union field. If you specify a selection field, the values on each request form must match; otherwise, you must create a selection field with a consolidated list of values and use the Convert Enumerated Values option when you define the union field. For more information, see Adding-requests-to-existing-Overview-console-columns.


Information
Example

These procedures add the Custom Character field (Field ID: 536870913) and the Custom Selection field (Field ID: 536870914) from various request forms. In the example, the Custom Selection field enumerated values are the same across the different source forms and do not require enumerated value conversion.

To define configuration data

You create the configuration data for the Custom Character Field union field as well as for the Custom Selection Field union field.

  1. Open the SHR:Union_DataSource_Fields form in New mode.
  2. From the Implementation Area menu, select Overview console.
  3. In the Union Field Name field, type the name of the custom character field; for example, CUSTOM_CHAR_FIELD.
    • If the name of a custom character field consists of more than one word, connect the words with an underscore ( _ ).
    • In IBM DB2 environments, you must type the name in uppercase characters.
    • The Union Field DataType field is blank. The system populates this field later.
  4. (Optional) Provide a value for the Union Default Value field.
    This field is used by the system when a mapping is not found. Use single quotation marks to specify a default value that is a string; for example, 'N/A'.

    Warning

    Important

    If you specify a value in the Union Default Value field, depending on your customizations, you might need an additional workflow or you might need to customize an existing workflow. 
    If the values that you are mapping come from a selection field, you can convert the enumerated values to match those values specified in a consolidated version of the field.
    In the example used in this topic, you do not need to set this value to Yes. For more information, see Adding additional requests to existing Overview console columns.

  5. Use the Status field to set the status.
    The default status value is Enabled. If you must exclude a column at a later time, but you want to keep it in the system, set the status to Offline.
    All records associated with Union field records with a status of Offline (for example, field mappings) are ignored when the database union structure is built.

    Warning

    Important

    Do not change the default Record Type value, Custom. This value indicates that this record was added as a customization.

  6. Repeat this procedure by specifying CUSTOM_SELECTION_FIELD as the Union Field Name value in step 3.

To create mappings

Create the mappings between the source forms and the union field. You repeat this procedure to create mappings for each of the source forms that you are using.

  1. Open the SHR:Union_DataSource_FieldMappings form in New mode.
  2. From the Implementation Area menu, select Overview Console.
  3. In the Source Form field, select the source form; for example, HPD:Help Desk.
  4. From the Select Source Field menu, select Custom Character Field.

    Warning

    Important

    To ensure that you selected the correct field, verify that the source field ID matches the field name. The source field ID is used when building or rebuilding the union structure. If you select an incorrect source field, use the Select Source Field menu to select another field to populate the associated source field information.

  5. Using the Union Field Name menu, specify the CUSTOM_CHAR_FIELD for the union field name.
  6. Use the Status field to set the status.
    The default status value is Enabled. If you must exclude a mapping at a later time, but you want to keep it in the system, set the status to Offline. Offline mappings are ignored when the database union structure is built.

    Warning

    Important

    Do not change the default Record Type value, Custom. This value indicates that this record was added as a customization.

  7. Repeat this procedure by selecting Custom Selection Field as the source field in step 4, and CUSTOM_SELECTION_FIELD as the value for the Union Field Name field in step 5.

To build the database union structure

  1. Open the SHR:Union_ConfigurationConsole form in Search mode or New mode.
  2. From the Implementation Area menu, select Overview Console.

    Success

    Tip

    If you change the mappings or any other configuration records and need to refresh the information displayed in the SHR:Union_ConfigurationConsole tables, reselect the Implementation Area menu.

  3. Click Build/Rebuild Database Union Structure.
    This action removes the previous database union structure and replaces it with the new union fields and mappings.
Warning

Important

  • If you include union fields or mappings that require enumerated value conversion, you must set the Bypass Enum Value Conversion flag to Yes until you create the corresponding Enum field on the AR View form. The AR View form contains the consolidated list of enumerated values, in this example, it is the SHR:Union_OverviewConsole form. For more information, see Adding-requests-to-existing-Overview-console-columns.
  • (For Oracle database) If any of the Source forms contains a Character Large Object (CLOB) type of field, the Build or Rebuild action displays an error. To resolve this error, add the CLOB field to the Run If qualification of SHR:UCC:UnionFieldLoop_NoMap_NoDefaultVal_UseSpace_SV_Orcale filter.

To add new fields to the overlay

  1. Open Developer Studio in Best Practice Customization mode.
  2. In the Form list, locate the SHR:Union_OverviewConsole form.
  3. (Optional) If an overlay has not yet been created for the form, right-click the form name in the list and select Create Overlay.
    The form opens automatically.
  4. (Optional) If you did not create the overlay in the preceding step, double-click the form name in the Form list to open it.
  5. In the view that you are customizing, select Create View Overlay from the Form menu.
  6. (Optional) If you need to include a new custom field on the form, copy the field from the source form into the overlay.
     For example, if you want to add the Status Reason field from PBM:Known Error, copy the field from the form and paste the field to  SHR:Union_OverviewConsole.

    Warning

    Important

    Ensure that the field name is same as on SQL view.

  7. Position the field in the view.

    Warning

    Important

    This form is a back-end form and is not visible to end users.

  8. On the Properties tab, change the View Information attributes of each field to match the union field; for example, CUSTOM_CHAR_FIELD and CUSTOM_SELECTION_FIELD.
  9. (Optional) If the field ID number is within the reserved range of field ID numbers, change the field ID number.
  10. (Optional) If the fields that you are copying come from the base layer (that is, they are out-of-the-box fields), modify the database name to include a prefix or suffix to ensure that the name does not conflict with any out-of-the-box fields that might be added by subsequent system upgrades.
  11. In a localized environment, if you are implementing selection fields, ensure that the localized alias values are set as required.
  12. Modify the additional field attributes, permissions, and so on, as required.
  13. Save the form.

To add new columns to the table in the overlay

  1. Open Developer Studio in Best Practice Customization mode.
  2. In the Form list, locate the SHR:OverviewConsole form.
  3. (Optional) If an overlay has not yet been created for the form, right-click the form name in the Form list and select Create Overlay.
    The form opens automatically
  4. (Optional) If you did not create the overlay in the preceding step, double-click the form name in the Form list to open it.
  5. In the view that you are customizing, select Create View Overlay from the Form menu.
    To show the columns on the Home page as well as on the main Overview console, which is located under Foundation Elements, you must overlay the Default User View and the Overview Homepage Content view (and any localized views that must be included). 
  6. Locate the z2TH_ConsolidateTable1 table field (Field ID: 301444200), right-click the table, and select Create Overlay.
  7. In the table Properties tab, change the Others > Overlay Type value to Overwrite, and then save the form.
  8. In the table Properties, click the Tree/Table Property attribute box to open the Tree/Table Property dialog box.
  9. In the Fields from Remote Form SHR:Union_OverviewConsole and Local Form SHR:OverviewConsole list, select the fields you need to add and then click the arrow (>) to add them to the Table Columns list.
    1. If you have created the overlay views for all applicable views, you can select the Add columns to table in overlay views only option and click OK.
    2. Alternatively, you can select the Add columns to table in all views option to create overlays on all of the views and include the new column.
  10. Modify any additional field attributes, permissions, and so on, for the new column as required.
  11. Save the form.

To view the changes on the Overview console

To see the changes on the Overview console, clear the Mid Tier cache.

 

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

BMC Helix ITSM 23.3