The WebFOCUS Client installation creates configuration files, several of which contain settings that you can use to customize WebFOCUS for your environment. The starting point for locating client configuration files is defined in ibiweb.cfg.
You can use the Configuration section of the WebFOCUS Administration Console to:
All default global settings generated by installing WebFOCUS are located in \ibi\webfocus\client\wfc\etc\cgivars.wfs.
The following table describes the configuration files that may be customized using the WebFOCUS Administration Console. For information on accessing the WebFOCUS Administration Console, see WebFOCUS Administration Console.
File Name |
Location of File (Windows) |
Description |
---|---|---|
webconfig.xml |
\ibi\WebFOCUS\config |
WebFOCUS application settings file. It specifies configuration parameters required by various components of the WebFOCUS application. For more information, see Changing Application Settings in the WebFOCUS Administration Console. |
odin.cfg |
wfc\etc\ |
WebFOCUS communications file. It specifies the WebFOCUS Reporting Servers to which the WebFOCUS Client can connect. For more information, see WebFOCUS Reporting Server Settings. |
ibiweb.cfg |
wfc\web\cgi |
Initial configuration file loaded by the CGI, ISAPI, or servlet. It is used to:
For more information about ibiweb.cfg, see Changing WebFOCUS Client Settings in the WebFOCUS Administration Console. |
cgivars.wfs |
wfc\etc |
Contains default global settings. This file is updated when the WebFOCUS Administration Console is used to modify the WebFOCUS environment. For more information about cgivars.wfs, see Changing WebFOCUS Client Settings in the WebFOCUS Administration Console. |
mime.wfs |
wfc\etc |
Contains information about available MIME types. For more information about mime.wfs, see Changing Redirection Settings. |
site.wfs |
wfc\etc |
Used to define site-specific behavior for WebFOCUS script processing. For more information about site.wfs, see Changing WebFOCUS Client Settings in the WebFOCUS Administration Console. |
nlscfg.err |
wfc\etc |
Contains National Language Support (NLS) settings. For more information about nlscfg.err, see Configuring National Language Support. |
ibimultilanguage.js |
ibi\WebFOCUS\ ibi_html\javaassist\ |
Used to customize the Dynamic Language Switch settings. For more information, see Customizing the Dynamic Language Switch. |
mrAdminFlags.js |
ibi\WebFOCUS\ibi_html\ workbnch
|
Used to specify the type of interface administrators will have to the Managed Reporting tools. |
mrdeveloperflags.js |
ibi\WebFOCUS\ibi_html\ workbnch
|
Used to specify the type of interface developers will have to the Managed Reporting tools and the ReportCaster User Interface. |
cgipath.js |
ibi\WebFOCUS\ ibi_html\javaassist\ |
Used to specify whether Managed Reporting and ReportCaster are installed, and configure the WebFOCUS and ReportCaster context roots. You can also configure the WebFOCUS Client for the CGI, ISAPI, or Servlet path. For more information, see WebFOCUS Utilities. |
Caution: Do not edit the following WebFOCUS Client files, as they are for internal use only. Note that the names of some of these files are proceeded by a language prefix (for example, en for English).
File Name |
Location of File (Windows) |
Description |
---|---|---|
default.wfs |
wfc\etc |
Invokes a WebFOCUS Reporting Server request. |
ibicommd.wfs |
wfc\etc |
Contains WebFOCUS Reporting Server connection information. It is invoked by a WebFOCUS Reporting Server Sign-on, or from default.wfs. |
ibidir.wfs |
wfc\etc |
Processes variables defined in cgivars.wfs. |
ibstdd.wfs |
wfc\etc |
Loaded after ibiweb.cfg and is responsible for loading ibidir.wfs, cgivars.wfs, mrsso.wfs, and mime.wfs. |
install.cfg |
WebFOCUS\config |
Records the parameters used for WebFOCUS installation. Has no effect on operations. |
vcplow |
wfc\etc |
Used for On-demand paging. |
Reference: |
The Application Settings menu enables administrators to update configuration settings that are required by various components of the WebFOCUS web application. The web application settings are stored in the install_drive:\ibi\WebFOCUS\config\webconfig.xml file.
In Release 7.6.nn and earlier, these settings were configured in the WebFOCUS \ibi\WebFOCUS76\webapps\webfocus76\WEB-INF\web.xml file. Moving the settings to the webconfig.xml file enables administrators to modify settings for the WebFOCUS web application even after it has been deployed.
Initially, WebFOCUS reads the webconfig.xml file to locate the parameter(s) and its value(s). If the parameter does not exist in the webconfig.xml file, WebFOCUS will then obtain the parameter and its value from within the web.xml of the deployed WebFOCUS web application.
Choose the Application Paths category to edit or view the following settings.
Choose the Security category to edit or view the following setting.
Choose the Portal category to edit or view the following setting.
Choose the ReportCaster category to edit or view the following setting.
The client configuration settings are grouped into categories under the Configuration menu in the WebFOCUS Administration 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.
Choose the Cookie category to view or edit the following settings.
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.
Choose the General category to view or edit the following settings.
The administrator can change the backup directory to another location. However, the conf directory must be created under the new location.
Note: If you change this setting and you deploy the ibi_html.war or approot.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, see Configuring WebFOCUS in a Split Web-Tier and Application Server-Only Environment in the WebFOCUS installation manual for your platform.
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:
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.
_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.
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.
The WebFOCUS 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.
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.
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.
Specifies the application server to be used to zip the file components that comprise an EXCEL 2007 file (.xlsx) as follows:
&URL_PROTOCOL//:servername/alias/IBIEXCELSERVURL
where:
IBIF_EXCELSERVURL cannot 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 EXCEL 2007 file. IBIF_EXCELSERVURL can be used with Basic authentication when the credentials are supplied as follows:
http:// userid:password@host:port/alias/ IBIEXCELSERVURL
However, this is not recommended since the password is displayed as plain text in the WebFOCUS Administration Console and the Web server logs.
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 Reporting Applications With Developer Studio manual.
Choose the Graph category to view or edit the following settings.
IBIF_graphengine can also be set in the Client Settings Graph panel located in the Configuration section of the WebFOCUS Administration Console.
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.
...\ibi\WebFOCUS\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.
For more information, see WebFOCUS Reporting Server Settings.
Choose the Multiple Reports category to view or edit the following settings.
Choose the OLAP category to view or edit the following settings.
Choose the On Demand Paging category to view or edit the following settings.
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.
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.
Choose the Parameter Prompting category to view or edit the following settings.
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.
Choose the Performance category to view or edit the following settings.
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.
Choose the Plugin category to view or edit the following settings.
For more information about writing a WebFOCUS plug-in, see Developing Your Own WebFOCUS Plug-in.
For more information about writing a WebFOCUS plug-in, see Developing Your Own WebFOCUS Plug-in.
Choose the Web Services category to view or edit the following setting:
Choose the ReportCaster category to view or edit the following settings.
All Magnify settings are available in the Magnify section of the WebFOCUS Administration Console. For more information, see Magnify Settings.
Choose the WebFOCUS Quick Data category to view or edit the following settings.
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.
Note: Only one Managed Reporting Logon menu is presented per WebFOCUS Administration Console session.
How to: |
A WebFOCUS site profile is sent to the WebFOCUS Reporting Server by the WebFOCUS Client and is executed on the WebFOCUS Reporting Server. It can override settings and variables in the WebFOCUS Reporting Server profiles and process WebFOCUS amper variables. WebFOCUS Reporting Server profiles cannot process variables.
Set _site_profile as follows
_site_profile = -INCLUDE PROFILE
where:
For more information about _site_profile, see Editing WebFOCUS Client Custom Settings.
Note: If you want the profile to launch a WebFOCUS procedure, IBIF_ex is generally used by self-service applications and IBIF_adhocfex is used by Managed Reporting, OLAP, and Developer Studio. ReportCaster is not supported. Once you have completed these steps, the profile procedure (or procedures) automatically execute. There is no need to restart or recycle the server. 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.
How to: Reference: |
The initial configuration file loaded by the WebFOCUS Client is ibiweb.cfg. The WebFOCUS installation program only inserts ADMINISTRATORS, IBIWFC_AUTHENTICATION, TRACE_LOCATION, and DEVELOPERS into ibiweb.cfg. The console displays all of the options that can be configured in ibiweb.cfg. You can then configure them if necessary.
To modify a configuration setting. Select the setting (for example, ENCRYPT_WF_USER) and then click Modify. The Modify Settings window appears with the selected setting.
At installation time, the parameters marked optional are not in the ibiweb.cfg file. Modifying them adds them into the file.
To remove a setting. Select the setting (for example, ENCRYPT_WF_USER) and then click Remove Setting. Only settings marked optional can be removed and only if they have been modified (until you modify them, they are not in ibiweb.cfg). If you attempt to remove a setting that is not optional, a message displays telling you that you cannot remove the setting. Settings are removed from the ibiweb.cfg file, but not from the Console display. However, to indicate that they have been removed, the word optional next to the setting no longer appears.
You can modify the setting after it has been removed and it will be added back into ibiweb.cfg.
The following settings may be added, modified, or deleted in the ibiweb.cfg file:
DEVELOPERS = [*|dev1;dev2]
For information about requirements for developer IDs, see the description of the IBIWFC_AUTHENTICATION parameter.
* - Signifies that any user ID is valid.
dev1;dev2 - Are user IDs that can access the resources under the Quick Links menu. In Developer Studio, these user IDs can issue application commands.
For more information about application commands, see the Developer Studio Application Development Getting Started manual.
For information about requirements for administrator IDs, see the description of the IBIWFC_AUTHENTICATION parameter.
admin1;admin2 - Are the user IDs that can issue configuration commands and application commands.
where:
The MR User Log files are created in the location specified by the TRACE_LOCATION variable. The names of the log files have the following format:
mr_user_MMDD[_HH].log
where:
ON - Turns tracing on.
OFF - Turns tracing off. It is the default value.
Also, setting TRACE=ON overrides the CONNECTOR_TRACE setting. When TRACE=ON is set, the Client Connector trace information is included within the trace file of the component (for example, WFServlet) that uses the WebFOCUS API (WFAPI) to make use of the client connector.
The WF_USER cookie is not encrypted by default.
Reference: |
The mime.wfs file contains information about format types available with WebFOCUS. Setting the redirect column to yes for a specific extension enables redirection, which allows you to save report output in a temporary directory when a request is executed. Then, an HTTP call is made from the browser to retrieve the temporary stored output for display in the browser. If redirection is turned off (set to no), the report output displays in the browser immediately after the request is executed. The len value for the IBIWF_redirect setting stores report content in the temporary directory when it exceeds the buffer size and then sends the output to the browser without an additional HTTP call.
For more information about these values, see the descriptions of the IBIWF_sendbufsize and IBIWF_redirect variables in General Settings in cgivars.wfs.
Note:
In Version 7 Release 6.7 and Version 7 Release 6.8, the WebFOCUS Administration Console does not have the option to encrypt the mime.wfs file and cannot display the information when mime.wfs is encrypted. This change is because of internal changes required to add SAVE AS functionality for the Save Report option in the Redirection Settings panel. As a result, the ENCRYPT check box was removed from the Redirection Settings panel, but was added back in Version 7 Release 6.9. To edit the Redirection Settings using the WebFOCUS Administration console, you must first manually decrypt the mime.wfs.
To access the redirect setting using the WebFOCUS Administration Console, click Configuration and then Redirection Settings.
In the Redirection Settings panel:
For example, specifying ON TABLE PCHOLD AS MYREPORT FORMAT PDF in a request and setting Save Report to yes for the .pdf extension enables a user to open or save the output as MYREPORT.pdf. The AS name specified is returned to the browser in uppercase. If Save Report is set to yes and no AS name is specified in the request, a random file name is generated.
Important: You must do the following to utilize Save Report functionality for WebFOCUS GRAPH requests (specified with a PNG, SVG, GIF, JPEG, or JPG format in the procedure):
Running a server-side GRAPH request creates an HTM file that contains a link to the actual graph output, which is stored as a temporary image file with a .jpeg, .jpg, .gif, .svg, or .png extension.
The following describes different product behaviors when utilizing Redirect and Save Report functionality with EXCEL, EXL2K, EXL2K TEMPLATE, and Excel 2007 report formats:
The prompt displays when the Excel 2007 content-type information associated with the report output is not recognized by an application on the end user machine. The user can click Save and save the report using an .xlsx extension. The report can then be opened from the file system once the .xlsx file type has been associated with the Microsoft Excel application.
Note: In WebFOCUS 7 Release 6.10, the EXL2K Pivot format uses the SET WEBARCHIVE=ON command by default and therefore does not need to be added to the report procedure.
Note: In WebFOCUS 7 Release 6.10, the EXL2K Pivot format uses the SET WEBARCHIVE=ON command by default and therefore does not need to be added to the report procedure.
Otherwise, an error message displays with the xml file for the pivot table specifying that there are problems loading the file. You can click OK to load the report, but when accessing the pivot table in the report the following error message displays:
The PivotTable Report is not valid.
To create multiple workbooks in Microsoft Excel, set the Save Report option to yes for following WebFOCUS extensions:
Note: When the Save Report option is set to yes, it is recommended that you use the AS command for each request so that each report output contains an assigned name. If the AS command is not specified, the name of the report output is randomly generated.
Setting the Save Report option to yes allows users to compare the output of multiple workbooks simultaneously. By default, a new Excel session opens in a separate Excel window. This behavior may be different for users who expect Excel to start as a Web browser plug-in. However, users can select the different view options available under the Windows menu in Microsoft Excel to see the different report outputs in the same window pane.
You can customize the default global settings for WebFOCUS using the \ibi\webfocus\client\wfc\etc\site.wfs file. You would use site.wfs to override cgivars.wfs for a specific user or request.
To override the default global settings in the cgivars.wfs file, click Configuration and then Custom Settings. The settings in the site.wfs file appear. Make the necessary changes (after the <VER 1> tag) and then click Save.
The following settings may be added to site.wfs:
Settings |
Description |
---|---|
MR_USER_ADMIN |
Enables the MRCEXT1 exit. This is not set by default. Note that this exit is available to self service applications only. It is not supported by Managed Reporting. |
_HTML_COMMENT_VAR |
Displays as an HTML comment, and is generally used for debugging purposes. |
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. |
SIGNON_CORRECT |
HTML page that opens after a successful sign-on. |
URL_PROTOCOL |
Default URL protocol (http or https). By default, this is automatically set by WebFOCUS on the incoming request. |
ENCRYPT |
If you select the ENCRYPT check box, the site.wfs file will be encrypted. When you access the file again using the console, it will be decrypted for you to view, and the ENCRYPT check box will still be selected. If you edit the site.wfs file outside of the console, its contents will be encrypted. On z/OS, you must decrypt a file using the same implementation of the WebFOCUS Client that was used to encrypt it. |
Tip: You can use WebFOCUS Script (WFS) commands with WebFOCUS Client settings in site.wfs (recommended) or cgivars.wfs to further customize processing and control of the WebFOCUS Client. For more information, see WebFOCUS Script Commands.
WebFOCUS |