QueryContext Configuration

This section configures the search queries available for retrieving objects from OpenPDM. These queries are used in the UI to find and display Item Revision Business Objects (BOs) and their associated metadata.

Key Concepts

  • Only ItemRevision BOs and their children are supported.
  • All configuration values must align with the definitions in resourceBundle.properties.
  • Ensures user-friendly dropdowns and precise filtering for OpenPDM-integrated workflows.

Query Definition

Each <Query> must define the object type and display logic for search filtering.

Attributes:
type
The OpenPDM Business Object type (must be valid in your source system).
typeKey
A key linked to resourceBundle.properties for localized display. Do not modify.
keyword
A unique internal identifier for the query. Must be distinct across all queries.
displayName
The name shown in the query drop-down in the UI. Must be unique.
Search criteria:
  • Each <Value> defines a field that users can search by.
  • Keys must match entries in resourceBundle.properties.
Example:
<QueryContext>
  <Query type="ItemRevision"  typeKey="openpdm.query.Type" keyword="OpenPdmItemRevision" displayName="PDM CAD Revisions">
    <SearchCriteria>
      	<Value>openpdm.query.Id</Value>
    </SearchCriteria>
  </Query>
</QueryContext>

QueryAttributeWhitelist

The QueryAttributeWhitelist element controls which attributes are pulled from OpenPDM during the search.
  • Format: comma-separated list of attribute names (for example, Name, Description, PartNumber).
  • If left empty or undefined, no attributes will be fetched from OpenPDM.
Current configuration: <QueryAttributeWhitelist/>.