Help > Web Development > Object Reference > Object Reference > ISYSSearch > Attribute Property
Perceptive Enterprise SearchLocal Administration ConsoleOther Products
<a name="kanchor532"></a>ISYSSearch:Attribute Property
Attributes control some advanced features available in ISYS. Set any of the attributes before executing the search to have them take effect.

Syntax
[VBScript]
 property ISYSSearch.Attribute(variant Name)
[C#]
void ISYSSearch.get_Attribute(
  System.Object Name);
void ISYSSearch.set_Attribute(
  System.Object Name, void value);
[ColdFusion/Java]
void ISYSSearch.Attribute(
  System.Object Name
) throws ComException;
void ISYSSearch.set_Attribute(
  System.Object Name, 
  void value
);
Parameters
NameName indicates which attribute you wish to set. You can either use a string version or select one of the attribute ids below.
AUTHENTICATEThat the documents in the result list are to be authenticated before being shown to the user.
CONFLATIONIndicates the conflation to use when executing the query. 0 for none; 1 for narrow; 2 for broad; 3 for plurals.
MAX_ROWSIndicates the maximum number of documents to return
META_RELEVANCEControls how relevant hits in metadata are. Ranging from 0 to 10, where 10 is most relevant.
REMOTE_ADDRStore the remote address (ip address) of the searching user. User when user tracking is enabled.
SEARCH_SCOPEIndicates the scope of the search. Set to 0 for whole document; 1 for metadata only; 2 for body only.
SEARCH_TIMEOUTIndicates the maximum time to allow a query to run (in milliseconds) before timing out.
SECURITY_SYSTEMAllows you to specify a custom security filter. Defaults to Windows Security.
SESSION_IDStores the session information of the searching user. Used when user tracking is enabled.
SITEStores the site that the query is being executed on. Used when user tracking is enabled.
SORTIndicates the sort order to use when executing the query. Same as ISYSResultList.Sort.
SYNONYMSBoolean value indicating whether synonyms shown be used during the search.
THESAURUSBoolean value indicating whether the thesaurus should be used during the search.
USER_AGENTStores the user agent of the searching user. Used when user tracking is enabled.
PerserveHighlightsIndicates the hit highlighting should be perserved when performing Query Withins.
BestBetsBoolean value indicating whether Best Bets should be executed.
BestBetsDictionaryString value override the Best Bets dictionary to use.
BestBetsThresholdDouble value indicating the Best Bets threshold, a best bet must meet or exceed this value (between 0 and 1).
BestBetsMaximumInteger indicating the maximum number of Best Bets to include in the result list.
HitLimitInteger value indicating the maximum number of hits allowed in the result list. If a search exceeds this list, the search will fail.
DocLimitInteger value indicating the maximum number of documents allowed in the result list. If the search exceeds this list, the search will fail.
ValidateIndexesInstruct ISYS that the indexes should be checked for changes. ISYS will generally perform a fast check, this option performs a lower check which may take a little more time.
DisableEarlyBoundSecurityIndicates that early binding security should not be performed, even if the index is capable of it.
LanguageIndicates the language to be used when performing stemming and synonym lookup, expressed as an ISO639 2 digit language code.

Examples
[VBScript]
<%
' This sample demonstrates setting attributes on the ISYSSearch object.  It includes  
' setting session information for user tracking.  

' Create a new ISYSSearch object from the ISYSEngine  
dim ISYSSearch : set ISYSSearch = ISYSEngine.NewSearch

' User Tracking Attributes
ISYSSearch.Attribute("SESSION_ID") = Session.SessionID
ISYSSearch.Attribute("REMOTE_ADDR") = Request.ServerVariable("REMOTE_HOST")
ISYSSearch.Attribute("USER_AGENT") = Request.ServerVariables("HTTP_USER-AGENT")

' Enable Security
ISYSSearch.Attribute("Authenticate") = True
%>

Remarks
You can use this property to control how ISYS authenticates the result list, by specifying a SECURITY_SYSTEM attribute. The value is formatted using name=value pairs and seperated by semicolon. The published attribute values are:

SYSTEM
Values: NT, WINDOWS, APACHE or DOMINO
Indicates the security provider to use, the default is WINDOWS.

USER
Value: {Username} The login name for the user in the given system.

PASSWORD
Value: {Password} The password for the user in the given system.

VerifyCachedACLs
Value: (none)
When present, documents that are flagged as "authorized" when using cached ACLs will be verified against the live ACL.

IgnoreCachedACLs
Value: (none)
Forces the ISYS engine to always confirm authorization against the live ACL, bypassing the cached one.

FileNotFound
Value: ALLOW or DENY
Indicates the default behavior for documents that are in the index, but cannot be found on disk. The default option is ALLOW, meaning the document will be visible to the user.


 

© 2016 Lexmark. All rights reserved. | Terms of Use | Contact