WebFOCUS Online Help > WebFOCUS Administration Console > Configuration Settings > Changing WebFOCUS Client Settings in the WebFOCUS Administration Console

Changing WebFOCUS Client Settings in the WebFOCUS Administration Console

In this section:

Reference:

The client configuration settings are grouped into categories under the Configuration menu in the WebFOCUS console. The term Initial Value next to a setting means that the value shown initially is the installation default value and that it can be overridden by setting the variable explicitly in the URL request.


Top of page

Reference: Cookie Settings in cgivars.wfs

Choose the Cookie category to view or edit the following settings.

WF_COOKIE_EXPIRATION

Number of minutes the WebFOCUS cookie remains in effect. A value of 0 means that there will be no expiration time applied to the cookie.

This expiration time is refreshed each time a WebFOCUS report is run. WF_COOKIE is deleted when the expiration time is reached. Once WF_COOKIE is deleted, user credentials must be reentered in order to continue using WebFOCUS.

REDIRECT_COOKIE

Prevents a redirected request that was run on one machine from being viewed from a browser on another machine. It uses a unique encrypted identifier to ensure that the person that sent the original request is the same person retrieving the output again. As of WebFOCUS Version 7 Release 6.10, REDIRECT_COOKIE is set to ON by default.

IBI_COOKIE_DOMAIN

Value of the domain field of a cookie. This value restricts where the cookie is sent. For example, if you specify a particular domain, cookies are only sent to hosts in that domain. By default, the cookie is only sent to the host from which it was generated.

IBI_COOKIE_PATH

Path(s) on the server to which the cookie will be sent. By default, WebFOCUS sets the path to the root directory ("/").

IBI_COOKIE_SECURE

When enabled, this variable restricts the exchange of cookies to only HTTPS sessions. This variable is not set by default.


Top of page

Reference: General Settings in cgivars.wfs

Choose the General category to view or edit the following settings.

APPROOT

Location of the Application Namespace root directory on the Web server where WebFOCUS is installed. The default directory is installationdrive:\ibi\apps unless a different directory was specified during the installation of the WebFOCUS Client.

IBI_DOCUMENT_ROOT

Location of the WebFOCUS installation directory.

CGI_TEMP_DIR

Location of the temporary directory.

IBI_BACKUP_DIR

Location of the backup directory. By default, points to webfocus\backup. The conf subdirectory under backup contains a copy of cgivars.wfs with all of the default values. This is where the console retrieves the default values for cgivars.wfs when the Restore Default Values option is selected.

The administrator can change the backup directory to another location. However, the conf directory must be created under the new location.

IBI_HTML_DIR

Location of the root directory for HTML and Java language files.

IBI_CONFIG_DIR

Location of the directory containing WebFOCUS configuration files, including install.cfg, mrrealm.cfg, mradmin-config.xml, and approotConfig.xml.

Note: If you change this setting and you deploy the ibi_html76.war or approot76.war static content server Web applications, you may need to update their deployment descriptors with the new location of the approotConfig.xml file.For more information, please see Configuring WebFOCUS in a Split Web-Tier and Application Server-Only Environment in the WebFOCUS installation manual for your platform.

EXPIRE_REPORTS

The time when reports generated by the WebFOCUS Reporting Server are to be re-executed. The expiration time is set in seconds, and the default setting is 300 seconds.

You can view a previously executed report on the browser without re-executing its request. If the request for a report you are running is the same as the one executed previously (within 300 seconds), then the browser displays the previously executed report stored in the cache when you use the Back, Reload, or the Refresh button of the browser.

You can set EXPIRE_REPORTS in the following ways:

  • To ensure that the reports are re-executed, set EXPIRE_REPORTS to 1 second.
  • To view the cached output of the browser without using the Back, Reload, or Refresh button, set EXPIRE_REPORTS to a large number, such as 4,000,000,000 seconds.
CACHE_CONTROL

An HTTP Header field that is used to specify how a browser should handle the caching of data in a request. Possible values are:

PRIVATE - The data in the response message is intended for only one user and should not be cached by a shared cache. This is the default value.

NO-CACHE - Browser caching is disabled. No files will be created on disk in the Temporary Internet Folder of the user.

WF_CODEPAGE

For internal use only. This setting is only for Japanese or Korean languages.

_site_profile

The following syntax enables you to include code to be executed on the WebFOCUS Reporting Server.

_site_profile=command

where:

command is any valid WebFOCUS Reporting Server syntax. The WebFOCUS Site Profile is not processed during a reporting server sign-on. It is only processed when running a procedure. Therefore, you cannot use it to record sign-on events.

_TempFileTimeout

Deletes files from the temporary directory. Files are deleted if they are older than the number of seconds specified.

LANG

This setting is applicable only when using the WebFOCUS CGI on UNIX. In order to display NLS characters on a report with Server Side Graphics, you must set this parameter to the appropriate UNIX locale encoding (for example, en_us).

_eda_config

Points to where the odin.cfg file resides.

WFTRANSINOUT

Is a fully qualified Java class that does the transin/transout processing (processing of a request to/output returned by the WebFOCUS Reporting Server) for a plug-in for the Servlet version of the WebFOCUSClient. This class must implement the WFTransInOutInterface java class. For example, one use of this class can be to enable data that is passed between the WebFOCUS Reporting Server and the Servlet to be parsed for bi-directionality (left/right vs. right/left strings).

WFEXT

Specifies the qualified name of a WebFOCUS plug-in class to be invoked by the WebFOCUS Servlet. By default, this variable is set to ibi.webfoc.WFEXTDefault, which is the default plug-in supplied with WebFOCUS that contains several useful functions.

FOCHTMLURL

Alias used to locate WebFOCUS resources on the Web server.

WF_SIGNON_MESSAGE

Points to the HTML page that opens after a successful sign-on occurs.

IBIF_persistentamp

Turns on the persistent && feature. By default, this is set to YES. To disable, set to NO. The persistent && feature allows you to persist && variables for the duration of the browser session.

WF_AUTOSIGNON

Auto prompting of server credentials. Possible values are:

YES - Displays a dynamic server sign-on page after a failed connection to the WebFOCUS Reporting Server. YES is the default value.

NO - Disables the dynamic server sign-on page. Users will receive a message after a failed connection to the WebFOCUS Reporting Server.

PREPROMPT - Displays a dynamic server sign-on page before attempting to connect to the WebFOCUS Reporting Server for the first time.

IBIF_webapp

The alias of the WebFOCUS Web application.

IBIWF_language

With the Dynamic Language Switch feature, the default user interface language for a session is based on the language of the browser, or by setting the IBIWF_language=nn parameter in the URL (where nn is the ISO language abbreviation).

