Brava Webtop Installguide PDF

Brava 6.
2 for Webtop Integration

Brava! Enterprise
Webtop 6.5 Integration
Brava! Client/Brava! Webtop Server/JobProcessor

Installation and Configuration Guide
(ActiveX) Version 6.2
Table of Contents
1.0 Preparing to Install Brava Webtop ........................................................................... 2
1.1 Supported configurations: ............................................................................................ 2
1.2 Hardware Requirements ............................................................................................... 4
1.3 Planning Considerations ............................................................................................... 4
1.4 New Integration Features ............................................................................................. 5
2.0 Installing Brava! Enterprise for Documentum Webtop ............................................. 6
3.0 Configuring your Installation ................................................................................. 19
3.1 Copy Custom Contents ............................................................................................... 19
3.2 Installing the DAR File................................................................................................ 21
3.3 Customize Brava JSP Pages ........................................................................................ 22
3.4 Customizing the Webtop Integration components .......................................................... 45
3.4.1 Adding Custom Stamps (Raster Images) ............................................................... 47
3.4.2 Configuring Brava for Webtop in Multi-select Launch Mode ...................................... 47
3.4.3 Enabling additional Brava audit events .................................................................. 48
3.4.4 Disabling the Brava! Flash Viewer ......................................................................... 49
3.5 Uninstalling Brava Webtop Components ........................................................................ 49
4.0 Integration Users Guide ........................................................................................ 50
4.1 Launching Brava Viewer from within Webtop................................................................. 50
4.2 Saving Markups to the Docbase .................................................................................. 50
4.3 Using Term Hit Highlighting ........................................................................................ 51
4.4 Using the Webtop Compare Feature ............................................................................. 51
4.5 Using the External Bookmark Feature .......................................................................... 52
4.6 Using the Watermark Folder Feature ............................................................................ 54
4.7 Bi-directional Stamp Feature Overview ......................................................................... 54
4.8 Brava 6.2 Startup Debugging ...................................................................................... 56
5.0 Troubleshooting Tips .............................................................................................. 57
1
Brava 6.2 for Webtop Integration
1.0 Preparing to Install Brava Webtop

1.1 Supported configurations:
Supported Application Server Environments for Brava! Enterprise for Webtop
Documentum Webtop 6.5 sp1, SP2, or SP3 with:
Windows 2003 Server, SP3* & Windows 2008 Server (32 & 64 bit)
Tomcat 5.5.23 to Tomcat 6.0.20
Sun Java JDK 1.5.0_09 to 1.6.0_17*
BEA Weblogic 9.2.2, 10.0 10.2, and 10.3

JRockit 1.5.x** and 1.6.x**
Sun Java JDK 1.5.0_17 and 1.6.0_17*
IBM WebSphere 6.1.0.7 (6.1 Fix Pack 17)

IBM Java 1.5 (update 2 or higher recommended)**
Red Hat Jboss 4.3 EAP

Sun Java JDK 1.5.0_9 to 1.6.0_17*
*32-bit Version Only

