Adding a Preference Page

This procedure lists the main steps for adding a Preference page and adding a new preference category to place the new page under, if needed. The graphics in the procedure illustrate the steps needed to create a Preference called Default Templates for the Custom Central application.

  1. Launch Business Modeler.

  2. To create the command for the new preference, follow these steps:

    1. Click Object > New > Command.
    2. Fill in the parameters (on the Basic tab) and settings (on the Settings tab) for the command as defined in the table.



      Parameter/Setting Description Accepted Values/Examples

      Label

      The text displayed on the link for the preference. The link appears under the category name to which the command is assigned.

      Either a string resource ID for the text string or the actual text string that should appear. To internationalize the text, you must use a string resource ID. See Internationalizing Dynamic UI Components.

      The system first looks for a string resource ID that matches the entered value. If it finds one, it uses the value for the ID. If it doesn't find one, it displays the entered text.

      Home Page

      Date/Time Formal

      emxFramework.Preferences.Conversions

      Name

      Name of preference.

      Home Page

      Default Language

      href

      The URL executed when the link for the preference is clicked. This URL is displayed in the right frame of the Preferences page.

      The value for the href parameter should be a JavaScript function or JSP and any associated parameters. You can specify the path of the JSP using any of the standard directory macros or you can leave off the path designation to use the registered directory. For more information, see Macros and Expressions in UI Components.

      ${COMMON_DIR}/emxPrefConversions.jsp

      ${SUITE_DIR}/emxENCPrefVault.jsp

      Access The persons, roles and groups who can access the preference. To make the link available to all users, regardless of role/group assignments, choose All.

      Names of group, role, person administrative objects.

      or

      All (default)

      Setting: Image Icon displayed in the Preference window. COMMON_DIR/buttonToolbarPreferences.gif
      Setting: Registered Suite The name of a suite that registered this command

      Framework

      TeamCentral

    3. Click Create.

  3. To create a new category for the preference, follow these steps.

    If the preference fits under an existing category (such as Engineering Central or another ENOVIA product), skip this step.

    1. Click Object > New > Menu.
    2. Fill in the parameters (on the Basic tab) and settings (on the Settings tab) for the Menu as defined in the table.

      Parameter/Setting Description Accepted Values/Examples

      Label

      The text for the category on the Preferences page.

      Either a string resource ID for the text string or the actual text string that should appear. To internationalize the text, you must use a string resource ID. See Internationalizing Dynamic UI Components.

      The system first looks for a string resource ID that matches the entered value. If it finds one, it uses the value for the ID. If it doesn't find one, it displays the entered text.

      Engineering Central

      Custom Central

      Name

      Name of category.

      Engineering Central

      Custom Central

      Setting: Registered Suite

      The name of a suite that registered this command

      Framework

      TeamCentral

    3. Click Create.

  4. To add the new command to a menu, follow these steps: Assign the command you created in Step 1 to the appropriate category menu object. This is the menu object you created in Step 2 or an existing menu object.

    1. Locate the needed menu, either the one you just created or an existing menu where you want to add the command for the new preference, and open it for editing.
    2. Click the Items tab and add the menu object you just created.
    3. Click Edit to save the menu.

  5. If you created a new menu, follow these steps to add it to the Preference menu:

    If you added the command to an existing menu, that menu should already be included in the Preference menu and you can skip this step.

    1. Open the Preferences menu object for editing.
    2. On the Items tab, add the menu you created above.
    3. Click Edit to save the Preferences menu.

    The Preferences menu should show the new menu and/or command.



The preference is added to the list of preferences as shown in the image.



In this example, Custom Central Preferences is the new category (menu) for the Preferences page, and Default Templates is the new command.