Administration and serviceability enhancements

Several enhancements have been made to help you administer, maintain, and support IBM OpenPages®.

New system Title field

The new System Title Field feature provides additional options for administrators to use for referencing a record. Prior to 9.0, administrators were provided with only one option for referencing a record within OpenPages: the Name field (System Fields:Name).

The Name field is displayed in many prominent locations within OpenPages that cannot be configured to display a different field (including the banner at the top of Task Views, relationship tree diagrams, and panels and tabs on dashboards). The Name field must be unique within a folder, which, in turn, results in the field functioning more as an ID field than as the typical way of referencing a record by name. As a workaround to this issue, many clients use another field as the Title of the record, which results in a lack of standardization within and across client environments.

In order to balance preventing disruption for existing clients and a better experience for new customers, we have created a fully optional configuration that is available for each object type, Enable Title Component. This option controls how the reference to an object is displayed. If the Enable Title Component option is set to False (which is the default setting for clients upgrading to 9.0), then you will experience no change in behavior related to the System Name field.

An administrator can access this feature by clicking Administration menu > Solution Configuration > Object Types. After you select an object, click the Edit button to open a side panel that displays the new Enable Title Component option. When you set the option to True, you are given three options for displaying the Name field: Title only, Title (ID), and ID (Title). This selection dictates how the object is referenced throughout the system and provides the Title component to the end user to populate on records of this object type. The Title component is not required to be unique within a folder and has a 4,000 character limit. In the same side panel, you can also make the Title a required field, which prevents users from saving a record unless the Title field is populated.

Figure 1. Example: Enabling the Title component for the KRI object type
The configuration page for the KRI object type is shown. In another image, the side panel is displayed. The new Enable Title Component option is highlighted. The option is turned on and off by using a toggle button. Three radio buttons are displayed: Title only, Title (ID), and ID (Title). Another toggle, Title is required, is also shown. In this example, Enable Title Component is set to True, Title only is selected, and Title is required is set to False.

When Enable Title Component is set to True, the Name field displays two components: ID and Title. The ID field is populated with any existing values that were provided in the System Name field prior to 9.0. When Enable Title Component is set to False, the ID field is populated with any values populated in the Name field.

The ID component has the same rules that apply to the System Name field (a required field and unique within a folder) and auto-naming settings will apply to the ID component.

When the Title component is populated, the Name field is displayed throughout OpenPages according to the Name Display setting that is set on the Object Type page. The configuration setting also makes the Title component available within the workflow designer, calculations, and in the filters related to that object. If the Title component is not populated on a record, then the value that is provided in the ID component is displayed.

The following example shows the View Designer with the ID and Title components of the Name field. You can set the Title component’s Read-Only and Required settings on the view.

Figure 2. Example: Viewing the ID and Title components of the Name field in the View Designer
The View Designer is shown. The Creation View for the KRI object type is displayed. The Name field is selected. In the side panel, the ID and Title components are shown. For Title, two toggles are available: Read-Only and Required. In this example, both toggles are set to False.

This example shows a Creation View in which the Title component is enabled and auto-naming is in place for the ID component.

Figure 3. Example: A Creation View with Title enabled and auto-naming for the ID
The Creation View for the KRI object type is displayed. The General section displays the Name field with two components: ID and Title. The ID is _KRI_001. The Title field is empty. The side panel shows that Name:ID is required and is complete while Name:Title is optional and not filled in yet.

Based on the setting that is configured on the KRI object, the Title component displays in prominent locations within the Task View. In the following example, clicking the Name field displays both the ID and Title components when at least one component is editable; otherwise the Name Display setting dictates the display of the Name field. In this example, the Name Display setting on the KRI object is set to Title Only, and so the Title component is displayed in the Task View header and within the relationship tree diagram.

Figure 4. Example: A Task View with Title enabled
The Task View of the KRI object type is displayed. The header of the view displays the Title field. The view contains a tree diagram. Within the tree, the Title of the KRI is shown.

The following example shows the Grid View for KRIs with Title enabled. The Title component displays in the Name column in grid views, based on the setting on the KRI object type. Hovering over the entry displays the ID and Title of the object. With the Title component populated on this object, the ID, Title, and Description are all available for search and filtering within Grid Views.

Figure 5. Example: A Grid View with Title enabled
The Grid View of the KRI object type is displayed. The Filter panel is open. The grid is filtered to show KRIs where Name.Title starts with Client Complaints. In the grid, the Name column displays the Title of the KRIs. The mouse pointer is on the name of a KRI. A tooltip displays both the ID and the Title of the KRI.

The following examples show a dashboard with the Name Display setting dictating the display of the Name field for KRI objects.

Figure 6. Example: A Dashboard with Title enabled
A dashboard is shown. A panel shows the top five KRIs by due date. The list displays the titles of the KRIs. The mouse hovers over Client Complaints. The tooltip shows the ID and title of the KRI.
Figure 7. Example: The My Tasks dashboard tab with Title enabled
The My Tasks tab is shown. In a grid, KRIs are listed. The Name column displays the title of the KRIs.

The Name Display setting provides the ID and Title components within the workflow and calculation engines. If the Enable Title Component setting is set to False, then only the Name field (and not the two ID and Title components) will display (the pre-9.0 to behavior).

The following example shows the workflow designer with the Name Display setting dictating the display of the Name field.

Figure 8. Example: A workflow in the designer with the Title component enabled for the object type
The workflow designer is shown. The KRI Value Creation workflow is shown. The side panel shows the workflow conditions. The Object Field list displays Name.ID and Name.Title.

The following example shows a calculation with the Name Display setting dictating the display of the Name field.

Figure 9. Example: A calculation with the Title component enabled for the object type
A calculation is shown. In the side panel, the Object Field list displays Name.ID and Name.Title.

The following example shows an email that was produced by a workflow that uses the Title component of the KRI, as established by the Name Display setting on the KRI object.

Figure 10. Example: A notification email that displays the Title of an object
An email is shown. The message shows the title of a KRI, Client Complaints.

Migrating users, groups, and roles

You can now export the following items by using Export Configuration:
  • Groups and users
  • Role templates
  • Role assignments

The following example shows how you can export groups. When you export a group, the export includes the group hierarchy under the group, including sub-groups, users, user and group profile associations, and the group's administrators.

Figure 11. Selecting groups to export
The Select items to export page is shown. The available items to export now include Groups/Users, Role Assignments, and Role Templates. In this example, Groups/Users is selected and two groups are selected for export.

Updates to the user interface and custom themes (Carbon)

The user interface now uses Carbon 11. The names of the color settings for custom themes are now easier to understand.

Figure 12. Selecting colors for a custom theme
The Add theme side panel is shown. The available colors are listed. The color settings include button-primary-active and link-primary. In previous releases, the names were less intuitive.
The following table shows examples of the name changes:
Previous name New name
interactive-01 background-brand
interactive-03 button-tertiary
interactive-04 Split into two settings: border-interactive and interactive
text-04 text-on-color
link-01 link-primary
focus focus
hover-primary button-primary-hover
active-primary button-primary-active
hover-primary-text link-primary-hover
hover-tertiary button-tertiary-hover
active-tertiary button-tertiary-active

If you are upgrading or migrating, you don't need to update your custom themes to use these new color settings.

For more information about the color settings, see https://carbondesignsystem.com/guidelines/color/usage

For more information about Carbon, see https://carbondesignsystem.com/all-about-carbon/what-is-carbon/.

For information about creating custom themes, see Defining custom themes.