emxSystem.properties for Search and Advanced Search

emxFramework.Search.QueryLimit = 100 

Default = 100.

emxFramework.Search.UpperQueryLimit=1000 

Default =1000. Allowable values are 1 to 32767.

emxFramework.DefaultSearchVaults = ALL_VAULTS 

• ALL_VAULTS--all main and secondary vaults for the company to which the person belongs. This list includes both local and remote vaults.
• LOCAL_VAULTS-- all main and secondary vaults for the company to which the person belongs. This list includes only local vaults.
• DEFAULT_VAULT--default vault of the logged in person
• String of vaults [separated by commas].

See Setting Up Vaults, Companies, and Users for details about determining and implementing a vaulting strategy for your company.

The user also can set a personal preference for which vaults to search.

emxFramework.GenericSearch.Types = 
type_Part,type_DOCUMENTS,type_Issue,type_ECR,type_ECO, 
type_ProjectSpace,type_Project,type_RFQ,type_Quotation, 
type_Change,type_Library,type_Task, 

Include only top-level types, since you can drill down for the child types.

emxFramework.ContextSearch.ContainedIn.Types= type_Project,\ 

    type_DOCUMENTS,\

    type_ProjectSpace,\

    type_Libraries

emxFramework.ContextSearch.Relationships.type_Project =

    relationship_DataVaults,\ 

    relationship_VaultedObjects,\

    relationship_ReferenceDocument,\

    relationship_Issue, \

    relationship_SubVaults

emxFramework.ContextSearch.Relationships.type_ProjectSpace =

    relationship_ProjectVaults,\ 

    relationship_VaultedDocumentsRev2,\

    relationship_Issue, \

    relationship_SubVaults

emxFramework.ContextSearch.Relationships.type_Libraries =

    relationship_Subclass,\

    relationship_ClassifiedItem,\

    relationship_ReferenceDocument,\

    relationship_PartSpecification,\

    relationship_Issue

emxFramework.ContextSearch.Relationships.type_DOCUMENTS = 
relationship_Issue,\ 

relationship_DocumentSheets

emxFramework.TypeChooser.MaximumDisplayLimit=250 

emxFramework.Search.AdditionalBasicAttributes=owner,description, 
policy,originated,modified 

emxFramework.Search.OnSelect.Action = Show Content 

• Show Content. The search popup window remains open but moves behind the application window so the user can see the object details.
• Show Search.The search popup remains open and on top of the main window
• Close Window. Closes the search popup window when a user clicks an object name

emxFramework.BackgroundProcess.NumberOfThreads = <number> 

emxFramework.FullTextSearch.QueryType=Real Time

• Real time (default). The full search window uses a real time search presented in a form view.
• Indexed. The full search window uses the parametric search functions (requires installation and configuration defined in the Exalead Full Text Search Server Installation Guide).

Defines the search type for all Full Search windows, whether accessed from the Search menu on the global toolbar or from a browse button in a dialog box.

To see the difference in the search types, see Types of Searches.

emxFramework.FullTextSearch.NavigationView.ImmediateMode=true

• true (default). (Immediate mode) The user continues to pare down the search results by selecting types (or workspace or other taxonomy item) and attribute values and the search results are updated each time the user selects an attribute value.
• false. (Delayed mode) The attribute section is updated when the user selects a type or other taxonomy item, but the search results do not display until the user clicks Search.

In indexed/navigation mode, you can configure your system to either search immediately when a user enters a value for an attribute, or to delay displaying search results until the user enters multiple criteria and then clicks Search. Either way, if the user selects a type or other taxonomy item, the attribute list is still updated for that selection, but in delayed mode, the search results do not display until the user clicks the Search button.

emxFramework.Search.Range.Limit=10

Default = 10. If the numeric or date attribute contains less than 10 unique values, the values are displayed in the select box.

emxFramework.FullTextSearch.QueryLimit=100

Default = 100.

The value of this property can be overriden for an individual search page by passing the queryLimit URL parameter to the emxFullSearch.jsp.

emxFramework.FullTextSearch.MaxQueryLimit=1000

Default = 1000.

Use this property to define a maximum limit for real-time searches to prevent users from entering larger values.

emxFramework.FullTextSearch.PageSize=50

Default = 50.

Limits the number of results per page for Indexed searches when enabled by the ShowPagination property. Pagination allows users to click on a specific page, or go to the first, previous, next, or last page in the search results.

This value can be overridden for a specific page by passing the pageSize URL parameter as described in URL Parameters Passed to emxFullSearch.jsp.

emxFramework.FullTextSearch.ShowPagination=true

• true (default). The pagination controls show on the advanced search toolbar.
• false. The pagination controls are not available.

emxFramework.FullTextSearch.DidYouMean=true

• true (default). Did you mean is enabled.
• false. Did you mean is disabled.

