Configuring a Where Used/Related Page

The Where Used component defines a two-channel page. The Where Used channel lists objects that "use" the context object. For example, the Where Used page for a Feature can list Models and Products that include that feature. The Related channel lists objects that are somehow related to the context object, such as Specifications related to a Part. You can add the default Where Used/Related page as a category for an object; or you can configure a Where Used/Related page for a specific or custom application.

This task shows you how to:

Use the Default Where Used/Related Page

You can use the Where Used/Related page as defined by ENOVIA Business Process Services.

  1. Using Business Modeler, add the APPWhereUsed command to the needed object's type menu:

    1. Locate the type menu and open it for editing. For example, if adding a Where Used/Related page to a feature, use the type_Feature menu. This menu defines the items that show in the Categories menu for a Feature.
    2. Click the Items tab.
    3. Click Add.
    4. Locate the APPWhereUsed command and select it.
    5. Click Edit.

  2. Add the object type to the Where Used XML definition:

    1. Open the XML file for editing.
    2. Add a section that includes these lines:

      <type_TYPE>
           <Hierarchical_Data toolBarMenu=<"MENUNAME">
                <whereUsed relatedBy="<STRINGRESOURCEKEY>" expandRel="<SYMBOLIC RELATIONSHIP PATTERN>"
                application="<SUITEKEY>" fromTypes="<OBJECTS EXPECTED FOR HIERARCHICAL PATTERN LOOKUP>" />
           </Hierarchical_Data>
      
           <Related_Data>
                <whereUsed relatedBy="<STRINGRESOURCEKEY>" select="<OBJECT SELECT>"
                application="SUITEKEY" />
           </Related_Data>
      </type_TYPE>  
      
      where:

      TYPE is the object type that will include a Where Used/Related category.

      MENUNAME is the name of the toolbar

      STRINGRESOURCEKEY.

      SYMBOLIC RELATIONSHIP PATTERN is the symbolic name or the relationship used for evaluation.

      SUITEKEY is the ENOVIA product.

      OBJECTS EXPECTED FOR HIERARCHICAL PATTERN LOOKUP is an object type that could be listed on the Where Used page, if it meets the requirements.

      OBJECT SELECT is the MQL select clause to evaluate .

      For example:
      <type_Products>
           <Hierarchical_Data toolBarMenu="PLCChangeMenu">
                <whereUsed relatedBy="emxWhereUsed.RelatedBy.ManagedUnder" expandRel="relationship_Products" 
                application="ProductLine" fromTypes="type_Model" />
                <whereUsed relatedBy="emxWhereUsed.RelatedBy.UsedinLogicalStructure" expandRel="relationship_LogicalFeatures"
                application="ProductLine" fromTypes="type_Products" />
                <whereUsed relatedBy="emxWhereUsed.RelatedBy.UsedinLogicalStructure" expandRel="relationship_LogicalProducts"
                application="ProductLine" fromTypes="type_Products" />
           </Hierarchical_Data>
           <Related_Data>
                <whereUsed relatedBy="emxWhereUsed.RelatedBy.UsedinRulesAsLeftExpression" 
                select="to[Logical Features].tomid[Left Expression].from.id"application="Configuration" />
                <whereUsed relatedBy="emxWhereUsed.RelatedBy.UsedinRulesAsRightExpression"
                select="to[Logical Features].tomid[Right Expression].from.id"application="Configuration" /> 
           </Related_Data>
      </type_Products>
    3. Save the XML file.

The Where Used/Related page is available for the context object type.

Customize the Where Used/Related Page

You can configure a Where Used/Related page for an ENOVIA product or a custom application.

  1. In Business Modeler, clone the default command:

    1. Search for the APPWhereUsed command and select it.
    2. Select Object > Clone.
    3. Enter a name for the command. For example, if creating the command for a custom application that uses the DMD trigram, name the cloned command DMDWhereUsed.
    4. Click Create.

  2. In Business Modeler, edit the default settings:

    1. Locate the cloned command and open it for editing.
    2. Click the Link tab.
    3. Update the href to use any custom table, toolbar, or other configurable component. This code shows the default href for a Where Used page.

      ${COMMON_DIR}/emxIndentedTable.jsp?program=WhereUsed:getWhereUsed
      &expandProgram=WhereUsed:getWhereUsed&table=APPWhereUsed&sortColumnName=Type
      &sortDirection=ascending&toolbar=APPWhereUsedToolbar,APPWhereUsedToolbarFilter
      &expandLevelFilter=false&relationshipFilter=true&appendColumns=
      &header=emxWhereUsed.Heading.WhereUsed&selection=multiple
      &HelpMarker=emxhelpwhereusedlist
      

    4. Change any other settings as needed for the customized page.
    5. Click Edit.

  3. Add the cloned command to the needed menu the same way as described in step 1 in Use the Default Where Used/Related Page.

  4. Update the XML definition for the object type as described in step 2 in Use the Default Where Used/Related Page.