Customize a menu using order.txt files

IMPORTANT

Read more about Data Workbench’s End-of-life announcement.

You can customize the appearance of any menu by editing the order.txt file associated with that menu.

The steps in this section apply to all types of menus.

To edit the order.txt file to customize a menu

  1. In the Profile Manager, in the profile name column, right-click the check mark for the order.txt file and click Make Local.

  2. Right-click the check mark for the order.txt file in the User column and click Open > in Notepad. The order.txt file displays.

    Step Info

  3. (Optional) Add or change the [Inclusive] or [Exclusive] setting at the top of the file if desired. This setting controls whether items not listed in the order.txt file but present in the Profile Manager is listed on the menu. The options include:

    • [Inclusive]: This is the default setting. This setting results in menu items that are not specified in the order.txtfile being listed at the bottom of the menu in alphabetical order. For example, if the Profile Manager contained a Profile item in addition the those listed in the order.txt above, Profile would display below Data.

    • [Exclusive]: This setting results in menu items that are not specified in the order.txt file being excluded from the menu. For example, if the Profile Manager contained a Profile item in addition the those listed in the order.txt above, Profile would not be displayed anywhere on the menu.

    • blank: If neither [Inclusive] or [Exclusive] appears at the top of the file, Data Workbench displays the menu items as if the setting were [Inclusive].

  4. Complete one or more of the following steps:

    To perform this task... Do the following...

    Reorder menu items

    Type the item names in the order that you want them to appear in Data Workbench.

    For example, as long as each menu item name matches its corresponding file or folder name, the following would result in Add Table appearing first, then Add Visualization, Add Legend, and Add Note appearing last.

    Add Table

    Add Visualization

    Add Legend

    Add Note

    Rename a menu item

    Rename the corresponding file or folder in the Profile Manager, then change the name of the item in the order.txt file.

    For example, to rename Add Annotation to New Annotation, rename the Add Annotation folder in the Profile Manager to New Annotation, then change the name of the Add Annotation item in the order.txt file to New Annotation.

    Hide a menu item

    To hide the menu item but not delete the item itself, type a minus sign (-) at the beginning of its name.

    For example, the following results in Add Annotation not appearing in the menu.

    Add Legend

    -Add Annotation

    To again show the hidden menu item, simply remove the minus sign (-) or use the Unhide All parameter in the Insight.cfg file, see Insight Configuration Parameters.

    You can also hide menu items using the following methods:

    • The Show parameter in a .filter, .metric, or .dim file hides filters, derived metrics and dimensions, and extended dimensions from their respective menus. When using this option, the item is not listed in the menu, but it is still in the profile and available to be used.

      To use this parameter to hide filters and derived metrics and dimensions, add the following line to the end of the .metric, .dim, or .filter file:

      show = bool: false

      To use this parameter to hide extended dimensions, see Chapter 10 of the Dataset Configuration Guide for instructions.

      You can temporarily unhide items hidden using this method by setting the Unhide All parameter in the Insight.cfg file. For more information about this parameter, see Insight Configuration Parameters.

    • The Hidden parameter in the Transformation.cfg file or any dataset include file hides extended dimensions from the dimension menu. When using this option, the item is not listed in the menu, but it is still in the profile and available to be used.

      Note: When hiding extended dimensions using this method, you must retransform your dataset for the dimensions to be hidden.

      You can temporarily unhide items hidden using this method by setting the Unhide All parameter in the Insight.cfg file. For more information about this parameter, see Insight Configuration Parameters.

    • Zero-byte files hide any type of item on any menu. When using this option, an empty (zero-byte) file hides the presence of a file with the same name that contains data. Data Workbench treats zero-byte files as if they do not exist. For more information, see Hiding Files Using Empty (Zero-byte) Files.

    Delete a menu item

    If this file is set to use the [Exclusive] option, you can simply delete the menu item from this file. The item itself is still in the profile, but it is not listed in the menu.

    If this file is set to use the [Inclusive] option, you must remove the menu item name from this file and either delete or zero-byte the corresponding file to remove the item from the menu.

    For information about deleting files, see Deleting Files from Your Working Profile. For information about zero-byte files, see Hiding Files Using Empty (Zero-byte) Files.

    Add a group header

    Type three hyphens before and after the heading text that you want to appear.

    For example, the following would result in a Manage group header for a set of related menu items.

    ---Manage---

    Profile

    Dataset

    Add a line to separate sections of a menu

    Type three hyphens where you want a line to appear.

    For example, the following results in a line separating Add Annotation and Add Custom.

    Add Annotation

    ---

    Add Custom

  5. Save and close the file.

  6. (Optional) To make the changes available to all users of the working profile, right-click the white check mark for the order.txt file in the User column and click Save to > * working profile name.

On this page