Professional Documents
Culture Documents
Brava Webtop Installguide PDF
Brava Webtop Installguide PDF
Brava! Enterprise
Webtop 6.5 Integration
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
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*
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
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.
2
Brava 6.2 for Webtop Integration
Note that ACS must be enabled on the Content Server for Brava Flash Viewer support.
Supported Repositories
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
Brava 6.2 for Webtop Integration
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)
4
Brava 6.2 for Webtop Integration
5
Brava 6.2 for Webtop Integration
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
Brava 6.2 for Webtop Integration
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
Brava 6.2 for Webtop Integration
Step 5
Setup will detect if the IGC Writer Printer Driver is installed, which is a required component for
use with Brava Enterprise.
8
Brava 6.2 for Webtop Integration
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
Brava 6.2 for Webtop Integration
Step 8
You are now ready to install. Click Install.
10
Brava 6.2 for Webtop Integration
Step 9
At the IGC Writer Install Complete screen, click Finish.
Select Use Tomcat, or, if you will be using a different Application Server simply select Use
different servlet engine. Click Next
11
Brava 6.2 for Webtop Integration
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
Brava 6.2 for Webtop Integration
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
Brava 6.2 for Webtop Integration
Step 13
In the Choose Destination Location screen, browse to or enter the path to install the Brava
Enterprise Webtop files. Click Next.
14
Brava 6.2 for Webtop Integration
Step 14
Click Install to begin the installation of the Brava Enterprise files.
15
Brava 6.2 for Webtop Integration
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
Brava 6.2 for Webtop Integration
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
Brava 6.2 for Webtop Integration
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
Brava 6.2 for Webtop Integration
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).
**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.
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
Brava 6.2 for Webtop Integration
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).
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.
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.
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
Brava 6.2 for Webtop Integration
Execute the following DQL line through the administration console, or from the DQL editor in
Webtop http://<server>/webtop/component/dql:
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.
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.
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.
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.
21
Brava 6.2 for Webtop Integration
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.
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
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
Brava 6.2 for Webtop Integration
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.
Add the following code to the brava_actions.xml file and alter the <insert their custom type
here> to your custom type:
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
Brava 6.2 for Webtop Integration
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.
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.
24
Brava 6.2 for Webtop Integration
Server.
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
Brava 6.2 for Webtop Integration
26
Brava 6.2 for Webtop Integration
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.
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
Brava 6.2 for Webtop Integration
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.
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
Brava 6.2 for Webtop Integration
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.
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.
29
Brava 6.2 for Webtop Integration
EnableSaveViewAsJPG TRUE
FALSE Default Prevents/allows viewers from creating JPG
snapshots of the currently viewed CSF file.
30
Brava 6.2 for Webtop Integration
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.
31
Brava 6.2 for Webtop Integration
32
Brava 6.2 for Webtop Integration
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.
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.
33
Brava 6.2 for Webtop Integration
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.
34
Brava 6.2 for Webtop Integration
35
Brava 6.2 for Webtop Integration
EnableSaveAsMinorVersionTIF TRUE
FALSE Default Turns on/off the ability to save a TIF file as
the next logical minor version of the original
file.
EnableSaveAsSameVersionTIF TRUE
FALSE Default Turns on/off the ability to save a TIF file as
the same version of the original file,
overwriting the current version. Use with
care.
AutoNameTIFImport TRUE
FALSE Default Turns on/off the ability to have the TIF file
automatically name itself when saved.
36
Brava 6.2 for Webtop Integration
EnableSaveAsMinorVersionPDF TRUE
FALSE Default Turns on/off the ability to save a PDF file as
the next logical minor version of the original
file.
EnableSaveAsSameVersionPDF TRUE
FALSE Default Turns on/off the ability to save a PDF file as
the same version of the original file,
overwriting the current version. Use with
care.
AutoNamePDFImport TRUE
FALSE Default Turns on/off the ability to have the PDF file
automatically name itself when saved.
37
Brava 6.2 for Webtop Integration
TRUE Default
EnableMarkup Turns on/off the Markup option.
FALSE
TRUE Default
EnablePrivate Turns on/off the Save Markup as Private function
FALSE
38
Brava 6.2 for Webtop Integration
TRUE Default Turns on/off the markup menu option to Review all
EnableReviewChangemarks
FALSE Changemarks.
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
Brava 6.2 for Webtop Integration
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 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
Brava 6.2 for Webtop Integration
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
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
Brava 6.2 for Webtop Integration
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 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
42
Brava 6.2 for Webtop Integration
PDF_Rendition_Control_For_Group TRUE Default Turns on/off PDF rendition viewing access for
s FALSE groups when UsePDFRendition is enabled
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
Brava 6.2 for Webtop Integration
PDF_Rendition_Control_For_Groups=FALSE
PDF_Rendition_Control_For_Users=TRUE
44
Brava 6.2 for Webtop Integration
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.
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
Brava 6.2 for Webtop Integration
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>
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
Brava 6.2 for Webtop Integration
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
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
Brava 6.2 for Webtop Integration
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.
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>
....
....
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:
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:
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
Brava 6.2 for Webtop Integration
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:
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
Brava 6.2 for Webtop Integration
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:
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.
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
Brava 6.2 for Webtop Integration
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.
Note: See section 3.1 for steps to enable the markups save with all versions feature.
51
Brava 6.2 for Webtop Integration
You can add as many bookmark parameters as you wish, as long as they are incremented by one
integer.
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
Brava 6.2 for Webtop Integration
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
Brava 6.2 for Webtop Integration
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
Brava 6.2 for Webtop Integration
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
Brava 6.2 for Webtop Integration
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.
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.
56
Brava 6.2 for Webtop Integration
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.
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
Brava 6.2 for Webtop Integration
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.
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
Brava 6.2 for Webtop Integration
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.
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
Brava 6.2 for Webtop Integration
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