**32-bit Version for Microsoft Windows Only
*** Includes BEA Weblogic Express (Brava! for Webtop is only tested with BEA Weblogic
Express while using Sun JDK 1.5.0_17 or JRockit 1.5.x (Windows 32-bit Java Versions only)
Brava! Enterprise Job Processor and Brava! Enterprise Licensing Services
Brava! Enterprise Job Processor - Microsoft Windows 2003 Server or Windows 2008 Server &
Windows XP Professional
(XP is recommend when viewing larger volumes of MS Office format documents)
Brava! Enterprise License Service - Microsoft Windows 2003 Server and Windows 2008 Server
Supported Web Servers:
Because the Brava! for Webtop integration is hosted in the Application Server running Webtop
and not directly by a Web Server, Brava! for Webtop will work fine with any web server
supported by the application server environment.
Brava Webtop Client System Requirements

Windows XP Professional with Internet Explorer 6 SP2
Windows XP Professional with Internet Explorer 7 or 8
Windows Vista Professional with Internet Explorer 7 or 8
Windows 7 Professional with Internet Explorer 8
2
Brava Webtop Flash Viewer Requirements

Flash Version 9 and up
Windows XP Professional with Internet Explorer 7 or 8
Windows Vista Professional with Internet Explorer 7 or 8
Windows 7 Professional with Internet Explorer 8
Mac OS X.6 with most up-to-date Flash version
Note that ACS must be enabled on the Content Server for Brava Flash Viewer support.
Supported Client Browser (Brava ActiveX Client)
Internet Explorer 6 SP2

Internet Explorer 7
Internet Explorer 8
Supported Client Browser (Brava Flash Viewer)
Internet Explorer 7 (Windows Only)

Internet Explorer 8 (Windows Only)
Firefox 3.6 (Windows, Mac OS)
Safari 4.0.4 and 4.0.5 (Windows, Mac OS)
Supported Repositories
Federated Content Servers

Replicated Content within the Content Server
Brava Webtop Support for Documentum BOCS
Brava Webtop supports Documentum Branch Office Cashing Server (BOCS) in the
following modes:
Pull: read only
Push: read only
Note: While write maybe enabled for the BOCS server, the Brava Webtop integration
does not utilize writing to the BOCS server. All writing of Markups and Published
Content (PDF, TIFF & CSF Files) can only be written directly to the content server that
the file resides in (main Content Server or Federated Content Servers). Caution should
therefore be used in Firewall and Routing to allow clients to write Markups and/or
Published Content back to the Content Server if such operations are to be permitted in
a BOCS' Zone. Failure to permit such traffic in the BOCS Zone will result in failure
errors for the Save Markup operation and the Publish File Operations if the Published
Content's target is an operation that requires writing the published content to the
Content Server. This includes operations such as Save as Major Version, Save to User's
Home Cabinet, and Save as Rendition. Publishing Content that does not write content
to the Content Server (operations such as Save to Local Path and Attach to Email) are
not affected by network configurations in most cases. Seek the advice of your Local
Network administrators for Firewall and routing configuration concerns and to plan for a
successful deployment of BOCS with Brava for Webtop.
3
1.2 Hardware Requirements
Brava Server
See Requirements of Application Server
5 - 60GB of free hard drive space for displaylistcache (the amount required depends on
how much caching of published files is required for your integration)
Brava! Enterprise Job Processor

1.5Ghz P4 class processor (recommended 3.0 GHZ (or faster) P4 or XEON class processor)
512 MB of RAM (recommended 1.5GB (or more) of RAM)
70 MB of free hard drive space for Job Processor and all installed files
500 MB depending on amount and size of original files) of hard disk space is required for
temporary files created during the processing of requests (the location of this temporary
directory is configurable via the JobProcessor.config file
Additional disk space required for temporary files during publishing. Space requirement
varies with number and complexity of documents served recommend at least 500 MB of
temporary disk space on the C: drive for DLAutoPublish processing of files through the IGC
Writer printer driver. The location of this temporary directory is configurable via the
JobProcessor.config file.
1.3 Planning Considerations

You should have the following information gathered before you begin installing Brava 6.2 for
Webtop. Keep in mind that all listed system names should be fully qualified domain names. To
ensure the reliability of your configuration, Wins short names should not be used in setting up
Brava Webtop.
1. The name of the system where Webtop is running.
2. The application server software and version that Webtop is deployed to.
3. The port that the application server is configured to use.
4. The Webtop version that you have deployed for Brava Webtop.
5. What is the Webtop application context? (default is: /webtop)
6. Whether you will deploy the Brava Server to the same application server where Webtop
resides. If the answer to this is NO:
a. The name of the server(s) where you will deploy the Brava Server.
b. The application server software and version number that will be used to deploy the
Brava Server (list all).
c. The port number that the application server is configured to use.
7. The name(s) of the Brava Enterprise Job Processor servers that you will use for this
configuration.
4
1.4 New Integration Features

The following features and enhancements have been added to the Brava/Webtop integration. See
sections 3.1, 3.3, 3.4, and 4.0 for more information about these features.
Integration with Brava 6.2 new features include:

Optional Brava flash viewer added in SR1 as an alternative client viewer. Limited features.
Addition of external bookmarks feature, public and private.
Ability to control launching of documents based on user or group.
Ability to control Stamp Templates by user or group.
Additional audit events added.
Ability to select multiple files in Webtop and launch them in separate browser windows.
Publish as Minor Version added as a Publish dialog option.
Ability to Cut and Paste annotations between Brava windows.
Integration with Brava 6.1 new features include:

Ability to turn on watermarks based on the folder where the content resides. Two new
optional parameters for this feature are WatermarkFolders and WatermarkFolderName.
Brava_parameters.jsp configuration file is now Brava_parameters.properties.
Support for External Bookmarks.
New licensing controls based on User/Group permissions.
Optional Exit button can be displayed on viewer toolbar to close a Brava viewing window.
Bi-Directional Stamps
Support for BOCS (Branch Office Caching Server) communication.
5
2.0 Installing Brava! Enterprise for Documentum

Webtop
**IMPORTANT**
Brava Licensing: By default, the Brava Enterprise product installs a 5-user 30 day evaluation
key stored in the IGCkey.lic file. Once you obtain a permanent key from Informative
Graphics, the IGCKey.lic must be copied to the following installation directories to overwrite
the 30 day evaluation key:
\<intstall location>\IGC\Brava! Webtop\Brava! Enterprise JobProcessor\

\<intstall location>\IGC\Brava! Webtop\Brava! License Server\
Step 1:
Run the Installation CD or double-click on the web package file that you downloaded. A Demo
Shield installation browser launches automatically. Select the Install Brava! 6.2 for Webtop
button to begin the InstallShield Wizard. You can launch this install guide and the core Brava
6.2 Administrators guide at any time through this screen.
Step 2:
From the Brava Enterprise Webtop Welcome screen, click Next>.
6
Step 3
On the License Agreement screen, click I accept.. if you have read and agree to the terms
contained in the product license.
Step 4
Select which Brava Enterprise components you would like to install on this machine. You can
install the components on the same or different machines, depending on your scaling
requirements. Having multiple Job Processor machines increases scalability.
7
Step 5
Setup will detect if the IGC Writer Printer Driver is installed, which is a required component for
use with Brava Enterprise.
Step 6 IGC Writer Installation

If setup did not detect the correct version of IGC Writer, the IGC Writer Printer Driver
installation begins. Note that Terminal Services cannot be used to install the Brava IGC writer
components for Brava Webtop. You must install the components at the physical machine that
the Net-It Enterprise Job Processor is being installed to.
8
If you already have the correct version installed, skip to Step #11 below.
On the Welcome screen, click Next> then click Yes on the license agreement screen after you
have read and agreed to the terms of use.
Step 7
In the Choose Destination Location screen, set the desired destination folder or accept the
default location. (IGC strongly recommends accepting all the defaults.) Click Next
9
Step 8
You are now ready to install. Click Install.
10
Step 9
At the IGC Writer Install Complete screen, click Finish.
Step 10: Continue with Brava Enterprise Installation

The Brava Enterprise installation should now detect the correct version of IGC Writer and
continue the installation.
Select Use Tomcat, or, if you will be using a different Application Server simply select Use
different servlet engine. Click Next
11
If you have elected NOT to use Tomcat, you are prompted to select a location to write the
Brava Enterprise WAR file. Its best to select a common default location for your application
server. With an application server such as BEA Weblogic, it is recommended that WAR file be
12
placed in a common, accessible place such as the C:\bea\user_Projects\Domains directory to

ensure that the file (WAR) is located in a common default location for deployment. Click Next.
Step 11
In the Edit Data screen, the default servlet port 8080 is shown. This is the default port to use
for Tomcat. If your application server is not Tomcat, or if you have configured Tomcat to use a
non-default port, enter the application servers communication port number.
Complete the three fields provided for the Brava Enterprise Webtop Server and click Next:
URL Prefix: Enter either HTTP:// or HTTPS:// depending on whether the servers are
configured to communicate using SSL and https.
Machine: Enter the fully qualified domain name of the server that is used for
communicating with the Brava Server.
Port: Enter the port number that your application server is using (where Brava Server is
running/deployed to).
Examples:
Tomcat (Default): 8080
Weblogic (Default) 7001
Websphere (Default) 9080
Step 12
In the Enter Webtop Server Information screen, the default server port 80 is shown.
13
Step 13
In the Choose Destination Location screen, browse to or enter the path to install the Brava
Enterprise Webtop files. Click Next.
14
Step 14
Click Install to begin the installation of the Brava Enterprise files.
15
During the Brava Server install the Webtop Client portion gets installed to the
custom<version>\custom directory. Copy those customizations over to the Webtop machine
as per section 3.1. Copying Custom Contents.
Step 15
The Job Processor files are installed. Upon completion, you are asked if you would like to
install Brava Enterprise JobProcessor as a Service. Select Yes to install the service or No to
skip the service setup and complete the Job Processor installation.
Step 16
Enter the Webtop Alias. The Alias is the context path where you installed Documentum
Webtop. For example, if the URL used to log in to Webtop is http://<Your Server
Name>/webtop, then the application servers context path for Webtop is webtop. By default,
this value will be webtop in the Alias screen. Click Next to complete the Brava Webtop Server
installation
16
Step 17
Brava Licensing: Choose YES to install the Brava Enterprise License Server as a
service. Note that choosing No will require you to run the License Server as a console
application inside a login session, which is available on the Start menu (StartAll
ProgramsIGCBrava! License ServerStart Brava! License Server).
By default, the Brava Enterprise product installs a 5-user 30 day evaluation key. Once you
obtain permanent keys from Informative Graphics, you must copy them to the installation
directories to replace the 30 day evaluation keys. These three keys are included in the
following two files, which will need to be updated separately:
o The Job Processor IGCKey.lic file (located in your installed \Brava! Enterprise
JobProcessor directory)
o The Brava Server and Brava Client keys contained in the IGCKey.lic file (located in
your \Brava! License Server directory)
Step 18
Youll be prompted to enter the service username and password information for the Brava
Enterprise JobProcessor. Click Next.
17
You will be prompted whether to start the Brava Enterprise JobProcessor and License Server
services.
Step 19
At the InstallShield Wizard Complete screen, click Finish to complete the installation.
18
3.0 Configuring your Installation

After completing the component installation, you will need to configure your installation for your
specific environment.
3.1 Copy Custom Contents

Before you begin copying over any customizations, make a backup copy of your existing
<webserver directory>/webtop/custom directory.
1. Navigate to the directory where you installed the Non-Servlet portion of the Brava Webtop
Server. Default is C:\Program Files\IGC\Brava! 6.2 Webtop\
2. Locate the custom directory for your version of Webtop. Brava Webtop Server 6.2 supports
Webtop 6.5 SR1 and SR2. Integration files are not interchangeable between Documentum
Webtop versions outside of the Versions that each integration was created for. You need to
ensure that you have the correct files for the version of Documentum Webtop you are
using.
3. To add the Brava Webtop integration to Documentum Webtops deployed application, copy
the correct integration sub-directorys contents to the deployed Webtops custom folder.
(Open the Webtop custom folder and paste the Contents from the installed integration
Brava Webtop customXXX folder into Webtop).
Markup Indicator and Term Highlighting Component Installation REQUIRED STEP
**IMPORTANT**
The Brava 6.2 Webtop Integration requires the following custom class files to be placed
in the correct folder in order for the Brava Integration to function correctly and not
return errors when Webtop is started. In addition, these steps are required to ensure that
the markup indicator and Term Hit Highlighting components are installed for these features to
function.
1. Ensure your webapp server is shutdown.

2. In the Brava Server install directory there should exist custom650sp1, or custom650sp2
directory containing a classes sub-folder. Copy the contents of the /brava/classes folder
into your Webtop (or Webtop app name) directory /WEB-INF/classes folder. These custom
files consist of the following Brava class files (along with their package names):
com.infograph.LaunchBravaPrecondition.class
This class ensures the object selected has a defined format. If no format is defined for this
object, annotation is not allowed.
com.infograph.MarkupIndicator.class
This class holds the functionality for displaying the markup indicator.
19
com.infograph.drl.DRLComponent.class
This class allows Brava to be integrated into Documentum web-links.
com.infograph.search.AdvSearchEx.class,com.infograph.search.Search60.class
These classes allow Brava's Term Hit Highlighting to be integrated into Webtops Advance
search capabilities.
Note: Adding these classes may require you to explode/rewar the webtop.war file. Please
refer to your webapps documentation for instruction.
3. Once installed, it is recommended that you now redeploy the Webtop application in the
application server (or restart the application server completely).
Configure the No Launch Properties File
In addition to the class files listed above, a custom properties file is located in the
webapp/<webtop>/custom/strings/com/infograph folder called
bravaformats.properties.
Webtop will check this file when the menus are initialized. Based on the formats found in
this properties file, the 'annotation' feature will be disabled if the format is found to match
a file type listed in this file.
The bravaformat.properties file is formatted as follows:
formats=<format>
For example: formats=avi,mpg,quicktime,zip,java,win32shrlib,unknown
There is no limit to how many formats you can have in this file as long as they are named
uniquely. This file should be copied in during the class file copy (outlined above) for the
integration installation.
The current default formats restricted from annotation include:
quicktime
mpg
avi
java (jar)
zip
win32shrlib (plugins, windows shared library)
unknown
Note that because this file is read each time the menu is initialized, altering it does not
require a restart of the webapp server for Webtop to see your changes.
Configure for the Save Markups with all Versions option (EnableVersions)
An additional installation step must be performed to allow the Save Markups with all Version
feature to recognize the proper security permissions and work properly:
20
Execute the following DQL line through the administration console, or from the DQL editor in
Webtop http://<server>/webtop/component/dql:
update dm_relation_type objects set security_type='PARENT' where

relation_name='DM_ANNOTATE';
Notes:
You must be the docbase owner to execute the above command.
If a file with Markups is present and is published as a new Rendition, the markups will
be disassociated with the main document unless the markups are saved with the Save
with all Versions check box enabled.
The parameter EnableVersion must be set to TRUE in the brava_parameters.properties
file to make this feature active.
Additional Notes for IBM WebSphere Users
If you are using IBM WebSphere 6.1.07 (6.1 Fix Pack 7) as the application server servlet
engine for the Brava Server, you may need to edit the Brava Servers Properties file to change
the parameter check.cache.blocking.timeout= from the default value of 3 to a value of 4
or higher. This should only be needed if you are viewing large files of 12.5MB or larger. If
viewing files in excess of 30MB, this value may need to be increased to 5. Changing the
Brava Server timing resolves a (500 error) message cache issue (related to how WebSphere
works) that may occur when launching large files in Brava from the Webtop Annotate option.
3.2 Installing the DAR File

This section involves installing the necessary DAR files to the 6.5 Documentum Content Server.
There are two general methods that can be used to install the files:
1. Install the DAR file with a batch file using the Documentum Headless Composer.
2. Navigate to the installed Brava Server directory and locate the Brava Formats DAR
folder.
Installing a DAR file (excerpt from Documentum Composer User Guide)
Use the emc.install command to install a projects DAR file into a repository. The install
process requires a batch file, as described in Creating a batch file, page 236, and a build
fie in XML format that contains the install parameters and the emc.install command.
The build file should look similar to the following:

<emc.install
dar="C:\builds\headless\project.dar"
docbase="repository name"
username="user1"
password="xxyyzz"
domain=""/>
21
This example XML file installs the project.dar file.
Note: The build file should be saved in Unicode (UTF8) encoding in case the file path contains any I18N
characters. The installation of the DAR file fails if the file path contains any other characters than
Unicode.
emc.install command parameters
Parameter Required Description

dar Yes The absolute file path to the .dar file being
installed. The file path must contain only
Unicode (UTF8) characters or the
installation will fail.
inputfile No The absolute file path to the installbased
parameter file.
localesFolder No The absolute file path to localized
properties files. If you want to make your
application available in other languages,
you need to localize the project data, for
example labels, tabs, and descriptions. For
more information about localizing a
project, see Localizing a project, page 37
docbase Yes The name of the repository into which the
.dar file is installed.
username Yes The login name for the repository
password Yes The password for logging into the
repository.
domain No The domain in which the repository resides.
To install a DAR file:
1. Retrieve the DAR file from the workspace or a source control repository and store the
file in a directory local to the install script.
2. Create the build file, as described in Creating a build file, page 235.
3. Create the batch file, as described in Creating a batch file, page 236.
4. Open the command line editor on your local machine.
5. Run the Ant task, as follows:
C:\><batch file name>.bat <build file name>.xml
3.3 Customize Brava JSP Pages
The Brava Webtop Server installation includes the following pages:
Markup.jsp - Each file to be viewed by Brava must have an HTML page generated. For the
Documentum integration, this file is generated by the Markup.jsp page (located in
\webtop\custom\brava\component\markup). This jsp file should not be edited unless directed by
our support team.
22
Retrieve_content.jsp This is the page that is called by the Brava client to retrieve the
document for client side publishing. It uses DFC calls to extract the document and stream it back
to the client.
Brava_parameters.properties This file, used in combination with markup.jsp, contains all of

the Brava viewer parameters that can be customized (such as enable markup, enable printing,
etc.) Contained in the custom/config/brava directory, this file can be edited to meet your custom
requirements.
Customizing Brava for DCTM to launch non-dm_document types in Brava
Add the following code to the brava_actions.xml file and alter the <insert their custom type
here> to your custom type:
<scope type = "<insert their custom type here>">

<action id="brava">
<params>
<param name="objectId" required="true"></param>
</params>
<preconditions>
<precondition class="com.infograph.LaunchBravaPrecondition"/>
<nlsbundle>com.infograph.bravaformats</nlsbundle>
</preconditions>
<execution class="com.documentum.web.formext.action.LaunchComponentWithPermi
tCheck">
<permit>read_permit</permit>
<component>bravaview</component>
<container>brava_container</container>
</execution>
Editing Brava_parameters.properties
Follow the steps below to setup brava_parameters.properties to fit your configuration.
Note: The Brava Webtop Server install must be complete prior to customizing the Brava Webtop
Server parameters via the brava_parameters.properties file. In the install steps above, you
copied the contents of the Webtop version-appropriate Custom Directory that contains the
integration components into Webtops custom directory. It is very important that you modify the
deployed brava_parameters.properties file and not the default file located in the Brava Webtop
Server install location. Modifying the un-deployed copy will result in no changes taking place to
the active deployed Brava Webtop configuration. Some application servers may require a restart
or redeployment the Web Application before the changes in the brava_parameters.properties will
take effect.
1. Using a text editor such as Notepad, open brava_parameters.properties, located in the
deployed Webtop directory <drive>: \<jakarta install
directory>\webapps\webtop\custom\config\brava or
\bea\user_projects\dctm\applications\webtop\custom\config\brava.
2. Parameters contained in the section below must be edited with the correct parameter
values as dictated by your specific environment and needs.
3. Save and close the .properties file.
23
The following table lists the parameters (and possible values) contained in the
brava_parameters.properties page that you can customize for the Brava ActiveX client. Many of
these parameters determine which features will be available to viewers using the Brava ActiveX
Client. You can choose to enable or disable a feature by setting its value to TRUE or FALSE.
It should be noted that the brava_parameters.properties file contains parameters for setting
behaviors that are unique to Brava Webtop. Some Brava Enterprise parameters that have no
functional behavior for Brava Webtop are not in the brava_parameters.properties so they will not
be covered in this section.
See the Brava Enterprise core installation guide (Brava_6.2_AdministrationGuide.pdf) for a
detailed list of all the Brava Enterprise Client and Server parameters.
Note that blank values for parameters will cause the BravaX Client to use the default value in
cases were values are defined values other then TRUE or FALSE, or where a Blank value has the
effect of turning the parameter off.
Brava Webtop Parameters Used in the brava_parameters.properties file
Parameter Value
Description
ServerHostName http://<your_server>:Port
This value is the fully qualified domain
(FDQ) name of your server with the
Application server port. This value will be
completed during the install.
ServerHostNameFromWebtop http://<your_server>:Port
This parameter adds a hostname for
Methods in Class file, adding the ability to
specify the brava server parameter for
external users. If this parameter is set,
Brava will use this brava server hostname
to get a Brava session and publish a file
(URL calls are made from the webtop
server to the brava server). For example,
the BravaComponent class (which
executes on the webapp, webtop, server)
makes calls to the BravaServer. This is
valuable when the Brava server has a
different name or ip address when it exists
outside of a firewall and can be used in
cases when the outside users cannot
access the Brava server and webtop
cannot communicate with the Brava server
based on param value. The
server_precedence file will not override the
url in this situation.
ClientLoadedMaxFileSize Any whole integer value.

2000 - Default This setting determines the maximum file
size (in kilobytes) allowed for client side
publishing (all formats). For example, if the
file size of the file is less than this value
and its format is TIFF or PDF, the original
file is sent to the client for viewing. If the file
size is greater than this value, the file is
processed normally through the Brava
24
Server.
PublishCheck TRUE Default

FALSE Turns advanced Brava Enterprise
JobProcessor publishing version checking
on/off.
BannerFontSize Any Valid Font Size

Sets the ISO Banner Font Size
BOCSBravaServerPairing Possible values:

<BocsServer>|http://<BravaS This setting tells Brava which Brava server
erver>:8080,<BocsServer2>| it should use when using the associated
http://<BravaServer2>:8080,. BOCs Server. Pairing allows the use of a
.... local Brava server to cache files rather than
to cache them on a remote Brava Server.
Example:
BOCSBravaServerPairing=BocsServer1|htt
p://BravaServer1:8080,BocsServer2|http://
BravaServer2:8080
In this case, if the user was assigned to use
'BocsServer1' from their current login, the
Brava Client would be directed to hit the
'BravaServer1' Brava Server which would
be local to them and the BOCs server.
UseBOCsIfAvailable TRUE Default

FALSE If set to True, Brava checks the user's
current network location and if an
associated BOC Server is found, this is
used as the location from which to retrieve
files.
ClientLog Valid string values are as

follows: This is the Level of Logging that can be
done by the Brava Webtop Client.
All or 0 designates all levels With a default logging level set to Error,
of messages are logged. both Error and Fatal Messages are logged.
Debug or 1 designates fine-

grained informational events See also Brava Startup Debugging
that are most useful to debug
an application.
Info or 2 designates
informational messages that
highlight the progress of the
application at coarse-grained
level.
Warn or 3 designates
potentially harmful situations.
Error or 4 (default)
25
designates error events that

might still allow the
application to continue
running.
Fatal or 5 designates very

severe error events that will
cause the application to
abort.
ClientLogFile Any valid path on the Brava
Client Systems The path the Brava Client will attempt to
%USERPROFILE%/Applicati write the client log file.
on
Data/BravaWebtop/Logs/Clie
ntlog.txt Default
ClientLogFileLength Any whole integer value

100000 Default The Number of bytes the log file will allow
to before the contents are overwritten.
CompareViewMode Possible values for this

parameter are Overlay Determines the display mode in Brava
Differences, Overlay, Side- Veiwer for files being compared (as
By-Side (default), Deletions, specified by DocId and CompareDocId
Additions, Unchanged, parameters).
Open File, and Compare
File.
ConvertOnClient TRUE - Default
FALSE This setting determines whether the Client
or Server will convert the native source file
to IGC's display list format which is
required by the Brava Client. If set to
TRUE, the Client converts all TIFF and
PDF formats. The default is TRUE,
meaning the Client loads and converts
native files.
Setting this value to TRUE for the
appropriate formats reduces the load on
the server by shifting conversion to the
client.
Note that conversion of password protected
PDF files is not supported on the Server
(when convertonclient=false).
ConvertOnClientCADExtensions List of CAD document

extensions to be converted This parameter tells Brava what CAD
on the client. Default value formats can be converted on the client.
is: If ConvertOnClient is set to true and
000,906,907,bmp,cal,cg4,cg the document extension is listed here,
m,cit,cmi,mi,dcx,dft,dg,dgn,d Brava will try to convert the file on the
gn7,dif,dwf,dwg,dx,dxf,edc,e client by passing the publishing event.
dm,ftk,g3,g4,gp4,igs,iso,jpg,j
peg,mil,mot,mvs,pcx,plt,prt,p
s,rlc,rle,rnl,slddrw,tif,tiff,dsn,rt
l,txt,png,hgl,idw,axp,gif,cc,ps
d
26
ConvertOnClientOfficeExtension List of Office document

s extensions to be converted This parameter tells Brava what Office
on the client. Default value formats can be converted on the client.
is: If ConvertOnClient is set to true and
cdr,dbf,doc,drw,fax,flw,fmt,fw the document extension is listed here,
k,htm,html,img,mpp,msg,pcd Brava will try to convert the file on the
,pct,pic,pict,ppt,pps,ppt,prs,p client by passing the publishing event.
rz,rnd,rtf,sam,shw,vsd,vw,wb Use of this parameter requires special
1,wb2,wdb,wk1,wk3,wp,wp5,
licensing.
wp6,wpd,wpf,wpg,wq1,wri,w
s,xbm,xls
ConvertOnClientImageExtension List of image format
s This parameter tells Brava what image
extensions to be
formats can be converted on the client.
converted on the client.
If ConvertOnClient is set to true and
Default value is:
the document extension is listed here,
tif,pdf,bmp,png,gif,jpg,cal,
Brava will try to convert the file on the
csf
client by passing the publishing event.
DllPath A valid path location

Users can edit the DllPath
where all Dll files
BravaXParam within the
downloaded for the Brava
server_precedence.properties, the
Client will be placed.
HTML page, or
(Note that DllPath cannot
client_precendence.properties file
be a user-specific
(listed in descending order of
dynamic location)
precedence). All files that are
installed from the .cab need to be in
the path location specified in DllPath
EnableConvertOnClientOfficeFor TRUE
mats FALSE - Default Enables/disables Convert on Client for
Office Document formats.
EnableConvertOnClientCADFor TRUE
mats FALSE - Default Enables/disables Convert on Client for
CAD formats.
EnableConvertOnClientImageFo TRUE Default

rmats FALSE Enables/disables Convert on Client for
Image formats.
DefaultBackgroundColor DEFAULT Default*

BLACK Allows the documents default background
WHITE color be overridden (effects all file types).
GRAY (or GREY)
EnableFileExtensions TRUE Default
FALSE Enables/disables the default use of adding
the original format file extension to CSF
and PDF output from Brava.
EnableBackground TRUE Default

FALSE Turns on/off the Background Color Options.
EnableBookmarkPanel TRUE
When set to true, Brava will display the
FALSE - Default
Bookmark panel in the right side of the
viewing window. If set to false, the panel
will not display in the viewer, nor will its
corresponding menu items and hotkeys.
27
EnableExternalBookmarks TRUE - Default

FALSE This parameter controls whether the
External Bookmarks functionality is
enabled. True allows setting session based
external bookmarks and enables a
bookmarks button on the main toolbar. Use
False to disallow setting external
bookmarks.
BookmarkTitle<n> <category>|<title>
Category and title can be any This setting is used to pre-populate the
valid word, phrase or alpha settings listed in the drop down list in the
numeric string Add Bookmark dialog.
Format:
BookmarkTitlen=<category>|<title>
Where n is any integer (>=1)
Examples:
bookmarktitle1=mycategory|mytitle
bookmarktitle2=my second category|my
other title
bookmarktitle3= my second category|my
newer title
In this example, when Brava is launched
and a bookmark is added, you will have two
categories for selection in the drop down
list ('mycategory' and 'my second
category'). 'Mycategory' will have only one
title option ('mytitle') while 'my second
category' will have two titles ('my other title'
and 'my newer title')
CapitilizeDbUpdateLabel TRUE
FALSE Default If set to True, the labels for the dialog items
will be equal to the DbUpdateToken string
value, except that underscores will be
replaced with spaces, and the first letter of
every word will be capitalized.
DbUpdateStringNotRetrieved Hide or not set

If set to Hide, then the client will not display
that field in the DbUpdateString dialog. If
not set, the default behavior is to show the
field in the dialog with a blank value. In
future releases, this parameter may be
updated to accept additional values other
than Hide.
HideStampDialogOnPlacement TRUE
FALSE If set to True, when the stamp is initially
placed, the bi-directional stamp dialog will
not display. Note that the stamp must
contain at least one token besides a
dbupdatestring token to be able to detect
whether stamp placement is occurring. In
order to enable this functionality, an
integration may want to add a dbstring
token in the stamp, and have the
28
integration display a blank string for that

dbstring token.
RefreshStampOnCancel TRUE
FALSE If set to True, when a user cancels out of
the bi-directional stamp dialog, the stamp is
updated with the most current values from
the server. On an initial stamp placement
(there must be at least one token that is not
a dbupdatestring for the integration to
detect initial stamp placement), the stamp
is always populated with the latest values
from the server, regardless of whether the
user selects Cancel.
EnableCopyText TRUE Default

FALSE Turns on/ off the users ability to copy text
from documents viewed in the Brava Client.
EnableDefaultPrivate TRUE
Sets the Private option in the markup Save
FALSE - Default
As dialog to be enabled by default.
EnableDefaultVersion TRUE
FALSE - Default Sets the Version option in the markup Save
As dialog to be enabled by default. Note
that the Markup Save As dialog does not
display at all if EnablePrivate and
EnableVersion are set to FALSE, and
AutoNameMarkup is set to TRUE.
EnableLayers TRUE Default

FALSE Turns on/off Bravas ability to show a
documents layers.
EnableMagnifier TRUE Default

FALSE Turns on/off Bravas Magnifier tool item so
it no longer appears on the toolbar.
EnableMeasurement TRUE Default

FALSE Turns on/off Bravas Measurement tools
and functionality.
EnableMirror TRUE Default

FALSE Turns on/off Bravas ability to mirror raster
files (such as Tiff). If the option is on when
the user right clicks a raster image in the
Brava client, a mirror context menu item will
be available.
EnableMono TRUE Default

FALSE Turns on/off the Monochrome Display Tool.
29
EnablePrinting TRUE Default

FALSE Turns on/off printing in the Brava Client.
See also:
disable_printing_for_these_formats
printing_control_for_users/groups
EnableRotate TRUE Default

FALSE Turns on/off the ability to rotate the views of
files.
EnableSaveView TRUE Default

FALSE Turns on/off the Save/Publish menu button
option. This option takes priority over the
following parameters settings:
EnableSaveViewasJPG,
EnableCSFPublishing, and
EnablePDFPublishing.
EnableSaveViewAsJPG TRUE
FALSE Default Prevents/allows viewers from creating JPG
snapshots of the currently viewed CSF file.
EnableThumbnails TRUE Default

FALSE Turns the Page Thumbnails feature on/off.
EnableZoomWindow TRUE Default

FALSE Turns on/off the Zoom Window Tool.
HyperlinkLaunch one - All documents launch

in a single separate window Determines how Brava handles hyperlinks
from Brava (2 windows). in files being viewed by the Brava Client.
default (default value) All

documents launch in multiple
separate windows (multiple
windows).
self Documents launch in

the frame (if frameset
present) that the Brava
Viewer is in.
top Documents launch in

the same instance of the
browser window replacing its
current contents.
LaunchBravaInNewWindow TRUE
FALSE Default Setting this parameter to TRUE will force
Brava to launch in a new Browser window
or tab.
To have Brava launch in new tabs instead
of new windows, adjust the following in IE:
1. From the Internet Options dialog, select
Settings.
2. Select "Always open Pop-ups in a new
tab" from the When a pop-up is
30
encountered section.
3. Optionally, you can select "Always switch
to new tabs when they are created" if you
want to adjust focus to the Brava window
when it is launched.
MeasurementSettings This is a string of four

integers, separated by a |. Controls the initial values of the
Integer values are listed in measurement settings dialog.
the next column. The first integer is the measurement
system. Valid values are:
0 = ENGLISH_ARCHITECTURAL
1 = ENGLISH
2 = METRIC
3 = UNITLESS
The second integer is the units. Valid
values are:
0 = INCHES
1 = FEET
2 = METERS
3 = MILIMETERS
4 = CENTMETERS
5 = MILES
6 = KILOMETERS
7 = UNITLESS
8 = YARDS
The third integer is the distance precision.
Valid values are:
0 = MEAS_PREC_1
1 = MEAS_PREC_2
2 = MEAS_PREC_3
3 = MEAS_PREC_4
4 = MEAS_PREC_5
5 = MEAS_PREC_6
The fourth integer is the architectural
distance precision. Valid values are:
0 = ARCH_PREC_ONE
1 = ARCH_PREC_ONEHALF
2 = ARCH_PREC_ONEQUARTER
3 = ARCH_PREC_ONEEIGHTH
4 = ARCH_PREC_ONESIXTEENTH
If the format is incorrect or if the values are
inconsistent (i.e. system is English and
units are meters), the parameter value is
ignored.
Example:
MeasurementSettings=0|0|0|0
PrintMeasurementSystem 0 = English Controls the measurement system initially

1 = Metric displayed in the print dialog
31
PaperViewSize Entered as Width, Height,

inches or meters Scale an image to a particular paper size.
The Brava clients render engine can then
Default value is 22 x 36 map the documents world space
inches (entered as 22,36,i) coordinates to real world coordinates. This
value affects the zoom percentage and size
of print banners relative to the overall size
of the published PDF file.
SaveViewQuality Any whole number between

1 and 100 (100 is best, 1 is Adjusts the quality of the jpeg created with
worst, 75 is default) the Save View As JPEG function.
SearchTextAtStartup Any Valid Word, Phrase or

Alpha Numeric String Performs a search of the file loaded in the
(has no default value) Client using the Value as the search string.
TimeZone The valid syntax is:

tzn[+ | ]hh[:mm[:ss] ][dzn] Specifies a single common Time zone for
Where: all time/date stamps used by the Brava
tzn = Three-letter time-zone system.
abbreviation.
hh = Difference in hours
between UTC (Universal
Time Coordinate) and local
time. Optionally signed.
mm = Minutes. Separated
from hh by a colon (:).
ss = Seconds. Separated
from mm by a colon (:).
dzn = The three-letter
daylight-saving-time zone
such as PDT. If daylight
saving time is never in effect
in the locality, no dzn
value.(Default is blank, which
local client system time
zone)
UseACSIfAvailable TRUE Default
FALSE Setting this to False causes Brava to not
use ACS (even when Webtop notifies that
ACS is working) when Brava is launched.
Sometimes Webtop/WDK sends a
response that ACS is functioning but will
fail to provide a valid ACS URL. This
setting provides a means to get past this
issue without requiring any code changes.
UseBravaSession TRUE Default

FALSE This value tells Brava whether to attempt to
obtain a Brava Server Session when
launched. If Brava Server Session Tracking
is disabled on the server you should also
set this to false to avoid any issues with
invalid sessions. Typically, this would only
need to be changed with odd configurations
or with Firewall setups.
32
WatermarkBannerFontName Any valid font (font must

exist on all systems or the Specifies the default font name for
font will revert back to the Watermarks and ISO Banners.
default font if specified font in
not available)
WatermarkBannerFontStyle Valid values are:

0 Plain 2 Italic Specifies the default font style to use for
1 Bold 3 Bold Italic Watermarks and ISO Banners.
WatermarkLineSpacing Valid values are 0, 1,

2(default), or 3 Specifies the print density of the print
watermark. A value of 0 prints the most
opaque watermark, while 3 prints the most
transparent.
WatermarkFolders TRUE
FALSE Default Turn on/off the ability to create watermarks
based on the folder name where the
content resides. Brava checks the folder
name set in WatermarkFolderName and
compares it to the current folder to see if
Brava should display this folder name as a
watermark.
WatermarkFolderName Any valid document folder

name If the document being viewed is in this
folder and the WatermarkFolders
parameter is set to True, the watermark will
be set to be the folder name. Multiple
values are allowed, but need to be
separated by a comma (i.e.
folder1,folder2,folder3). Note: The
watermark will be seen both on-screen and
when printed.
SecurityOptionsFromServer TRUE
FALSE Default Turns on/off getting the CSF security
options (the security.xml file) from the
Brava Server and not interactively from the
user.
EnableCSFPublish TRUE Default

FALSE Turns on/off the Publish as CSF option in
the Save/Publish Menu.
EnableSaveCSFFile TRUE Default

FALSE Turns on/off the ability to save a CSF file as
a new to the local system.
EnableSaveCSFEmail TRUE Default

an attachment to an email message (MS
Outlook or MS Exchange).
EnableSaveCSFRendition TRUE Default

a Rendition of the file in the Docbase.
EnableSaveCSFNewDocFile TRUE Default

a new file to the users home cabinet.
33
EnableSaveAsMajVersionCSF TRUE Default

a new major version of the original file.
Note that the user needs to have at least
WRITE privileges on the object for the
Publish as Major Version option to be
available as a publishing option.
EnableSaveAsMinorVersionCSF TRUE
FALSE Default Turns on/off the ability to save a CSF file as
the next logical minor version of the original
file.
EnableSaveAsSameVersionCSF TRUE
FALSE Default Turns on/off the ability to save a CSF file as
the same version of the original file,
overwriting the current version. Use with
care.
AutoNameCSFImport TRUE
FALSE Default Turns on/off the ability to have the CSF file
automatically name itself when saved. If set
to true, user is not allowed to manually
enter a name.
AuditBravaView TRUE Default

FALSE A value of TRUE logs a "brava_view" event
to the audit trail of the document when
Brava is launched. This enables some
basic auditing events such as opening a file
and saving a markup file. When set to
False, no audit trail is logged. Set to True to
enable additional audit events. See
Enabling additional Brava audit events.
DefaultCSFPublishOption Valid values:

Sets the Default Publish/Save method for
File New file to local the CSF Publish Option.
system
Email New file as email Hint: Setting a default method and turn off
attachment (Exchange or the individual options will allow you to
Outlook only) restrict the Publish Option to a single
option. Set AutonameCSFImport to TRUE
Rendition To Docbase as will allow for only 1 method and without
a CSF rendition prompting.
NewDocFile New File to
Docbase Home Cabinet
MajorVersion As a New
Major Version to the original
file
MinorVersion As the next
logical minor version of the
original file
SameVersion Overwrites
current file version
34
TiffExportOutputMonochrome TRUE Default

FALSE If set to TRUE, all published output will be
monochrome. If set to FALSE, all
published output will be the color of the
current document/drawing. This parameter
affects the UI state of the radio buttons
controlling color output found in the TIFF
Publish Options dialog.
DisplayTIFFExportOptions TRUE Default

FALSE If set to TRUE, a dialog displays allowing
the end-user to set publishing output
options. If set to FALSE, no options dialog
displays and documents will publish with
default options and/or options set by the
TIFF Export parameters.
DisplayPDFExportOptions TRUE Default

FALSE If set to TRUE, a dialog displays allowing
the end-user to set publishing output
options. If set to FALSE, no options dialog
displays and documents will publish with
default options and/or options set by the
PDF Export parameters.
EnablePDFPublish TRUE Default

FALSE Turns on/off the Publish as PDF option in
the Save/Publish Menu.
EnableTIFPublish TRUE Default

FALSE This parameter enables/disables the
Publish To TIFF menu item from the
toolbar Save and Publish button. If
EnableSaveView is set to false, this setting
is ignored.
EnableSavePDFFile TRUE Default

FALSE Turns on/off the ability to save a PDF file as
a new to the local file system.
EnableSaveTIFFile TRUE Default

FALSE Turns on/off the ability to save a TIFF file
as a new to the local file system.
EnableSaveTIFEmail TRUE Default

as an attachment to an email message (MS
EnableSaveTIFRendition TRUE Default

as a Rendition of the current file in the
Docbase.
EnableSaveTIFNewDocFile TRUE Default

as a new file to the users home cabinet.
EnableSaveAsMajorVersionTIF TRUE Default

as a new major version of the original file.
35

EnableSaveAsMinorVersionTIF TRUE
FALSE Default Turns on/off the ability to save a TIF file as
file.
EnableSaveAsSameVersionTIF TRUE
FALSE Default Turns on/off the ability to save a TIF file as
care.
AutoNameTIFImport TRUE
FALSE Default Turns on/off the ability to have the TIF file
automatically name itself when saved.
DefaultTIFPublishOption Valid values:

Sets the Default Publish/Save method for
File New file to local the TIF Publish Option.
system
Hint: Setting a default method and turn off
Email New file as email the individual options will allow you to
attachment (Exchange or restrict the Publish Option to a single
Outlook only) option. Set AutonameTIFImport to TRUE
will allow for only 1 method and without
Rendition To Docbase as
prompting.
a CSF rendition
NewDocFile New File to
file
original file
EnableSavePDFEmail TRUE Default
an attachment to an email message (MS
EnableSavePDFRendition TRUE Default

a Rendition of the current file in the
Docbase.
EnableSavePDFNewDocFile TRUE Default

a new file to the users home cabinet.
EnableSaveAsMajVersionPDF TRUE Default

a new major version of the original file.
36
EnableSaveAsMinorVersionPDF TRUE
FALSE Default Turns on/off the ability to save a PDF file as
file.
EnableSaveAsSameVersionPDF TRUE
FALSE Default Turns on/off the ability to save a PDF file as
care.
AutoNamePDFImport TRUE
FALSE Default Turns on/off the ability to have the PDF file
automatically name itself when saved.
DefaultPDFPublishOption Valid values:

File New file to local Sets the Default Publish/Save method for
system the PDF Publish Option.
Email New file as email Hint: Setting a default method and turn off
attachment (Exchange or the individual options will allow you to
Outlook only) restrict the Publish Option to a single
Rendition To Docbase as option. Set AutonamePDFImport to TRUE
a CSF rendition will allow for only 1 method and without
NewDocFile New File to prompting.
file
original file
UsePdfRendition TRUE Default
FALSE If set to TRUE Brava will use the PDF
Rendition of a file is available. If set to
FALSE Brava will use the original file. This
setting is ignored (disabled) if launching
Brava Viewer through the renditions
screen.
See also:
PDF_Rendition_Control_For_Groups and
_Users
EnableThreadedXdlLoad TRUE Default

FALSE If set to TRUE (the default), the Brava
Client control loads documents in a
separate thread and does not allow focus
to be set to the IE browser during the
loading process. If set to FALSE, the
document loading process happens in the
IE browser's main thread, which can cause
conflicts with other applications that need to
receive events from Windows main event
loop.
37
EnableThumbnailsResize TRUE Default

FALSE Controls whether the Page Thumbnails can
be resized. If set to TRUE (the default), the
images can be resized by clicking the right
mouse button (over the Thumbnails panel)
and selecting Reduce Page Thumbnails, or
Enlarge Page Thumbnails from the menu. If
FALSE, the right mouse menu is disabled
and images remain at the default size.
The following parameters control markup behavior.
TRUE Default
EnableMarkup Turns on/off the Markup option.
FALSE
This is a markup entity GUID. If a changemark

having this GUID exists in the currently open
TRUE document (i.e. a CSF with burned in markups) or
AutoloadChangemark
FALSE - Default any preloaded markup file(s), that Changemark will
be "executed" upon load of the document if set to
TRUE.
If set to True and any Changemarks exist in the

currently open document or in any preloaded
markup file(s), the Changemark panel will be
TRUE
AutoloadChangemarkPanel displayed upon load of the document. If the
FALSE - Default
Changemark panel is auto loaded, the Changemark
panel will display and override any Thumbnail panel
display setting.
Determines whether to append pages listing the

AddChangemarkInfoPageT TRUE
contents of Changemarks (if they exist on the
oPublishedPDF FALSE - Default
current file) when publishing to PDF.
Indicates how Brava will handle Brava Markup

Comment (Default) Changemarks when publishing a file to PDF with
PDFMarkupType Burnin open markup(s) that contains Changemarks.
Choice Only 'Comment' burns in Changemarks as Adobe
style annotation entities.
TRUE Default
EnablePrivate Turns on/off the Save Markup as Private function
FALSE
Turns on/off the Save Makeup with all versions

TRUE Default function. Note that in order for the permissions to
EnableVersion
FALSE work properly, you must have performed the
installation step in section 3.1.
Turns on/off the ability to copy most markup objects

EnableCopyMarkupToAllPa TRUE to all pages of a file that has an active markup in
ges FALSE - Default Brava. (Non copy able entities include strikethrough,
Changemarks, and block-out.)
38
Turns on/off the ability to transfer ownership of a

markup entity. If set to TRUE, when a user shift-
EnableMarkupChangeOwne TRUE
clicks on a markup entity (in a markup open for edit)
r FALSE - Default
using the markup select tool, the author information
of that entity changes to the current author.
TRUE Default Turns on/off the markup menu option to Review all
EnableReviewChangemarks
FALSE Changemarks.
This parameter enables/disables the Consolidate

TRUE
EnableMarkupConsolidate Markups item on the Markup menu if at least two
FALSE - Default
markups are open (for edit or for review).
This parameter controls whether the user can

create/edit markup stamp templates. Set to False by
EnableMarkupStampTempl TRUE default (can't create new stamps). This feature will
ate FALSE - Default be enabled (True) if the user has Delete access on
an object, regardless of the parameter setting in the
brava_parameters.properties file.
If this setting is TRUE, the markup consolidation

TakeOwnershipOnMarkupC TRUE action will change the ownership of ALL consolidate
onsolidate FALSE - Default markups entities associated with the drawing to the
current user.
If set to TRUE, this enables the Consolidate

EnableConsolidateIfMarkup TRUE Markups item on the Markup menu if a markup is
OpenedForEdit FALSE - Default open for edit, regardless of the
EnableMarkupConsolidate value.
Sets the default path for the Markup Raster tool. The
path must be set using double back slashes to work
Default value is properly. It is recommended that you use a path
MarkupRasterDirectory %USERPROFILE%\\IGC relative to and within the users profile. The path
\\StampImages starting point of %USERPROFILE%\\ should help to
ensure that the user has the proper permissions to
the raster image files.
39
Name (or names,

separated by a comma) Preloads the specified markup(s) as read only
of a valid markup file in (Opened for Review)
PreloadReadOnlyMarkupNa
the Docbase for the file
mes If markup does not exist no markup is opened or
being opened or ALL (to
open all the markups created).
related to that file).
Name of a markup in the

Docbase, if the markup
Opens a specific mark file name as editable if
PreLoadMarkupName does not exist one will be
allowed.
created for saving with
that name.
TRUE Default
Enablemarkuparrowtool Turns on/off the markup toolbar arrow tool.
FALSE
TRUE Default
Enablemarkuptexttool Turns on/off the markup toolbar text tool.
FALSE
Enablemarkupchangemarkt TRUE Default Turns on/off the markup toolbar Changemarks tool.
ool FALSE
Enablemarkupcloudgroupto TRUE Default
Turns on/off the markup toolbar cloud tools group.
ol FALSE
Enablemarkupsketchgroupt TRUE Default
Turns on/off the markup toolbar sketch tools group.
ool FALSE
Enablemarkuplineargroupto TRUE Default
Turns on/off the markup toolbar lines tools group.
ol FALSE
Enablemarkupshapegroupt TRUE Default
Turns on/off the markup toolbar shapes tools group.
ool FALSE
TRUE Default
Enablemarkupblockouttool Turns on/off the markup toolbar CSF Blockout tool.
FALSE
TRUE Default Turns on/off the markup toolbar text scratch out,
Enablemarkupabcgrouptool
FALSE Highlight, Underline tools group.
EnableMarkupHyperlinkToo TRUE Default Turns on/off the markup toolbar markup object
l FALSE Hyperlink tool.
TRUE Default
EnableMarkupRasterTool Turns on/off the markup toolbar raster tool.
FALSE
TRUE Default This parameter controls whether the markup stamp

EnableMarkupStampTool
FALSE button is displayed on the markup toolbar.
TRUE Default Turns on/off the markup menu option to close open
EnableMarkupClose
FALSE (for editing) markups.
EnableMarkupCloseForRevi TRUE Default Turns on/off the markup menu option to close
ew FALSE markups open for review.
MarkupColor Any valid color. Color Sets the default markup color to the value specified.
40
name or Hex Values

(#RRGGBB or Windows
Web Safe
Recommended)
TRUE Default Turns on or off Bravas ability Burn-in Markups and
EnableMarkupBurnin
FALSE output a CSF file.
TRUE Default
EnableMarkupColorPalette Turns on or off Bravas markup color palette.
FALSE
Saves Markups to the Docbase as a DXF file. This
TRUE setting is useful if you want to save markups locally
EnableMarkupSaveAsDXF
FALSE Default to be opened in AutoCAD. Currently, the file cannot
be checked into the Documentum Content Server.
Any valid font (must exist

on all systems or will
Sets the Default Markup Font for the Markup Text
DefaultTextMarkupFont revert back to the default
Tool. Effects Markup Text Tools default font.
font if specified font is not
available).
Turns (automatically) naming of all markup files

saved to the Docbase on or off. If set to TRUE, the
TRUE name of the markup file will be the same as the
AutoNameMarkup
FALSE Default name of the document.
This parameter controls whether the user can

EnableMarkupStampTempl TRUE
create/edit markup stamp templates. The default
ate FALSE Default
value is FALSE for creating new stamps
The following parameters control markup permissions and default markup permissions for users
with READ access.
TRUE
EnableMarkupNew Turns on/off the ability to create a new markup.
FALSE Default
TRUE
EnableMarkupReview Turns on/off the ability to Review a markup.
FALSE Default
TRUE
EnableMarkupSaveAs Turns on/off the ability to Save a markup as
FALSE Default
TRUE
EnableMarkupOpen Turns on/off the ability to open a markup for edit.
FALSE Default
TRUE Turns on/off the ability to save a markup without giving

EnableMarkupSave
FALSE Default a markup open for editing a new name.
If TRUE, only one markup can be created for each

user for each file. It will open the existing markup
TRUE created by the user for edit when one exists or it will
EnableSingleEditableMarkup
FALSE - Default create a new markup for editing when none exists. To
use this feature, EnableMarkupNew must be set to
FALSE.
The markup permissions above are overwritten depending on the permission settings below.
These can be modified to fit your needs. RELATE permission grants you the following:
41
TRUE Default
RELATE_EnableMarkupSaveAs Turns on/off the ability to Save a Markup As
FALSE
TRUE Default
RELATE_EnableMarkupNew Turns on/off the ability to create a new markup.
FALSE
TRUE Default
RELATE_EnableMarkupReview Turns on/off the ability to Review a markup.
FALSE
TRUE Default Turns on/off the ability to save a markup without
RELATE_EnableMarkupSave
FALSE giving a markup open for editing a new name.
TRUE Turns on/off the ability to open a markup for

RELATE_EnableMarkupOpen
FALSE Default edit.
HRELATE (higher than relate) grants you the following:
TRUE Default
HRELATE_EnableMarkupSaveAs Turns on/off the ability to Save a markup as
FALSE
TRUE Default
HRELATE_EnableMarkupNew Turns on/off the ability to create a new markup.
FALSE
TRUE Default
HRELATE_EnableMarkupReview Turns on/off the ability to Review a markup.
FALSE
TRUE Default Turns on/off the ability to save a markup without

HRELATE_EnableMarkupSave
FALSE giving a markup open for editing a new name.
TRUE Turns on/off the ability to open a markup for

HRELATE_EnableMarkupOpen
FALSE Default edit.
TRUE
Printing_Control_For_Groups Turns on/off print control for groups.
FALSE Default
TRUE
Printing_Control_For_Users Turns on/off print control for users.
FALSE Default
Adding a format to this comma delimitated

list disables printing through Brava if the
current document's format is in this list.
Note that if printing is disabled for PDF
files, then printing of PDF renditions will
Coma separated list also be disabled. For example, if
Disable_printing_for_these_formats of supported UsePdfRendition is True, then all files that
document formats have PDF renditions will have the PDF
rendition loaded for viewing in Brava and
not the original file format. Because these
are PDF files, which may not be obvious to
the end-user, the disable printing for PDF
format will be active.
int NONE=1;BROWSWE=2:RELA As written DO NOT EDIT THIS LINE !!!
42
Controls printing functionality of all valid listed

groups. If you use the ( ) character for a value
in this parameter, it must be encoded. For
Coma separated list example, if Group Name: Standard "Group" One
disable_These_Groups_For_Printin
of valid Documentum needs to have printing disabled. The correct
g
Groups value would be Standard \"Group\"One.
String disable_These_Groups_For_Printing =
"Standard \"Group\" One " ;
Controls printing functionality of all valid listed

users. If you use the ( ) character for a value in
this parameter, it must be encoded. For
Coma separated list example, if User Name: Standard "User" One
disable_These_Users_For_Printing of valid Documentum needs to have printing disabled. The correct
Users value would be Standard \"User\"One.
String disable_These_Users_For_Printing =
"Standard \"User\" One " ;
PDF_Rendition_Control_For_Group TRUE Default Turns on/off PDF rendition viewing access for
s FALSE groups when UsePDFRendition is enabled
TRUE Turns on/off PDF rendition viewing access for

PDF_Rendition_Control_For_Users
FALSE Default users when UsePDFRendition is enabled
Coma separated list Controls group access to viewing the PDF

Disable_These_Groups_For_Viewin
of valid Documentum Rendition of a file when UsePDFRendition is
g_PDF_Rendition
Groups enabled.
Coma separated list Controls user access to viewing the PDF

Disable_These_Users_For_Viewing_
of valid Documentum Rendition of a file when UsePDFRendition is
PDF_Rendition
Users enabled.
Coma separated list

Allow_These_Groups_To_Control_S Controls group access to creating stamp
of valid Documentum
tamp_Templates templates.
Groups
Coma separated list

Allow_These_Users_To_Control_St Controls user access to creating stamp
of valid Documentum
amp_Templates templates.
Users
Note: Based on the above permission sets with Printing, Stamp Templates, and Disabling PDF
Renditions where Permissions can be set based on Groups and Users, setting control to both (by
Group and User) will result in the default (User) overriding the Group setting.
Example:
Printing_Control_For_Groups=TRUE
Printing_Control_For_Users=FALSE
43
PDF_Rendition_Control_For_Groups=FALSE
PDF_Rendition_Control_For_Users=TRUE
The following parameters control licensing behavior:
Turns on license checking based on

groups. If this value is set to true, when
Brava is launched, it checks to see if the
Licensing_Control_For_CAD_Group TRUE
s FALSE Default
current user is listed in the groups for the
License_These_Groups_For_CAD
parameter. If found, the user is given a
CAD license.
Turns on license checking based on users.

If this value is set to true, when Brava is
launched, it checks to see if the current
TRUE
Licensing_Control_For_CAD_Users
FALSE Default
user is listed in the
License_These_Users_For_CAD
CAD license.
Turns on license checking based on

groups. If this value is set to true, when
Brava is launched, it checks to see if the
Licensing_Control_For_Documents TRUE
_Groups FALSE Default
current user is listed in the groups for the
License_These_Groups_For_Documents
Document license.
Turns on license checking based on users.

If this value is set to true, when Brava is
launched, it checks to see if the current
Licensing_Control_For_Document_ TRUE Default
Users FALSE
user is listed in the
License_These_Users_For_Documents
Document license.
List the groups that Brava checks to see if

the user is a part of. If the user is found in
Any valid group in one of these defined groups, the user
Document.
License_These_Groups_For_CAD
Default value is
receives a CAD license. The groups should
empty be comma deliminated. Assuming
Licensing_Control_For_CAD_Groups is set
to TRUE.
List the groups that Brava checks to see if

the user is a part of. If the user is found in
Any valid group in one of these defined groups, the user
License_These_Groups_For_Docum Document.
ents Default value is
receives a Document license. The groups
empty should be comma deliminated. Assuming
Licensing_Control_For_Document_Groups
is set to TRUE.
44
List of users that Brava checks to see if the

current user is part of. If the user is listed
as one of these defined users, he receives
a Document license. The users should be
Any valid user in comma deliminated. Assuming
License_These_Users_For_Docume Document.
nts
Licensing_Control_For_Document_Users
Default value is
empty is set to TRUE. Note that this parameter
uses the Users short login name (e.g., Log-
in name = johnd), and not the full Webtop
name (e.g., Full Webtop name = John
Tester Doe)
List of users that Brava checks to see if the

current user is part of. If the user is listed
as one of these defined users, he receives
a CAD license. The users should be
Any valid user in comma deliminated. Assuming
Document.
License_These_Users_For_CAD Licensing_Control_For_CAD_Users is set
Default value is
empty to TRUE. Note that this parameter uses the
Users short login name (e.g., Log-in name
= johnd), and not the full Webtop name
(e.g., Full Webtop name = John Tester
Doe)
Note: Based on the above permission sets, if the user/group falls into more than one possible
user/group slot they will receive the better license. For instance, if
Licensing_Control_For_Documents_Groups is set to TRUE and the current user falls into one of
the defined groups in the parameter License_These_Groups_For_Documents
while at the same time Licensing_Control_For_CAD_Users is set to TRUE and the user also falls
into that slot, the user will receive a CAD license and NOT a Document license.
3.4 Customizing the Webtop Integration components
Before you begin copying over any customizations, make a backup copy of your existing
<webserver directory>/webtop/custom directory.
Tip: When you are either adding or extending an already customized Webtop application, the
following tips can help to simplify the process and make it less prone to error.
1. Make two additional copies of your complete Webtop deployed directory.
2. Name one directory Brava Webtop and name the other for your custom integration, or,
if you have an existing Webtop Integration, name the second copy of the Webtop
directory Default Webtop.
3. Remove all of your customizations from the Default Webtop directory.
4. In the Brava Webtop directory, remove all directories from the Custom folder and then
add the contents of the provided Brava Customized Directory appropriate for the
version of Webtop you are using.
45
5. Test the generic Brava integration, Default Webtop, and <Your Custom Webtop
Integration>. All three should work as expected.
6. In the directory that contains the default Webtop application, combine the directories,
sub-directories, and the unique (xml, jsp, or properties) files they contain. If both
<Your Custom Webtop Integration> and the Brava Webtop Integration contain the
same files, you will need to carefully combine the contents of the two files to create a
single file. Its important to remember that some of the content will be the same and
some will be unique. When combining files with the same name in both integrations, be
sure to include all of the unique code and not copy the duplicate code.
Follow the set of instructions below depending on whether you built your Webtop server on
Tomcat or WebLogic.
For Tomcat:
1. In a text editor, open the web.xml file (located at the root of your application server e.g.,
webapps\webtop\WEB-INF folder). Verify that you have the top-level application folder set
to custom. For example:
<context-param>
<param-name>AppFolderName</param-name>
<param-value>custom</param-value>
</context-param>
2. If no current customizations/configurations are present, copy the contents of the entire

IGC/Brava! 6.2 Webtop/custom directory from your Brava! Server install into your
<webserver directory>/webtop/custom directory in the Webtop install location. The install
location would be: //..Apache Tomcat 6.0/webapps/webtop/custom. (See NOTE below
for existing customizations)
For WebLogic:
1. If no current customizations/configurations are present, copy the contents of the Brava
'custom' folder to replace the current contents of the custom folder in your
\webtop\custom directory. Warning dialogs should pop up stating that "some folders
already exists do you wish to overwrite them?". Select YES. (If current customizations
exist, see Note below.)
2. Restart your Weblogic Webtop server, update the webtop web app in the BEA Weblog
console and the Brava! customizations/configuration changes should be present.
_____________________________________________________________________
*NOTE: If the Webtop product has previously undergone a customization, cautiously merge both
the current customization and the Brava customization files together as outlined in the Brava
Webtop Developers guide (contact IGC). If no customizations are present, you can simply copy
the custom folder from the Brava! installation directory into your webapps\webtop directory.
46
3.4.1 Adding Custom Stamps (Raster Images)
You can add your own directory of custom raster images to be used with the integration. These
images are available to the client machines when using the Insert Raster Image markup entity in
Brava markup mode.
1. Create or gather your desired raster images (PNG or JPG) and place them in a zip file.
2. Rename the file StampImages.bin
3. Place the bin file in the <application
server>\webapps\webtop\custom\brava\component\markup directory.
4. The bin file will automatically be downloaded to the client machines and unzipped to the
StampImage directory defined by the MarkupRasterDirectory parameter. By default, this is
C:\Documents and Settings\<user_name>\IGC\StampImages
3.4.2 Configuring Brava for Webtop in Multi-select Launch Mode
You can configure Brava ActiveX viewer to launch multiple brava views at once when multi-
selecting documents. To do this:
1. From the custom/brava directory, copy the
brava_multiselect_dm_sysobject_configuration.xml file and paste it into the
webtop/custom/config/brava directory.
2. Delete the file brava_singleSelect_dm_sysobject_configuration.xml from the
webtop/custom/config/brava directory.
3. Located in the C:\Program Files\IGC\Brava! Webtop\Brava! Webtop Server directory, open
the server_precedence.properties file and edit it by uncommenting and changing this
line (#EnableThreadedXdlLoad=True) from true to false:
EnableThreadedXdlLoad=False
4. Located in the webtop/custom/config/brava directory, open the
brava_parameters.properties file and set the following:
LaunchBravaInNewWindow=TRUE
EnableThreadedXdlLoad=FALSE
5. Restart your Webtop and Brava application server(s).
IMPORTANT NOTES:
A copy of both of these files is stored in the custom/brava directory, however, there can
only be one of these files in the custom/config/brava directory at runtime: either
brava_singleSelect_dm_sysobject_configuration.xml or
brava_multiSelect_dm_sysobject_configuration.xml. If the custom/config/brava directory
contains both files, the annotate menu item will appear twice.
The optional Brava Flash viewer does not support multi-select launching.
47
3.4.3 Enabling additional Brava audit events
To enable Documentum to log specific Brava events into the audit trail, you must set the AuditBravaView
parameter to TRUE in the brava_parameters.properties file. All of the events that can be audited are listed in
the Interface_detailsBravaClient.pdf document located in your installation folder.
In addition, those events are contained in the custom650sp1 or

custom650sp2/brava/component/markup/markup.jsp file.
To enable any of these additional events to be audited, simply uncomment the // on the event you wish to
add to Bravas auditing trail.
For example:
<taken from markup.jsp>
....
<SCRIPT language="javascript" type="text/javascript" for="BravaXClient"

event="XDLIsComplete()">
//doAuditEvent("XDLIsComplete:", "", objectid);
</SCRIPT>

event="PrintJobComplete()">
//doAuditEvent("PrintJobComplete:", " ", objectid);
</SCRIPT>
....
The below example will enable the auditing of a completed print job thru the Brava
Interface. Simply remove the '//' on the line where the printjobcomplete event is caught:

doAuditEvent("PrintJobComplete:", " ", objectid);
</SCRIPT>
Now the following would be added to this object audit trail: PrintJobComplete:
You can change what is added to the audit trail by modifying the first string in the
doAuditEvent call. So, to add 'print done' instead of 'PrintJobComplete:' it would look like
this:

doAuditEvent("print done", " ", objectid);
</SCRIPT>
You can also add additional information in the 2nd string if needed. This is typically where extra
information returned from the Brava Event is stored.
48
3.4.4 Disabling the Brava! Flash Viewer
The Brava! Flash Viewer menu item is enabled by default on installation. This menu option allows users to
launch documents in the limited feature Brava Flash Viewer rather than the full featured Brava ActiveX client.
To disable the Brava! Flash Viewer, the following lines must be commented out or deleted from the following
files:
From either the brava_singleSelect_dm_sysobject_configuration.xml, or

brava_multiSelect_dm_sysobject_configuration.xml (see section 3.4.2):
<actionmenuitem dynamic='singleselect' name='brava_flash'

nlsid='MSG_BRAVA_FLASH' action='brava_flash' showifinvalid='true'
And from brava_menu_configuration.xml:
<actionmenuitem dynamic='singleselect' name='view_brava_flash' value='Brava!

Flash' action='brava_flash' showifinvalid='true'
3.5 Uninstalling Brava Webtop Components

At some point, you may choose to uninstall Brava Webtop. To do this, run the Add or Remove
Programs command from your Control Panel.
Remove:
Brava! Enterprise Webtop
IGC Writer
The Brava Client and customizations can be removed (reversed) from the Webtop server.
If no configuration customizations have occurred: Delete all items in the
custom/brava/component directory, custom/config directory, custom/strings directory
If you had previous configuration customizations, carefully back out edits that had to be
made for Brava.
49
4.0 Integration Users Guide

This section explains how to use the following Brava features within the Documentum Webtop
application:
Launching Brava Viewer within Webtop
How to Save Markups to the Docbase
Using Webtop Term Hit Highlighting
Using the Webtop Compare Feature
Using the External Bookmark Feature
Using the Watermark Folder Feature
Bi-directional Stamp Feature Overview
Brava 6.2 Startup Debugging
4.1 Launching Brava Viewer from within Webtop
Log into the WDK/Webtop system and navigate to a document you would like to view in Brava.
Webtop 6.5, 6.5 sp1 or sp2 users can view documents in Brava through any of the following
methods:
1. Select Annotate from the File menu.

2. Right click on the file and select Annotate from the popup menu to launch in the
Brava ActiveX viewer.
3. If the document has markups associated, the View Annotations icon will be
present. Click on the Indicator icon to launch the file and markups in Brava.
You can optionally choose to launch documents in the Brava Flash viewer, if enable. Note that multi
content files and launching multiple files at once are not supported with the Flash viewer.
4.2 Saving Markups to the Docbase
See the Brava Viewer help for assistance with creating and saving markups. Note that you
can only create markups if you have Webtop Relate or higher permissions.
1. You can save markups to the Docbase using the Save As feature from within Brava
Viewer.
2. The Brava Webtop Save As dialog displays giving you the option to enter a name
for the markup and to determine your options:
50
a. The default security option is to grant everyone access to your markup. Select
the Private check box to allow only the owner to view and edit this markup.
b. The default behavior is for the saves markup to stay only with the specific file
version. If you would like your markup to be saved with all versions of the
document, select the Save with all Versions check box.
You can view where a documents annotations are stored:
1. Right click on a document that displays the markup exists indicator

2. Select ViewRelationships from the pop up menu.
3. Annotation relationship information displays. The path for the markup file, by
default, is the /Resources/<login name> folder.
Note: See section 3.1 for steps to enable the markups save with all versions feature.
4.3 Using Term Hit Highlighting

Term Hit highlighting will function as below in the Documentum Integration
1. Select the Advanced Search button at top of the Webtop interface
2. Enter search terms on the Advanced Search page and select Search.
3. A list of documents displays that contain the specified search WORDS.
4. Selecting Annotation launches Brava with each search word highlighted. NOTE:
phrases are not supported.
4.4 Using the Webtop Compare Feature

The Documentum Webtop Compare feature allows you to compare two versions of a single
document.
1. From the Webtop interface, right mouse click on a file you want to compare to
another version.
2. Select the Compare To Versions command from the pop up menu.
3. From the Documentum Webtop Versions page, select the icon next to the
version you want to open for comparison.
4. Brava launches and displays the two file versions in Compare mode. View the Brava
help for assistance with using the Brava Compare mode.
51
4.5 Using the External Bookmark Feature

This feature enables the end-user or administrative user to create a bookmark to an item currently
displayed in the Brava client. Users can select a category and title from public bookmarks, including
free text public bookmarks.
To enable this feature, set the parameter EnableExternalBookmarks=TRUE

To make public bookmarks available, define your desired bookmark titles and categories via the
bookmarktitles parameters in the format bookmarktitlesn=categorie|title, where n is any
integer.
The following sample bookmarks are provided in the default installation:

bookmarktitles1=Authority|Temporary Authority
bookmarktitles2=Authority|Power of Attorney
bookmarktitles3=Home Loan Control Documents|Title Search
You can add as many bookmark parameters as you wish, as long as they are incremented by one
integer.
Adding Bookmarks to Documents
In the following use-case example, the bookmark titles are defined as:
bookmarktitles1=Patient Record|Classified
bookmarktitles2=Patient Record|Unclassified
bookmarktitles3=Last Page|Placeholder
bookmarktitles4=Free-Text
There can only be one bookmark file created per document. Using these examples above, to create
bookmarks with Brava:
1. Launch a document with Brava Viewer and click on the document page or object where
you wish to place a bookmark and from the Bookmark button pop up menu, select Add
Bookmark
2. In the Add Bookmark dialog, the Category options defined in bookmarktitles will be
available from the Categoies drop down. If a category is defined with more than one
Title, those selections will be available from the Titles drop down.
52
If you select the special Free-Text category, instead of a drop down field with predefined
titles, the Titles field will be a text entry field where you may type in any title of your
choosing. All users will be able to view the free text bookmark that you entered and
saved to the docbase.
3. The bookmark will be added to the list of docbase bookmarks available for selection
when you choose the Open Bookmark command from the Bookmark menu in step #1.
4. To delete a bookmark, simply select Delete Bookmark from the Bookmark menu,
highlight the bookmark you wish do delete, and click OK.
53
4.6 Using the Watermark Folder Feature

The Documentum Webtop Watermark folder feature allows you to turn on watermarks base on
the folder where the content resides.
In the brava_parameters.properties file, set WatermarkFolders to True, and set a value for
WatermarkFolderName.
This allows you to add a folder name watermark to the files contained in the specified
directory. For example, you have three folders named "Documents", "Invoice", and
"Statement" and only want to apply watermarks to documents that are added to "Invoice"
and "Statement".
Set WatermarkFolders=True
Set WatermarkFolderName=Invoice,Statement
Any file you add or drag to the "Invoices" or "Statement" folder will now have watermarks
applied (the folder name). If you drag and drop a file from "Invoices" to "Documents", the
file will no longer have watermarks applied.
4.7 Bi-directional Stamp Feature Overview
When inserting dynamic stamp tokens into markup text strings, an integration can use the custom
%dbupdatestring and %dbstring tokens in the stamp template to allow communication with
the integration database and to dynamically update the stamp's field label values when the stamp
is inserted into a document markup, or when an end-user double clicks on the inserted markup
stamp.
Stamp templates can be created using mulitple %dbstring and %dbupdatestring tokens for fields
that need to be populated from Webtop. Fields marked with %dbupdatestring will be displayed in
a "bi-directional" dialog when the end-user initially places the resulting stamp on a document, or
when double clicking on the stamp.
Upon dialog initialization, the field values are populated with the latest values from the docbase.
This dialog allows users to update various fields in the docbase. The fields can be either edit
fields or combo boxes. The dialog has two buttons: "Update To Server" and "Cancel".
If the user modifies a field value and then hits 'Cancel', they'll be asked if they want to update
their changes to the server. When the dialog closes, the stamp values will be updated
accordingly.
When the 'Update To Server' button is selected, any values the user has updated are saved
immediately to the server. If the stamp entity that launched the bi-directional dialog is later
deleted, or if the markup that the stamp was added to isn't saved, that doesn't affect the
document attribute values that were previously saved to the server via this dialog.
Token Notes:
54
The values to the %dbstring and %dbupdatestring fields are case insensitive in terms of client
processing. For example, %dbupdatestring(Project) is considered to be the same as
%dbupdatestring(project).
If the server value for a particular token is set to a null or blank value, then the stamp will
display a blank as opposed to the term <no value>.
If the parameter CapitilizeDbupdateLabel is set to true, the labels for the dialog items will be
equal to the %dbupdatetoken string value - except that underscores will be replaced with
spaces, and the first letter of every word will be capitalized. The default for this parameter is
false.
If the %dbupdatestring string is prefaced by _readonly: than the field will be disabled in the
dialog (i.e. %dbupdatestring(_readonly:document_id).
When a stamp is initially placed, or if it is double clicked, values for the dbupdatestring fields
are retrieved from the server. The server's values (displayed in the "bi-directional" stamp
dialog) may be more current than what is currently displayed in the stamp. If the user selects
cancel on the "bi-directional" stamp dialog and if the parameter RefreshStampOnCancel is set
to true, the values on the stamp are still updated with the latest values retrieved from the
server in order to reflect the current status. There must be at least one token that's not a
dbupdatestring for the integration to detect initial stamp placement. On an initial stamp
placement, the stamp's dbupdatestring fields (unless the field is prefaced with
_populateStampOnUpdateOnly, see next bullet) are always populated with the latest values
from the server regardless of whether the user selects cancel.
If the %dbupdatestring string is prefaced by _populateStampOnUpdateOnly, the
corresponding field on the stamp will not be updated until the user selects "Update To
Server". Note that the _populateStampOnUpdateOnly prefix may be combined with the
_readOnly prefix (e.g.
%dbupdatestringtoken(_populateStampOnUpdatePrefix,_readOnly:responsible_person). The
prefixes are order independent and case insensitive.
If the stamp contains a %dbupdatstring starting with "_rowHeight:", the height of each row
will be set to the value after this prefix (i.e. %dbupdatestring(_rowHeight:45). If this token
isn't set, the param DbUpdateStringRowHeight sets the row height. If set to a value of less
than 30 or is not set at all, its value will be set to 30.
If the stamp contains a %dbupdatstring starting with "_labelWidth:", the width of the label
column will be set to the value after this prefix (i.e. %dbupdatestring(_labelWidth:65). If this
token isn't set, the parameter DbUpdateStringLabelWidth sets the width of the label column.
If not set, then its width is calculated based on the longest token string.
If the stamp contains a %dbupdatstring starting with "_editWidth:", the width of the edit
control column will be set to the value after this prefix
(i.e. %dbupdatestring(_editWidth:170). If this token isn't set, the parameter
DbUpdateStringEditControlWidth sets the width of the edit control column. If not set, then its
width is calculated based on the longest value retrieved for the %dbupdatestring fields. The
minimum length for the field is 85, and the maximum is 220.
If the stamp contains a %dbupdatstring starting with "_function:", then the value after the
colon is passed as a http parameter to all server calls. For example, for
%dbupdatestring(_function:marketing) would add the parameter
&dbupdatefunction=marketing to the query string for HTTP GET server calls. For POST calls,
this is added to the header.
If the server does not recognize a field as one it can update, the field does not need to be
returned in the response to the client. If a field is not returned in the client response, and the
55
param DbupdatestringNotRetrieved is set to Hide then the client will not display that field in
the DbUpdateString dialog. If this parameter is not set, the default is to show the field in the
dialog with a blank value.
4.8 Brava 6.2 Startup Debugging
Brava startup logging displays information about how Brava is creating its launch page for the
current user. This information includes ACS status as well as how different Brava parameters are
being set. This logging is controlled by using the Webtop logging system which is built upon the
Apache Logging Library log4j, contained within the Webtop libraries.
The log file location is specified in a log4j.properties file in the (webtop) WEB-INF/classes folder.
Debugging can be turned on by setting the clientlog parameter in the

brava_parameters.properties file to DEBUG. This causes output to be placed into the directory
specified in the log4j.properties file (e.g., Tomcat's default directory would be /Tomcat
<version>/documentum/logs/documentum.log).
56
5.0 Troubleshooting Tips

Problem: Loading a PDF file that has been "Published to PDF" with password protection
results in an error when trying to view the resulting file in Brava for Webtop.
Solution: If clients want to publish and view password protected PDF files, these files must be
converted on the client and not the server. Integrators need to set the parameter
ConvertOnClient (in the brava_parameters.properties file) to TRUE.
Problem: When a user opens a markup layer containing bi-directional stamps, the
dbupdatestring values are not retained after closing the markup.
Solution: When a markup containing a stamp with dbupdatestrings is opened and dynamically
updated, and no other changes to the markup are made, the markup is not recognized as
having been updated and no save prompt displays on close. A markup containing dynamic
stamps needs to be saved to retain those updated values.
Problem: When trying to save a markup, I get a Failed to save markup error message.
Solution: Ensure that the URLs you enter in your brava_parameters.properties file have the
correct hostnames. These hostnames should be the same names that your end-user enters in
their browser to ensure the session cookies are in sync. The parameter names that should be
checked are WebtopURL and WebtopURLToBravaJSPPages.
Problem: HPGL files will not view in the Brava Client and cause a Job Processor exception
error.
Solution: All file formats need a DOS extension associated with them in the Format in the
Documentum Content Server to be viewed through the Brava Webtop Integration. If a
particular format produces an exception error, Use Documentum Administrator to check to
make sure a DOS extension exists for that format and add the DOS Extension if it if not
present.
Problem: A 500 error occurs while using Websphere

Solution: If you are using IBM WebSphere 6.1.07 (6.1 Fix Pack 7) as the application server
servlet engine for the Brava Server, you may need to edit the Brava Servers Properties file to
change the parameter check.cache.blocking.timeout= from the default value of 3 to a
value of 4 or higher. This should only be needed if you are viewing large files of 12.5MB or
larger. If viewing files in excess of 30MB, this value may need to be increased to 5.
Changing the Brava Server timing resolves a (500 error) message cache issue (related to how
WebSphere works) that may occur when launching large files in Brava from the Webtop
Annotate option.
Sizes provided are our best estimates based on our testing. Test before changing as some
hardware running IBM WebSphere 6.1.07 may not experience this issue at the file sizes
indicated. Faster or slower systems will have different response timing with respect to
WebSphere.
57
Problem: I am not able to get the Brava ActiveX control to download on my Vista machine.
Solution: In IE (or Internet Options), add the Web site's URL as a Trusted Site. This should
allow the Brava Client ActiveX control to download and install on your Windows Vista system.
Problem: I am not able to get the Brava ActiveX control to download on first click with IE 7.0
set with medium-high or high security enabled. It works if I hit the link twice.
Solution: The Active X control will install after you click the IE information bar about installing
the Brava ActiveX Control. However, the screen is refreshed and the Webtop browse screen is
shown. This is normal behavior of this security level and the launching of the Brava ActiveX
control. Selecting 'Annotate' after this action should result in normal Brava operation.
Problem: When I publish a file with markups to a Rendition, the markups are removed.
Solution: Note that if a file with Markups is present and is published as a new Rendition, the
markups will be disassociated with the main document unless the markups are saved with the
Save with all Versions check box enabled.
Problem: How do I turn on Brava logging?

Solution: Client, Server, and JobProcessor logging can be set in following three locations,
depending on the error:
1. In brava_parameters.properties (Brava Client control logging), set the parameters
ClientLogging=DEBUG and ClientLogFileLength=100000 (adding a few extra
0s ensures that everything gets written to the log file). The file will be written to
your Web Server application log, for example C:\Program Files\Apache Software
Foundation\Tomcat 6.0\documentum\logs.
2. In Server.properties (Brava Server logging), set log.level=all. The file will be

written to the C:\Program Files\IGC\Brava! Webtop\Brava! Webtop Server\log.
3. To turn on the JobProcessor logging, go to http://localhost:7070/config and set the

log parameter to ON. Select Update server and restart the service. To view the logs,
go to http://localhost:7070/log.
Notes on Vista Compatibility:
The User Account Control (UAC), depending on the User's Permission level and rights, may
prevent the user from being able to perform some functions with the Brava Client:
When installing the Brava Client, UAC (if on) can prevent the Brava Client from being
installed as UAC blocks the user's ability to write files being downloaded by the browser
(Internet Explorer).
With the Brava Client installed, UAC (if on) can prevent the Brava Client from
saving/writing files to the local file system.
58
During Brava's client side loading/processing, UAC (if on) can prevent Brava's client
side loading/processing by preventing the Brava Client from writing the temporary
output CDL files to the user's temp directory.
To turn off UAC:
1. From the Control Panel, open User Accounts.

2. Click the Turn User Account Control on or off link.
3. In the Turn on User Account Control (UAC) to make your computer more secure
options screen, un-check Use User Account Control (UAC) to help protect your
computer check box.
4. Click OK and restart the system.
Note: The User's permissions level/rights will effect how the UAC works.
Internet Explore Security settings and Automated direct Brava Client install on Vista Client
Systems:
Provided the user has the underlying permissions and rights, the Brava Client may
install without an administrator deploying the Brava Client MSI install package.
Add the site to the Internet Options Security Trusted sites list.
On the Trusted Sites Security level settings, set the Zone to Medium or Lower
(assuming you're using the default settings for the zone).
Make sure the Enable Protected Mode is not checked.
Select OK in the Internet Options Control Panel and restart IE
Access the Brava website and attempt to open the file using Brava (in Webtop, select
Annotate from the menu after you are logged in). The Brava Client will install as it does
on Windows XP.
If you have attempted to automatically install the Brava Client without following these steps,
you may need to clean-up files that were installed in the failed attempt. Check the following
locations and delete the listed files before attempting the install again:
C:\Users\<logged in user>\IGC
Delete the entire IGC directory and its contents.
Delete the class file:
1. Open the Internet Options Control Panel and on the General tab, locate the
Browsing history section.
2. Click on the Settings button to open the Temporary Internet Files and History
Settings dialog.
3. Click the View objects button. This will open the Downloaded Program Files
folder in a new window.
4. In the file list, check to see if the BravaClientXView 6.2 Class is present. If
so, delete it and then close all the open windows and control panels.
5. Restart the system and try the installation again.
Note: A User account with very limited rights will not have the permissions needed for
the Brava Client Automatic Install process when running Vista. In this case, a manual
install will be needed.
59
Additional Resources
For additional information on customizing the Brava Client for your integration, please see the
Brava_6.2_AdministrationGuide.pdf included in this integration. Please note that any
installation and configuration information contained in this integration guide takes precedence
over any seemingly conflicting information found in the Core guide
Brava_6.2_AdministrationGuide.pdf.
60

Brava Webtop Installguide PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Brava Webtop Installguide PDF

Uploaded by

Copyright:

Available Formats

Brava 6.

2 for Webtop Integration

Brava! Client/Brava! Webtop Server/JobProcessor

1.0 Preparing to Install Brava Webtop

Supported Application Server Environments for Brava! Enterprise for Webtop

Documentum Webtop 6.5 sp1, SP2, or SP3 with:

BEA Weblogic 9.2.2, 10.0 10.2, and 10.3

IBM WebSphere 6.1.0.7 (6.1 Fix Pack 17)

Red Hat Jboss 4.3 EAP

*32-bit Version Only

Brava! Enterprise Job Processor and Brava! Enterprise Licensing Services

Supported Web Servers:

Brava Webtop Client System Requirements

Brava Webtop Flash Viewer Requirements

Supported Client Browser (Brava ActiveX Client)

Internet Explorer 6 SP2

Supported Client Browser (Brava Flash Viewer)

Internet Explorer 7 (Windows Only)

Federated Content Servers

Brava Webtop Support for Documentum BOCS

1.2 Hardware Requirements

Brava! Enterprise Job Processor

1.3 Planning Considerations

1.4 New Integration Features

Integration with Brava 6.2 new features include:

Integration with Brava 6.1 new features include:

2.0 Installing Brava! Enterprise for Documentum

\<intstall location>\IGC\Brava! Webtop\Brava! Enterprise JobProcessor\

Step 6 IGC Writer Installation

Step 10: Continue with Brava Enterprise Installation

placed in a common, accessible place such as the C:\bea\user_Projects\Domains directory to

3.0 Configuring your Installation

3.1 Copy Custom Contents

Markup Indicator and Term Highlighting Component Installation REQUIRED STEP

1. Ensure your webapp server is shutdown.

Configure the No Launch Properties File

The bravaformat.properties file is formatted as follows:

The current default formats restricted from annotation include:

update dm_relation_type objects set security_type='PARENT' where

Additional Notes for IBM WebSphere Users

3.2 Installing the DAR File

Installing a DAR file (excerpt from Documentum Composer User Guide)

The build file should look similar to the following:

This example XML file installs the project.dar file.

emc.install command parameters

Parameter Required Description

To install a DAR file:

3.3 Customize Brava JSP Pages

The Brava Webtop Server installation includes the following pages:

Brava_parameters.properties This file, used in combination with markup.jsp, contains all of

Customizing Brava for DCTM to launch non-dm_document types in Brava

<scope type = "<insert their custom type here>">

Brava Webtop Parameters Used in the brava_parameters.properties file

ClientLoadedMaxFileSize Any whole integer value.

PublishCheck TRUE Default

BannerFontSize Any Valid Font Size

BOCSBravaServerPairing Possible values:

UseBOCsIfAvailable TRUE Default

ClientLog Valid string values are as

Debug or 1 designates fine-

designates error events that

Fatal or 5 designates very

ClientLogFileLength Any whole integer value