TheWebFOCUS Client uses this default setting to control the display language when the browser language of the user is not one of the available options from the Select Language drop-down list during logon, or if no parameter is set in the URL call.

For possible values for the ISO language abbreviations, see the WebFOCUS National Language Support for International Computing manual.

CGI_PROG

Overrides the CGI/ISAPI/WFServlet client path for every redirected request.

IBIWF_sendbufsize

Defines the size of the buffer used for accumulating report content before moving it to the report cache (a temporary directory) or displaying it in the browser when using the Servlet implementation of the WebFOCUS Client. Possible values are:

blank, missing, or less than 1024 - Indicates that the WFServlet will use the current default size of 16384 bytes.

nn - Is the size in bytes of the buffer that will hold the report output when nn is greater than or equal to 1024.

IBIWF_redirect

Globally sets redirection on or off. Valid values are:

MIME - Respects the values set in the mime table. MIME is the default value.

ALWAYS - Always redirects. The report content is saved in the report cache (a temporary directory). Content is moved from memory to the report cache when it exceeds the value of IBIWF_sendbufsize. Then a second HTTP call is made from the browser to retrieve the report content for display.

NEVER - Never redirects. The report output displays in the browser immediately after the request is executed. The report content is streamed to the browser without writing anything to the report cache when the content exceeds the value stored in IBIWF_sendbufsize.

LEN - Does not redirect. If the size of the report content exceeds the value stored in IBIWF_sendbufsize, the report output is moved from memory to the report cache. Once the report output is completely accumulated in the report cache, it is sent to the browser without an additional HTTP call. This setting is useful for report formats such as PDF that require the CGI/WFServlet to accumulate the entire report on the middle tier in order to get the correct file size before sending it to the client.

IBIF_max_messages

Controls how many WebFOCUS Reporting Server messages will be accumulated before WFServlet stops processing the request and displays error message 32100: "Reporting Server messages exceeded IBIF_max_messages, report retrieval aborted." Messages include –TYPE commands, &ECHO=ALL variables, and errors or warnings from a data adapter. The setting protects against the situation where the Java VM executing WFServlet runs out of memory. 20000 is the default value. IBIF_max_messages can be passed with the request, in which case it overrides the value set in the console. When debug mode is enabled in Developer Studio, a value of 50000 is passed with each request. A value of 0 indicates that no limit exists.

IBI_RES_GOV_ADVISE

Enables the display of Resource Governor advise messages for the servers you select. When enabled, redirection is turned on for all report formats when the WebFOCUS Reporting Server returns any Resource Governor advise messages to display to the user. You can access the redirection settings by selecting Redirection Settings under the Configuration menu of the WebFOCUS Adminstration Console.

WF_proj_list_from_wfrs

Controls how Developer Studio loads the Projects tree and the Web Applications tree in the Project Development Environment. The default setting is NO to preserve legacy behavior. NO means that the project tree and Web application tree in the development environment are loaded with the set of applications found by WFServlet in the Web-tier application root directory. YES means that these trees are loaded with the set of applications found by the Project Development Reporting Server, except for APP MAP applications which are filtered out. Customers who wish that their developers see only their own projects/applications in a shared development environment may wish to change this setting to YES and also do one of the following: APPLOCK the project development server (for more information, see Technical Memo 4613: Creating Private Application Views With APPLOCK 7.1 and higher) or use file system permissions on the application folders of the server.

WF_EMAIL_SERVER

Specifies the fully qualified name of an SMTP server that can be used by WebFOCUS to send e-mail messages. It is used to send links to Dashboard Mobile Favorites pages for Mobile Favorites users.It is also used by Magnify to send Notification and Reply e-mails.

SCC_NAME

Used by the WebFOCUS Developer Studio Source Control feature to identify the development environment. It is required by certain Version Control Systems such as ClearCase, CVS, and Subversion. This variable is transparent to the developers.

A value for this string must be provided if the environment will be used to source control files. Here is an example using the host name of the machine:

SCC_NAME=dev-server-1

The value needs to be unique for every WebFOCUS environment accessing the same Source Control repository, and the name should not contain spaces or any of the following special characters:

. / \ " ` ? : * < > |

Note: Avoid changing the value after files have been added to the Source Control repository. If you need to change the value, either add all files to the repository again or change the repository to be consistent with the new value. For more information, see Managing a Project With Source Control in the Creating a Reporting Application chapter of the Developing Reporting Applications With Graphical Tools manual.

google_maps_api_version

Determines the version number of the Google Maps API. Can be an integer or decimal value. An integer value represents a stable version. The default value is 2.

google_maps_api_key

Provides access to the Google Maps API. The key is an 80+ character string that is copied from the Google site and pasted into this field. The key enables Google Maps to be embedded in customized HTML pages. To obtain a Google Maps API key, go to: http://code.google.com/apis/maps/signup.html.


Top of page

Reference: Graph Settings in cgivars.wfs

Choose the Graph category to view or edit the following settings.

ENABLE_SSG

Setting this variable to Y (the default) enables server-side graphics. If set to N, WebFOCUS uses applets to display graphics. When set to APPLET, the graph displays in an applet in the browser window and the SET GRAPPLETONLY=ON command syntax is sent to theWebFOCUS Reporting Server.

IBIF_graphengine

Controls which graph engine to use for Server Side Graphics. Valid values are GRAPH53 and GRAPH32. GRAPH53 is the graph engine in Version 5 Release 3 and higher. GRAPH32 is the graph engine in Version 5 Release 2 and earlier, and is provided for backward compatibility because older procedures may require changes or may display differently with the GRAPH53 engine.

IBIF_graphengine can also be set in the Client Settings Graph panel located in the Configuration section of the WebFOCUS Administration Console.

IBIF_graphservurl

Configures graph image files on the Server. This is the default configuration option and is the required option on z/OS. In all other environments, JSCOM3 is the recommended configuration option.

The IBIF_graphservurl parameter has the following form:

&URL_PROTOCOL://machinename/alias/IBIGraphServlet

where:

URL_PROTOCOL is HTTP.

machinename is the name of the Web server where the WebFOCUS Client is installed.

alias is the context root of the WebFOCUS application (usually ibi_apps).

IBIF_graphservurl should not be used when Web Server security is enabled. This includes Basic authentication, IWA, SSL, and third party Security products (such as SiteMinder, Clear Trust, Oblix, Web Seal). In these cases the Web Server security settings can prevent WebFOCUS from creating the graph. IBIF_graphservurl can be used with Basic authentication when the credentials are supplied as shown below:

http:// userid:password@host:port/ibi_apps/IBIGraphServlet

However, this is not recommended because the password is displayed as plain text in the Console and the Web server logs. If Web server security is enabled, JSCOM3 should be used.