emxFramework.FullTextSearch.FormBased=false

• true. The search is form-based.
• false (default). The search is navigation-based.

This property defines the global setting for all full-text search pages defined for all installed applications. For a specific full-text search page, this property can be overridden using the viewFormBased URL parameter. See Full-Text Search for details.

emxFramework.FullTextSearch.AllowModeSwitch=true

• treu (default). The toggle button is enabled.
• false. The toggle button is disabled.

Shows or hides a button that toggles between form-based and navigation-based modes.

emxFramework.FullTextSearch.FormView.FixedFields= \

TYPE, NAME, REVISION, \

OWNER, POLICY, CURRENT, \

ORIGINATOR, VAULT, ORIGINATED, \

TITLE, DESCRIPTION, MODIFIED

The default value is shown.

emxFramework.FullTextSearch.FormView.Indexed.FixedFields= \

TYPE, NAME, REVISION, \

OWNER, POLICY, CURRENT, \

ORIGINATOR, VAULT, ORIGINATED, \

TITLE, MODIFIED

The default value is shown.

emxFramework.FullTextSearch.FormView.RealTime.FixedFields= \

TYPE, NAME, REVISION, \

OWNER, POLICY, CURRENT, \

ORIGINATOR, VAULT, ORIGINATED, \

TITLE, MODIFIED

For a full search page, you can use the formInclusionList URL parameter to pass additional fields for displaying in the search criteria section.

emxFramework.FullTextSearch.ExplicitWildcard=false

• true. The user must explicitly enter the * to indicate a wildcard search.
• false (default). The user can leave the text box blank.

emxFramework.FullTextSearch.MinRequiredChars=3

For example (if the value is 10), a user could enter:

Project PR*

to search for any text starting with the above string. If the user enters a shorter string, a warning message displays and the search is not executed.

When using wildcards (* and ?) in a Search or non-parametric text box in the advanced search page (indexed searching), performance can be poor because of the large number of matches for a wildcard. You can require that the user enter a minimum number of characters when executing a wildcard search to reduce the number of matches.

The number of characters for search strings that do not use a wildcard is not affected by this property; this minimum does not apply to non-indexed searches.

For any specific advanced search page, you can override the default value by passing the minRequiredCharacters URL parameter with a field name to emxFullSearch.jsp. See Full-Text Search for details on emxFullSearch.jsp.

To support this functionality, all fields that previously used the * wildcard no longer accept the wildcard.

emxFramework.FullTextSearch.MinRequiredChars.AllowSearchWithViolation=
true

• true (default). If the user enters fewer than the minimum number, a warning displays but the user can click Yes to continue.
• false. If the user enters fewer than the minimum number, an error displays and the user cannot continue with that search.

Enables/disables the requirement for entering a minimum number of characters when using wildcards.

emx<SUITENAME>.FullText.CallbackInclude

emxFramework.FullTextSearch.NavigationView.IncludeFields = ORIGINATED, 
MODIFIED, NAME

If you edit the config.xml file on a running server, you must restart the server for changes to take effect.

The fields must also be configured in config.xml (field names must match exactly, including case) to set the searchindex system variable, or the search will fail. For example, if the field "Unit of Measure" is configured to appear, it must also appear with the same spelling and capitalization as a field name entry in the config.xml file: FIELD name= "Unit of Measure". A field name should appear exactly the same, not a select=attribute[Unit of Measure] entry in the config.xml file.

emxFramework.FullTextSearch.NavigationView.IncludeFieldsShownFirst = 
true

• true (default). Breadcrumb list is populated with default fields.
• false. Breadcrumb list is not populated with the default fields.

Specifies that the fields listed in the above property are shown in the breadcrumb list when the search page is initially opened.

For a specific search page, the formInclusionList URL parameter can be used to add additional fields to the attribute pane in the real-time or form-view indexed searches.

emxFramework.FullTextSearch.NoCountsThreshold= 10000

Default = 10000.

If the value is set to -1, the search always returns counts for attribute values and taxonomies.

If the value is set to 0, the search never returns counts for attribute values and taxonomies.

When the result set exceeds the specified value, the indexed search page does not show counts for attribute values or taxonomies. This property does not limit the result set, it only defines a threshold over which counts do not display if the result set is larger than that number. By not calculating the individual attribute value counts, the search results can be loaded faster.

emxFramework.FullTextsearch.ShowInitialResults=true

• true (default) When a user selects the navigation search, an initial, unfiltered result set is loaded into the page.
• false. The user must enter criteria before any results are shown on the page.

This property can be overridden on a specific page by the showInitialResults URL parameter defined in Initial Search Criteria.

emxFramework.FullTextSearch.EnableSearchButton=false

• true. Users can Search without entering specific criteria, using the criteria entered by properties and URL parameters. For a general search with few pre-defined criteria (such as limiting the Types), the search could result in a huge query.
• false (default). The Search button is disabled until the user enters search criteria.

