iConsole Search Definition Reference Guide › Reference Information › Content Searches <parameter>

Content Searches <parameter>

These parameter names are available for defining content searches. They define input fields that can be used as content search parameters. You must not rename these parameters!

The supported attributes are as follows:

lstMachine

Specifies the content proxy server. This can be a drop-down list or a hidden text input box set to a predefined content proxy.

Whatever the parameter type, its name must be lstMachine.

Required: No

txtSearchTerm

A text input box for specifying the search text, that is, the key words or phrases to look for in an e-mail or attachment.

Required: No

chkEE

A check box for choosing whether to search for e-mail events.

Required: No

lstEE

Specifies a drop-down list for choosing the scope of an e-mail search. The supported options (that is, list items) are:

1 Return internal and external events

2 Return only internal events

3 Return only external events

Required: No

txtEEAddress1

A text input box for specifying the From: address.

Required: No

lstEEDir

Specifies a drop-down list for choosing the e-mail direction. The supported options (that is, list items) are:

1 Return incoming and outgoing events

2 Return only incoming events

3 Return only outgoing events

Required: No

txtEEAddress2

A text input box for specifying the To: address.

Required: No

chkIME

A check box for choosing whether to search for IM events.

Required: No

lstIME

Specifies a drop-down list for choosing the scope of a search for IM events. The supported options (that is, list items) are:

1 Return internal and external events

2 Return only internal events

3 Return only external events

Required: No

chkFE

A check box for choosing whether to search for File events.

Required: No

chkME

A check box for choosing whether to search for 'My events' only. When selected, this retrieves events associated with the current user, that is, the account they currently logged on to the CMS with.

Required: No

txtNameMatch

A text input box for specifying the name, or name fragment, of a CA DataMinder user. The search returns events associated with this user.

Required: No

txtSpecificMatch

A field for specifying the name, or list of names separated by semicolons, of CA DataMinder users. This parameter typically uses a lookup_function to allow the reviewer to browse the user hierarchy and choose specific users. The search returns events associated with these users.

Required: No

txtUserIDs

A field for specifying a list of user IDs separated by semicolons or CRLF. This will usually be populated using the lookupbyid parameter type and PopupWithHiddenField lookup_function.

Required: No

txtGroupIDs

A field for specifying a list of group IDs separated by semicolons or CRLF. This will usually be populated using the lookupbyid parameter type and PopupWithHiddenField lookup_function.

Required: No

chkIncSubGrps

A check box to indicate that the search is to also include events from groups that are descendants of the specified groups.

Required: No

dateRange

A date field for specifying the search period.

Required: No

numConfidence

A numeric input field for specifying the confidence level (as a percentage) for the search results.

This is an estimate of how relevant a document is to the main search 'theme'. Documents that meet the search criteria but which do not have a high enough confidence level are excluded from the results.

Required: No

numRowLimit

A numeric input field for specifying the maximum number of results that the search can return.

Required: No

txtSimilar

This input field is normally hidden. It is populated automatically with document IDs when the user runs the 'More Like This' search from the Search Results screen.

Required: No

numSampling

Specifies the result sampling rate. The value is the sampling percentage but this will only give accurate results in a content search when the reciprocal is a whole number e.g. 1/20% = 5 so 1 in 5 results will be returned, however 1/15% = 6.667 and 1 in 6 will be returned.

Recommended options are:

100 Return all results

20 Return 1 in 5 results (20%)

10 Return 1 in 10 results (10%)

5 Return 1 in 20 results (5%)

1 Return 1 in 100 results (1%)

Required: No

choSort

Specifies a list of sorting options. The supported options (that is, list items) are:

1 Sort by Relevance

2 Sort by Descending Date

Required: No

choResultsClass

Specifies a compulsory post-processing option that enables the iConsole to interpret the search results as, for example, e-mail or IM events. The supported options are:

Email

For e-mail and IM searches.

IM

For IM searches.

Required: Yes