Skip navigation FileNet logo
  Open Client Developer's Guide
  Search  |  Index  |  Glossary   |  
Open menu Overview
Open menu Open Client Architecture
Open menu Developing for Process
Open menu Error and Exception Handling
Close menu Customizing the Framework
  Best Practices
  Customizing the Error Page
  Customizing the Java Viewer
  XML Schema to INI Format
Globalization / Localization
Open menu General Information
   

Customizable HTML Parameters

The following lists identify some of the HTML parameters that are commonly used to achieve viewer customization. Sample values are provided and the effects of setting the parameters are described.

Modifiable Parameters

The following parameters may be modified by developers to customize the Java Viewer.

Parameter = Sample Value Description
ResProduct = WebViewer Identifies the product name.
ResWebSite = www.WebViewer.org Supplies the product Web site.
ResEmail = contact@WebViewer.org Supplies the email address or contact URL for the product.

description =
<%=getDocumentDescription()%>
where DocumentDescription could be
      WebVewer Document ####

Displays a title that describes the current document.
HelpURL = <%=getHelpUrl()%> Identifies the URL to use to read documentation associated with the product.
annotationAllowHideAll = True Causes all of the annotation type toolbar buttons to not be displayed, thus preventing the use of annotations by the end user.
annotationHideContextButtonsIDs = save,text,hyperlink,behind

Hides the identifiers for context buttons marked as hidden through the use of the annotationHideContextButtons parameter.

Non-modifiable Parameters

The following parameters are implemented by FileNet and are listed here for informational purposes only. These parameters should not be modified by developers.

Parameter = FileNet Value Description
filenet = True Indicates that the Java Viewer is communicating with IDM Web Services implemented in Open Client, thus enabling the use of FileNet annotations.
filenetSystem =
<%=getSystemType()%>
Indicates whether an IS or CS library is being accessed.
filenetUG =
<%=getSecurityURL()%>
Specifies the URL to call to retrieve security options from an IS or CS library.
getFilenameType =
<%=getDocContentUrl()%>
Creates the URL used to retrieve a document from a CS or IS server. This URL is later used to make a call to docview.aspx with the correct (dynamically added) parameters.
annotationFile =
<%=getDaejaAnnotationURL()%>
Specifies the URL to call to retrieve annotations from an IS or CS library.
annotationFreeHandLimit = 300 The pen annotation, also called freehand, allows a maximum of 300 points in any annotation. This parameter specifies that an annotation cannot contain more than 300 points.
annotationHideButtons =
line,solidtext,highlightpoly,rectangle,
redact,redactpoly,poly,openpoly,oval,
hyperlink
Causes the specified annotation type toolbar buttons to not be displayed, thus preventing the use of the associated annotation types by the end user.
Note: The list provided above indicates those annotation styles that are not currently supported by the IDM viewer, and therefore, are not saved or retrieved by Image Services or Content Services.
annotationHideContextButtons =
save,text,hyperlink,behind
Causes the specified context toolbar buttons to not be displayed, thus preventing their use by the end user.