URL Parameters Passed to emxFullSearch.jsp

cancelLabel

Shows a Cancel button that closes the pop-up window without any other actions. By default, the label is "Cancel".

Can be a text string or a string resource id.

emxFramework.GlobalSearch.Done = Cancel

emxFramework.GlobalSearch.Select=Close

default

For each field in the form-based view, you can pass default values. The search page uses these values to load the initial search results, and users can change these values as needed.

default=POLICY=policy_ECPart,policy_DevelopmentPart

enableSearchButton

The emxFramework.FullTextSearch. EnableSearchButton property defines globally whether the Search button is enabled prior to the user entering criteria.

This parameter overrides that property for the specific page. The default value for this parameter is the value set for this property in emxSystem.properties.

true

false

excludeOIDprogram

The JPO program:method that returns a list of Object IDs (OIDs) that should not display in the result list. This program:method provides an additional level of filtering.

JPO program:name

emxECR:getAffectediItemsAlreadyConnected

field

A colon-separated list of indices and the default/allowed values for the inital search results. See Initial Search Criteria. In the value for this parameter, colons (:) act as the AND operator and double-pipes (||) act as the OR operator.

Type=type_Part:Originator='Test Everything':Policy=policy_P1,policy_P2:LatestRevision=true

TYPES=Person:LASTNAME=*William"||FIRSTNAME=*William"||USERNAME=*William*

fieldLabels

Allows for custom fields names. The value for this parameter can be an absolute value or a string resource, and you can provide a comma-separated list of values.

fieldLabels=NAME:emxFramework.Document.Number,DESCRIPTION:Custom Description Name

fieldNameActual

Optional. The name of the field where the selected value from the search results is returned.

<string>

fieldNameDisplay

Optional. If fieldNameActual is used and the actual value and display value are different, this parameter defines the name of the field where the display value should be returned.

<string>

true

false

filterColumnPosition

Optional. Defines where dynamically-generated columns based on a user's attribute selection will be inserted in the results table.

The value must be non-negative and cannot exceed the number of columns in the resutls table. Or, you can use last to indicate that the column(s) should be inserted after the last column.

If no parameter is passed, the columns are inserted after the structure browser pane divider.

A positive integer or the reserved word last (case insensitive)

fieldSeparator

Defines the character to use to separate fields in the URL string. This parameter overrides the value set using the emxFramework.FullTextSearch.FieldSeparator property defined in emxSystem.properties.

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 }

?

,

"

^sep^

formInclusionList

Optional. Comma-separated list to limit the list of indexed attributes to display on a form-based search. This parameter does not affect navigation-based searches.

Name,Description,Policy,attribute_title

frameName

Optional. If using form-based search, this parameter provides the name of the frame that contains the form.

<string>

genericDelete

When true, shows the Delete action (AEFGenericDelete command) on the toolbar for the search page.

When false, the Delete action is not included in the toolbar.

true

false (default)

hideHeader

The header includes the search text box, and the Search and Reset buttons. For full-text search, the default is true (although for other structure browser pages the default is false).

true (default)

false

hideToolbar

Shows or hides the toolbar in the search results section of the search page. To hide the toolbar, set this parameter to true.

true

false (default)

includeOIDprogram

The JPO program:method that returns a list of Object IDs (OIDs) to search within. This program:method provides an additional level of filtering.

JPO program:name

emxECR:getAffectedIems

LASTREVISION

When true, the Highest check box for the Revision field is selected when the page opens. When false, the check box is clear.

Default value is the value for the emxFramework.FullTextSearch.LASTREVISION property in emxSystem.properties.

Passing this URL parameter overrides the default value set in emxSystem.properties.

true

false

LATESTREVISION

When true, the By State check box for the Revision field is selected when the page opens. When false, the check box is clear.

Default value is the value for the emxFramework.FullTextSearch.LATESTREVISION property in emxSystem.properties.

Passing this URL parameter overrides the default value set in emxSystem.properties.

true

false

mandatorySearchParam

A comma-separated list that defines mandatory search criteria. The user will not be able to de-select any criteria specified.

Real Time mode does not support this parameter.

Type

Originator,Policy

minRequiredChars

The listed fields will use the specified minimum number of characters for wildcard searches; any other fields on the page use the system default set using the emxFramework.FullTextSearch.MinRequiredChars property in emxSystem.properties.

minRequiredChars=TEXT=5:NAME=3:DESCRIPTION=6

pageSize

An integer defining the initial page size (number of rows) for the search results. The parameter overides the emxFramework.FullTextSearc.PageSize property.

50

500

queryLimit

For the specific full-text search page, overrides the limit defined by the emxFramework.FullTextSearch.QueryLimit property in emxSystem.properties for the maximum number of results results returned from a search

<integer value>

queryType

Default value is defined by the emxFramework.FullTextSearch.QueryType property in emxSystem.properties.

Real Time

Indexed

searchCollectionEnabled

When true, includes the Search in Collection toolbar button for navigation-based searches.

This parameter is not recommended when searching type-specific tables, or results tables that use expandJPOs or relationships.

true (default)

false

selection

Controls whether the table page adds a column of check boxes or radio buttons in the left-most column of the search results.

multiple--Default. Users can select more than one row in the table. A check box displays in the left column of each row. There are no access restriction for the check boxes.

single--Users can select one row in the table. A radio button displays in the left column of each row.

none--A selection column is not added to the table page.

showInitialResults

If true, shows an unfiltered result set when the full-text search (navigation mode) is opened. If false, the user must select initial criteria and click Search and then a result set is displayed.

This value overrides the system property emxFramework.FullTextSearch.ShowInitialResults set in emxSystem.properties.

true

false

showPageURLIcon

When true, shows in the toolbar. This tool lets users copy the URL to the specific ENOVIA application page. When false, ICON does not show in the toolbar.

The default value for this parameter is defined by the emxFramework.Toolbar.ShowPageURLIcon property in emxSystem.properties.

true

false

showSavedQuery

Includes the AEFSaveQuery command on the page toolbar.

true (default)

false

submitLabel

The label to display on the submit button. If not passed, the label shows as "Done". You can pass a static text string or a string resource value (recommended).

emxFramework.GlobalSearch.Done = Done

emxFramework.GlobalSearch.Select=Select

SubmitURL

Defines a callback URL. The JSP called when a user clicks the Submit button. For example, the page that performs post-processing when the search was initiated from an Add Existing command.

../engineeringcentral/emxFullSearchAddPartEC.jsp

table

Defines the name of the table used to display the search results. By default, the AEFGeneralSearchResults table is used.

AEFGeneralSearchResults (default)

ENCPartSearchResults

toolbar

Defines the name of a custom toolbar to display in the search results frame. Use this parameter only if you need to define a custom toolbar for context search using the consolidated search component.

string

txtExcludeOIDs

Comma-separated list of Object IDs (OIDs) to exclude from the search results.

txtTextSearch

If a value is passed using this parameter, that value is used as a search criteria for the initial load of the search page. The search criteria/results page loads with the results of this initial search, and the user can continue entering criteria as needed.

string

viewFormBased

Overrides the emxFramework.FullTextSearch.FormBased property defined in emxSystem.properties. True uses the form-based search; false uses the navigation-based search.

true

false (default)