For information about using JSCOM3, see the description of the IBI_USE_JSCOM3 variable.

IBIF_graphAgents

Specifies the number of pre-started agents available for graph processing.

SSG_EXTERNAL

Enables Server Side Graphics when using the WFServlet. This setting is recommended for large graph requests since it spawns new JVM processes for each request.

IBIJAVADIR

This setting has been superseded by IBI_USE_ JSCOM3, which is the recommended graph configuration option for the CGI/ISAPI implementation of the WebFOCUS Client. It points to the location of the JRE/JDK installation directory. It is not used by WebFOCUS Servlet.

IBIJAVACMD

This setting has been superseded by IBI_USE_ JSCOM3, which is the recommended graph configuration option for the CGI/ISAPI implementation of the WebFOCUS Client. It points to where the Java Virtual Machine (JVM) is located in order to execute Java language-based programs such as Server Side Graphics.

IBI_USE_JSCOM3

When set to YES, enables the use of JSCOM3. This setting enables the use of Server Site Graphics when the Web Server has security enabled. The CGI/ISAPI implementations of the WebFOCUS Client must use JSCOM3 if amper auto prompting is desired. To use JSCOM3:

  • You must blank out the IBIF_graphservurl value (as it takes precedence when it has a value).
  • IBI_USE_JSCOM3 must be set to YES.
  • A JSCOM3 node must be defined and properly configured in the WebFOCUS Reporting Server ODIN.CFG file (configured by default during installation). The WebFOCUS Reporting Server must also include the following jar file in either the IBI_CLASSPATH or classpath variable:
    ...\ibi\WebFOCUS76\ibi_html\javaassist\IBIGifGraphChart.jar

The IBI_CLASSPATH is configured automatically during installation. However the variable can be maintained either in the WebFOCUS Administration Console or in the Reporting Server Web Console. To set IBI_CLASSPATH in the WebFOCUS Administration Console, go to Special Services under Reporting Servers and modify the JSS node. To set it in the Reporting Server Web Console, Select Listeners & Special Services, then Special Services, then Configured, then JSCOM3.


Top of page

Reference: Multiple Reports Settings in cgivars.wfs

Choose the Multiple Reports category to view or edit the following settings.

IBIWF_mframename

Used to name each frame in a multi-frame report. The name of each frame will be this value followed by an index number. For example, for two frames with IBIF_mframename set to MYFRAME, the two frames will be named MYFRAME1 and MYFRAME2. MREPORT is the default value.

IBIWF_mrcolumns

Specifies the maximum number of columns per page in multi-frame reports. 1 is the default value.

IBIWF_morder

Specifies whether the report frames in a multi-frame report should appear in the order that the columns are specified in the request or the reverse order. Valid values are FORWARD and REVERSE. FORWARD is the default value.

IBIWF_mreports

Specifies whether to create an index report, a multi-frame report, or a standard report. Valid values are OFF, INDEX, and FRAME. OFF is the default value.

IBIWF_mprefix

Specifies up to 50 characters of descriptive text that precedes a sequence number and identifies a report on a TOC. Used to create hyperlink names in index reports. For example, if the value is MyReport, the hyperlinks will be composed of the name MyReport followed by an index number starting with 1. Report is the default value. Do not use this variable if IBIWF_mreports=FRAME.

IBIWF_mrrows

Is the number of vertically stacked reports when IBIWF_mreports is set to FRAME.

IBIWF_index

Controls whether a sequence number is appended to the end of the names on the TOC when IBIWF_mreports=INDEX. ON appends a sequence number of 1 (for the first report generated) to n (for the last report generated). This value is the default. OFF omits a sequence number. Only the text specified by IBIWF_mprefix applies.


Top of page

Reference: OLAP Settings in cgivars.wfs

Choose the OLAP category to view or edit the following settings.

OLAP_DOCKED

The OLAP Control Panel is permanently displayed while running an OLAP report when set to YES. NO is the default value.

IBIF_olappos

Location of the OLAP panel (top, bottom).

Skin Name

Enables administrators to preview and set a new color scheme for OLAP components, such as the OLAP Control Panel.


Top of page

Reference: On Demand Paging Settings in cgivars.wfs

Choose the On Demand Paging category to view or edit the following settings.

IBIF_odpenable

Controls display of On-Demand Paging (ODP) reports.

YES - Displays the report. Yes is the default value.

NO - Does not display the ODP report. Instead, a page with a message displays. You can specify the message text in variable IBIODP_disable_msg. If you do not, a blank line displays.

IBIODP_disable_msg

This variable contains a message, which will be displayed instead of the ODP report output when IBIF_odpenable is set to NO. A blank line is the default value.

ODP_target

Controls the action of the back-button in the Web Viewer.

ON - The Back button of the browser re-displays the first ODP page.

OFF - The Back button of the browser returns the browser to the calling page of the ODP report.

_search_begin

Opening HTML tag for highlighting text found as a result of a search in an ODP report. <u> is the default value, to underline the text.

_search_end

Closing HTML tag for highlighting text found as a result of a search in an ODP report. </u> is the default value, to underline the text.


Top of page

Reference: Parameter Prompting Settings in cgivars.wfs

Choose the Parameter Prompting category to view or edit the following settings.

IBIF_wfdescribe

Variable for amper auto prompting for self service reporting. Possible values are:

OFF - Turns auto prompting off. This is the default value.

XML - The XML document describing the amper variables is displayed in the browser. This setting is used internally by the WebFOCUS tools and is recommended for debugging purposes only.

XMLRUN - Only prompts for amper variables created with -DEFAULT when there is another amper variable that does not have a value assigned and, therefore, will be prompted for.

XMLPROMPT - Prompts for amper variables created with -DEFAULT and for any other amper variable that does not have a value.

Note: Managed Reporting uses a separate variable setting, which is IBIMR_prompting.

IBIF_describe_xsl_location

Specifies the location of the XSL document used to transform the XML document that describes the amper variables in the request. This variable replaces IBIF_external_xsl used in earlier releases. If the variable is blank, then the resulting document from the internal transformation is sent to the client.

IBIF_describe_xsl

Specifies the name of the XSL document used to transform the XML document that describes the amper variables in the request. A file extension is not required. This variable replaces IBIF_external_xsl used in earlier releases. If the variable is blank, then the resulting document from the internal transformation is sent to the client.

IBIF_report_xsl_location

Specifies the location of the XSL document used to transform a resulting XML report. This variable replaces IBIF_external_xsl used in earlier releases. If the variable is blank, then the resulting document from the internal transformation is sent to the client. This setting is blank by default.

IBIF_report_xsl

