Customize the Main ribbon

You can customize the Main ribbon, defining which buttons and/or button options to be displayed or hidden on the ribbon as well as changing the display order of the menu options and define your own labels for the ribbon buttons. Ribbon customizations are stored in the user configuration, so your ribbon customizations can be accessed by you from any machine. You can also reset any changes you have made to the ribbon and revert to the default ribbon configuration.

Lock main ribbon changes

When editing configurations, you can lock changes made to the Main ribbon. This enables you to single out and prevent user access to specific Main ribbon elements - for example updating the Unit configuration to only display certain case types when unit members create new cases.

Locked Main ribbon elements cannot be unlocked by users that are not assigned the CONFIGADM access code even though all users can edit their Personal configuration's main ribbon.

Button options

There are two types of button and button options you can configure in the ribbon:

  • Global options
  • Local options

Global ribbon options

Global ribbon options enable you to automatically deploy your customized ribbon configuration to all major ribbons.

Global ribbon options are identified by a capital G in the right column of the Configure ribbon form. If a ribbon option does not contain a capital G, it is a local ribbon option.

There are following global ribbon buttons and options:

  • Case
  • Contact
  • Word
  • Document
  • New Search

Local ribbon options

Local ribbon options enable you to deploy your customized ribbon configuration to the current ribbon only. If you want to apply the same local ribbon options for other ribbons, you must configure these ribbons individually.

Major and minor ribbons

Only major ribbons can be automatically updated with changes to the global ribbon options and contain the Save globally option on the Save button of the Configure ribbon form.

Minor ribbons can only be updated with local changes and do not contain the Save globally option on the Save button of the Configure ribbon form.

The following ribbons are major ribbons :

  • The home page and home page lists opened in new tabs
  • All Case detail pages
  • All Document detail pages
  • All Meeting detail pages
  • All Contact detail pages
  • The Actor sequences page
  • All Search pages

All other ribbons are considered minor ribbons.

The Configure ribbon form

The Configure ribbon form is used to configure the ribbon configuration of the current ribbon and to distribute changes to global ribbon options to all other major ribbon configurations.

The Configure ribbon form is opened from the ribbon on the current detail page by clicking Configure ribbon in the Help button.

Note: Configure ribbon is always present in the ribbon and not connected to the Help button. If you hide the Help button, you can still access the Configure ribbon dialog by pressing Configure ribbon.

Ribbon options

Global ribbon options are identified by a capital G in the right column of the Configure ribbon form. If a ribbon option does not contain a capital G, it is a local ribbon option.

Buttons

The Configure ribbon form also contains the following Save and Reset button options:

Button Type

Description

Save

Button

All changes to local and global ribbon options are saved to the current ribbon configuration only.

Save globally

Button option

All changes to local and global ribbon options are saved to the current ribbon configuration. Additionally, all changes to global ribbon options are applied to all other major ribbon configurations.

Changes to local ribbon options are not applied to other ribbon configurations.

Reset

Button

Removes all changes to local and global ribbon options for the current ribbon configuration only, reverting the current ribbon configuration to the default ribbon configuration.

Reset globally

Button option

Removes all changes to local and global ribbon options for the current ribbon configuration, reverting the current ribbon configuration to the default ribbon configuration. Additionally, all changes to global ribbon options are removed from all major ribbon configurations.

Changes to local ribbon options are not removed from other ribbon configurations.

Change the order of the Main menu options

The Main menu options are by default displayed in alphabetical order or by the defined ranking order in WorkZone Configurator for Case types. You can customize the drop-down list by dragging and dropping the individual menu options in the Configure ribbon form to override the default sort order. Adjusting the display order of the menu options enables you to better reflect the workflows of your organization.

How to customize and save a ribbon configuration

  1. After you have opened the configuration for editing1, navigate to the detail page you want to change the ribbon configuration for.
  2. In the Main ribbon, click Configure ribbon in the Help button to open the Configure ribbon form.
  3. In the Configure ribbon form:
    • Select the check box for each button and/or menu option to be displayed in the menu.
    • Clear the check box for each button and/or menu option to be hidden in the menu.
  4. Click the unlocked padlock () to lock the ribbon element. To unlock a locked main ribbon element, click the locked padlock ().
  5. To change the display order of menu options, click to expand the menu title then drag each menu option to its new position.
  6. Click Save to save your changes and exit the Configure ribbon form.
  7. Save the configuration you are editing1.

1See See Also section below.

Changes made to global ribbon options can only be distributed to major ribbons. Any changes made to local ribbon options are applied to the current ribbon configuration only.

  1. After you have opened the configuration for editing1, navigate to the detail page you want to change the ribbon configuration for.
  2. In the Main ribbon, click Configure ribbon in the Help button to open the Configure ribbon form.
  3. In the Configure ribbon form:
    • Select the check box for each button and/or menu option to be displayed in the menu. Global ribbon options are displayed with a capital G.
    • Clear the check box for each button and/or menu option to be hidden in the menu.
  4. Click the unlocked padlock () to lock the ribbon element. To unlock a locked main ribbon element, click the locked padlock ().
  5. Click Save globally to save your changes and exit the Configure ribbon form.
  6. Save the configuration you are editing1.

