Customizing the Where Used Page

You can customize the objects to be displayed in the Where Used page (which is common for all of the commands).

Objects are configured by assigning the values to the following settings in each where used command:

  • ExpandFilterRelationships: Relationship on which the expand occurs.
  • ExpandFilterTypes: Types on which the expand occurs.
  • IntermediateFilterTypes: Intermediate types whose objects are to be hidden from the user.

The value for the each of these settings can be one of the following:

  • A comma-separated string of symbolic names
  • Properties file key

By default, the where used functionality is configured by adding a separate UI3 command for each of the following object type menus:

  • type_Builds
  • type_Features
  • type_Products
  • type_Specification
  • type_TestCase
  • type_UseCase

  1. Create or open the text file for customized properties. For more information, see Editing Properties Using MQL.
  2. Add the following keys for each type of object to which you want to add where used functionality:

    KeyDescriptionValue
    emxProduct.WhereUsed.<type of the object>.ExpandTypesObject types on which the where used program expands the context object.

    A comma separated string of the symbolic type names: type_type1,type_type2 type_type3,...

    emxProduct.WhereUsed.<type of the object>.ExpandRelationships.Relationships which the where used program traverses to get the parent objects connected to the context object.

    A comma separated string of the symbolic names of the relationships: relationship_relationship1, relationship _ relationship2...

    emxProduct.WhereUsed.IntermediateTypesIntermediate types objects which are not to be displayed to the users.

    A comma separated string of the symbolic names of the intermediate types: type_IntermediateType1,type_IntermediateType2...

  3. If the where used query of the object involves some intermediate objects, update the emxProduct.WhereUsed.IntermediateTypes setting to include the symbolic names of all of the intermediate types.
  4. When you are finished updating the text file with all properties that you want to modify, use the text file to modify the emxProductLine.properties page object. For more information, see Editing Properties Using MQL.
  5. To create a command to display an object's where used information and set its page link (HREF), run the following MQL command:

    add command <Command Name> description <STRING VLAUE> label <VALUE> href "${COMMON_DIR}/emxTable.jsp?program=emxPLCCommon:getWhereUsed&FilterFramePage=${SUITE_DIR}/emxProductWhereUsedTableFilterInclude.jsp&FilterFrameSize=55&table=PLCWhereUsedList&header=emxProduct.Heading.WhereUsedGeneric&selection=multiple&topActionbar=PLCWhereUsedListTopActionBar&HelpMarker=emxhelpwhereusedlist&command=command_commandName";
    where:
    • <Command Name> is the name of the command that you want to create.
    • command_commandName is the symbolic name of the command that you want to create.

  6. Open the Run MQL window:
    1. From the compass, select Collaboration and Approvals.
    2. In the navigation pane, click Utilities > Run MQL.
    To run an MQL command, enter the command in the MQL Command box and click Run or press Enter.
  7. To add the filter settings to the new command, run the following MQL commands:

    modify command <Command Name> add setting ExpandFilterRelationships <relationship_relationship1, relationship _ relationship2...>;
    modify command <Command Name> add setting ExpandFilterTypes <Type_type1, type_type2 type_type3,...>;
    modify command <Command Name> add setting IntermediateFilterTypes <type_IntermediateType1, type_IntermediateType2...>;
    where:
    • <Command Name> is the name of the command that you created.
    • <relationship_relationship1, relationship _ relationship2...> is a comma-separated string of the symbolic names of the relationships.
    • <Type_type1, type_type2 type_type3,...> is a comma-separated string of the symbolic names of the object types.
    • <type_IntermediateType1, type_IntermediateType2...> is a comma-separated string of the symbolic names of the intermediate types.
    Note: These are the values that you defined in emxProductLine.properties in Step 2.

  8. To add the newly-created command to the object type's menu, run the following MQL command:

    modify menu <Menu Name> add command <Command Name>;
    where:
    • <Menu Name> is the object type menu to which you want to add the command.
    • <Command Name> is the command that you want to add to the menu.