Specifies the name of the XSL document used to transform a resulting XML report. A file extension is not required. This variable replaces IBIF_xsl used in earlier releases. If the variable is blank, then the resulting document from the internal transformation is sent to the client. This setting is blank by default.

IBI_AUTOPROMPT_CGI_PROG

Overrides the client path for CGI, ISAPI, or WFServlet for WebFOCUS AUTOSIGNON feature.


Top of page

Reference: Performance Settings in cgivars.wfs

Choose the Performance category to view or edit the following settings.

WF_OPTIMIZEIO

Enhances request processing for the WebFOCUS Reporting Server.

WF_BURST_OUTPUT

Enables the WFServlet to send simple HTML reports to the WebFOCUS Client faster. If the request is being redirected, or if it is a complex ODP or OLAP report or a report with frames, this option should be turned off.

WF_DATATRANSFER_SIZE

Sets the amount of data (in MBs) that is sent per request. For example, if the file is 6 MBs and the WF_DATATRANSFER_SIZE is 3, two requests are sent, each with half of the data.

If the variable is not specified or is equal or less than 0, 1 MB of data is sent for each request. This is used by Developer Studio when sending files to the approot directory.


Top of page

Reference: ReportCaster Settings in cgivars.wfs

Choose the ReportCaster category to view or edit the following settings.

AGENT_NODE

ReportCaster Agent Listener node.

AGENT_PORT

ReportCaster Agent Listener port.

BKR_REPORT_DIR

FTP alias that is used to store ReportCaster files.


Top of page

Reference: WebFOCUS Quick Data Settings in cgivars.wfs

Choose the WebFOCUS Quick Data category to view or edit the following settings.

quick_data_security

The type of logon that WebFOCUS Quick Data will use. Reporting Server is the default selection and requires no additional configuration.

If MR is selected and you click the drop-down menu for either the quick_data_domain_desc or quick_data_folder_desc setting, the Managed Reporting Logon opens. To select values for these settings, the Managed Reporting Logon must be validated with the User ID and Password of an MR Administrator who has the authority to see all of the Domains in the MR Repository. Both an MR Domain and Standard Reports folder must be selected in order to save these settings when MR is selected for the WebFOCUS Quick Data logon.

quick_data_domain_desc

The drop-down menu for this setting enables you to select the MR Domain that contains the Standard Reports folder used for the quick_data_folder_desc setting.

quick_data_folder_desc

