Reference: |
The WebFOCUS Administration Console enables you to configure Magnify and related Luceneā¢ settings. In the Magnify section, the settings are grouped into the General Settings and Lucene Security categories in the Magnify section and are described in the following topics. Note that a valid Magnify license key must be entered in the License Management window for the Magnify section to display in the WebFOCUS Administration Console.
In the Magnify section of the WebFOCUS Administration Console, select General Settings to view or edit the following Magnify client settings in the cgivars.wfs file.
The search engine configured with Magnify. The selections are:
URL to the Google Search Appliance. This is only active for Google Search Appliance (GSA).
Full path to the directory where all Magnify configuration files are located including the lucene index, cached index files, log files and the Magnify stylesheet. The default path is &IBI_DOCUMENT_ROOT/magnify.
Full path to the directory where the configuration files for the stopwords and synonyms feature are located.
The default path is &IBI_DOCUMENT_ROOT/config/magnify
Full path to the directory where the Magnify style sheets reside. This setting enables you to set the path to a directory outside of your WebFOCUS installation to prevent it from being overwritten when you perform an upgrade or a reinstallation.
The default path is &IBI_DOCUMENT_ROOT/config/magnify.
Full path to the directory where the Lucene index resides. This is only active for the Lucene search engine. The default is &IBI_DOCUMENT_ROOT/magnify/lucene_index.
The maximum number of URL items to be returned by a search request. (These items will appear in the Dynamic Categorization tree.) Any results beyond this number are not displayed to the user. The default value is 1000.
The directory where Magnify creates a cached version of the Lucene index being created. After all content is added to the Lucene index, the cached version is deleted. The default value is &IBI_DOCUMENT_ROOT/magnify/feedcache.
If a HTTP cookie name is specified, Magnify verifies that the cookie is set. If the required cookie does not exist, Magnify displays the web page specified by the magnify_required_cookie_redirect parameter. If the parameter is set to false (the default value), Magnify does not verify any cookies.
The web page Magnify displays if the HTTP cookie specified by the Magnify_required_cookie does not exist. By default, the WebFOCUS Welcome page displays.
Magnify functionality can be integrated with the Lucene search engine. In the Magnify section of the WebFOCUS Administration Console, select Lucene Security to view, edit, create, or remove Lucene security plug-ins. The following image shows the Lucene Security Settings page displaying existing security plug-ins.
Selecting New or Modify takes you to the Lucene security plug-in creation and modification page, as shown in the following image.
The Lucene security plug-in creation and modification page contains the following required and optional fields.
Type a name for the security plug-in. A security plud-in name binds individual search results to security and provides an alternative name for the Java class name. This field is required.
Type a name for the Java class. The Java class name is the file name of the Java class assigned to the security plug-in. The Java class contains functions for authentication, authorization, and alarms. This field is required.
Provide instructions to be displayed in the browser for a search when prompting for a userid and password. All characters except quotes and colons are allowed. This field is required.
Type the time limit in milliseconds to wait for a response. The time limit determines how long Magnify waits for a response before timing out for each security plug-in. The actual wait time is twice the specified time limit because it is applied independently to both authentication and authorization. This field is required and it must be populated with a positive numeric value. Note that one thousand (1000) milliseconds is equal to one second.
Provide a list of optional parameters that can be passed to the security plug-in. The optional parameters are command line statements. This field is optional.
Type a valid userid. If this field is populated, the userid is passed to the security plug-in. This field is optional.
Type a valid password. If this field is populated, the password is passed to the security plug-in. This field is optional.
Provide one or more e-mail addresses to be used for sending notifications based on the results of the security plug-in alarm. Multiple addresses must be separated by a comma or semi-colon. This field is optional.
Provide the e-mail address that notification e-mail recipients can reply to after receiving an e-mail alarm for a security plug-in. This field is optional.
Type the number of failure attempts that must occur before Magnify Search:
This field is optional and it must be populated with a positive numeric value when provided.
Type the number of milliseconds that Magnify Search must wait before retrying the security plug-in after it has failed the number of times set in Allowed Failures field. The security plug-in must be successful on the first retry attempt or the specified wait time goes into effect again. This field is optional and it must be populated with a positive numeric value when provided.
WebFOCUS |