Enables or disables the Search button during the initial load.

This property can be overridden for a specific page using the enableSearchButton URL parameter.

emxFramework.FullTextSearch.DynamicColumns.AddExactMatch=false

• true. The search results add a column for any attribute selected by the user for refinement, even if all attribute values in the results are the same.
• false (default). Dynamic columns are only added to the results table if the user inputs 2 or more values or does not use wildcard characters for refining the results.

If a user specifies an attribute value in a full-text search, the page adds that column to the result set if:

• Multiple values for an attribute
• A date range for an attribute using the On or after, On or before, and between operators
• A number (real or integer) using the <, >, and between operators

emxFramework.FullTextSearch.AddDynamicLibraryAttributes=false

• true. Attributes are added as columns to the result set.
• false (default). Classified attributes are not added as columns to the result set, even if they meet the criteria listed above.

Defines whether the dynamic columns property also applies to attributes in library classes. The library attributes must be configured in config.xml as fields.

You also need to differentiate the classified attributes from other attributes in the config.xml file. This example shows how to define a standard ENOVIA attribute (as a parametric attribute) compared to a classifed attribute:

<FIELD name="Severity" select="attribute[Severity]" 
type="STRING,PARAMETRIC"/>

<FIELD name="RESISTANCE" select="attribute[Resistance]" 
type="STRING,CLASSIFICATION"/>

This property only affects attributes for library classes; it has no effect on attributes of object types, such as Parts or Documents.

emxFramework.FullTextSearch.Libraries = LIBRARIES

• LIBRARIES (default)
• TAXONOMY

See the Exalead Full Text Search Server Installation Guide for details on defining taxonomies in the config.xml file.

emxFramework.FullTextSearch.Pagination.RememberSelection=false

• true. The system remembers the selection status of all check boxes when the user moves to a different page of the search results.
• false (default). The system does not retain the selection status of check boxes.

emxFramework.FullTextSearch.FastSortThreshold=1000

Default = 1000.

If the result count is greater than this threshold, the search application executes a fast sort. Sorting is done across all pages of the search results for fields that have both the fastsort and sortable attributes set to true in config.xml. No other columns can be sorted on.

If the threshold is below this value, only the current page is sorted, but all columns can be sorted on.

This property applies to indexed searching; it does not apply to real time searches.

This property only applies to those fields defined in the config.xml file with fastsort=true when the user clicks the header for the column listing those field values. When fastsort is used, any field not defined in config.xml with fastsort=true is not sortable in the search results table. When fastsort is enabled for a search results page, the column headings are underlined.

If the search results do not exceed the threshold defined by this property, fast sort is not enabled and the user can sort by any column, although sorting is only done on the current page.

emxFramework.FullTextSearch.RefinementSeparator=,

emxFramework.FullTextSearch.TextRefinement.SearchTermsAllowed = 20

This property defines how many search terms (a comma-separated string of terms) can be executed in a single query.

emxFramework.FullTextSearch.TextRefinement.SearchTermsLength = 10

This property defines how many characters can be used for a single search term. If you increase either of these values, performance may be degraded.

emxFramework.FullTextSearch.FieldSeparator=:

By default, the colon (:) is used. If you change the value, do not use any of these values:

• value of the emxFramework.FullTextSearch.RefinementSeparator property (these 2 properties must have different values)
• #
• !
• &
• % (any text that begins with the percent symbol, such as %3A, %3D, %2C)
• [ or ]
• {or }
• ?
• ,
• "

To override this value for a specific search page, use the fieldSeparator URL parameter. See URL Parameters Passed to emxFullSearch.jsp.

emxFramework.FullTextSearch.CaseSensitive = false

• true. The case sensitive check box is selected.
• false (default). The check box is not selected.

This property applies only when the first advanced search page is opened. If the user selects or clears the check box, that choice is saved as a preference and is used for any other advanced search page for this user.

emxFramework.FullTextSearch.LATESTREVISION = true

emxFramework.FullTextSearch.LASTREVISION = false

LATESTREVISION corresponds to the By State check box; LASTREVISION corresponds to the Highest check box. Both properties can be set to false, but do not set both properties to true (this results in an invalid configuration).

This filter includes check boxes for Highest and By State. Only one of these check boxes is selected at a time.

These properties set the default for all search pages defined by emxFullSearch.jsp. The default values can be overridden for a specific search page using the LATESTREVISON or LASTREVISION URL parameters. See Searches for details.

emxFramework.FullTextSearch.FillPages = false

• true. The fill pages feature is used and the results consolidate the list to fill the page.
• false (default). The fill pages feature is not used and the results could include empty or partially-filled pages.

This property sets the default for all search pages defined by emxFullSearch.jsp. The default values can be overridden for a specific search page using the fillPages URL parameter. See Searches for details.