In this section: |
This chapter explains verification and common configuration procedures for the WebFOCUS Client.
In this section: |
In a split web-tier environment, all WebFOCUS web components run through the application server, and you should not create the ibi_html and approot aliases on a web server. Instead you configure your application server to serve the content in the directories.
The steps for configuring WebFOCUS to run in an application server only configuration is similar to split web-tier in that you configure the application server to serve static content from the ibi_html and apps directories. This is described in Using the Static Content Server Option.
The one difference is where the ReportCaster Default Library URL is pointing. With split web-tier, this setting points to the web server. In an application server only configuration, it points to the application server.
WebFOCUS installs a pair of web applications into the install_directory/ibi/WebFOCUS80/webapps directory, which are designed to serve static content from the file system to the browser:
Deploy one or both of these applications to address the following split web-tier and standalone application server configurations:
Note: Tomcat can be used by itself without these applications because it can map a directory on the file system to a context path.
Each application includes a deployment descriptor (webconfig.xml) that is used to locate the directory containing its configuration file. The context parameter IBI_Configuration_Directory in webconfig.xml is updated during installation to point to install_directory/ibi/WebFOCUS80/config, which contains the configuration file approotConfig.xml. The configuration file is shared by both content server applications even though its name suggests it would be used by only one. The configuration file is used to maintain MIME mappings, the physical path of the directories being served, and the logging level.
The applications also include a Log4J property file (log4j.xml), which contains the path to the log file used by each application. The installation updates each log4j.xml file with the path to its own log file, install_directory/ibi/WebFOCUS80/logs/wfapproot.log and install_directory/ibi/WebFOCUS80/logs/wfibihtml.log, respectively.
The content server applications roll the log files over daily by appending the date to the log file and creating a new one (for example, wfibihtml.log.2010-10-31). You can increase the log level by editing install_directory/ibi/WebFOCUS80/config/approotConfig.xml and changing the log level setting to DEBUG, INFO, WARN, ERROR, or FATAL, where DEBUG is the most verbose.
Generally speaking, the approach of specifying a fully qualified path to the configuration file (approotConfig.xml) in webconfig.xml and of specifying a fully qualified path to the log files in log4j.xml is sufficient for most installations. These paths are properly set during installation.
However, there is an option to pass the content servers these paths from the Java VM command line. To do this, complete the following steps:
<context-param> <param-name>IBI_Configuration_Directory</param-name> <param-value>${IBIARCFG}</param-value> </context-param>
<param name="File" value="${IBIARLOG}/wfapproot.log"/>
<param name="File" value="${IBIARLOG}/wfibihtml.log"/>
–DIBIARCFG=install_directory/ibi/WebFOCUS80/config –DIBIARLOG=install_directory/ibi/WebFOCUS80/logs
In this section: |
To configure WebFOCUS Client, you edit files either through a text editor or using the WebFOCUS Administration Console. The WebFOCUS Administration Console also provides tools to verify the installation.
For NLS configuration information, see the WebFOCUS Security and Administration manual.
WebFOCUS Version 8.0 contains a Welcome page in the WebFOCUS BI Portal from which you can access WebFOCUS interfaces, such as the WebFOCUS Administration Console.
http://hostname:port/ibi_apps/
where:
Are the host name and HTTP port of the web server or application server. If you require SSL, use https instead of http.
Note: If you receive a page not found error, ensure that your application server is started and that you have deployed the WebFOCUS application. For more information on configuring your application server, see Installing the WebFOCUS Client.
Note: If you receive an invalid user name or password error, ensure that the WebFOCUS repository has been created and contains initial table data. For more information, see WebFOCUS Repository Post-Installation Tasks.
The WF BI Portal page displays, as shown in the following image.
You can change the default credentials using the Security Center facility. Click Administration from the top menu, and then Security Center. For more information, see the WebFOCUS Security and Administration manual.
The following procedure explains how to access the WebFOCUS Administration Console.
You can also manually enter the following URL in your browser:
http://hostname:port/ibi_apps/console/webfocusconsole.jsp
The WebFOCUS Sign In page opens, as shown in the following image.
If a logon page does not appear, ensure your web and/or application servers are started and configured.
Note: After you have verified the WebFOCUS Client configuration, change the password of the default administrator user ID, which is admin. For more information on WebFOCUS Client security, see the WebFOCUS Security and Administration manual.
The WebFOCUS Administration Console opens, as shown in the following image.
Using this console, you can edit WebFOCUS Client communication and security settings. This console is documented in the WebFOCUS Security and Administration manual and relevant sections are available by clicking Help.
The WebFOCUS Administration Console contains a verification tool to further test the configuration.
For troubleshooting assistance, see Troubleshooting WebFOCUS and ReportCaster.
It is a good idea to set authentication for the WebFOCUS Administration Console. The WebFOCUS Administration Console does not have its own authentication mechanism and, by default, none is used.
If you wish to set authentication for the console, you can choose to do it through the WebFOCUS Reporting Server or the web server. For more information, see the WebFOCUS Security and Administration manual.
WebFOCUS Client communication settings are stored in the following file:
/install_directory/ibi/WebFOCUS80/client/wfc/etc/odin.cfg
This file contains node blocks defining WebFOCUS Reporting Servers that the client accesses. A node block is a set of parameters that define a server, listener, or other communication component.
When you installed the WebFOCUS Client, you specified a default WebFOCUS Reporting Server that the client accesses. If this is the only server the client will access, you can proceed to Configuring Static Authentication.
To change connection information for the default server or define additional servers, use the procedures that follow.
The right pane displays all defined WebFOCUS Reporting Servers. To edit parameters of a defined WebFOCUS Reporting Server, select its radio button and click Modify.
This page lets you choose to define a single server (Client), CLM Processing, or a Cluster node. A cluster node is a node that consists of multiple servers. When the client accesses the cluster, it chooses one of the servers in that cluster. This is used for load balancing and fail over. The best way to use clusters is through the Cluster Manager component that you can optionally add to your WebFOCUS environment.
The remaining fields are optional in most environments.
Note: Setting the User ID and Password here is not recommended and may not have the desired result.
When you make a connection from client to server without specifying a server, the default server is used. The default server and many other settings are set in the following file:
/install_directory/ibi/WebFOCUS80/client/wfc/etc/cgivars.wfs
The following variable specifies the default server:
IBI_REPORT_SERVER
To set this using the WebFOCUS Administration Console:
When the client accesses a WebFOCUS Reporting Server running with security, the client must log on to the server for tasks such as browsing metadata, listing files, or running reports. Either your applications or users can provide a log on, or you can use Static Authentication. With Static Authentication, you specify a user ID and password that the client always passes to the server. This can be set for all servers or for each individual server. Static authentication ensures that every WebFOCUS Client connection to a server accesses the server using the same environment configuration.
Note: In some environments, you may be able to use Trusted Authentication (Already Verified Processing) instead of Static Authentication. For more information, see the WebFOCUS Security and Administration manual. This section only addresses static authentication.
The following variables define static authentication:
IBI_REPORT_USER IBI_REPORT_PASS
You should set these variables using the WebFOCUS Administration Console so that you can encrypt the file containing your password. Static authentication is defined globally for all nodes in the cgivars.wfs file. Static authentication can be defined for a specific node by creating a profile with the node name.
These steps set a logon that is used when accessing all servers.
These steps set a logon that is used when accessing a specific node (a server or a cluster).
The right pane displays defined WebFOCUS Reporting Servers.
IBI_REPORT_USER=your_user_id
IBI_REPORT_PASS=your_password
For additional information on using the WebFOCUS Administration Console, click Help or see the WebFOCUS Security and Administration manual.
Although most WebFOCUS Client features are configured through the WebFOCUS Administration Console, some features are enabled and configured through the WebFOCUS Reporting Server. If you license Active Technologies, you must provide the Active Technologies license code in the WebFOCUS Reporting Server Web Console.
This console was introduced in How to View the Web Console and Test the Server.
As a default, Apache Tomcat sets the maximum size limit to 2097152 (2MB) limit for accepting HTTP POST requests. Since EXL07 MIME files can easily reach this limit, ExcelServlet will fail with a HTTP 400 error or produce a corrupted .XLSX file. To fix this problem, Tomcat needs to be configured by setting an attribute in the server.xml file.
In the /tomcat_home/conf/server.xml file, confirm or add the maxPostSize attribute and set it to 0 to disable the limit check. For example, in the <Connector port> element block:
<Connector port="8080" protocol="HTTP/1.1"
connectionTimeout="20000"
redirectPort="8443" maxPostSize="0" />
In this section: |
This section explains how to enable, verify and troubleshoot the most common type of graphics. By default, WebFOCUS graphics are generated through the Web or application server using a Java-based graph engine installed with WebFOCUS Client. This is known as Server Side Graphics or PCHOLD. Using this approach, a complete graph file is created on the Web or application server and then sent to a browser.
For the graph engine to create Server Side Graphics, you must either set DISPLAY or use the headless Java VM option:
To set DISPLAY, you must configure a VNC Server and the Native Abstract Windowing Toolkit (NAWT) on your IBM i machine. Then you must set the DISPLAY and other variables to connect to and use the VNC server. This configuration supports all WebFOCUS graph options.
or
To set DISPLAY, you must configure a VNC Server and the Native Abstract Windowing Toolkit (NAWT) on your IBM i machine.
Note: You can optionally install a VNC client on a PC to test the VNC server connection to IBM i.
MKDIR DIR('/home/userid') (if it does not exist)
MKDIR DIR('/home/userid/.vnc')
where:
Is the user ID that will start the VNC server.
CHGAUT OBJ('/home/user/.vnc') USER(wsuser) DTAAUT(*RWX) OBJAUT(*ALL) SUBTREE(*ALL)
where:
Is the user ID that will start the VNC server.
Is the user ID under which the application server runs.
QAPTL/VNCPASSWD USEHOME(*NO) PWDFILE('/home/userid/.vnc/passwd')
where:
Is the user ID that will start the VNC server.
VNC on IBM i acts as a server which renders characters and lines that would be displayed on screen.
ADDENVVAR ENVVAR(DISPLAY) VALUE('systemname:n')
where:
Is the display number to be used for the VNC server, which must match the display number used when the VNC server is started.
ADDENVVAR ENVVAR(XAUTHORITY) VALUE('/home/userid/.Xauthority')
where:
Is the name of the user directory where the .Xauthority file was created.
CALL PGM(QP2SHELL) PARM('/QOpenSys/QIBM/ProdData/DeveloperTools/vnc/vncserver_java' ':n')
where:
Is the display number to be used for the VNC server. Display numbers must be an integer ranging from 1 to 99.
Note: A confirmation message will be displayed.
CHGAUT OBJ('/home/user/.Xauthority') USER(wsuser) DTAAUT(*RWX) OBJAUT(*ALL)
where:
Is the user ID that started the VNC server.
Is the user ID under which the application server runs.
The Native Abstract Windowing Toolkit (NAWT) lets Java applications use the Abstract Windowing Toolkit (AWT) graphic functions on a host that does not have a graphical user interface.
To test the Native Abstract Windowing Toolkit (NAWT):
ADDENVVAR ENVVAR(DISPLAY) VALUE('systemname:n')
ADDENVVAR ENVVAR(XAUTHORITY) VALUE('/home/userid/.Xauthority')
where:
Is the display number to be used for the VNC server.
Is the user ID that will start the VNC server.
JAVA CLASS(NAWTtest) CLASSPATH('/QIBM/ProdData/Java400')
A QSH session will open up and the following will be displayed:
jpgName will be /tmp/NAWTtest.jpg JPG construction is complete Java program completed
This process will produce a JPG file named NAWTtest.jpg in the /tmp directory. You can download this file to a PC and view it in a Web browser or JPEG file viewer.
For now you can keep the VNC Server running. However, when you wish to stop it, run the following:
CALL PGM(QP2SHELL) PARM('/QOpenSys/QIBM/ProdData/DeveloperTools/vnc/vncserver_java' '-kill' ':n')
where:
Is the port number that the VNC server is using.
You need to make the following entries to WebSphere Application Server for the WebFOCUS servlets to use Server Side Graphics.
http://hostname:port/ibm/console
Add two new value pairs:
Name |
Example Value |
Explanation |
---|---|---|
DISPLAY |
HOSTNAME:0.0 |
Value to match the system and VNC server port you are using. |
XAUTHORITY |
/home/user/.Xauthority |
Location of the .Xauthority. Usually in the user home directory. |
You must make the following entries to the Tomcat Application Server for the WebFOCUS servlets to use Server Side Graphics.
You may need to create setenv.sh as a new file.
export DISPLAY=hostname:nexport XAUTHORITY=/home/user/.Xauthority
where:
Is the display number assigned when the VNC server was started.
Is the user name that started the VNC server.
GRAPH FILE CAR SUM RCOST ACROSS COUNTRY ON TABLE PCHOLD FORMAT GIF END
If you receive the following:
E SRVE0026E: [ServletError]-[Could not find class: sun.awt.X11GraphicsEnvironment]: java.lang.Error:Could not find class: sun.awt.X11GraphicsEnvironment java/lang/Throwable.<init>(Ljava/lang/String;)V+4(Throwable.java:85)
The class for the graphics environment was not found. Ensure the WebSphere CLASSPATH includes the path to the /qibm/ProdData/Java400/jdk14/RAWTAHost.jar file. Ensure to use the correct file for the version of Java that WebSphere requires.
These errors may also appear after opening InfoAssist or running a graph procedure.
E SRVE0026E: [Servlet Error]-[Can’t connect to X11 window server using 'System:1.0' as the value of the DISPLAY variable.]: java.lang.InternalError: Can't connect to X11 window server using 'System:1.0' as the value of the DISPLAY variable.
“NOT AN IBFS ERROR”
This error points to the VNC server not being started, the VNC server not using the specified port, the VNC server not starting properly, the .Xauthority file not being read correctly, or the application server does not have READ access to the .Xauthority. Ensure you set the environment variables and start VNC in batch. There should be no errors in the VNC server log files. If there are, restart the server, and troubleshoot the error. Make sure that the user ID running WebSphere has *RWX authority to the .Xauthority file.
Tips: Be aware of the following:
If an X Server is not available, the headless option must be set. This is a Java VM option and not a WebFOCUS-specific feature, which must be set in the application server.
You must use the WebSphere Administrative Console to set the following JVM property:
java.awt.headless=true
As of WebSphere 6.0, the default value is true.
java.awt.headless
If an X Windows Server is not available, you can set the headless Java VM option. However, be aware that headless does not support GIF files or the older WebFOCUS graph engine (GRAPH32). Open the following file in a text editor:
/TOMCAT_HOME/bin/catalina.sh
You can add the headless option by setting the $JAVA_OPTS variable. Near the beginning of the file, just after the commented section, add the following line:
export JAVA_OPTS="${JAVA_OPTS} -Djava.awt.headless=true"
GRAPH FILE CAR SUM RCOST ACROSS COUNTRY ON TABLE PCHOLD FORMAT JPEG END
Your browser should display a graph similar to the following image.
If you get an errors:
WebFOCUS |