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\WebFOCUS77\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\WebFOCUS77\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\WebFOCUS77\ ibi_html\javaassist\ |
Used to customize the Dynamic Language Switch settings. For more information, see Customizing the Dynamic Language Switch. |
mrAdminFlags.js |
ibi\WebFOCUS77\ ibi_html\workbnch
|
Used to specify the type of interface administrators will have to the Managed Reporting tools. |
mrdeveloperflags.js |
ibi\WebFOCUS77\ 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\WebFOCUS77\ 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\WebFOCUS77\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.
Location of Application Namespace root directory on the Web server where WebFOCUS is installed. The default location is ibi_apps, unless a different directory was specified during the installation of the WebFOCUS Client.
Context root for the ReportCaster web application. This value and the one specified by the ReportCaster Context root parameter in the Client Selection section of the Utilities menu and the context root on the application server must be the same.
Alias used to locate WebFOCUS resources on the Web server.
Alias of the WebFOCUS Web application.
Location of translated files required to access the WebFOCUS client in different languages. The default location is install_drive:/ibi/ibi_html/javaassist/intl.
Location of the Managed Reporting Change Management package. The default location is install_drive:/ibi/WebFOCUS/utilities/cm/extract.
Location of repository content, previously known as custom_data_path. This variable is set to the parent of the worp directory, which includes Business Intelligence users, groups, and views. It can be used by Managed Reporting to locate where the basedir directory resides. Typically used in a clustered environment to point to a shared directory containing the basedir directory and worp subdirectories.
Location of temporary files when running a WebFOCUS request. For example, redirected requests are written to this location. The default location is install_drive:/ibi/WebFOCUS/temp. This value and the one specified by the CGI_TEMP_DIR parameter in the General section of the Client Settings menu must be the same.
Directory where trace files are written.
Used to locate the WebFOCUS configuration files, such as cgivars.wfs.
Path to the WFServlet servlet in the WebFOCUS application. The default value is /ibi_apps/WFServlet.
Choose the Security category to edit or view the following settings.
Enables the PKI filter which will extract the attribute specified in PKI_userid_source and put the value into the REMOTE_USER variable. Managed Reporting and ReportCaster must be configured to use the REMOTE_USER variable for logon separately. For more information, see Configuring Trusted Authentication.
Specifies a list of IP addresses, separated by semi-colons, that will be allowed to pass the PKI filter even if there is not a valid client certificate in the request. The ReportCaster distribution server IP address must be included in this list for the ReportCaster distribution server to be able to retrieve Managed Reporting content. A sample list might look like:
127.0.0.1;127.0.0.2
If an IP address is not specified here and a client certificate is not provided, the PKI filter will return a 403 forbidden error when accessed.
Specifies the certificate attribute that should be retrieved into REMOTE_USER for the userid. The possible values are:
The common name for the certificate. For example,
Joe.Smith.1122334455
The userPrincipalName attribute from the Subject Alternate Name section of the certificate. For example,
1122334455@mil
Due to the way the UPN is encoded, you must have a copy of the Bouncy Castle Java Cryptography library within your classpath. It can be downloaded from their website at http://www.bouncycastle.org/java.html.
When set to YES, the WebFOCUS Client verifies that the MR_COOKIE and the WF_COOKIE are associated with the correct session identifier. This additional verification step prevents potential cookie replay and cookie hijacking vulnerabilities. The default value is NO.
Choose the Portal category to edit or view the following setting.
Removes the domain prefix and suffix from a user ID when using Windows authentication to connect to your portal environment (for example, as user IBI\john_smith). The default value is FALSE.
Specifies the IP address from which the WebFOCUS client allows a Open Portal Services request. The default value is 127.0.0.1.
Enables the use of the WebFOCUS Open Portal Services Gateway. The use of a gateway is required when the WebFOCUS client and the portal server are residing on two separate machines. If the WebFOCUS client and the portal server are installed on the same system, installing a gateway is not required. The default value is YES.
Choose the ReportCaster category to edit or view the following setting.
ReportCaster Agent Listener node. This value and the one specified by the AGENT_NODE parameter in the ReportCaster section of the Client Settings menu must be the same.
ReportCaster Agent Listener port. This value and the one specified by the AGENT_PORT parameter in the ReportCaster section of the Client Settings menu must be the same.
When enabled, this variable restricts the exchange of cookies to only HTTPS sessions. This variable is not set by default.
Represents the WebFOCUS installation time in milliseconds.
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.
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 re-entered in order to continue using WebFOCUS.
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.
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.
Path(s) on the server to which the cookie will be sent. By default, WebFOCUS sets the path to the root directory ("/").
When enabled, this variable restricts the exchange of cookies to only HTTPS sessions. This variable is not set by default.
Choose the General category to view or edit the following settings.
Location of the temporary directory.
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.
Location of the root directory for HTML and Java language files.
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_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.
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:
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.
For internal use only. This setting is only for Japanese or Korean languages.
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.
Deletes files from the temporary directory. Files are deleted if they are older than the number of seconds specified.
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).
Points to the HTML page that opens after a successful sign-on occurs.
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.
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.
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).
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.
Overrides the CGI/ISAPI/WFServlet client path for every redirected request.
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.
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.
Controls how many WebFOCUS Reporting Server message lines 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.
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:
Is HTTP.
Is the name of the application server where the WebFOCUS Client is installed.
Is the context root of the WebFOCUS application. The default is ibi_apps.
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, WebSEAL). 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.
Note: For more information on IBIF_excelservurl, see the Creating Reports with WebFOCUS Language manual.
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 Administration Console.
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 want their developers to see only their own projects and applications in a shared development environment, may 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.
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.
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 Reporting Applications With Developer Studio manual.
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.
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:
Choose the Graph category to view or edit the following settings.
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 the WebFOCUS Reporting Server.
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.
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 below.
Specifies the number of pre-started agents available for graph processing.
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.
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.
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.
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:
...\ibi\WebFOCUS77\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.
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. MYREPORT is the default value.
Specifies the maximum number of columns per page in multi-frame reports. 1 is the default value.
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.
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.
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.
Is the number of vertically stacked reports when IBIWF_mreports is set to FRAME.
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.
Choose the OLAP category to view or edit the following settings.
The OLAP Control Panel is permanently displayed while running an OLAP report when set to YES. NO is the default value.
Location of the OLAP panel (top, bottom).
Enables administrators to preview and set a new color scheme for OLAP components, such as the OLAP Control Panel.
Choose the On Demand Paging category to view or edit the following settings.
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.
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.
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.
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.
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.
Choose the Parameter Prompting category to view or edit the following settings.
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.
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.
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.
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.
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.
Overrides the client path for CGI, ISAPI, or WFServlet for WebFOCUS AUTOSIGNON feature.
Choose the Performance category to view or edit the following settings.
Enhances request processing for the WebFOCUS Reporting Server.
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.
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.
Choose the Plugin category to view or edit the following settings.
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 WebFOCUS Client. 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 versus right/left strings).
For more information about writing a WebFOCUS plug-in, see Developing Your Own WebFOCUS Plug-in.
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.
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:
Specifies whether to Base64 encode the SOAP response from the WebFOCUS web service. The default value is NO.
Choose the ReportCaster category to view or edit the following settings.
ReportCaster Agent Listener node.
ReportCaster Agent Listener port.
FTP alias that is used to store ReportCaster files.
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.
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.
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.
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.)
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.
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:
Is the name of the WebFOCUS site profile. The PROFILE file name must have a .fex extension.
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]
Specifies user IDs that can access quick links. This setting also controls certain Developer Studio features, such as the ability to deploy an application and write to the Web server directories. If you change this setting from an asterisk (*) to a list of developer user IDs, then these features will be available only to the specified developer user IDs. Developers can set these WebFOCUS Client credentials under the WebFOCUS Environments properties in Developer Studio.
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.
Admin is the default value.
For information about requirements for administrator IDs, see the description of the IBIWFC_AUTHENTICATION parameter.
admin1;admin2 are user IDs that can issue configuration commands and application commands.
Optionally specifies the authentication method used to verify the administrator or developer user IDs.
where:
Is the default value, which means that no password authentication is desired.
Indicates authentication against the default WebFOCUS Reporting server. Any user IDs stored in the ADMINISTRATORS and DEVELOPERS parameters must be able to connect to the default WebFOCUS Reporting Server (IBI_REPORT_SERVER).
Indicates authentication against a particular WebFOCUS Reporting Server. Only one EDANODE may be listed. If an EDANODE has been specified, then any user IDs stored in the ADMINISTRATORS and DEVELOPERS parameters must be able to connect to that EDANODE.
Indicates Web server authentication. If using the WFServlet, J2EE role based security is required for the WEB setting. Any user IDs stored in the ADMINISTRATORS and DEVELOPERS parameters must be able to connect to the Web server specified in the WebFOCUS configuration.
Indicates Web server authentication against the userid found in the HTTP variable you specify in the input box.
Indicates WebFOCUS Administration Console authentication against the Managed Reporting user ID.
This log should be enabled only when requested by a customer support representative. It determines whether a log file of user actions is created and, if so, how frequently:
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:
Is the value of the IBIMR_user variable.
Is a two-digit number to indicate the month. The first month of the year is JANUARY, which is 01.
Is a two-digit number to indicate the day of the month. The first day of the month has the value 01.
Is shown when the HOUR value of the MRUSERLOG variable is chosen. HH is a two-digit number to indicate the hour of the day using the 24-hour clock. For example, at 10:04:15.250 PM, HH is 22.
Used to enable and disable tracing. This setting includes WFAPI and client connector traces (NGXXJ or JLINK) and is set automatically when you enable or disable traces using the trace options under the Diagnostics menu. Tracing can be turned on or off at any time (the Web server does not need to be restarted). Every request generates a new trace file.
ON - Turns tracing on.
OFF - Turns tracing off. It is the default value.
When this setting is ON, connector traces (NGXXJ or JLINK) are enabled. This trace can also be enabled using the Client Connector trace option under the Diagnostics menu.
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.
When this setting is ON, procedure traces are enabled. You use the trace panel itself to enable the procedure trace. Doing so automatically updates this variable. OFF is the default value. The procedure trace writes the output procedure sent to the WebFOCUS Reporting Server to the trace file. It contains only the packaged request and is used only for debugging purposes.
Setting this variable to YES encrypts the WebFOCUS user cookie (WF_USER).
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 the 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\WebFOCUS77\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 |