Indexed-Search
The Indexed-Search webject queries the indexing engine for the indexed content of Windchill objects (if index search is installed).
It accepts a keyword string as input and returns XML-formatted results. It includes the UFID (obid), the object class, and a teaser for every associated content item for that object. It can also include one or more spelling suggestions.
Syntax
<ie:webject name="Indexed-Search" type="OBJ">
<ie:param name="ACCEPT_LANGUAGE"
data="$(@SERVER[]accept_language[])"/>
<ie:param name="AND_OR_OPERATOR" data="[SIMPLEANY | SIMPLEALL]"/>
<ie:param name="ATTRIBUTE_TYPE_CONTEXT" data="attributes"/>
<ie:param name="AUTHORIZATION"
data="$(@SERVER[]authorization[0])"/>
<ie:param name="CONNECTION_ATTEMPTS" data="attempts"/>
<ie:param name="CONNECTION_ATTEMPT_INTERVAL" data="interval"/>
<ie:param name="CONTAINER_REF" data="ufid"/>
<ie:param name="FETCH_FIELDS" data="fields"/>
<ie:param name="FILTER_ACCESS" data="[TRUE | FALSE]"/>
<ie:param name="GROUP_OUT" data="group_out"/>
<ie:param name="INSTANCE" data="appl_name"/>
<ie:param name="KEYWORD" data="keyword"/>
<ie:param name="LIBRARIES" data="libraries"/>
<ie:param name="MAX_DOCS" data="number"/>
<ie:param name="QUERY_TYPE" data="query"/>
<ie:param name="SEARCH_TIME" data="time"/>
<ie:param name="SESSION_ID" data="$(session[]session_id[])"/>
<ie:param name="SPELL_CHECK" data="[TRUE | FALSE]"/>
<ie:param name="SORTBY" data="attribute"/>
<ie:param name="SORTED" data="[ASC | DESC]"/>
<ie:param name="TYPE" data="type_name"/>
<ie:param name="TYPE_CONTAINER" data="context"/>
<ie:param name="UNFORMATTED" data="javaClass"/>
<ie:param name="WHERE" data="where_clause"/>
</ie:webject>
Parameters
|
Required
|
Interdependent
|
Optional
|
|
AND_OR_OPERATOR
|
AUTHORIZATION
|
ACCEPT_LANGUAGE
|
|
INSTANCE
|
ATTRIBUTE_TYPE_ CONTEXT
|
CONNECTION_ATTEMPTS
|
|
KEYWORD
|
CONNECTION_ATTEMPT_INTERVAL
|
|
LIBRARIES
|
CONTAINER_REF
|
|
TYPE_CONTAINER
|
FETCH_FIELDS
|
|
|
FILTER_ACCESS
|
|
|
GROUP_OUT
|
|
|
MAX_DOCS
|
|
|
QUERY_TYPE
|
|
|
SEARCH_TIME
|
|
|
SPELL_CHECK
|
|
|
SORTED
|
|
|
SORTBY
|
|
|
TYPE
|
|
|
UNFORMATTED
|
|
|
WHERE
|
|
|
If a parameter is listed in the table but is not defined below, then it has a common parameter definition. For descriptions of those parameters, see the Common Webject Parameters section in Adapter Webjects Overview. |
AND_OR_OPERATOR
Determines if the InStream query uses SIMPLEANY (OR) or SIMPLEALL (AND). This parameter is required.
ATTRIBUTE_TYPE_CONTEXT
When multiple types are supplied, then this parameter specifies which type should be used as a context in which to look up attribute definitions.
CONTAINER_REF
Filters the search results to those objects within the context reference. This parameter is optional.
FETCH_FIELDS
Specifies a set of fields that are stored in indexed search to be retrieved as part of the query.
PersistInfoOID is requested by default. This field is used by Search-Objects to retrieve the results from the Indexed-Search webject results. This parameter is optional.
FILTER_ACCESS
When set to TRUE, the indexing engine filters the results to a 'Potential' read list. This parameter is optional.
GROUP_OUT
The name of the output group containing the results. If this parameter is omitted, then the name of the output group is constructed by appending the string “-Output” to the webject name. This parameter is optional.
KEYWORD
A query expression identifying the keyword string to be queried for in the indexed search.
LIBRARIES
The set of indexed search libraries (indexes) to perform the search against.
MAX_DOCS
The maximum number of documents to return during the search. This parameter is optional.
QUERY_TYPE
Determines if the search uses advanced or simple search capabilities. This parameter is optional.
SEARCH_TIME
Amount of time, in seconds, that the index engine should perform a search before timing out. This parameter is optional.
SPELL_CHECK
If set to TRUE, then the indexing engine attempts to validate spelling and suggest possible query terms. This parameter is optional.
SORTBY
Specifies a set of attributes whose sorting orders are specified by the SORTED parameter to be sorted by and returned by the query.
Multiple values can be specified for this parameter. If multiple values are specified, then the first value is the primary sort attribute, the second value is the secondary sort attribute, and so on.
When multiple values are involved, if the list of SORTED parameters is shorter than the list of SORTBY parameters, then the last SORTED is used for the difference.
For example:
SORTBY=a SORTED=ASC
SORTBY=b SORTED=DESC
SORTBY=c
SORTBY=d
Both c and d would use descending order. If you do not specify SORTED, then all SORTBY values use ascending as it is the default value. This parameter is optional.
SORTED
Specifies whether the current attribute to sort by should be sorted as descending (DESC) or ascending (ASC). Multiple values can be specified for this parameter. The default value is ASC. This parameter is optional.
SORTED only produces sorted output if the SORTBY parameter is specified.
TYPE
The set of Windchill object types to constrain the search against. For example, wt.part.WTPart or wt.doc.WTDocument.
TYPE_CONTAINER
Determines the set of base types to be used in the search from the incoming TYPE parameter.
WHERE
If specified, the indexing tool attempts to filter results based on the where clause.
