Windchill Search Properties
Unless otherwise specified, use wt.properties.xconf to set custom property values.
Database and Indexed Search Properties
The following properties apply to both indexed searches and database searches.
com.ptc.windchill.enterpise.search.advancesearch.enableEmptySearch
|
Default
|
false
|
|
Synopsis
|
Controls whether empty and single wildcard queries can be executed.
|
|
Description
|
When enabled, this property allows you to execute empty or single wild card (“*” or “?”) keyword queries, as long as you include at least one of the following constraints:
• Select only one object type
• Select only one context or folder
• Provide a value for at least one attribute field under Criteria
|
com.ptc.windchill.enterprise.search.displayUnSelectableValue
|
Default
|
true
|
|
Description
|
Determines whether global enumeration entries that are no longer selectable from the Type and Attribute Management utility are available when performing an advanced search.
When set to true, these global enumeration entries are available to use as the advanced search criteria.
When set to false, these global enumeration entries cannot be used in an advanced search.
|
com.ptc.windchill.search.criteriaDisplayLength
|
Default
|
65
|
|
Synopsis
|
Limit the length of search history summaries.
|
|
Description
|
Use this property to control how many characters are used to identify each search in the search history. This property applies to the Search History URL strings that appear in the Search History and Saved Searches tab.
The string length is the number of 16-bit Unicode characters in the string, including spaces. Closing ellipses are not included in the string length count.
For example:
• Set to 65:
Keyword=01*; End Item=Yes; Sourcing Status=Approved; Type=CAD Doc…
• Set to 40:
Keyword=01*; End Item=Yes; Sourcing Stat…
• Set to 20:
Keyword=01*; End Ite…
|
com.ptc.windchill.search.futureDateAttributes
|
Default
|
thePersistInfo.createStamp, thePersistInfo.modifyStamp
|
|
Synopsis
|
Define attributes for which a future date is invalid.
|
|
Description
|
Use this property to provide a comma-separated list of date attributes for which future dates are invalid.
As a result, when the attribute is added to the search criteria, Tomorrow is hidden in the drop-down value list.
|
|
Modelled and soft attributes are supported. Use the internal name of the attribute when supplying the property value.
|
|
com.ptc.windchill.search.latestRevisionQueryLimit
|
Default
|
<not set>
|
|
Synopsis
|
Query limit for a latest revision search.
|
|
Description
|
This property allows users to set the query limit specific to latest revision search. If this property is not set, then the query limit uses the wt.pom.paging.snapshotQueryLimit property value.
|
com.ptc.windchill.search.queryBuilder.enableNullCriteria
|
Default
|
false
|
|
Synopsis
|
Allow searches to return results for null values.
|
|
Description
|
When set to true, you can search for blank values in attribute criteria. This applies to String, Real Number, and Real Number with Units attributes.
To support this, the is null and is not null operators appear as options when specifying search criteria from the Advanced Search page: | These operators are not valid when performing a classification search or an indexed search. Instead, an error message appears. |
|
com.ptc.windchill.search.relationQueryLimit
|
Default
|
<not set>
|
|
Synopsis
|
Defines the limit for the number of objects processed when searching on object relationships.
|
|
Description
|
This property limits the number of objects processed when performing a relationship search. If this property is not set, then the relationship search processes all objects.
This property does not apply when performing an indexed keyword search or a latest version search.
|
com.ptc.windchill.search.TypesForLatestVersion
|
Default
|
<not set>
|
|
Synopsis
|
A list of object types for which search results are limited to only the latest revision.
|
|
Description
|
This property is typically used to specify change object types.
By default, change object types cannot have multiple revisions. This behavior is set using the Change Modification Tracking preference in the Preference Management utility. The default value is No. If you set this preference to Yes, then users can revise change objects.
If the preference is set to Yes, then you should also consider setting the com.ptc.windchill.search.TypesForLatestVersion property. For example:
com.ptc.windchill.search.TypesForLatestVersion =
wt.change2.WTChangeIssue, wt.change2.WTChangeProposal,
wt.change2.WTChangeRequest2, wt.change2.WTVariance
|
|
This property is only effective if the user has limited their search to the object types defined in the property value. However, if multiple object types are included in the search (for example, a search that includes change objects and parts), then the search displays all revisions.
|
|
Windchill Index Search Properties
The following properties govern the use of indexing and index searches, and must be set appropriately for Windchill Index Search to work properly.
com.ptc.windchill.search.facet.enum.maxItemsToDisplay
|
Default
|
5
|
|
Synopsis
|
Maximum number of results to display under a result facet attribute group.
|
|
Description
|
If the result set includes multiple values for an attribute, the possible values are grouped under the attribute name. If there are a large number of values to display, the Show All link is displayed: Use this property to define how many values to display before providing the Show All link. |
com.ptc.windchill.search.facet.maxResultCountForAccessCheck
|
Default
|
500
|
|
Synopsis
|
Maximum number of faceted results to check against access control.
|
|
Description
|
This property specifies the maximum number of Solr results to check against access control rules before rendering the search result facets. For more information, see Faceted Search Results. If the result count is less than the specified limit, then facets are generated with only accessible facet attribute values. If the result count is greater than the specified limit, then facets are generated without checking against access control rules.
The maximum limit should not exceed the maxBooleanClauses property specified in solrconfig.xml.
|
wt.index.BulkIndexContentQueueList
|
Synopsis
|
Establishes indexing queues specifically for content holder objects.
|
|
Description
|
Specifies a list of indexing queues for content holder objects. Use this property with wt.index.BulkIndexQueueList to improve bulk indexing performance. For more information, see Bulk Index Tool. In a typical environment, you can set the value at a 2:1 ratio to the value of the wt.index.BulkIndexQueueList property. For example:
wt.index.BulkIndexQueueList=BulkIndexQueue1,
BulkIndexQueue2
wt.index.BulkIndexContentQueueList=
BulkIndexContentQueue1,BulkIndexContentQueue2,
BulkIndexContentQueue3,BulkIndexContentQueue4
However, you can customize this ratio depending on the difference between how many content holder objects are in your system when compared to non-content holder objects.
|
wt.index.BulkIndexQueueList
|
Default
|
BulkIndexQueue1,BulkIndexQueue2
|
|
Description
|
The list of indexing queues used by the bulk index tool.
|
wt.index.bulkIndexSize
|
Default
|
200
|
|
Description
|
The number of objects to index at one time during a bulk index operation.
|
wt.index.checkDocumentTypes
|
Default
|
true
|
|
Synopsis
|
Enable (true) or disable (false) functionality to exclude file types from indexing.
|
|
Description
|
Determines whether file types whose extensions are set in the wt.index.filterFileTypes property are excluded from being indexed for searching. If set to true, these file types are excluded.
|
|
Once this property is modified, you must re-index all data to remove already indexed files from the index server.
|
|
wt.index.checkIndexingRulesBeforeQueue
|
Default
|
false
|
|
Synopsis
|
Enable (true) or disable (false) checking objects for an indexing rule before adding the object to the indexing queue.
|
|
Description
|
If this property is enabled, objects are filtered from the queue based on indexing rules. If it is disabled, objects that are not indexable are filtered at indexing time.
|
wt.index.defaultQueueInterval
|
Default
|
60
|
|
Description
|
Initial sleep or time-out interval, in seconds, for the index queue polling thread.
|
wt.index.indexSearchableAttributes
|
Default
|
false
|
|
Description
|
The SearchableAttributesByType.properties file determines which attributes appear in the Criteria menu when performing an advanced search. You can use this property to limit indexing to the attribute configured in this file.
• false—Index all eligible attribute values.
• true—Limit attribute indexing to the attributes configured in SearchableAttributesByType.properties.
|
|
If you change this property value, you must re-index your search libraries.
|
|
wt.index.enabled
|
Default
|
true
|
|
Description
|
Enables (true) or disables (false) Windchill Index Search.
|
wt.index.enableIndexSearchHighAvailability
|
Default
|
false
|
|
Synopsis
|
Enables index search high availability (cloud mode).
|
|
Description
|
Enable or disable index search high availability.
• Set this value to false when Solr is installed in standalone mode. Windchill will attempt to contact the Solr host provided in the wt.index.solrHost value.
• Set this value to true when Solr is installed in cloud mode. Windchill will attempt to contact the hosts provided in the wt.index.zookeeperHosts value.
|
wt.index.enableSearchingUsingEnumDisplayName
|
Default
|
false
|
|
Description
|
When set to true, users can search against the display name of enumerated list entries.
|
wt.index.enableTextPreview
|
Default
|
false
|
|
Synopsis
|
Enables the keyword in context tool.
|
|
Description
|
This property determines whether the keyword in context functionality is available to users. When set to true, the Text Preview column is available to users when creating custom table views from the Search Results table. The Text Preview column includes a document preview tool  . Hover over the tool icon to view a preview where the keyword appears in file content. After enabling this preference, you must re-index the data before the preview tool can be used. | Use the wt.index.supportedTypesForTextPreview to configure additional content holder object types. |
|
wt.index.enableXMLTagSearch
|
Default
|
false
|
|
Synopsis
|
Determine how XML documents are indexed, and enables or disable XML tag searches.
|
|
Description
|
By default, XML documents are indexed. However, you can determine how much data from an XML document is indexed.
• false—Only index the XML document content (values between XML tags). Users can search for XML documents using keyword searches against the document content.
• true—Index all XML content, including the XML tags and tag attributes. Users can perform specialized xml: searches that limit keyword searches to XML documents. These searches can be performed against the document content, XML tags, XML attributes, and attribute values. For more information, see XML Document Searches.
|
|
If you enable XML tag searches, you must re-index previously indexed XML documents in order to include them in search results.
|
|
wt.index.excludeAttributes
|
Default
|
xml,organization,url,entrySet,templateObject
|
|
Synopsis
|
Object attribute to be excluded from indexing.
|
|
Description
|
Additional object attributes can be added to this property to exclude them from indexing.
|
|
Removing the default attributes from this property might cause indexing to fail.
|
|
wt.index.federatedLibraries
|
Default
|
wblib
|
|
Synopsis
|
The Solr core to which objects are indexed.
|
|
Description
|
If additional cores (or collections) are added to Solr for indexing of Windchill objects, they should be indicated using a comma-separated list.
|
wt.index.filterFileTypes
|
Default
|
XLSB,xlsb
|
|
Synopsis
|
The list of file extensions for files that should not be indexed for searches.
|
|
Description
|
File types whose content should not be indexed by Solr. The associated Windchill object is still indexed. Enter the file extensions separated by a comma and do not include a period (.).
|
|
Execute windchill wt.content.DataFormatUtil -list from a Windchill shell to see valid file extensions.
|
|
|
The wt.index.checkDocumentTypes property must be set to true for this property to take effect.
|
|
wt.index.generateContentIndexingFailureLogs
|
Default
|
true
|
|
Description
|
Enables or disables log generation for objects whose content indexing has failed.
|
wt.index.indexingLanguage
|
Default
|
<not set>
|
|
Synopsis
|
The language used to index and search Windchill objects and content.
|
|
Description
|
The default indexing language:
• <not set>—If wt.index.indexingLanguageList has only one value, then that value is used. Otherwise, the language is set to the same language as the method server.
• local—Uses the same language as the method server.
• Two-character ISO639 language code—A list of supported language codes is available in the properties.html file.
|
wt.index.indexingLanguageList
|
Default
|
<not set>
|
|
Synopsis
|
The list of languages used to index and search Windchill objects and content.
|
|
Description
|
This is a comma-separated list of two-character ISO639 language codes. The default indexing language is added to this list if it is not already present.
The corresponding keywords_xx field should be present in the Solr schema.xml file. If the detected language is not present in the property value list, then that content is indexed as default indexing language content.
|
wt.index.indexWorkingCopy
|
Default
|
true
|
|
Synopsis
|
Enable or disable indexing of checked out objects.
|
|
Description
|
If this property is set to true, checked-out object data is indexed. When the object is checked in, the object is re-indexed with the new version. If the check-out is undone, the checked-out index data is removed.
|
wt.index.solrAdminUser
|
Default
|
<not set>
|
|
Description
|
Username to access Solr.
|
|
This property is set in the following file:
<Windchill>/codebase/WEB-INF/conf/index.solrAuth.properties
|
|
wt.index.solrAdminPassword
|
Default
|
<not set>
|
|
Description
|
Password to access Solr.
|
|
This property is set in the following file:
<Windchill>/codebase/WEB-INF/conf/index.solrAuth.properties
|
|
wt.index.solrHost
|
Default
|
<not set>
|
|
Synopsis
|
Hostname Windchill uses to contact Solr.
|
|
Description
|
The server hostname that Windchill should use to contact Solr when Solr is installed in standalone mode.
If Solr is installed in cloud mode, then this property can be left empty.
If this property and wt.index.zookeeperHosts are both empty, this implies that Solr is not installed.
|
wt.index.solrPort
|
Default
|
<not set>
|
|
Description
|
The TCP/IP port on which Solr listens for direct server-to-server HTTP requests from Windchill.
|
wt.index.solrProtocol
|
Default
|
http
|
|
Description
|
The TCP protocol that Windchill uses to contact the Solr host when Solr is installed in standalone mode.
|
wt.index.zookeeperHosts
|
Default
|
<not set>
|
|
Synopsis
|
A comma-separated list of zookeeper hosts and ports. This property only applies when Solr is installed in cloud mode.
|
|
Description
|
Use the following format to specify Zookeeper nodes:
<zookeeper_host1>:</zookeeper_port1>,<zookeeper_host2>:</zookeeper_port2>
|
wt.indexsearch.maxResults
|
Default
|
5000
|
|
Description
|
Set a query limit for index search results for performance-intensive queries such as a latest version search or a scoped search.
|
|
This property is set in the search.properties file.
|
|
wt.index.solr.httpTimeoutSeconds
|
Default
|
600
|
|
Synopsis
|
The number of seconds before an internal HTTP SOLR request times out.
|
|
Description
|
The HTTP socket timeout for SOLR indexing and search requests. Specifying a smaller value might result in failure during indexing and timeout errors during search.
|
wt.index.supportedTypesForTextPreview
|
Default
|
wt.doc.WTDocument
|
|
Synopsis
|
Content holder object types that support the keyword in context tool.
|
|
Description
|
Specify any additional objects types for which the keyword in context tool is enabled.
When the wt.index.enableTextPreview property is set to true, the Text Preview column is available to users when creating custom table views from the Search Results table.
|