The drop-down menu for this setting enables you to select the top level Standard Reports folder within the selected domain where WebFOCUS Quick Data SAFs (Structured Ad hoc Forms) can be stored. (An SAF contains a report procedure that is tied to a data source and enables users to select from a series of parameters to create a data set that can be analyzed using WebFOCUS Quick Data.

quick_data_form_only

The Use guided ad hoc forms only check box is enabled for this setting when you select MR for the quick_data_security setting and specify a Domain for the quick_data_domain_desc setting to specify the location of Quick Data SAFs (Structured Ad hoc Forms). Selecting the check box restricts users from SAFs with ad hoc reporting tools, for example, Report Assistant. The default value for this setting (in the cgivars.wfs file) is NO and is set to YES when the check box is selected.

Note: Only one Managed Reporting Logon menu is presented per WebFOCUS Administration Console session.


Top of page

Reference: WebFOCUS Reporting Server Security Options
Default
Is the initial value for new nodes and represents the traditional behavior, where the odin.cfg file does not contain a SECURITY keyword. In this case, WebFOCUS makes an explicit connection to the Reporting Server with whatever user ID and password it has available for the request. A user ID may come from IBI_REPORT_USER on the console's Client Settings, Reporting Server pane, from a WebFOCUS Client Node Profile, or from the user's WF_COOKIE if a Reporting Server sign-on has taken place. How the server processes explicit connections depends on its security setting (OFF, PTH, OPSYS, LDAP, DBMS).
HTTP Basic
Configures WebFOCUS to extract the user's ID and password from the Authorization header. These credentials are then used to make an explicit connection to the WebFOCUS Reporting Server. You should only select this option when your Web-tier is performing Basic Authentication so that the user's Base64 encoded ID and password will be available in the request header. For example:
Authorization              Basic amx0XHdmdXNlcjp3ZnVzZXIx

To verify that the Authorization header is available to WebFOCUS , click the WebFOCUS Administrative Console's Diagnostics menu and select HTTP Request Info.

Kerberos
Configures WebFOCUS to pass the user's Kerberos ticket to theWebFOCUS Reporting Server. This option enables an end-to-end single sign-on solution from the desktop to WebFOCUS to the Reporting Server, to supported relational DBMS systems. When using this option, theWebFOCUS Reporting Server must run in security OPSYS mode. There are additional setup requirements for WebFOCUS and for Microsoft Active Directory, which are described in Technical Memo 4647: Configuring Single Sign-on to the WebFOCUS Reporting Server Using Kerberos.
SAP Ticket
Enables customers using WebFOCUS Open Portal Services in SAP Enterprise Portal to achieve single sign-on through WebFOCUS to a Reporting Server configured with the SAP Data Adapter. WebFOCUS passes along the user's MYSAPSSO2 cookie, created on SAP Enterprise Portal, to the Reporting Server which validates it using the SAP security API.
Service Account
Enables you to specify a user ID and password to be used for all connections to the Reporting Server. The credentials are encrypted and stored in the odin.cfg file's SECURITY keyword. When defined, the service account overrides any other credentials that might be presented to WebFOCUS for this Reporting Server node.
Trusted

Enables you to connect to the Reporting Server with only a user ID. This option is useful when no password is available for the user, and controls can be placed on the server to ensure that connections from unauthorized clients are rejected (for example, employing the server's RESTRICT_TO_IP setting so that only a particular WebFOCUSclient can connect to the server).

If the server runs in security OPSYS mode, the connecting user ID must be valid on the server's operating system and the Reporting Server cannot run on Windows. In this scenario, the connecting user appears in the server's edaprint.log and is returned by the server's GETUSER and CNCTUSR subroutines. The report agent runs in the security context of the connecting user, which makes it possible to use operating system permissions and the trusted option for DBMS adapters in order to restrict file and data access.

Trusted connections are also supported by servers running in security OFF, PTH, and LDAP modes provided that the server's trust_ext setting is enabled.

In this configuration the connecting user appears in the server's edaprint.log and is returned by the server's CNCTUSR subroutine. The server's GETUSER subroutine will always return the user ID that started the server. When the server runs in LDAP mode the connecting user must be found in the LDAP directory before the connection is accepted.

Note: Trusted connections are not supported by servers running in security DBMS mode.

If the server runs in the PTH or OFF security modes, then trusted connections will be accepted without authentication by Reporting Servers on any platform, including Windows. The server's edaprint.log and CNCTUSR subroutine will reflect the connecting user ID, and the server's GETUSER subroutine shows the user ID that started the server.

Trusted connections are not supported against servers running in security DBMS mode. The following lines in a report request are useful to determine connection behavior:

-SET &CONNECT_USER = CNCTUSR('A30');
-SET &AGENT_USER = GETUSER('A30'); 
-TYPE Connect User is: &CONNECT_USER
-TYPE Report Agent runs as: &AGENT_USER

When you select Trusted, the following additional settings are displayed:

Select which option will be used to retrieve the connected user.


Top of page

Reference: InfoAssist Settings

In the InfoAssist Properties menu under the Utilities section, the WebFOCUS Administrator can enable or disable reporting options in the InfoAssist tool by specifying Yes or No in the Setting column. For more information on the InfoAssist reporting tool, see the WebFOCUS InfoAssist User’s Manual, Version 7 Release 6.10.

Home Tab

In InfoAssist, the Home tab enables you to control the most commonly used properties and options from the Format, Design, Filter, and Report groups. The WebFOCUS Administrator can configure the following properties available in the InfoAssist Home tab:

Page Heading

Adds a heading to each page of the report output. Page Heading settings are configured in the Head/Foot menu of the Home Tab.

Record Limit

If set to Yes, the Record Limit menu in the Home Tab is enabled. If set to No, the Record Limit menu is removed from the InfoAssist interface.

Report Heading

Adds a heading to the first page of the report output. Report Heading settings are configured in the Head/Foot menu of the Home Tab.

Themes

This option provides you with various color-coded WebFOCUS StyleSheet themes that can be used to style your report or chart. You can select themes that are standard with InfoAssist, or select a customized Cascading Style Sheet theme created by you or someone else in your organization.

Use Interactive Design View

When set to Yes, the InfoAssist tool opens with Query Design View as the default. When set to No, InfoAssist starts with the Interactive Design View. If the Allow User Override Setting is checked for this option, the InfoAssist user can change the default settings specified by the WebFOCUS Administrator.

Format Tab

In InfoAssist, the Format tab provides different options for selecting output formats and other reporting features, depending on whether you are creating a report query or a chart query. For reports, the Format tab provides access to the Output Types, App Ribbon, Destination, Navigation, and Features groups. The WebFOCUS Administrator can configure the following properties available in the InfoAssist Format tab:

Active Flex Format

Creates report output that contains portability and interactive enhancements to Active Reports.

Active PDF Format

Creates report output that contains portability and interactive enhancements to Active Reports in PDF format.

Active Report Format

Creates an HTML Active Report, which is a self-contained report that is designed for offline analysis. It contains all of the data and JavaScript within the HTML output file and it includes analysis options such as filtering, sorting, and charting.

Excel Format

The Excel 2000 format supports most StyleSheet attributes, allowing for full report formatting. The computer on which the report appears must have Microsoft Excel 2000 or higher installed.

Excel Pivot

Creates a report that will be displayed as an Excel 2000 PivotTable.PivotTable is an Excel tool for analyzing complex data, much like WebFOCUS OLAP.

HTML Format

Creates the report output as an HTML page.

Other Chart Types

Provide options for creating more complex graph output types, such as Spectral Map, Gauge Chart, and Pareto Chart.

Pages on Demand

Displays report output one page at a time. You can use the navigation menu at the bottom of the output screen to view each page. This option is activated only when HTML or Active Report output format is selected.

PDF Format

Creates a report that will be displayed as a PDF document.

Powerpoint Format

Creates a report will be displayed as a PowerPoint document. The computer on which the report appears must have Microsoft PowerPoint installed.

Stacked Measures

Displays all numeric measure field names in the first column of the report output with the corresponding numeric data values displayed across time in a column for each selected time period. The Stack Measures feature is activated only when HTML, Excel, or PowerPoint output format is selected. If the Allow User Override Setting is checked for this option, the InfoAssist user can change the default settings specified by the WebFOCUS Administrator.

View Tab

Enables you to customize the view of different report components in the InfoAssist tool, such as the design mode, output location, and data view. The WebFOCUS Administrator can set the following properties in the InfoAssist View Tab:

Display View Tab

If set to Yes, the View Tab and all of the menu options is enabled. If Set to No, the View tab is removed from the InfoAssist interface.

Query Panel

Allows you to customize the view of the query's components, such as Filters, Column and Row labels, and Measures when building a report. Values are 2x2 (2 columns by 2 rows), 1x4 (1 column by 4 rows), and Tree. If the Allow User Override Setting is checked for this option, the InfoAssist user can change the default settings specified by the WebFOCUS Administrator.

Tool Options

Enables you to change the default settings to reflect the InfoAssist user's preferences. If the Allow User Override Setting is checked for an option, the InfoAssist user can change the default settings specified by the WebFOCUS Administrator. However, the WebFOCUS Administrator can not specify a default value that has already been disabled in one of the other Groups. For example, if the administrator has disabled the Active PDF format (APDF) in the Format tab section and attempts to set that format as a default Compose Output Format in the Dialog Defaults section, the following message displays:

Chart Output Format

Sets the default format for chart outputs. Valid values are PDF, and EXL2K, PPT, and PNG.

Compose Output Format

Sets the default format for report outputs that are generated in Compose mode. Valid values are Active PDF, PDF, Active Report, HTML, Excel, Active Flex, and PowerPoint.

Data Preview Method

Allows you to preview your report using sample data (Sample) or retrieve actual data from the datasource (Live).

Output Target

Sets the default value for the location of your report or chart output. Values are Single Tab, New Tab, Single Window, and New Window.

Page Orientation

Enables you to print reports and charts using a Portrait or Landscape page layout.

Page Size

Enables you to set the page size when printing your report or chart output.

Preview

Enables you to preview your report or chart output using the Interactive Design mode or Query mode.

Recordlimit

Limits the number of rows retrieved from the data source when Interactive Design view is selected. This feature is useful in reducing response time if you are working with a large amount of data. It is applicable only when developing your report. The record limit setting will not affect the report output at runtime.

Report Output Format

Enables you to specify a default format for your report output.

Splash Screen

Specifies the startup mode for the InfoAssist tool. When set to splash, the splash screen is launched every time InfoAssist is started. When set to report , chart, or compose, the Open dialog box displays where you can select a data source to use for your query.

StyleSheet

Enables you to specify a default stylesheet for your report output.

Miscellaneous

Expand Data Source Tree

Enables you to view all data source values in the tree. If set to Yes, the tree is expanded by default. If set to No, the tree is collapsed by default.

Join Button

Enables you to join several datasources in your query. If set to Yes, the Join menu option is enabled under the Data tab. If set to No, the Join menu option is removed from the Data tab.

Layout Tab

Enables you to set several page layout options, such as page orientation, size, and numbering for your report or chart output. If set to Yes, the Layout tab is enabled in the InfoAssist control panel. If set to No, the Layout tab is removed from the InfoAssist control panel.

Series Tab

The Series tab is enabled only when working with chart queries. It provides access to charting properties and options in the Properties, Line, and Pie menus. If set to Yes, the Series tab is enabled in the InfoAssist control panel. If set to No, the Series tab is removed from the InfoAssist control panel.


Top of page

Changing Default Reporting Server Credentials in cgivars.wfs

Choose the Reporting Server category under the Configuration menu to view or edit the following settings.

IBI_REPORT_USER

Default credentials for the WebFOCUS Reporting Server user ID. Only used when a user ID (IBIC_user) is not supplied.

IBI_REPORT_PASS

Default credentials for the WebFOCUS Reporting Server password. Only used when a user password (IBIC_pass) is not supplied.

IBI_REPORT_SERVER

Default credentials for the WebFOCUS Reporting Server. Only used when a server (IBIC_server) is not supplied.


Top of page

Adding or Changing Server Settings for a Specific Reporting Server Node

Administrators can use the WebFOCUS Administration Console to add WebFOCUS Reporting Servers and HTTP Listeners to the WebFOCUS environment. Additionally, the console can be used to add WebFOCUS Client node profiles for each WebFOCUS Reporting Server. We recommend setting WebFOCUS Reporting Server security using the node profiles. The nodes are added to the ibi/WebFOCUS76/client/wfc/etc/odin.cfg file.

A node can enable access to one server or multiple servers. If it specifies multiple servers, it is called a cluster node. The WebFOCUS Administration Console lets you define a basic cluster node and specify the servers it can access.

Tip: You can configure more advanced cluster functionality using the Web Console of the server. For details, see Technical Memo 4641: Distributing Workload Across Clustered WebFOCUS Reporting Servers.


Top of page

Procedure: How to Add a Remote Server to the WebFOCUS Environment
  1. Click Reporting Servers and then Remote Services.
  2. Click New.
  3. In the NODE field, specify the name by which you will refer to the server. The name is your choice, but cannot be the same as any other node name. In addition, the name must begin with a letter and cannot be more than eight characters. When the WebFOCUS Client accesses this server, it will use this name.
  4. Specify the Node class (Client, Cluster, or CLM Processing).

    If you specify:

    • Client, this node will function as a stand-alone server. It can also be used as an alternate server within a cluster configuration.
    • Cluster, this is the primary node that will be used to distribute workload to alternate servers.
    • CLM Processing, the Cluster Manager node monitors server performance statistics and sends the request to the best available server for processing.
  5. Click Next.
    • If you selected Client in step 4, proceed to step 6.
    • If you selected Cluster in step 4, proceed to step 7.
    • If you selected CLM Processing in step 4, proceed to step 8.
  6. The New Node window opens. Enter the following required parameters:
    1. HOST. Host name or IP address of the server.
    2. PORT. Port number for the TCP listener. The default port is 8120.
    3. HTTP_PORT. Port number for the HTTP listener. This is normally the second consecutive port that the server uses. Type the same port number that was specified during installation. The default HTTP port is 8121.
    4. CLASS. If this is a z/OS server, you must include a qualifier.
    5. SECURITY. Determines how WebFOCUS connects to the WebFOCUS Reporting Server. The following are possible SECURITY values:

      Default. Is the initial value for new nodes and represents the traditional behavior, where the odin.cfg file does not contain a SECURITY keyword. In this case, WebFOCUS makes an explicit connection to the Reporting Server with whatever user ID and password it has available for the request. A user ID may come from IBI_REPORT_USER on the console Client Settings, Reporting Server pane, from a WebFOCUS Client Node Profile, or from the user WF_COOKIE if a Reporting Server sign-on has taken place. How the server processes explicit connections depends on its security setting (OFF, PTH, OPSYS, LDAP, DBMS).

      HTTP Basic. Configures WebFOCUS to extract the user ID and password from the Authorization header. These credentials are then used to make an explicit connection to the WebFOCUS Reporting Server. You should only select this option when your Web tier is performing Basic Authentication so that the user Base64 encoded ID and password will be available in the request header. For example:

      Authorization              Basic amx0XHdmdXNlcjp3ZnVzZXIx

      To verify that the Authorization header is available to WebFOCUS, click the Diagnostics menu on the WebFOCUS Administrative Console and select HTTP Request Info.

      Kerberos. Configures WebFOCUS to pass the Kerberos ticket for the user to the WebFOCUS Reporting Server. This option enables an end-to-end single sign-on solution from the desktop to WebFOCUS, from WebFOCUS to the Reporting Server, and from the Reporting Server to supported relational DBMS systems. When using this option, the WebFOCUS Reporting Server must run in security OPSYS mode. There are additional setup requirements for WebFOCUS and Microsoft Active Directory that are described in Technical Memo 4647: Configuring Single Sign-on to the WebFOCUS Reporting Server Using Kerberos.

      SAP Ticket. Enables customers using WebFOCUS Open Portal Services in SAP Enterprise Portal to achieve single sign-on through WebFOCUS to a Reporting Server configured with the Data Adapter for SAP. WebFOCUS passes along the MYSAPSSO cookie of the user, created on SAP Enterprise Portal, to the Reporting Server which validates it using the SAP security API.

      Service Account. Enables you to specify a user ID and password to be used for all connections to the Reporting Server, as shown in the following image.

      The service account credentials are encrypted and stored in the SECURITY keyword of the odin.cfg file. When defined, the service account overrides any other credentials that may be presented to WebFOCUS for this Reporting Server node.

      Trusted. Enables you to connect to the Reporting Server with only a user ID. This option is useful when no password is available for the user, and controls can be placed on the server to ensure that connections from unauthorized clients are rejected (for example, employing the server RESTRICT_TO_IP setting so that only a particular WebFOCUS client can connect to the server).

      If the server runs in security OPSYS mode, the connecting user ID must be valid on the server operating system and the Reporting Server cannot run on Windows. In this scenario, the connecting user appears in the server edaprint.log file and is returned by the server GETUSER and CNCTUSR subroutines. The report agent runs in the security context of the connecting user, which makes it possible to use operating system permissions and the trusted option for DBMS adapters in order to restrict file and data access.

      Trusted connections are also supported by servers running in security OFF, PTH, and LDAP modes provided that the server trust_ext setting is enabled.

      In this configuration the connecting user appears in the server edaprint.log file and is returned by the server CNCTUSR subroutine. The server GETUSER subroutine will always return the user ID that started the server. When the server runs in LDAP mode the connecting user must be found in the LDAP directory before the connection is accepted.

      If the server runs in the PTH or OFF security modes, then trusted connections will be accepted without authentication by Reporting Servers on any platform, including Windows. The server edaprint.log file and CNCTUSR subroutine will reflect the connecting user ID, and the server GETUSER subroutine shows the user ID that started the server.

      The following lines in a report request are useful to determine connection behavior.

      -SET &CONNECT_USER = CNCTUSR('A30');
      -SET &AGENT_USER = GETUSER('A30'); 
      -TYPE Connect User is: &CONNECT_USER
      -TYPE Report Agent runs as: &AGENT_USER

      When you select Trusted, the WebFOCUS script variable and Web server HTTP variable settings are displayed, as shown in the following image.

      Select the option that will be used to retrieve the connected user.

      Note: Trusted connections are not supported by servers running in security DBMS mode.

      You can also specify the following optional parameters:

      Because you specified Client in Step 4, proceed to Step 8 (and skip Step 7, which is used when Cluster is specified).

  7. The New Cluster Node window opens. Enter the following required parameters:
    1. ALTERNATE. Select the servers to be included in the cluster.
    2. DESCRIPTION. Description for the cluster.
  8. The New CLM Processing Node window opens. Enter the following required parameters:
    1. HOST. The IP address of the Reporting Server where the Cluster Manager is configured.
    2. PORT. UDP Port number.
    3. DESCRIPTION. Optional description for the CLM Processing node.

      You can add multiple CLM hosts and ports by clicking Add. A check box is added next to each new host and port combination. To remove a host and port, select the associated check box and click Remove.

  9. Click Save.

Tip: More advanced cluster functionality can be configured using the Reporting Server Web Console. For details, see Technical Memo 4665: Distributing Workload Across Clustered WebFOCUS Reporting Servers.


Top of page

Procedure: How to Change a Remote Server Node
  1. Click Reporting Servers and then Remote Services.
  2. Select the node you want to change.
  3. Click one of the following buttons:
    • Modify. Displays the settings for the selected node, enabling you to make changes.

      You can select the Set as Default Server Node check box to specify that the node is the default WebFOCUS Reporting Server. The node will be written as the IBI_REPORT_SERVER parameter value in the cgivars.wfs file. Note that even if you check Set as Default Server Node, this can be overridden if an IBIC_server is set in site.wfs or a node profile.

      If the site.wfs file or request URL contains an IBIC_server setting, it will override the IBI_REPORT_SERVER parameter. In this case, the WebFOCUS Administration Console indicates that the IBI_REPORT_SERVER is the default node, even though it is no longer the default.

      You can also click Save As to save these settings for another specified node that will be added to the ibi\WebFOCUS76\client\wfc\etc\odin.cfg file.

    • Remove. Deletes the selected node. You will receive a message asking for you to confirm the deletion. This button only appears if you have more than one node defined.
    • Profile. Enables you to override WebFOCUS default settings for a specific WebFOCUS Reporting Server node. These settings are written to ibi\WebFOCUS76\client\wfc\etc\node.prf, where node is the node you selected in Step 2.
    • Server Console. Displays the WebFOCUS Reporting Server Console, which enables you to remotely manage your server environment. For more information, see the Server Administration for UNIX, Windows, OpenVMS, i5/OS, and z/OS manual.

    Note: You can select the Sort alphabetically check box to sort a list of multiple servers.


Top of page

Procedure: How to Configure 3DES Encrypted Communication to a WebFOCUS Reporting Server

This procedure assumes that you have already successfully installed and configured the WFServlet implementation of WebFOCUS.

  1. Download the Bouncy Castle .jar file from the following URL: http://www.bouncycastle.org/latest_releases.html .

    Depending on the JDK you installed on the machine where WebFOCUS resides, use the following.jar file:

    • For JDK1.5, use bcprov-jdk15-142.jar.
    • For JDK1.6, use bcprov-jdk16-142.jar.
  2. Add the Bouncy Castle .jar file in the \ibi\WebFOCUS76\webapps\webfocus76\WEB-INF\lib directory.
  3. Redeploy the webfocus.war file if it is necessary to point to the .war file. Otherwise, point to the Web application directory.
  4. In the WebFOCUS Administration Console, click Reporting Servers and then Remote Services.
  5. Select the WebFOCUS Reporting Server node (for example, EDASERVE) you want to configure for encryption, then click Modify.

    The Remote Services - Modify Settings window appears.

  6. Click Add Setting.

    The Remote Services - Modify Settings - EDASERVE window appears.

  7. Set the ENCRYPTION parameter to 3DES using the drop-down list.
  8. Click Set and then click Save.

Top of page

Changing Managed Reporting Settings

From the Configuration menu of the WebFOCUS Administration Console, choose the Managed Reporting category to view or edit the following settings in the cgivars.wfs file.

IBIF_dbapass_src

Controls whether to pass a DBA password to the WebFOCUS Reporting Server on each WebFOCUS request.

IBIMR_RC_SVCUSER

Is the user ID that the MR Realm Driver uses to connect to ReportCaster during Managed Reporting sign-on. This setting is used only when the MR Realm Driver is configured for external authorization and allows it to create (and update) the Managed Reporting user privileges in the ReportCaster Repository. The ID specified must have rcadmin privileges. Typically, this value is set to the same ID stored in the ReportCaster Server Configuration Tool under General > User Info > Administrator. By default, the value is admin.

MR_EXPIRED_PWD

Reserved for future password expiration feedback support when using the MR Realm Driver. OFF is the default setting.

MR_PARSER_VERSION

Servlet initialization parameter that controls which HTML parser Managed Reporting uses against the basedir directory. This setting was previously located in the \WEB-INF\web.xml file.

Information Builders recommends using the default value, as there is a 50% performance improvement.

MR_BASE_HTML_DIR

Location where all Managed Reporting published pages will reside.

MR_TEMPLATE_DIR

Location where all Managed Reporting templates will reside.

REPOSITORY_CACHE

When enabled, this setting significantly improves Managed Reporting performance and scalability. However, this setting only applies to installations where the Authorization setting in the MR Security Settings - General window of the console is set to Internal.

REPOSITORY_CACHE=ON tells WebFOCUS to cache information about Managed Reporting users, groups, roles, and Domain content. Information is always read from cache unless WebFOCUS detects that the date-time stamp of the files that contain this data has changed. The date-time stamp feature supports scenarios where a cluster of application servers is sharing a single Managed Reporting Repository. User My Report information is also cached. This setting is turned ON by default.

DOMAINS_CACHE

When set to a numeric setting, WebFOCUS caches information about Managed Reporting Domain content. For example, a setting of 10 caches information about the last 10 domains the WebFOCUS processed. This setting is disabled (set to 0) by default. This setting only applies to installations where the Authorization setting in the MR Security Settings - General window of the console is set to Internal.

USERS_CACHE

When set to a numeric setting, WebFOCUS caches information about Managed Reporting user resources such as information about My Reports and Deferred Receipt tickets. For example, a setting of 50 caches resource information for the last 50 users who have signed-on to WebFOCUS. This setting is disabled (set to 0) by default. This setting only applies to installations where the Authorization setting in the MR Security Settings - General window of the console is set to Internal.

WF_CGI_ENDIANNESS

In previous releases, when WebFOCUS was configured to use the CGI/ISAPI client, deferred output saved to a My Reports folder of the user in the Managed Reporting Repository, was written in a format that was incompatible with the WebFOCUS Servlet (WFServlet). This meant that if you upgraded to WebFOCUS Version 7 Release 1, which required the WFServlet configuration for Managed Reporting, you could not access your saved deferred output. The WFServlet now detects and reads the legacy output format, while continuing to read and write with the newer format.

The WF_CGI_ENDIANNESS setting is used by WFServlet to determine the byte order of the deferred output. If your legacy saved deferred output was created on a platform with a little-endian byte order, such as Intel x86, you should keep the default setting of LITTLE. If the output was created on a big-endian platform such as IBM S/390, z/Series, and some UNIX and Linux systems, you should change the setting to BIG. Some platforms can be configured either way so consult with your administrator or experiment if you are unsure of the proper setting for your environment.

Because WFServlet runs on Java technology, which is always big-endian, new deferred output will always be written in big-endian format. WF_CGI_ENDIANNESS is therefore used by WFServlet only to know which way to read legacy saved deferred output created by the WebFOCUS CGI/ISAPI Client.

IBIMR_prompting

Enables parameter prompting for all Managed Reporting requests. Possible values are:

XMLPROMPT

Prompts for amper variables created with -DEFAULT and any other amper variable that does not have a value. This is the default value.

XMLRUN

Only prompts for amper variables created with -DEFAULT when there is another amper variable that does not have a value assigned and, therefore, will be prompted for.

OFF

Turns off parameter prompting at the site level.

IBIF_publish_xsl

Contains the URL of the .xsl file that styles the XML document returned from the Reporting Server when IBIMR_prompting is set to XMLRUN or XMLPROMPT.

MR_BASE_DIR

Location of the Managed Reporting Repository.

MR_ANONYMOUS_RUN_ACCESS

This setting controls the security processing behavior of two different kinds of Managed Reporting requests:

  • Launch pages created outside of Managed Reporting by the Managed Reporting Publish feature.
  • Drill-down requests created by tools that reference a child report in a different Managed Reporting domain than the parent report.

When set to YES, a launch page can run a Managed Reporting report even though the user is not logged on to Managed Reporting. Additionally, a user who is logged on to Managed Reporting can run a drill-down request even when the child report is in a Managed Reporting domain that they do not have access to. If this behavior is a security concern, change the setting to NO.

When set to NO, Managed Reporting domain security is strictly enforced. The behavior for launch pages and drill-down requests is slightly different. If a user who is not logged on submits a Managed Reporting request from a launch page, they will receive an error message or be presented with the Managed Reporting logon page, depending on the value of MR_AUTOSIGNON. If a user who is logged on runs a drill-down request to a child report in a Managed Reporting domain that they do not have access to, they will receive an error message.

Note: This setting supersedes the <set> IBIMR_drill(protect) statement.The protect statement should no longer be used since it disables drill-down reporting, in addition to closing the publish security issue.

MR_AUTOSIGNON

When set to YES, in conjunction with MR_ANONYMOUS_RUN_ACCESS=NO, when a user who is not logged on submits a request from a published launch page, they will be presented with the Managed Reporting logon page. After their credentials are successfully validated, the report will be run automatically and they will remain logged on to Managed Reporting. In scenarios where single sign-on is configured (for example SiteMinder integration) the user will be logged on to Managed Reporting transparently.

The setting is only valid for HTTP requests, which means it is not supported with Managed Reporting API and Web Service requests.


Top of page

Magnify Settings

The WebFOCUS Administration Console enables you to configure WebFOCUS 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 WebFOCUS Magnify license key must be entered in the License Management window for the Magnify section to display in the WebFOCUS Administration Console.


Top of page

Reference: Magnify General Settings

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.

magnify_search_engine

The search engine configured with Magnify. The selections are:

  • Built-In Lucene (The Lucene search engine is included with WebFOCUS Magnify.)
  • Google Search Appliance (You must purchase this product separately.)
magnify_search_engine_url
URL to the Google Search Appliance. This is only active for Google Search Appliance (GSA).
magnify_root
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.
magnify_config

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

magnify_stylesheet_dir

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.

magnify_stylesheet

Name of the WebFOCUS Magnify style sheet (XSLT) used to display the search results page look and feel. (If you are using the Google search engine, this is the style sheet that was imported to the GSA.)

Do not include file extensions or spaces in this value. The default style sheet is magnify_stylesheet.

magnify_lucene_index_dir

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.

magnify_recordlimit

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.

magnify_feed_cache_dir

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. 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 &IBI_DOCUMENT_ROOT/magnify/feedcache.

magnify_generate_deltas

A flag that determines if a log file is created (true) or not (false) to record the changes made while feeding the Lucene index. The default value is false.

magnify_deltas_dir

The directory that contains the log files that record the index changes made while feeding the Lucene index. The default value is &IBI_DOCUMENT_ROOT/magnify/deltas.

magnify_required_cookie
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.
magnify_required_cookie_redirect
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.

Top of page

Reference: Magnify Lucene Security Settings

WebFOCUS 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.

Security Plug-in Name

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.

Java Class Name
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.
Realm Information

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.

Time to wait for response

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.

Optional Parameters

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.

Userid

Type a valid userid. If this field is populated, the userid is passed to the security plug-in. This field is optional.

Password

Type a valid password. If this field is populated, the password is passed to the security plug-in. This field is optional.

Notification Email Address(es)

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.

Reply to Email Address

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.

Allowed Failures

Type the number of failure attempts that must occur before Magnify Search:

  • Declares that the security plug-in experienced a catastrophic failure.
  • Stops calling the failed security plug-in until a retry occurs at a fixed time period.
  • Suppresses all of the data that the security plug-in is responsible for authorizing from the search results.

This field is optional and it must be populated with a positive numeric value when provided.

Time to wait before retry

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