customizing web view 5 5 2

Upload: parvathi12

Post on 03-Jun-2018

217 views

Category:

Documents


0 download

TRANSCRIPT

  • 8/12/2019 Customizing Web View 5 5 2

    1/57

    Vista Plus

    Customizing Web View

    This document discusses how to modify or customize certainareas of Vista Plus Web Views behavior. Some of this

    information is highly technical in nature. This document doesnot describe how to install or use Web View.

    50051552.1

    March 2011

  • 8/12/2019 Customizing Web View 5 5 2

    2/57

    Copyright 2007-2011 Open Text Corporation. All rights reserved. This software product and documentation islicensed subject to the terms of the license agreement shipped with the product.

    Open Text Corporation is the owner of the trademarks Open Text, The Content Experts, Open Text ECM Suite, Open TexteDOCS, eDOCS, Open Text FirstClass, FirstClass, Open Text Exceed, Open Text HostExplorer, Open Text ExceedOnDemand, Open Text Exceed 3D, Open Text Exceed Freedom, Open Text Exceed PowerSuite, Open Text Exceed XDK,Open Text NFS Solo, Open Text NFS Client, Open Text NFS Server, Open Text NFS Gateway, Open Text Everywhere, OpenText Real Time, Open Text Eloquent Media Server, Open Text Integrated Document Management, Open Text IDM, OpenText DocuLink, Livelink, Livelink ECM, Artesia, RedDot, RightFax, RKYV, DOMEA, Alchemy, Vignette, Vizible, Nstein,LegalKEY, Picdar, Hummingbird, IXOS, Alis Gist-in-Time, Eurocortex, Gauss, Captaris, Spicer, Genio, Vista Plus,Burntsand, New Generation Consulting, Momentum Systems, DOKuStar, and RecoStar among others. This list is notexhaustive.

    Open Text Corporation provides certain warranties and limitations in connection with the software that this documentdescribes. For information about these warranties and limitations, refer to the license agreement entered into between thelicensee and Open Text Corporation.

    Written by Robert Shelton

    Contacting Us

    Corporate HeadquartersOpen Text Corporation275 Frank Tompa DriveWaterloo, Ontario, CanadaN2L 0A1

    (519) 888-7111

    If you subscribe to our Software Maintenance Program or would like more information about additional supportprograms, visit Open Text Customer Support at http://www.opentext.com/services/support.html.

    If you have suggestions for this publication, send an e-mail message to [email protected] to contact the OpenText Publications Group.

    Visit our home page at http://www.opentext.com for more information about Open Text products and services.

    Program Version: 5.5.2

    Document Version: En-03Publication Date: March 2011

  • 8/12/2019 Customizing Web View 5 5 2

    3/57

    Customizing Web View i

    Table of Contents

    Introduction ............................................................................................................................. 1General Procedures......................................................................................................... 1Assumptions and Prerequisites........................................................................................1

    Changing Logo Images ......................................................................................................... 2Changing Field Width.............................................................................................................4Modifying the Login Page......................................................................................................5

    Information Required for Login .......................................................................................5Setting the Start Page for All Users.................................................................................. 7Using Defined Connections for Login............................................................................. 8Forcing the Host and Port................................................................................................ 9Creating a Custom Login Page.................................................................................... 10Other Login Methods .....................................................................................................11

    Integrating Tomcat with IIS ..................................................................................................12To integrate Tomcat with IIS 5.................................................................................12To integrate Tomcat with IIS 6.................................................................................14

    Single Sign On........................................................................................................................ 15Vista Plus Server Setup ...................................................................................................15Web Server Setup........................................................................................................... 16

    SSO and IIS Authentication..................................................................................... 16SSO and SiteMinder Authentication ......................................................................18SSO and Load Balancing........................................................................................24

    Web View Setup .............................................................................................................25Removing the Web View Change Password Option ....................................................... 26Customizing Browse View or My Vista View....................................................................... 28

    XML Data List Formats ....................................................................................................28Folders, Reports, and Bundles.................................................................................29Favorites ....................................................................................................................30Bundle Instances......................................................................................................30Bundle Components................................................................................................32

    Modifying the Display..................................................................................................... 33Adding or Removing Columns ...............................................................................35Changing Column Order........................................................................................39Changing Column Width........................................................................................39Showing or Hiding Empty Reports .......................................................................... 41

    Adjusting Tomcat Servlet Engine Memory Settings...........................................................42For Tomcat 5.5.x on a Windows Web Server ............................................................... 42For Tomcat 5.5.x on a UNIX Web Server.......................................................................42

    If You Use a Third-Party Version of Tomcat......................................................................... 43If You Use WebLogic.............................................................................................................44

  • 8/12/2019 Customizing Web View 5 5 2

    4/57

    Table of Contents

    ii Customizing Web View

    Changing the Web Application Time-out Setting.............................................................46Forcing Dates for Multi-Generation Searches ...................................................................47

    Changing the Object Display Order .................................................................................. 48Changing How TransVue Files Are Displayed....................................................................49Index....................................................................................................................................... 51

  • 8/12/2019 Customizing Web View 5 5 2

    5/57

    Customizing Web View 1

    IntroductionThis document describes procedures for customizing and modifying the operation of Vista PlusWeb View.It does not describe how to use or install Web View. For Web View installationinstructions, please see the Vista Plus Server Installation Guide. For information on using Web View,please see the Web View online help.

    General Procedures

    Before making any changes to Web View, install the unmodified Web View software and makesure it is functioning properly. Do not make changes to the Web View files before you know if WebView works in its default configuration!

    Most procedures discussed in this document involve changing one or more of the Web View files

    on the Web server where Web View is installed. Before making any change to any of these files,always make a backup copy of the original, unchanged file. That way, if your modifications do notwork as planned, you can always return to the original, working file.

    Even after it is clear that your modified files are working correctly, do not remove the copy of theoriginal file; if a problem occurs later, you may need to replace the modified file with the originalto see if that corrects it.

    Assumptions and Prerequisites

    This is a technicaldocument; it describes modifying the HTML, JSP, and XML files which make upthe Web View product. It assumes that anyone attempting to follow these instructions has a basicknowledge of how these technologies work.If you are unsure about any aspect of the change youwant to make, please contact Vista Plus Technical Support before proceeding.

    Unless otherwise stated, all file paths in this document start from the Web View root directorycreated when the vp_web.warfile is installed on the Web server. For example, if you are using theApache Tomcat servlet engine, this would be the webapps/vp_webdirectory under the Tomcatinstallation directory.

  • 8/12/2019 Customizing Web View 5 5 2

    6/57

    Changing Logo Images

    2 Customizing Web View

    Changing Logo ImagesThe Vista Plus and Open Text Corporation logos are included in various images in several placesin Web View. If desired, you can remove or change these logos by changing the application to calldifferent image files.

    Each image file is named in the srcattribute of an tag in a Web Viewjspfile. Eachtag also includes the image height and width; to maintain the overall appearance of theWeb View display, the replacement image file should be as close to the size of the original image aspossible. Also, we suggest you use unique, easily-identifiable names for your new image files, so itwill be easy to remake the appropriate changes if necessary after an upgrade. The image files youuse can be GIF, PNG, or JPG files; you can create them by modifying a copy of the original imagefile or by creating a new file. In most cases, we recommend you modify a copy of the original sothe colors and any unmodified parts of the image match the original exactly. Be sure the imageresolution in your new file matches the resolution in the original file.

    For example, you can modify thelogin.jspfile to call a different image to replace the Vista Plus logoon the startup page. This is the section of the file; the image file names are shown in bold blue:

    Just replace the image file name with the name of your new image file. Note that the image sizestays the same:

    Note Important!Before making any changes to any of the files listed below, make a backupcopy of the original file, so you can replace the modified file with the original file ifnecessary.

    Tip It is also possible to change the images by creating a new image file with the samename as the logo image being called by Web View; you then do not need to modify the

    jspfiles at all. However, we recommend you do not use this method, as the originalimage file will no longer exist with its proper location and name, making it moredifficult to remove the modification if you want to do so. It can also make it harder tomaintain the customized images after an upgrade.

    The table below lists the logo-related images called by the various Web View files. All file pathsstart from the Web View root directory. Notice that the same image file is sometimes called bymore than onejspfile. Images are not shown actual size, and are not in scale to each other.

  • 8/12/2019 Customizing Web View 5 5 2

    7/57

    Changing Logo Images

    Customizing Web View 3

    Note It is technically possible to change the color scheme and all background images forWeb View. However, we recommend you do notattempt to do this; there are noinstructions for it in this document.

    JSP File Path Image File Path Image and Notes

    login.jsp

    Front.jsp

    images/main/vp_web_front_01.gif

    This is one large image. You could replace orremove the name while maintaining theoverall look. For example:

    images/main/vp_web_front_05.gif

    Again, you can replace or remove the name:

    ExplorerTopFrame.jsp

    MyVistaTopFrame.jsp

    search/GenFindTopFrame.jsp

    OptionsContainer.jsp

    images/top_nav_right.gif

    The white in this image is actuallytransparent.

    About.jsp images/Qlogo.jpg

    ReportButtonBar.jsp images/vistalogo.gif

  • 8/12/2019 Customizing Web View 5 5 2

    8/57

    Changing Field Width

    4 Customizing Web View

    Changing Field WidthBy default, the page number field at the bottom of the Report Viewer window can display pagenumbers of four digits or less. If you have reports containing over 10,000 pages, you may want toincrease the width of this field. To do so, find this line in the ReportNavigator.jsp file:

    Change the SIZEattribute as desired. Setting it to 5 allows larger page numbers:

    Note that even if only four digits are shown in the field, the user can type in page numbers longerthan this and they will be accepted and the report viewer will show the correct page.

    Other text input fields have a similar SIZEvalue, or a WIDTHvalue, which can be adjusted ifnecessary. However, be sure to test any change you make, as changing the size of one field caneffect the placement of other fields or information, or possibly prevent information from showingcompletely. As with any change to Web View, be sure to back up the original file before makingany changes!

  • 8/12/2019 Customizing Web View 5 5 2

    9/57

    Modifying the Login Page

    Customizing Web View 5

    Modifying the Login PageGenerally, users log in to Web View by calling up the login page, login.jsp, and filling in the host,port, user name, and password to use. The most common customization of the login.jspfile willprobably be to define a list of connections for users to pick from when logging in, but other

    changes are also possible. You can also give users a way to log in to Web View without usinglogin.jspat all.

    The following sections first describe the information required for login, then discuss some of themodifications you may wish to make to login.jsp. Setting up Web View for single sign on is moreinvolved and is not covered in these sections; see page 15for information on single sign on.

    Information Required for Login

    The following section of login.jsp(with some comments removed) shows the information requiredto log in to Web View. Weve separated it into numbered sections to better illustrate the variousfunctions which must be performed for login.

    1

    2

    3

    4

    !-- Arguments for login from a server list -->

    defaultConnection>

    5 normal

    Development

    localhost

    7980

  • 8/12/2019 Customizing Web View 5 5 2

    10/57

    Modifying the Login Page

    6 Customizing Web View

    1. Either a POST or GET method can be used to login to Vista Plus. However, the GET methodleaves login information, including the password, in the address bar of the browser, exposing

    sensitive information. We recommend using POST.

    2. This section defines the page to be displayed after login. In this example, this is set to the pageselected by the user (LoginForm.USER_DEFINED).

    3. This section contains the prompt strings for the user name and password. These are passed tologin.xsl. These values are required unless you are using single sign-on; see page 15forinformation on setting up single sign-on.

    4. This section contains the prompt strings for the host and port. These are passed to login.xsl.

    5. This section determines whether users must enter the host and port, or select from a list ofdefined connections. It also defines the possible connections. See page 8.

    6. This section displays the Submitbutton, which must be used to submit the form. The

    appearance of the button depends heavily on style sheets.The following sections describe ways you can modify login.jspor otherwise modify the loginprocedure. As with any change to Web View, be sure to back up the original file before making anychanges!

    Production

    palau

    7980



    6

  • 8/12/2019 Customizing Web View 5 5 2

    11/57

  • 8/12/2019 Customizing Web View 5 5 2

    12/57

    Modifying the Login Page

    8 Customizing Web View

    Using Defined Connections for Login

    Instead of having users type the host name and port number for the server to log in to, you candefine a list of available connections(host/port combinations) and have users select the connectionfrom a list of connection names. This insulates users from the technicalities of host and port and

    lets you assign easy-to-understand names (such as Sales, Accounting, Production, and so on) toeach Vista Plus warehouse.

    To make this change, you will modify values in section 5 of login.jsp, as highlighted below. Thissection includes two sample connections and looks like this:

    normal

    Development localhost 7980

    Production Prod1 7980

    The typesetting and the information for the two sample connections are shown in bold blue type.Define the Vista Plus report warehouses by changing the connection name, host, and port givenfor the samples. We recommend you use the fully qualified name for the Vista Plus server host,rather than a local name. That way, users connecting from anywhere will be sure to be connectedto the correct host. To define more than two possible connections, copy one of the sampledefinitions and modify the copy. After completing the connection definitions, change the typesetting from normalto list. Here is a sample showing three defined connections, with changedvalues highlighted:

    list

    Test System eng.example.com 7981

    Engineering eng.example.com 7980

    Sales sales.example.com 7980

  • 8/12/2019 Customizing Web View 5 5 2

    13/57

    Modifying the Login Page

    Customizing Web View 9

    Once youve made these changes, instead of seeing the Hostand Portprompts on the login screen,users will see a Serverfield where they can select a connection name, like this:

    Note Users opening Web View via an e-mail favorite will see the Hostand Portfieldsinstead of the Serverfield. This is because the URL in the e-mail message includes thehostname and port number, not a connection name.

    Forcing the Host and Port

    If all users will be logging in to the same host and port, you may want to set these values so usersdo not have to enter them or select a connection. To do so, follow the instructions in the previoussection to create a connection list, but include only one entry in the list. This will allow all users tolog in only to that host and port.

    If desired, you can also remove the Serverfield from the login screen. To do so, you must edit thelogin.xslfile in the stylessubdirectory of the Web View directory. (As when changing any Web View

    file, make a backup copy of the file first!) Find this section of code about two-thirds of the waydown the file:

    You need to make two changes:

    Remove the reference to hintConnection; this is not needed since there will not be a Serverfield.

    Change the style of the connection field so it is hidden.

  • 8/12/2019 Customizing Web View 5 5 2

    14/57

    Modifying the Login Page

    10 Customizing Web View

    Here is the resulting section of the file:

    As mentioned in the previous section, even when Web View normally displays the Serverfield, itdisplays the Hostand Portfields when started from an e-mailed URL. You can hide the host andport fields in this case by making another change to login.xsl. (Do this only if you are using the

    Serverfield, or setting a single connection and hiding the field.) Near the top of the file, find thissection:

    true

    false

    Change this section so the value of the showHostportvariable is always false. This involvessetting the value and removing the xsl:choosefield; this reduces the section to a singlestatement. Here is the result:

    false

    Creating a Custom Login Page

    If for some reason you do not want to use login.jsp, you can construct a custom login page using anHTML or JSP file. The file must include code to set the start page, host, port, user name andpassword, as described above under Information Required for Login, and it must submit thesefields to the required POST location, the login.doservlet. The appearance of the login screen andthe method of setting the field values is entirely up to you. For example, you could hard code thehost and port information and provide only user and password text fields and a mechanism forsubmitting the form (usually a submit button).

    Note The and tags are specific to JSP and Web View. If youare using a custom login file which is not ajspfile, or is not in the Web View rootdirectory, you should replace these with hard-coded text.

  • 8/12/2019 Customizing Web View 5 5 2

    15/57

    Modifying the Login Page

    Customizing Web View 11

    Other Login Methods

    The simplest way to log in to Web View is via a URL which contains all the necessary information.This URL would be in this form (without any spaces or line breaks):

    http://Webservername/WebViewPath/login.do?user=name&password=pass&

    host=machine.domain.com&port=number

    For example:

    http://www.example.com/WebApps/WebView/login.do?user=Admin&password=secret&

    host=www.VistaPlus.example.com&port=7980

    You can construct this URL using any method: an ASP or JSP page, a Perl script, and so on. It canbe submitted via a link, a button, or any other appropriate method.

  • 8/12/2019 Customizing Web View 5 5 2

    16/57

    Integrating Tomcat with IIS

    12 Customizing Web View

    Integrating Tomcat with IISWeb View does not require a Web server to work. It can be accessed via a URL such ashttp://server:8080/vp_web/login.jsp , which goes directly to the Tomcat Applicationsserver, bypassing any Web server software which may also be present. However, in some

    situations, you may want to integrate Tomcat with a Web server. Some reasons for doing this are:

    Implementing Single Sign On, as described starting on page 15.

    To allow you to redirect an existing Vista Plus URL (such as one previously used for the JavaClient) to invoke Web View. Contact Customer Support for some information on redirecting aURL to Web View.

    As part of implementing Web View using SSL browsing.

    The following steps integrate Tomcat with IIS. There are separate procedures for IIS 5 and IIS 6.

    Note Important!Integrating Tomcat with IIS does not, by itself, implement secure SSLbrowsing with Web View. We have not tested, and do not support, Web View and SSLbrowsing.

    Note This procedure does not involve any Web View files in any way. It affects only Tomcatand IIS. It is included here because it is necessary if you want to use single sign onwith Tomcat and IIS.

    To integrate Tomcat with IIS 5

    1. Download the Tomcat extras for IIS integration. Contact Vista Plus Technical Support forinformation on acquiring this file.

    2. Execute the MSI file to install the extras. You can install it in any directory; the default isC:\Program Files\Apache Software Foundation\Jakarta Isapi Redirector. From here on, we willrefer to the installation directory as Redirector.

    3. Open the Redirector\conf\workers.properties.minimalfile using a text editor.

    4. Add ajp13wto the line beginning worker.list. For example:worker.list=wlb,jkstatus,ajp13w

    Save and close the file.

    5. Open the Redirector\conf\uriworkermap.propertiesfile using a text editor.

    6. Add any Web sites that IIS needs to serve to Tomcat and assign them to worker ajp13w. ForWeb View, add these lines to the end of the file:

    /vp_web=ajp13w

    /vp_web/*=ajp13w

    Save and close the file.

    7. You need to add the ISAPI filter isapi_redirect.dll to the server's IIS manager. To do so, from theWindows Task Bar, select Start, Run. Enter inetmgrand click OKto start the InternetServices Manager.

    8. In the tree view on the left, right-click the server name and select Properties.

    9. In Master Properties, select WWW Service. Click Edit.

    10. Click Add.

  • 8/12/2019 Customizing Web View 5 5 2

    17/57

    Integrating Tomcat with IIS

    Customizing Web View 13

    11. On Filter Properties, for File Nametype Jakarta Redirectand for Executabletype thepath to the Redirector\bin\isapi_redirect.dllfile.

    12. Click OK.

    13. Right-click the server name again. Select Restart IIS. This should change the status for thenew isapi filter from red to green.

    14. Stop and restart the Tomcat service:

    From the Start menu, select Settings, Control Panel, Administrative Tools, Services.

    Right-click the Apache Tomcat service and select Restart.

    15. Stop and restart IIS:

    If you closed the Internet Services Manager, run inetmgrto open it (see step 7).

    Right-click the server name and select Restart IIS.

    This completes the integration. You should now be able to access Web View through IIS. To testthis, in your Web browser, try to start Web View by entering:

    http://servername/vp_web

    Notice that there is no 8080after the server name in the URL.

  • 8/12/2019 Customizing Web View 5 5 2

    18/57

    Integrating Tomcat with IIS

    14 Customizing Web View

    To integrate Tomcat with IIS 6

    1. Download the Tomcat extras for IIS integration. Contact Vista Plus Technical Support forinformation on acquiring this file.

    2. Execute the MSI file to install the extras. You can install it in any directory; the default is

    C:\Program Files\Apache Software Foundation\Jakarta Isapi Redirector. From here on, we willrefer to the installation directory as Redirector.

    3. Open the Redirector\conf\workers.properties.minimalfile using a text editor.

    4. Add ajp13wto the line beginning worker.list. For example:

    worker.list=wlb,jkstatus,ajp13w

    Save and close the file.

    5. Open the Redirector\conf\uriworkermap.propertiesfile using a text editor.

    6. Add any Web sites that IIS needs to serve to Tomcat and assign them to worker ajp13w. ForWeb View, add these lines to the end of the file:

    /vp_web=ajp13w

    /vp_web/*=ajp13w

    Save and close the file.

    7. From the Windows Task Bar, select Start, Run. Enter inetmgrand click OKto start theInternet Services Manager.

    8. In the tree view on the left, right-click Web Sitesand select Properties.

    9. Click the Servicetab.

    10. Check the box Run WWW service in IIS 5.0 isolation mode. Click OK.

    11. In the tree view on the left, right-click Web Service Extensionand select Add a new use.

    12. On the New Web Service Extension dialog, type a name for the extension, such as Jakarta-Tomcat.

    13. Click Add.

    14. For the Path to file, browse to or enter the path to the isapi_redirector.dllfile in the Redirectordirectory. Click OK.

    15. Check the Set extension status to Allowedbox. Click OKto save the new extension and closethe dialog.

    16. Stop and restart the Tomcat service:

    From the Start menu, select Settings, Control Panel, Administrative Tools, Services.

    Right-click the Apache Tomcat service and select Restart.

    17. Stop and restart IIS:

    If you closed the Internet Services Manager, run inetmgrto open it (see step 7).

    Right-click the server name and select Restart IIS.

    This completes the integration. You should now be able to access Web View through IIS. To testthis, in your Web browser, try to start Web View by entering:

    http://servername/vp_web

    Notice that there is no 8080after the server name in the URL.

  • 8/12/2019 Customizing Web View 5 5 2

    19/57

    Single Sign On

    Customizing Web View 15

    Single Sign OnIntranet users are commonly required to use a separate password to authenticate themselves oneach server they access. Multiple passwords are an ongoing headache for both users and systemadministrators. Users have difficulty keeping track of different passwords, tend to choose poor

    ones, and sometimes write them down in obvious places. Administrators must maintain aseparate password database on each server and deal with potential security problems related tothe fact that passwords are sent over the network routinely and frequently.

    Solving this problem requires some way for a user to log in once, using a single password, and getauthenticated access to all servers he or she is authorized to usewithout sending any passwordsover the network. This capability is known as Single Sign On (SSO).

    Enabling SSO for Web View, so that users who have already logged on to the network do not haveto log in to Web View separately, requires special setup in three areas:

    Vista PlusYou must create Vista Plus user names which match the names used to sign on tothe network.

    Web site securityYou must set up the Web server environment so only users who have

    logged onto the network and been authenticated can start Web View. Web ViewYou must modify the WEB-INF/web.xmlfile to enable SSO.

    The following sections describe each of these steps in more detail.

    Note SSO is not the same as the external authentication method of user authorization whichcan be set for individual users on the Vista Plus server. With SSO, the Vista Plus serverdoes not perform any authorization check for a user at all; it trusts that this hasalready been done. With external authentication, Vista Plus passes the user name andpassword to an external program for authentication and allows access only if thatexternal program indicates that it should. For more information on externalauthentication, see the Maintaining Users chapter of the Vista Plus Server

    Administration Guideand the External Password Authorization section of the VistaPlus Technical Addendum.

    Vista Plus Server Setup

    You must do two things on the Vista Plus server before you can use single sign on. First, you mustenter the necessary user names. The Vista Plus user name for each user must have a matching username in the authentication store for the network. A Vista Plus Administrator can create these VistaPlus users using either vadmin or Server Admin. For example, if a user is authenticated by a webserver as CORPORATE\john.smith, then there mustbe a corresponding CORPORATE\john.smith user name in Vista Plus. Since Vista Plus user names are case-sensitive, the Vista Plus user namemust match the case used on the authentication store.

    With SSO, there will be no checking of passwords on the Vista Plus server, so the password in theVista Plus user record can be anything. For normal users (not Administrators) who will be usingonly Web View, and who will not have access to the Windows Client, you do not need to enter anypassword. Be sure to enter other user information, such as Home folder or primary group, asnecessary for each user.

    In addition to creating the required user names, you must set a value in the server.cfgfile to enablesingle sign on for this Vista Plus server. Add the statement ALLOW_SSO=1. You must restart theVista Plus server after making this change.

  • 8/12/2019 Customizing Web View 5 5 2

    20/57

    Single Sign On

    16 Customizing Web View

    Web Server Setup

    When SSO is enabled in Web View (see page 25), Web View does not perform any authenticationcheck for any users: it just logs the user into the Vista Plus server using his or her network username as the Vista Plus user name. Therefore, it is essential that your network authenticate every

    user before he or she can access the Web View server location.Weve tested three Web server security mechanisms with Web View SSO: Windows NT LANManager (NTLM) via IIS internal security, NTLM via Netegrity SiteMinder, and LDAP viaNetegrity SiteMinder. The following procedures describe how to configure SSO in an IIS nativeauthentication environment and in a SiteMinder authentication environment.

    SSO and IIS Authentication

    This is a sample procedure for the Tomcat servlet engine; it assumes you already have Tomcat andWeb View installed and running successfully, and just need to make the changes necessary forSSO. It also assumes you are using IIS 6. Other servlet engines or Web servers may requiredifferent procedures.

    1. Make sure the necessary user names have been entered on the Vista Plus server; see VistaPlus Server Setup on page 15.

    2. Configure Tomcat to be integrated with IIS, as described starting on page 12.

    3. Edit the Tomcat\conf\server.xmlfile. (Tomcatis the Tomcat installation directory.)

    4. Find the section of defining the AJP 1.3 connector (as shown below). AddtomcatAuthentication=falseto the definition, as shown:

    5. Save your change and close the file.

    6. Stop and restart the Tomcat service: From the Start menu, select Settings, Control Panel, Administrative Tools, Services.

    Right-click the Apache Tomcat service and select Restart.

    7. From the Windows Task Bar, select Start, Run. Enter inetmgrand click OKto start theInternet Services Manager.

    8. Right-click the Web site that contains theJakarta Redirectvirtual directory and selectProperties.

  • 8/12/2019 Customizing Web View 5 5 2

    21/57

    Single Sign On

    Customizing Web View 17

    9. Select the Directory Securitytab, then click the Editbutton.

    10. Clear the Anonymous accesscheck box.

    11. For best results using NTLM, check Integrated Windows authentication.

    12. Click OKtwice.

  • 8/12/2019 Customizing Web View 5 5 2

    22/57

    Single Sign On

    18 Customizing Web View

    13. Restart IIS:

    Right-click your server and select Restart IISfrom the pop-up menu.

    On the Stop/Start Reboot dialog, select Restart Internet Services on server.

    Click OK.

    You can test your configuration by pointing your browser to the TestHttpHeaders.jsppage underyour Web View URL, for example, http://localhost/vp_web/TestHttpHeaders.jsp . The Remote Userfield should show the user name that was authenticated by IIS and passed through to Web View.

    SSO and SiteMinder Authentication

    To use Netegrity SiteMinder, you must use New Atlantas ServletExec as the servlet container forthe application. ServletExec integrates with IIS and iPlanet Web servers; it is available on theSiteMinder 5.x installation CD or can be downloaded at https://support.netegrity.com. Theprocedure below assumes that Servlet Exec is installed and configured, and Web View is working

    correctly without SSO enabled.Note Important!Follow the procedure below only if you are familiar with using Netegrity

    to protect Web assets. This procedure outlines the necessary steps and shows many ofthe screen displays, but does not include complete, detailed instructions.

    Note In this example, we will be protecting assets (Web View) on Microsofts InternetInformation Server (IIS). We use IIS as the primary web server, using ServletExecsISAPI adaptor for IIS. The vp_web.warfile is unzipped to C:\Program Files\New

    Atlanta\ServletExec ISAPI\webapps\default\vp_web, and the web application is calledvp_weband made available via http://machineName.example.com/vp_web.

    1. Make sure the necessary user names have been entered on the Vista Plus server; see VistaPlus Server Setup on page 15.

    2. Make sure SiteMinder is properly installed and configured to run with the appropriate webserver application.

    https://support.netegrity.com/https://support.netegrity.com/
  • 8/12/2019 Customizing Web View 5 5 2

    23/57

    Single Sign On

    Customizing Web View 19

    3. Configure Netegrity to protect the ServletExec resource:

    Ensure the Web Agent is configured correctly for the Web server application.

    Make sure the correct Agent Configuration Object is present and the cookie domain isproperly configured.

    If there is not already a User Directory object to use for authentication and/orauthorization, create one. The sample screens below show the creation of an LDAP userdirectory using iPlanets Directory Server.

  • 8/12/2019 Customizing Web View 5 5 2

    24/57

    Single Sign On

    20 Customizing Web View

    Create a Policy Domain to use the appropriate User Directory, and create a Realm to beused to specify the directory to protect. Be sure to use the appropriate Resource Filterand Authentication Scheme settings for your environment.

  • 8/12/2019 Customizing Web View 5 5 2

    25/57

    Single Sign On

    Customizing Web View 21

  • 8/12/2019 Customizing Web View 5 5 2

    26/57

    Single Sign On

    22 Customizing Web View

    In the Domain configuration, create a Rule under the target domain to protect theappropriate resource; in this example, the resource is called vp_web. This is the samedirectory (in our example, C:\Program Files\New Atlanta\ServletExecISAPI\webapps\default\vp_web) which is made available to the Web Server viaServletExec.

    Next you must create a Policy. This involves specifying access privileges for users andbinding the above rule to the policy (effectively saying These people have/dont haveaccess to the directory specified in the rule vp_web realm.)

  • 8/12/2019 Customizing Web View 5 5 2

    27/57

    Single Sign On

    Customizing Web View 23

  • 8/12/2019 Customizing Web View 5 5 2

    28/57

    Single Sign On

    24 Customizing Web View

    4. Restart IIS. This is not required, but you may see odd behavior if you dont.

    Right-click your server and select Restart IISfrom the pop-up menu.

    On the Stop/Start Reboot dialog, select Restart Internet Services on server.

    Click OK.

    5. To test the setup, start your Web browser and open the Web View URL(http://machineName.example.com/vp_web). With basic authentication, you will see somethinglike:

    After logging in, you will see the Web View start page that you selected or that was configured bythe administrator.

    SSO and Load Balancing

    Many companies deploy Web View in a load-balanced environment, with two or more Web Viewservers behind a load balancer. This can present a problem when used with SSO. The load

    balancer needs to send requests to each server to see which one is most available. These requestsdo not include sign-on information, which means they will fail if sent to a URL which isconfigured to use SSO.

    One way to avoid this problem is to set up a second Web site on each Web View server, using adifferent port than Web View. This dummy Web site needs to contain only a keepalive.htmfile. Do

  • 8/12/2019 Customizing Web View 5 5 2

    29/57

    Single Sign On

    Customizing Web View 25

    not configure SSO for the dummy Web site. The load balancer can then use the dummy Web site tocheck for server availability before routing the actual Web View connection to the most availableserver.

    While we know this solution works in some situations, it may or may not be practical or effectivewith all combinations of Web servers and load balancers. You may need to contact Open TextGlobal Services and/or your Web server or load balancer vendor for help in configuring yourenvironment.

    Web View Setup

    Setting up Web View for SSO consists of modifying a single file,WEB-INF/web.xml. Below is thesection of this file you will need to modify. The four values shown in bold blue type are the onesyou must change. As with any change to Web View, be sure to back up the original file beforemaking any changes!

    ENABLE_SINGLE_SIGN_ON

    true. . .

    defaultTarget

    -1 . . .

    host

    machineName.domainName.com . . .

    port

    7980 . . .

    trueThis parameter tells Web View you want to use SSO. Set it to true, as shown, to enableSSO; set it to false to require users to log in to Web View. If this is set to false, the otherparameters in this file have no effect; the host, port, and start page are taken from login.jsp, asdescribed on pages 7and 9.

    -1This parameter sets the start page users see when they launch Web View. The 1valueshown allows users to select their own start page. You can force a particular start pageMyVista view, Browse view, or the Welcome pageby changing this value. See Setting the StartPage for All Users, on page 7, for the list of possible values.

    machineName.domainName.comThis is the host name for the Vista Plus server to connect

    to. To make sure the links in e-mail favorites work correctly for all users, wherever they areconnecting from, we recommend including the full domain name, as shown.

    7980This is the port number of the Vista Plus installation to connect to on the host. 7980 isthe default port number for Vista Plus, but it could be different.

    After making these changes, save and close the file. Stop and restart the servlet engine or Webserver to make the changes take effect.

  • 8/12/2019 Customizing Web View 5 5 2

    30/57

    Removing the Web View Change Password Option

    26 Customizing Web View

    Removing the Web View Change Password OptionIf all Web View users use either operating system passwords or a user supplied authorizationmodule (such as the Vista Plus LDAP Authentication module) for authentication when they log into Web View, you may want to remove the Change Passwordoption from the Web View page.

    Having this feature available could lead users to believe they can change their operating system orother password from inside Web View, which is not the case. The Change Password featurechanges only the users Vista Plus password, which has no effect when a different authorizationmethod is being used.

    To remove the Change Password feature, you remove (comment out) the definition of its tab in theOptionsContainer.jsp file.

    Tip As always, before making any of the changes described below, make a backup copy ofthe original file, so you can replace the modified file with the original file if necessary.

    1. Open the file OptionsContainer.jsp in a text editor.

    2. Find this section of the file:

    >/span>

    3. Comment out the section defining the Change Password tab. After the change, the section willlook like this. The change is highlighted in blue:

  • 8/12/2019 Customizing Web View 5 5 2

    31/57

    Removing the Web View Change Password Option

    Customizing Web View 27

    key='chGroup.title'/>

    --%>

    4. Save your change and close the file.

    You do not need to restart Tomcat to make the change take effect. Anyone with Web Viewcurrently open will see the change when they refresh their browser page.

  • 8/12/2019 Customizing Web View 5 5 2

    32/57

    Customizing Browse View or My Vista View

    28 Customizing Web View

    Customizing Browse View or My Vista ViewWeb Views Explorer interface can display five different types of lists, four in Browse view,depending on the type of object, and one in the right-hand pane of My Vista view:

    The combined folder/bundle/report list shown when a folder is selected. The generations in a report

    The instances of a bundle

    The components of a bundle instance

    The favorites list shown in the right pane of My Vista view

    The Explorer interface receives data for these listsexcept the generation listin XML (eXtensibleMarkup Language) format and uses an XSLT (eXtensible Stylesheet Language Transformation) toformat the data for display. Changing or reformatting the information shown in a list (adding orremoving columns or changing column width) requires changing the XSL file which controls thedisplay of that type of list.

    Note Generation lists are not displayed using XML and XSL; it would be too slow when

    listing a large number of generations. You cannot modify the generation list display.Note Important!The sections that follow assume you have a basic understanding of XML

    and XSL concepts and techniques.

    As always, before making any of the changes described below, make a backup copy ofthe original file, so you can replace the modified file with the original file if necessary.HTML, and therefore XSL, is very delicate and an extra or missing character could

    break the entire page.

    XML Data List Formats

    Each XML data stream received by the Web View Explorer interface has the same general format:

    . . .

    . . .

    . . .

    The column_headersection contains the definition of each column which can be displayed for thetype of data being sent in this listfolders, reports, and so on. This list generally includes morecolumns than are actually displayed by Web View. Each column heading is a string taken from

    Web Views properties file; the actual string depends on the language being used.The item_listcontains the actual data for each itemretrieved from the Vista Plus server. Withineach itemare a number of fields; the number of fields and the information they contain dependson the type of item. For all items, more information is provided than can be displayed; there arefields for which there are no column headers. In the folder/bundle/report data stream and thefavorites data stream there are two item lists, one for folders and bundles and a separate one forreports.

  • 8/12/2019 Customizing Web View 5 5 2

    33/57

    Customizing Browse View or My Vista View

    Customizing Web View 29

    The instructions below (following the detailed descriptions of the data formats) explain how toadd a column to the display if there is an entry in the column header table for that piece ofinformation. For example, there is a create_timecolumn defined for the folder/report list, but thatcolumn is not generally shown; you can add it using the instructions in this document. However,these instructions do not tell you how to add a piece of information to the display if it is included

    in the item data section but there is no column header defined for it. Displaying this data requiresa change to the XML list generator, which is beyond the scope of this document.

    The following sections describe in detail the format of each type of data list. You cannot changethis format; it is included here because you need this information to know how to change the XSLfile to add, remove, or modify display columns.

    Folders, Reports, and Bundles

    When a folder is selected in Browse view, Web View lists the folders, bundles, and reports in thatfolder. In this case, the data stream sent to Web View contains the column headers and two itemlists: one containing folders and bundles (bundles are saved in Vista Plus as folders, with anisBundleflag set to true) followed by a separate list of reports.

    The column header section looks like this:

    [explorer.column.name]

    [explorer.column.description]

    [explorer.folder.column3]

    [explorer.folder.column4]

    [explorer.report.column4]

    [explorer.report.column5]

    [explorer.folder.column5]

    [explorer.folder.column6]

    [explorer.report.column7]

    [explorer.bundle.column6]

    As noted above, the values in brackets are strings taken from Web Views properties file.The folder/bundle list looks like this:

    [integer]

    [string]

    [string]

    [integer]

    [integer]

    [integer]

    [boolean]

    [string]

    [integer]

    [string] [integer]

    . . .

    . . .

  • 8/12/2019 Customizing Web View 5 5 2

    34/57

    Customizing Browse View or My Vista View

    30 Customizing Web View

    Each item contains all the fields shown.

    The report list follows the folder/bundle list and has this format:

    [integer] [integer]

    [string]

    [string]

    [integer]

    [integer]

    [integer]

    [integer]

    [integer]

    [boolean]

    [boolean]

    [boolean]

    [boolean]

    [boolean]

    [string] [string]

    [string]

    [integer]

    [integer]

    . . .

    . . .

    Each item contains all the fields shown.

    FavoritesThe favorites list is displayed when you use My Vista view in Web View; it lists the reports andfolders you have selected as your favorites. The format of the data stream for the favorites list isthe same as for the folder/bundle/report list (see page 29). Since you cannot select bundles asfavorites, there are no bundle items in the folder list.

    Bundle Instances

    The bundle instance stream contains data on each instance of the selected bundle. The columnheader section looks like this:

    [explorer.bundle.column1]

    [explorer.bundle.column2]

    [explorer.bundle.column3] [explorer.bundle.column4]

    [explorer.bundle.column5]

    [explorer.bundle.column6]

    [explorer.bundle.column7]

    [explorer.bundle.column8]

    [explorer.bundle.column9]

    [explorer.bundle.column10]

  • 8/12/2019 Customizing Web View 5 5 2

    35/57

  • 8/12/2019 Customizing Web View 5 5 2

    36/57

    Customizing Browse View or My Vista View

    32 Customizing Web View

    Bundle Components

    When a bundle instance is selected, Web View lists the components in itthe report generations itcontains plus the header, separator, and trailer reports, if any are defined for the bundle. The XMLdata stream includes the column headers plus a list of the component items. The column header

    section looks like this:

    [explorer.bundle.column13]

    [explorer.bundle.column2]

    [explorer.bundle.column3]

    [explorer.bundle.column4]

    [explorer.bundle.column5]

    [explorer.bundle.column6]

    [explorer.bundle.column7]

    [explorer.bundle.column8]

    [explorer.bundle.column9]

    [explorer.bundle.column10]

    [explorer.bundle.column11]

    [explorer.bundle.column12]

    [explorer.bundle.column13]

    The component item list can contain items in two different formats: one for the report generationsin the bundle, and another format for the banner pages. The general format for the list is the sameas for the other item lists:

    . . .

    . . .

    . . .

    The individual items for report generations have this format:

    [integer]

    [integer]

    [integer]

    [integer]

    [integer]

    [integer]

    [integer]

    [integer]

    [integer]

    [integer]

    [boolean]

    [boolean]

    [string]

    [integer]

    [integer]

    [string]

    [integer]

    [integer]

  • 8/12/2019 Customizing Web View 5 5 2

    37/57

    Customizing Browse View or My Vista View

    Customizing Web View 33

    [integer]

    [string]

    [string]

    [string]

    [string]

    The items for the banner page componentsheader, separators, and trailerhave this format:

    [boolean]

    [integer]

    [string]

    [integer]

    [integer]

    [integer]

    Banneris either Header, Separator, or Trailerand indicates the type of banner page.

    Modifying the Display

    The appearance of each of the four types of list is controlled by a different XSL file. The file namesare:

    These files are found in the stylessubdirectory of the Web View root directory.

    These files contain tags which format the information in the corresponding XML data stream intoHTML tables and determine the appearance of the tables on the Web View page. There are

    separate templates in each XSL file, controlling the display of the column headers and of the listinformation. bundinstlist.xsland bundcomplist.xslhave two templates, whilefolderlist.xsland

    favoriteslist.xslhave three: one for the column headers, one for the folder list (including bundles forfolderlist.xsl), and one for the report list. To make any change to the display of a list, you mustmodify both the header template and the list template(infolderlist.xslandfavoriteslist.xsl, youmust modify both list templates).

    Here is a section offolderlist.xsl, showing relevant parts of the column header, folder list, andreport list templates. For space reasons, only one column definition from each template is shown:

    ...

    ...

    List XSL File Name

    Folder/bundle/report list folderlist.xsl

    Bundle instance list bundinstlist.xsl

    Bundle instance component list bundcomplist.xsl

    Favorites list favoriteslist.xsl

  • 8/12/2019 Customizing Web View 5 5 2

    38/57

    Customizing Browse View or My Vista View

    34 Customizing Web View

    ...

    ...

    /xsl:template>

    xsl:template match="report_list">

    ...

    xsl:variable name="description">

    /xsl:variable>

    xsl:choose>

    /xsl:choose>

    ...

    The following sections describe how to make three types of changes to the display: adding orremoving columns, changing column order, and changing column width.

    Note Important!The sections that follow assume you have a basic understanding of XMLand XSL concepts and techniques.

    As always, before making any of the changes described below, make a backup copy ofthe original file, so you can replace the modified file with the original file if necessary.HTML, and therefore XSL, is very delicate and an extra or missing character could

    break the entire page.

  • 8/12/2019 Customizing Web View 5 5 2

    39/57

    Customizing Browse View or My Vista View

    Customizing Web View 35

    Adding or Removing Columns

    As mentioned under XML Data List Formats on page 28, you can add a new data column to adisplay only if there is an entry for that piece of data in both the column header and the item list inthe XML data stream. There are two ways to add a column:

    For almost all columns, you must create a new definition for it in the appropriate XSL file. folderlist.xslcontains three column definitions that are commented outthe file name of a

    reports most recent generation, the number of subfolders in a folder, and the number ofgenerations in a report. You can activate any of these columns by uncommenting its definition.

    The following sections describe each of these methods.

    Adding a Column Definition

    To define a new column, you create entries for it in both the column header template (a tag)and the list template (a tag) in the appropriate XSL file. If there is no column header definedin the data stream, you cannot add a tag for it in the XSL file, and therefore you cannotdisplay that type of data.

    This process is somewhat more involved infolderlist.xslandfavoriteslist.xsl, as there are two data

    list templatesone for folders and one for reports. If the additional type of data is listed in bothplacesfor example, the creation time for folders and reportsyou can add it to the display byadding entries for it to the column header template, the folder list template, and the report listtemplate. However, if a type of data applies to folders but not reports, or vice-versa, you can add acolumn for it by defining the column in the column header template and in the appropriate data(folder or report) list template, then adding a tag containing a blank space () in the

    proper position in the other list template(it must contain the character to display properlyin Netscape). This is not an issue in the other XSL files, which contain only one list template.

    As an example of adding a column, here is part offolderlist.xsl, showing (in bold blue) the entriesfor a new column for creation time: This is the most complex case, as it involves adding entries toall three templates.

    . . .

  • 8/12/2019 Customizing Web View 5 5 2

    40/57

    Customizing Browse View or My Vista View

    36 Customizing Web View

    . . .

    . . .

    . . .

    . . .

  • 8/12/2019 Customizing Web View 5 5 2

    41/57

    Customizing Browse View or My Vista View

    Customizing Web View 37

    . . .

    In Web View the user can sort the displayed list by clicking the column header of any string ornumeric column, including date/time columns. This sorting is defined in the tag of thecolumn header template. For example, here is the tag for the number of folders column in a

    folder list:

    Here are the parts of this entry:

    This center-aligns the text in the column. In some cases, thiswill say sortleft.

    The hyperlink entry implements the sorting. Its name is the same as thesort_keyin the tag, and its onClickevent handler calls the sortBy

    JavaScript function with two parameters, this, to identify the column header element, and aboolean value. The boolean value indicates whether the sort is numeric or string-based, true(as in the example) indicates numeric; for a string sort the parameter can be omitted or set tofalse. The tag inside the element simply retrieves thestring column header for display.

    To conclude the element, an tag detects whether the current column ifthis column is being used as the sort column, and displays the appropriate image (a smalltriangle) when it is.

    Notice that the tag uses the name for theparameter from the column header section of the XML data stream (see page 29), while the and tags use the name from the XML item list section. When creating a tag for a new column, be sure to use the correct name in each location.

    For time parameterssuch as createTimea corresponding createTimeNumparameter existssolely for the purpose of sorting. The string version is displayed, while the numeric version isused for sorting.

    To remove a column from the display, simply remove its tag from the column headertemplate and its tag from the list template (both list templates infolderlist.xslor

    favoriteslist.xsl). Unless you have explicitly set column widths, as described below, the remainingcolumns will expand to fill the available screen space.

    Uncommenting a Column Definition

    Because we believe many customers may want to add them, we simplified the process for addingthree columns to the folder/report/bundle list:folderlist.xslcontains the definitions for thesecolumns, but they are commented out. The three columns available in this way are: the filename of the most recent generation of a report (this column is blank for bundles and folders); thenumber of subfolders in a folder (blank for bundles and reports); and the number of generations ina report (blank for folders and bundles).

  • 8/12/2019 Customizing Web View 5 5 2

    42/57

    Customizing Browse View or My Vista View

    38 Customizing Web View

    To add one of these columns, you move the tags marking its definitions as a comment. Asdescribed on page 33, each column is defined in three places: the column header template, thefolder list template, and the report list template. You must move the tags in all three locations.

    In an XSL file, anything between the tags is a comment. Here is the column headerdefinition for the file name column. The entire definition is enclosed by these tags (shown in bold

    blue):

    To activate this definition, you move the closing comment tag from the end of the definition to theend of the description of the column. The definition then looks like this:

    Again using the file name column as the example, here are what the folder and report listtemplate sections look like before activation:

    ...

  • 8/12/2019 Customizing Web View 5 5 2

    43/57

    Customizing Browse View or My Vista View

    Customizing Web View 39

    -->

    And after activation:

    ...

    There are equivalent entries for the number of subfolders and number of generations columns; toactivate either of those, make the same changes as shown for the file name column.

    Changing Column Order

    To change column order, simply move the entire tags for the columnthe tag in the headertemplate and the tag in the list template to the location you want. The tags in the templatedefine the columns in order from left to right. Infolderlist.xslorfavoriteslist.xsl, be sure to move theappropriate tag in both item list templates.

    Changing Column Width

    By default, only the name and description columns of most lists have a width set in the XSL code;the other columns grow/shrink as needed for the contents of the HTML object. To changethe width of a column with a width set, you need to modify the widthattribute in the andtags for the column header and column list. Be sure to keep the width of the and tags equal or the data in the list will not line up with the column headers.

    For example, to make the description column in the folder/report list 200 pixels wide instead ofthe default of 300, you will need to alter thefolderlist.xslfiles tags for the description column ineach templatefor the column header, folder list, and report list. The section of the file belowshows the change; the changed width attributes are shown in bold blue:

    ...

  • 8/12/2019 Customizing Web View 5 5 2

    44/57

    Customizing Browse View or My Vista View

    40 Customizing Web View

    ...

    ...

    ...

    /xsl:template>

    xsl:template match="report_list">

    ...

    xsl:variable name="description">

    /xsl:variable>

    xsl:choose>

    /xsl:choose>

    ...

    Of course, in bundinstlist.xsland bundcomplist.xslyou need to change the width in only twolocations, as there is only one list template.

    To set a width for a column which does not already have one defined, or for a new column you areadding, just add a style=attribute in the and tags, as shown in the example above.

  • 8/12/2019 Customizing Web View 5 5 2

    45/57

    Customizing Browse View or My Vista View

    Customizing Web View 41

    Showing or Hiding Empty Reports

    By default, empty reports (reports with no online generations) do not appear in the Browse viewfolder and report list. Each user can change this using Web Views Options feature. You canchange the default so all users list empty reports unless they choose not to.

    To set the default behavior for empty reports, you must edit the WEB-INF/web.xmlfile. Open thefile in Notepad or another editor and look for these lines:

    ShowEmptyReports

    0

    Change the setting from 0to 1to have empty reports appear in the report listfor all users by default. Save your change and close the file.

  • 8/12/2019 Customizing Web View 5 5 2

    46/57

    Adjusting Tomcat Servlet Engine Memory Settings

    42 Customizing Web View

    Adjusting Tomcat Servlet Engine Memory SettingsThe Vista Plus Server Installation Guidesection on installing Web View notes that you may need toincrease the memory settings for your servlet engine to enable Web View to display pages,especially in layout mode. If you are using the Tomcat 5.5.x engine, you can use the procedures

    below to change the memory settings.

    There are probably similar settings for other servlet engines, and they may need to be adjusted.These procedures are for Tomcat 5.5.x only; for any other servlet engine, refer to the servlet enginedocumentation.

    For Tomcat 5.5.x on a Windows Web Server

    1. From the Start menu select Programs, Apache Tomcat 5.5, Configure Tomcat. If you receivean error message or cannot find the program, see the tip below.

    2. Click theJavatab.

    3. In the Initial memory poolfield, type the desired initial memory pool size, in MB. For smallhosts, this may be as low as 128. For larger hosts, you can set this to 256, or to 512 if the hosthas 2GB or more of memory.

    4. In the Maximum memory poolfield, type the desired maximum memory pool size, in MB.This should always be at least 256. For larger hosts, you can set this to 512, or to 1024 if thehost has 2GB or more of memory.

    5. Click OK.

    Tip If the Tomcat icon appears in your System Tray, right-click it and select Configure.

    If Apache Tomcat 5.5 does not appear in your program list, use Windows Explorer oranother method to execute the file Tomcat\bin\Tomcat5w.exe, where Tomcatis theTomcat installation directory. This displays a menu where you can change thememory settings.

    For Tomcat 5.5.x on a UNIX Web Server

    1. Open the file Tomcat/bin/catalina.sh using a text editor.

    2. Add the following line at the beginning of the file:

    JAVA_OPTS=-Xmsxxxm Xmxyyym

    xxxis the initial memory pool size, in megabytes. It should be between 128 (for smallserver hosts) and 512 (for hosts with 2GB or more of memory).

    yyyis the maximum memory pool size, in megabytes. It should be between 256 (forsmall server hosts) and 1024 (for hosts with 2GB or more of memory).

    3. Make sure that the graphical environment is configured with Xvfb. How to configure Xvfbdiffers greatly depending on the type of UNIX; contact the operating system provider for

    instructions if you need them.

  • 8/12/2019 Customizing Web View 5 5 2

    47/57

    If You Use a Third-Party Version of Tomcat

    Customizing Web View 43

    If You Use a Third-Party Version of TomcatIf you have a version of Tomcat which came from a third party, it may not contain the same files,or file versions, as the same version of Tomcat found on the Apache organization Web site(http://tomcat.apache.org). In some cases, this can keep Web View from working. For example, the

    version of Tomcat 5.5.9 included with some versions of the HP-UX operating system includesolder versions of the xml-apis.jarand xercesImpl.jarfiles; because of their location, Web View tries touse these older files instead of the proper versions included with Web View. When a user tries toaccess Web View using the HP version of Tomcat, he or she receives a blank screen.

    If this happens, you can remove the older versions of these files; Web View will then use theproper versions. Follow this procedure to do so:

    Note In steps 2 and 3 below, Tomcatrefers to the path to the Tomcat installation directory.

    1. Shut down Tomcat.

    2. In the Tomcat/common/endorsed directory, rename or remove the xml-apis.jarandxercesImpl.jarfiles.

    3. Delete the Tomcat/work/Catalina/localhost/vp_web directory. This is where Tomcat cachesworking copies of the Web Viewjspfiles.

    4. Restart Tomcat.

    You should now be able to access and use Web View.

    http://tomcat.apache.org/http://tomcat.apache.org/
  • 8/12/2019 Customizing Web View 5 5 2

    48/57

    If You Use WebLogic

    44 Customizing Web View

    If You Use WebLogicIf you are using Web View with the WebLogic Web server, you need to perform an additionalprocedure: with WebLogic, Web View must use a different XSL tag library than with most otherWeb servers. To change the tag library Web View uses, after installing Web View, follow this

    procedure:

    1. Open the WebLogic Server Console.

    2. In the tree on the left, expand the domain containing Web Viewfor example, vistadomainthen expand Deployments and Web Applications.

    3. Select vp_web.

    4. Click Edit Web Application Descriptor.5. In the tree, expand Web Descriptor, Web App Descriptor, and Tag Libs.

  • 8/12/2019 Customizing Web View 5 5 2

    49/57

    If You Use WebLogic

    Customizing Web View 45

    6. Select http://jakarta.apache.org/taglibs/xtags-1.0.

    7. Change the Locationentry to /WEB-INF/xsl.tld. Click Apply.

    8. In the tree, select Web Descriptor.

    9. Click the Persistbutton.

  • 8/12/2019 Customizing Web View 5 5 2

    50/57

    Changing the Web Application Time-out Setting

    46 Customizing Web View

    Changing the Web Application Time-out SettingNote Important!As always, before making the change described below, make a backup

    copy of the original file, so you can replace the modified file with the original file ifnecessary. HTML, and therefore XSL, is very delicate and an extra or missing

    character could break the entire page.

    Note Important!You should change the Web application time-out only if necessary to makeit longer than the inactive time-outsetting on the Vista Plus server. The Vista Plusserver will shut down a Web View connection when the inactive time-out setting isreached. It is always better to allow the Vista Plus server, rather than the Web server,to shut down the connection. The Vista Plus server can reclaim all resources used onthe Vista Plus server: memory, worker processes, and the user license. When the Webserver shuts down a Web View session, none of this activity occurs on the Vista Plusserver: worker processes are not stopped and the user license count is notdecremented.

    Inactive Web View sessions are closed when the application time-out setting is reached on the Webserver. This setting is in Web Views web.xmlfile; this is in the WEB-INFsubdirectory of the vp_web

    directory. The default setting is 180 minutes (three hours).

    To change this setting:

    1. Using a text editor, edit the WEB-INF/web.xmlfile.

    2. Look for these lines about two-thirds of the way down the file:

    180

    3. Change 180(highlighted in the lines above) to the number of minutes the Web server should

    wait before disconnecting an inactive Web View session.4. Save your changes and close the file.

    5. Stop and restart the applet server or Web server that is running Web View to make the changetake effect.

  • 8/12/2019 Customizing Web View 5 5 2

    51/57

    Forcing Dates for Multi-Generation Searches

    Customizing Web View 47

    Forcing Dates for Multi-Generation SearchesUsers performing a global index search or using the Find in Report feature can either search allreport generations or select a date range or number of days to search only generations captured inthe selected time frame. To reduce search demands on the Vista Plus server, some installations

    prefer to force users to select a date range or number of days, removing the all dates option. Youcan do this by modifying the web.xmlfile.

    Note Important!As always, before making the change described below, make a backupcopy of the original file, so you can replace the modified file with the original file ifnecessary. HTML, and therefore XSL, is very delicate and an extra or missingcharacter could break the entire page.

    To disable the all dates option and force entry of a date range or number of days for thesesearches:

    1. Using a text editor, edit the WEB-INF/web.xmlfile.

    2. Find this section:

    forceDateRangeForGlobalIndexSearch

    false

    If true, the U/I for the Global Index Search will have the date

    range section visible by default, and users cannot select All

    Generations. This is used to limit the number of generations which

    are searched in a Global Index Search.

    3. Change false, shown in blue in the example, to true.

    4. Save your change and close the file.

    5. Stop and restart the applet server or Web server that is running Web View.

  • 8/12/2019 Customizing Web View 5 5 2

    52/57

    Changing the Object Display Order

    48 Customizing Web View

    Changing the Object Display OrderIn Vista Plus, each report page is stored as a collection of separate objects: text, images, patternssuch as shaded boxes, and so on. By default, when Web View displays a page in normal view, it

    builds the page by placing each object on it, in the order they are stored in the report file. In most

    cases, this is the most efficient way to display the information. However, with certain reports, itcan lead to problems with the display, when an object that should be under other objects is placedover them instead. For example, if a gray box is used to shade text, placing the box on top of thetext instead of under it covers up the text completely. This can be made worse because Web Viewcannot display transparent objects using HTML. To enable normal mode to display more reportscorrectly, you can set an option to have it display all pattern objects before all text objectsthisensures the text is always on top and visible.

    This option is found in the WEB-INF/web.xmlfile. To change it, open the file using Notepad oranother editor and look for these lines:

    drawPatternFirst

    false

    Change the setting from falsetotrueto have all pattern objects drawn beforeall text objects. Save your change and close the file.

    This setting affects only normal view. It has no effect on layout view.

  • 8/12/2019 Customizing Web View 5 5 2

    53/57

    Changing How TransVue Files Are Displayed

    Customizing Web View 49

    Changing How TransVue Files Are DisplayedTransVue files are files that are captured into Vista Plus in their original formats. They are notconverted into Vista Plus format during capture. File types that are typically captured as TransVuefiles include Word documents, Excel spreadsheets, scanned images, and so on. By default, Web

    View opens TransVue files as attachments. This causes the browser (either Internet Explorer orFirefox) to open the file in the same way it opens a file of that type when a user clicks a link to it inany Web page. In general, it opens either in a separate browser window or in a new instance of theapplication associated with the file type.

    This behavior is controlled by a setting in the WEB-INF/web.xmlfile. If desired, you can change thesettings value from attachmentto inlineto have Web View attempt to open the file in thesame browser window instead of a new window. The exact behavior will depend on your browserand browser settings. One effect of using the inlinesetting is that the original TransVue filename will not appear in the title bar of the window. Instead, it will show a temporary nameassigned by the browser.

    To change the setting, open web.xmlusing Notepad or another editor and look for these lines:

    ContentDisposition

    attachment

    Change the setting from attachmentto inlineto change the way Web Viewopens TransVue files. Save your change and close the file.

  • 8/12/2019 Customizing Web View 5 5 2

    54/57

    Changing How TransVue Files Are Displayed

    50 Customizing Web View

  • 8/12/2019 Customizing Web View 5 5 2

    55/57

    Customizing Web View 51

    Index

    A

    About.jsp 3Adding columns 35, 37

    by uncommenting definition 37Assumptions 1

    B

    Background colors 3Browse view

    adding or removing columns 35, 37changing column order 39changing column width 39customizing 28XML formats 28XSL file list 33

    bundcomplist.xsl 33bundinstlist.xsl 33Bundle list

    customizing 28

    C

    Change Password tab, removing 26changegroup.jsp 7Color scheme 3Columns

    adding or removing 35, 37changing order 39changing width 39removing 37uncommenting definition 37

    Connectiondefining for login 8defining only one 9

    Custom login page 10

    Customizing Browse view and My Vista view 28

    D

    Dates for search, forcing entry 47

    drawPatternFirst in web.xml 48

    E

    E-mail favorites and login 9Empty reports, showing in report list 41ExplorerTopFrame.jsp 3

    F

    Favoritescustomizing 28

    favoriteslist.xsl 33Field width 4File path format 1Folder list

    customizing 28folderlist.xsl 33Front.jsp 3

    G

    General information 1Generation list

    customizing 28GenFindTopFrame.jsp 3

    H

    Hiding empty reports 41Host and port

    forcing for login 9Host and port, removing from start page 8

    I

    IIS 12and single sign on 16and Tomcat 12

    Images, changing 2Integrating Tomcat and IIS 12

    IIS 5 12IIS 6 14

  • 8/12/2019 Customizing Web View 5 5 2

    56/57

    Index

    52 Customizing Web View

    K

    Keeping copies of original files 1

    L

    LDAPand single sign on 16

    Load balancing and single sign on 24Login

    other methods 11Login page

    after e-mail favorite 9contents 5creating custom 10defining connections 8

    forcing host and port 9forcing start page for users 7modifying 5removing host and port 8

    login.do 10login.jsp 3, 5login.xsl 9, 10Logos, changing 2

    M

    Memory settings for Tomcat 42My Vista view

    adding or removing columns 35

    changing column order 39changing column width 39customizing 28XML formats 28XSL file name 33

    MyVistaTopFrame.jsp 3

    N

    Netegrity SiteMinder See SiteMinderNormal view, changing object display order 48

    O

    Object display order in normal view 48opening TransVue files 49OptionsContainer.jsp 3, 26

    P

    Page number field width 4Prerequisites 1

    Q

    Qlogo.jpg 3

    R

    RemovingChange Password tab 26columns 35, 37

    Report listcustomizing 28showing empty reports 41

    ReportButtonBar.jsp 3ReportNavigator.jsp 4Root directory for file paths 1

    S

    Search date options 47server.cfg 15ServletExec 18ShowEmptyReports in web.xml 41Showing empty reports 41Single sign on 15

    and IIS 16and LDAP 16and load balancing 24and SiteMinder 16, 18and Vista Plus passwords 15Vista Plus server setup 15Web server setup 16Web VIew setup 25

    SiteMinderand single sign on 16, 18

    SSL browsing 12SSO See Single sign onStart page for users 7

    T

    Time-out setting for Web View 46Tomcat 12

    and IIS 12and single sign on 16

    Tomcat memory settings 42

  • 8/12/2019 Customizing Web View 5 5 2

    57/57

    Index

    top_nav_right.gif 3TransVue files, opening 49

    U

    Uncommenting column definitions 37URL for login 11User start page 7

    V

    vistalogo.gif 3vp_web_front_01.gif file 3vp_web_front_05.gif 3

    W

    Warnings 1Web application time-out setting 46Web server

    single sign on setup 16web.xml 46, 47

    and single sign on 25opening TransVue files 49

    WebLogic 6 and Web View 44WebLogic special setup 44

    X

    XSL files for Browse view and My Vista view 33