1See See Also section below.

Customizing ribbon button labels

You can create your own customized ribbon button labels for all supported languages in WorkZone. When you select a display language in WorkZone, any customized button labels will be displayed instead of the default button labels for the selected language. If you have not defined any custom button labels for the selected language, the default button label will be used instead.

New button labels can be up to 256 characters long, but it is recommended to use short labels as a long label text may not be correctly displayed in the ribbon.

Note: The button labels of locked ribbons cannot be changed.

You can create custom button labels for your own personal configuration freely, but you must be assigned the CONFIGADM access code to edit and save configurations other than your own Personal configuration.

  1. In the Main ribbon, click Configure ribbon in the Help button to open the Configure ribbon form.
  2. In the Configure ribbon form, locate the button you want to customize the label of and click Rename to open the Rename <button label> button form1.
  3. In the Rename <button label> button form1 > Button name (<Language>) field2, enter the new button label for each language.
  4. Click Save to save your changes and close the Rename <button label> button form1.
  5. In the Configure ribbon form, click Save to save your changes to the active ribbon only or in the Save button, select Save globally to apply your changes to all major ribbons that contain the button.

1 where <button label> is the label of the currently selected button.

2 where (<Language>) is one of the supported languages in WorkZone.

Casing and button label texts

You can use lower and upper case characters as label text but if you only change existing default labels to upper case, for example changing Document to DOCUMENT, the default label (Document)will be displayed in the ribbon even though the DOCUMENT text is displayed in the Button name (<Language>) field in the Rename <button label> button form.

If you create a new label (create a label that is different from the default label text, disregarding all casing), the new label is displayed in upper case, lower case or any combination of the two, for example changing Document to DOCUMENT New.

Restore the default ribbon button labels

If your customized button labels no longer are required, you can restore your custom button label to the default values. Each custom button label must be manually restored to its default label.

  1. In the Main ribbon, click Configure ribbon in the Help button to open the Configure ribbon form.
  2. In the Configure ribbon form, locate the button you want to restore the label default to and click Rename to open the Rename <button label> button form1.
  3. In the Rename <button label> button form1, clear the Button name (<Language>) field2 of all values for the language you want to restore the label default for. The Use default label text will be displayed in the field.
  4. Click Save to save your changes and close the Rename <button label> button form1.
  5. In the Configure ribbon form, click Save to save your changes to the active ribbon only or in the Save button, select Save globally to apply your changes to all major ribbons that contain the button.

1 where <button label> is the label of the currently selected button.

2 where (<Language>) is one of the supported languages in WorkZone.

Exporting and importing custom button labels

You can export the customized button labels of a language in the configuration you are working on. You must select the configuration suffixed with the specific language and culture code (for example da-DK or en-GB )when you export the configuration.

Configurations that are suffixed with the specific language and culture code will only contain customized label text and do not contain any other customizations. In this way, only customized button labels will be exported and as a result, only customized button labels will be imported by other users, enabling you to distribute only customized button labels to other users. 

Configurations suffixed with the specific language and culture code are exported and imported as any other configuration - by using the Settings > Import/Export > Export to File or Import from file options in the main ribbon.

Resetting the ribbon configuration

Reset the configuration to quickly remove all your changes to the ribbon configuration and apply the default ribbon settings.

If you have changed any global ribbon options, you can reset the current ribbon configuration by pressing the Reset button or reset all your major ribbon configurations by selecting the Reset globally button option.

If you have changed local ribbon options, only the current ribbon configuration can be reset, regardless of which button (Reset or Reset globally) you press.

Manually reset the current ribbon configuration

You can also reset a current ribbon configuration by manually selecting all the ribbon options in the Configure ribbon form.

If your ribbon configuration contains global ribbon options, any changes will only be applied to the specific ribbon configuration and not to all ribbon configurations.

  1. After you have opened the configuration for editing1, navigate to the detail page you want to reset the ribbon configuration for.
  2. In the Main ribbon, click Configure ribbon in the Help button to open the Configure ribbon form.
  3. In the Configure ribbon form, click Reset to open the Confirm dialog.
  4. In the Confirm dialog
    • Click Yes to reset the ribbon configuration and exit the Configure ribbon form or
    • Click No to return to the Configure ribbon form.
  5. Save the configuration you are editing1.

1See See Also section below.

You can only reset changes to global ribbon options for all major ribbon configurations. Any changes to local ribbon options must be reset for each specific ribbon configuration.

  1. After you have opened the configuration for editing1, in the Main ribbon, click Configure ribbon in the Help button to open the Configure ribbon form.
  2. In the Configure ribbon form, click Reset globally to open the Confirm dialog.
  3. In the Confirm dialog:
    • Click Yes to reset all ribbon configurations and exit the Configure ribbon form or
    • Click No to return to the Configure ribbon form.
  4. Save the configuration you are editing1.

1See See Also section below.