®

Brava! Enterprise
Webtop 5 Integration

Brava! Client/Brava! Server/Net-It Enterprise

Installation and Configuration Guide
(ActiveX) Version 5.3

Table of Contents
PART I - Brava! Webtop Installation

1.0 Preparing to install Brava Webtop

1.1 Supported Configurations
1.2 Hardware Requirements
1.3 Planning Considerations
1.4 New Integration Features
2.0 Installing Brava and Net-It Enterprise for DCTM Webtop
2.1 Install Net-It Enterprise Queue Server
2.2 Install Net-It Enterprise Job Processor (and Black Ice Drivers)
2.3 Install Brava Webtop Server
3.0 Configuring your Installation
3.1 Copy Custom Contents
3.2 Install Brava DocApp
3.3 Customize Brava! JSP Pages
3.4 Customizing the Webtop Integration Components
3.4.1 Customizing Integration Components When Previous Customizations Exist
3.5 Uninstalling Webtop components

PART II – Core Brava! User’s Guide

1.0 Overview
1.1 Brava! Enterprise for Webtop
1.1.1 Customizing and Integrating Brava! Enterprise
1.1.2 Security
1.1.2.1 Protecting Transmitted Information
1.1.2.2 Preventing Unauthorized Access to the Brava! Services

1
 1.1.2.3 Protecting the Brava! Server Machine
1.1.2.4 Other Considerations
1.2 Net-It Enterprise
1.2.1 Net-It Enterprise Queue Server
1.2.2 Net-It Enterprise Job Processor
1.3 Supported File Formats
1.3.1 Publishing with Outside In Drivers
1.4 New Features in this Release
1.4.1 Major Differences between 5.0 (Java) and 5.1+(ActiveX) Releases
1.4.2 Migration Notes

2.0 Install
2.1 Install Requirements
2.2 Installing Brava! Components
2.2.1 Permissions to Install the Brava! Client Control
2.2.2 Installing Brava! Enterprise Components as a Service
2.2.3 Installing Autodesk Inventor View for Inventor Support
2.3 Test and Verify your Installation
2.3.1 Verify the Brava! Server is Installed
2.3.2 Verify the Net-It Enterprise Queue Server is Installed Correctly
2.3.3 Verify the Net-It Enterprise Job Processor Installed Correctly
2.3.4 Verify Net-It Enterprise is Working
2.3.5 Verify Brava! Enterprise is Working

3.0 User’s Guide

3.1 Configuring Brava! ActiveX
3.1.1 Encoding of Double Byte Characters
3.1.2 BravaX Control Parameters
3.1.3 Optional BravaX Parameters
3.2 Configuring Brava! Server
3.2.1 Editing the Server Parameter Files
3.2.2 Editing the Precedence Properties file
3.3 Configuring Net-It Enterprise Queue Server
3.3.1 Editing the HttpQueueServer.properties File
3.4 Configuring Net-It Enterprise Job Processor(s)
3.4.1 Editing the JobProcessor.properties File
3.4.2 Configuring JobProcessor to Process Particular Request Types
3.4.3 Using Xrefs with the Job Processor
3.4.4 Configuring for Auto Restart
3.4.5 Publishing Using Other Applications
3.4.6 Configuring DLAutoPublish for the Job Processor
3.5 Monitoring Net-It Enterprise
3.6 Tips and Troubleshooting
3.6.1 Brava! Enterprise
3.6.1.1 Tips
3.6.1.2 Troubleshooting
3.6.2 Net-It Enterprise
3.6.2.1 Tips
3.6.2.2 Troubleshooting
3.6.2.3 Workaround Macros
4.0 Contacting Informative Graphics

2
PART I – Brava Webtop Installation

1.0 Preparing to Install Brava Webtop

1.1 Supported configurations:
(All Microsoft Windows updates and tested as of December 20, 2005)

For Documentum Webtop 5.3.0 sp0

Windows 2003 Server

Tomcat 5.0.28
Sun Java JDK 1.4.2_05
BEA Weblogic 8.1 sp4***
Sun Java JDK 1.4.2_05
JRockit 1.4.2._05**

For Documentum Webtop 5.3.0 sp1, sp2 and sp3

Windows 2003 Server

Tomcat 5.0.28
Sun Java JDK 1.4.2_05
BEA Weblogic 8.1 sp4***
Sun Java JDK 1.4.2_05
JRockit 1.4.2._05**
IBM WebSphere 5.1.1 cf3
IBM Java SDK 1.4.2 update 2**

**32-bit Version for Microsoft Windows Only

*** Includes BEA Weblogic Express (Brava Webtop is only tested with BEA Weblogic
express while using Sun JDK 1.4.2_05 or JRockit 1.4.2_05 Windows 32-bit)

Supported Web Servers:

Because the Brava Webtop integration is hosted in the Application Server and not
directly by a Web Server Brava Webtop will work fine with any web server supported
by the application server that the Brava Server is running in.

Brava Webtop Client System Requirements

Windows 2000 Professional with Internet Explorer 6 SP2
Windows XP Professional with Internet Explorer 6 SP2

3
 Supported Client Browser
Internet Explorer 6 SP2

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)

Net-It Enterprise Queue Server

See Requirements of Application Server

Net-It 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.properties file
 Additional disk space required for temporary files during publishing and. 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 Black Ice printer driver. The location of this temporary directory is
configurable via the JobProcessor.properties file.

1.3 Planning Considerations

You should have the following information gathered before you begin installing Brava Webtop 5.3.
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.3.0, or 5.3.0 sp1, sp2 or
sp3).
5. What is the Webtop application context? (default is: /webtop)
6. Whether you will deploy the Brava Server and the Net-It Queue Server to the same
application server where Webtop resides. If the answer to this is NO:
4
 a. The name of the server(s) where you will deploy the Brava Server and the Net-It
Queue Server.
b. The application server software and version number that will be used to deploy
the Brava Server and the Net-It Queue Server (list all).
c. The port number that the application server is configured to use.
7. The name(s) of the Net-It Job Processor servers that you will use for this configuration.

1.4 New Integration Features

The following features and enhancements have been added to the Brava/Webtop 5.3 integration. See
(Part 1) sections 3.1, 3.3 and 3.4 for more information about these features. Note that the new Term
Highlighting and Markup Indicator features are only supported for Webtop 5.3 sp1 and sp2:
 Web Link and Drop n Drag support via a new HTML button “Annotate”. See section 3.3
Customize Brava JSP pages for details.
 New in this release is the Brava! Markup Indicator. When installed a small red exclamation
point icon will be displayed next to the Properties icon (in Streamline mode), or next to
file name (in Classic mode). When the icon is selected, Brava Webtop will launch with all
associated markups preloaded in read only mode.
 New parameters and pages: ConvertOnClient, ClientLoadedMaxFileSize,
retrieve_content.jsp
 Documentum Webtop Term Hit Highlighting - Term Hit highting 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.
 Documentum Webtop Compare Integration – ability to compare versions of documents has
been added.
1. From the Webtop machine, open a file you want to compare to another version.
2. Select Compare Versions from the Webtop File menu.
3. From the Documentum Webtop Versions page, select two versions of the file that
you wish to compare.
4. Brava! launches and displays the two files in Compare mode.

5
2.0 Installing Brava and Net-It Enterprise for DCTM Webtop
**IMPORTANT**
Brava! Licensing: By default, the Brava! Enterprise product installs a 5-user 30 day
evaluation key stored in the IGCkey.lic file (located in the Brava! Server directory). Once
you obtain a permanent key from Informative Graphics, you must copy it to the Brava!
installation directory to replace the 30 day evaluation key. Similarly, the Net-It Enterprise
JobProcessor component is installed with a 30-day license. It is stored in the IGCKey.lic file
located in the JobProcessor\LicenseKey directory and it must also be updated once an
extended license has been purchased from IGC.

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 5.3 for DCTM button.

Step 2:
Read the Brava! Enterprise End user License Agreement and select “Yes, I agree” if you have read,
understand and agreed to the terms of the Licensing Agreement.

6
2.1 Install the Net-It Enterprise Queue Server

Step 1:
From the installation screen, you can launch this install guide through button #1. Install in order the
three listed components, returning to this screen after each installation completes. Begin by selecting
#2 – Install Queue Server.

Step 2:
From the Queue Server Setup Welcome screen, click Next.

7
If you are using any application server other then Tomcat (or have no application server is installed)
you are presented with the Install Tomcat screen. Select Install Tomcat, or, if you will be using a
different Application Server simply select Do Not Install Tomcat. Click Next.

Step 3:
If you have elected NOT to install Tomcat, you are prompted to select a location to write the Net-It
Enterprise WAR files. It’s best to select a common default location for your application server. With
an application server such as BEA Weblogic, it is recommended that WAR or EAR files be placed in
a common, accessible place such as the C:\bea\user_Projects\Domains directory to ensure that the
files (WAR and EAR) are located in a common default location for deployment. Click Next.

8
Step 4:
In the Servlet Port screen, the default 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 server’s communication port number.

Click Next to begin the installation of the Net-It Enterprise Queue Server files. At the “Install has
completed successfully” screen, click Finish.

2.2 Install the Net-It Enterprise Job Processor (and Black Ice drivers)
Step 1:
On the Demo Shield installation screen, select #3 – Install Net-It Enterprise. This option installs the
Black Ice printer drivers (if not detected) and the Job Processor.

9
When you start the Net-It Enterprise installation, the installer will check to see if the correct version
of the Black Ice Printer Driver is installed. If not found, the Net-It Enterprise installer will start the
Black Ice EMF Printer Driver install. If the correct version of Black Ice is found, the installer will
begin the Net-It Enterprise installation.

Net-It Enterprise Installation Notes:

1) If you are installing on Windows 2003 and have MS Terminal Server installed, you must
install Net-It Enterprise from the server’s console. You can not install Net-It Enterprise
using a Terminal Server Session.
2) If you are installing on a Windows 2003 server, you must disable the “Disallow
installation of printer using kernel-mode drivers” in the Administrative Templates for the
Group Policies Objects.
a. Type gpedit.msc in the Run Application (or from DOS).
b. In the Group Policy Object Editor, navigate to \Computer
Configuration\Administrative Templates\Printers and select Printers in the left
pane.
c. From the right pane, find and open the item “Disallow installation of printer using
kernel-mode drivers”. Change the selection from “Not Configured” to “Disabled”.
d. Apply your changes and close all open Windows for the Group Policy Object
Editor

If the correct version of Black Ice is detected, skip the following Step 2.

Step 2: Installing the Black Ice EMF Printer Driver TS

1. If the correct version of Black Ice is not detected, the following screen displays. Click OK.

10
2. The Black Ice Installation begins. On the Welcome screen, click Next.

3. In the Choose Destination Location screen, set the desired destination folder or accept the
default location. (IGC strongly recommends accepting all the Black Install Defaults except
where noted to change the default value.) Click Next.

4. In the Select Program Folder screen, accept the default value and click Next.

11
 5. In the Choose output folder for the printer screen, select a destination for the printed files.
These are the temporary files that Net-It Enterprise will use to create the Brava Display List
files. Click Next.

6. Select the Common Settings button.

7. Click Finish at the Installation Complete screen. The Net-It Enterprise installation begins.

Step 3: Installing the Job Processor

The Net-It Enterprise installation should now detect the correct version of Black Ice and continue
with the job processor installation.

12
 1. In the Choose Destination Location screen, select a location for the Net-It Enterprise Job
Processor or click Next to accept the default location and continue.

2. The Job Processor files are installed. Upon completion, you are asked if you would like to
install Net-It Enterprise as a Service. Select Yes to install the service or No to skip the
service setup and complete the Job Processor installation.

3. If you have chosen to install the service, click OK.

Note: After the Net-It Enterprise install is complete, you must update the service log-in account. The
Net-It Enterprise service can not run correctly as the Local System Account because the service must
interact with other processes and components. Attempting to run the Net-It Enterprise service as the
Local System Account will cause unexpected and undesirable behaviors with Net-It Enterprise.

4. At the Installation Complete screen, click Finish to complete the Net-It Enterprise
installation

13
2.3 Install Brava Webtop Server

Step 1:
On the Demo Shield installation screen, select #4 – Install Brava Webtop Server. Select Next on the
Brava Webtop Server Welcome screen. Again you will be prompted to install Tomcat if it is not
detected on your machine. If your application server is something other than Tomcat, select Do not
Install Tomcat and click Next.

Step 2:
In the Choose Destination Location screen, browse to or enter the path to install the Brava Server
WAR files if you are not using Tomcat. This is normally the location that you use to deploy WAR
files for your application server. Click Next.

14
Select a location to install the remaining Brava Server files. Click Next to begin the installation of
the Brava Server files.

Step 3:
In the Enter Machine Information screen, 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

Important note: If using a port other than 8080, when installation is complete, you will need to
manually edit the ports for the following settings contained in the *.properties files:

In server.properties please check the following parameters to reflect proper host and port:
queue.server.push.url
done.notification.url

In JobProcessor.properties please check the follow parameters to reflect proper host and port:
jobprocessor.job.queue.http.url

If you are using the server_precedence.properties (optional) you will need to change the following
parameters to reflect proper host and port:

15
 IsReady=
PublishDocument=
GetXdl=
GetDl=
CreateMarkup=
CreateDxfMarkup=
UpdateMarkup=
GetMarkup=
MarkupList=
GetPrepublishedFile=
GetSecurityXml=

Step 4:
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 server’s 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
Click Finish at the Installation Complete screen, and then click Exit in the upper right corner of the
Demo Shield installer to close and complete the Brava Webtop 5.3 installation process.

17
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! 5.3 Webtop\
2. Locate the custom directory for your version of Webtop. Brava! Webtop Server 5.3 supports
Webtop 5.3.0 sp0 to sp3. 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. Below is a list of the Brava! Webtop integrations included with this version. Each of these
integrations is installed as a sub-directory in the C:\Program Files\IGC\Brava! 5.3 Webtop
folder.
Brava Webtop Sub-folder name Supported Documentum Webtop Version
custom53 5.3.0 sp0
custom53sp1sp2sp3 5.3.0 sp1, 5.3.0 sp2, 5.3.0 sp3
4. To add the Brava! Webtop integration to Documentum Webtop’s deployed application, copy
the correct integration sub-directory’s contents to the deployed Webtop’s 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

The Brava 5.3 Webtop 5.3 sp1 (or higher) 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 customsp1sp2sp3 directory containing
a classes sub-folder. Copy the contents of the 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):

18
 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.

com.infograph.drl.DRLComponent.class
This class allows Brava to be integrated into Documentum web-links.

com.infograph.search.AdvSearchEx.class,com.infograph.search.SearchEx.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 for the “Save Markups with Versions” option (EnableVersions)

An additional installation step must be performed to allow the Save Markups with Version
feature to recognize the proper security permissions and work properly:

Execute the following DQL line through the administration console, or from the DQL editor in
Webtop http://<server>/webtop/component/dqleditor:

update dm_relation_type objects set security_type='PARENT' where

relation_name='DM_ANNOTATE';

You must be the docbase owner to execute this command.

Additional Notes for IBM WebSphere Users

If you are using IBM WebSphere 5.1.1 cf3 as the application server servlet engine for the Brava!
Server, you may need to edit the Brava! Server’s 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.

19
3.2 Installing Brava DocApp

The docapp folder (located in your installed Brava! Server directory) contains the docapp that adds
the Informative Graphics custom formats to the Docbase. The brava_formats docapp installs the
needed formats for Brava! to function correctly. This only needs to be run if you have never used
Brava with your configured Docbase.

The custom formats include:

igc_markup (the format for Brava! custom annotation files)
igc_csf_format (the format for Brava!'s burn-in/redaction capabilities)

If you have never used Brava Webtop Server with the configured Docbase you will need to install
the brava_formats docapp to your Docbase so Brava and your Docbase can properly handle and
identify Markups and CSF files.
To run the brava_formats docapp installation:
1. Open the Documentum Application Installer
2. Select the brava_formats docapp
3. Select to install and just follow the Application Installer Prompts

(Attention Brava! Webtop Server 5.0 and earlier users: We strongly recommend that you install the
brava_formats docapp into the Docbase that you are using as well.)

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 <drive>:
\<jakarta install directory>\webapps\webtop\custom\component\markup). This jsp file should
not be edited unless directed by our support team.

Multi_markup.jsp – This file allows users to launch multiple documents and can be used in
place of markup.jsp. When in Classic Webtop mode, users can select (by checking) multiple
documents and launch them in multiple Brava! windows. When in Streamline Webtop mode,
users can select the Annotation links.

Using multi-markup.jsp: If you would like to use multiple window instances of the
Brava! viewer, you can edit the brava_component.xml file to call the
mult_markup.jsp file which in turn opens a new window and calls the markup.jsp file.
Open brava_component.xml (located at \<AppServer>\...\Webtop\Custom\Config
directory) in a text editor and change the instance of markup.jsp to multi_markup.jsp
as shown below and save the file.
<start>/custom/component/markup/multi_markup.jsp</start>

How to enable multi-markup.jsp for the Markup Indicator:

20
 (launching Brava through the markup indicator to spawn a new vs. embedded
window)
0. Stop the webapp server
1. Edit the file markupindicator_component.xml that is located in
webapps/<webtop>/custom/config
2. Change the following line, and then restart the webapp server:
<start>/custom/component/markup/markup.jsp?preloadread_all_markups=tr
ue</start>
to
<start>/custom/component/markup/multi_markup.jsp?preloadread_all_mark
ups=true</start>
NOTE: The Markup Indicator only supports Webtop 5.3 SP1, SP2 and
SP3

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.jsp – This file, used in combination with either markup.jsp or multi-

markup.jsp, contains all of the Brava! viewer parameters that can be customized (such as
enable markup, enable printing, etc.) Contained in the same directory as the markup.jsp file,
this file can be edited to meet your custom requirements.

Drl.jsp - The Brava Webtop integration offers support for Web link and Drop and Drag by
adding an 'Annotation' link to the Web link selection page. This is the page that is viewed
whenever a Web link or Drop and Drag file is launched. An HTML button called
'Annotation' exists, and when selected, Brava launches viewing the web linked file.
The Web link selection page can be modified by editing the drl.jsp file (located in the
custom/system/drl/ directory). The page includes comments describing the changes and how
to alter them to best suit your business needs.

Editing Brava_parameters.jsp
Follow the steps below to setup brava_parameters.jsp 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.jsp file. In the install steps above, you copied the
contents of the Webtop version-appropriate Custom Directory that contains the integration
components into Webtop’s custom directory. It is very important that you modify the deployed
brava_parameters.jsp 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.jsp will take effect.

1. Using a text editor such as Notepad, open brava_parameters.jsp, located in the deployed
Webtop directory <drive>: \<jakarta install
21
 directory>\webapps\webtop\custom\component\markup or
\bea\user_projects\dctm\applications\webtop\custom\component\markup.
2. Parameters contained in the JSP section below must be edited with the correct parameter
values as dictated by your specific environment and needs.
3. Save and close the .jsp file.
4. To view documents in Brava!, simply log into the WDK/ Webtop 5 system. Go to a valid
markup document and select the annotate link in Streamline mode or annotate from the File
menu in Webtop 5.3.0. .
5. Save markups using the ‘Save As’ feature. A markup dialog displays giving you the option to
enter a name for the markup and to determine security options. The default security option is
to grant everyone access to your markup. Select Private to allow only the owner to view and
edit this markup.

The following table lists the parameters (and possible values) contained in the brava_parameters.jsp
page that you can customize. 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.jsp 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.jsp so they will not be covered in this section.
See Part II section 3.1.3 Optional Brava ActiveX Parameters for a detailed list of all the Brava
Enterprise parameters.

Brava Webtop Parameters Used in the brava_parameters.jsp 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.
WebAppName webtop This is the context used when you installed
Webtop in the Application Server.
IntegrationDllName BravaWebtop This is the name of the Brava Webtop
Integration DLL will always be
BravaWebtop If no Custom Integration has
occurred where the dll was given a new
name.
ClientLog Valid string values are as This is the Level of Logging that can be
follows: done by the Brava Webtop Client.
All or 0 designates all levels With a logging level set to Error only,
of messages are logged. Error and Fatal Messages are logged.

Debug or 1 designates fine-

grained informational events
that are most useful to
debug an application.

Info or 2 designates
informational messages that

22
 highlight the progress of the
application at coarse-grained
level.

Warn or 3 designates
potentially harmful
situations.

Error or 4 (default)
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.

PublishCheck TRUE – Default Turns advanced Net-It Enterprise

FALSE
BannerFontSize Any Valid Font Size
ClientLoadedMaxFileSize Any whole integer value.
2000 - Default
ClientLogFile Any valid path on the Brava
Client Systems
%USERPROFILE%/Applic
ation
Data/BravaWebtop/Logs/Cli
entlog.txt – Default
ClientLogFileLength Any whole integer value
100000 – Default
CompareViewMode Possible values for this
parameter are Overlay
Differences, Overlay,
Side-By-Side (default),
Deletions, Additions,
Unchanged, Open File,
and Compare File.
ConvertOnClient TRUE
FALSE - Default
publishing version checking on/off.
Sets the ISO Banner Font Size
This setting determines the maximum
file size (in kilobytes) allowed for client
side publishing. 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 Server.
The path the Brava Client will attempt to
write the client log file.
The Number of bytes the log file will allow
to before the contents are overwritten.
Determines the display mode in Brava
Veiwer for files being compared (as
specified by DocId and CompareDocId
parameters).
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.
23
 If set to true, the Client converts all
TIFF and PDF formats. The default is
false, meaning the Server converts
native files and client side loading is
never done.
This value should only be set to true for
formats the client is capable of
converting (i.e. pdf, tif). Setting this
value to true for the appropriate formats
reduces the load on the server by
shifting conversion to the client.
DefaultBackgroundColor DEFAULT – Default* Allows the documents default background
BLACK color be overridden (effects all file types).
WHITE
GRAY (or GREY)
DoNotLaunchFormats Any Documentum file Documentum file formats entered here will
format. be launched by the default mime type
application instead of by Brava when the
file is selected in Webtop (annotation).
Multiple values are supported, separated by
a comma. For example; avi,pdf,msw8
EnableFileExtensions TRUE – Default Enables/disables the default use of adding
FALSE the original format file extension to CSF
and PDF output from Brava.
EnableBackground TRUE – Default Turns on/off the Background Color Options.
FALSE
EnableCopyText TRUE – Default Turns on/ off the user’s ability to copy text
FALSE from documents viewed in the Brava Client.
EnableDefaultPrivate TRUE Sets the Private option in the markup
FALSE - Default Save As dialog to be enabled by default.
EnableDefaultVersion TRUE Sets the Version option in the markup
FALSE - Default 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 Turns on/off Brava’s ability to show a
FALSE document’s layers.
EnableMagnifier TRUE – Default Turns on/off Brava’s Magnifier tool item so it
FALSE no longer appears on the toolbar.
EnableMeasurement TRUE – Default Turns on/off Brava’s Measurement tools and
FALSE functionality.
EnableMirror TRUE – Default Turns on/off Brava’s ability to mirror raster
FALSE 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 Turns on/off the Monochrome Display Tool.
FALSE

24
EnablePrinting TRUE – Default Turns on/off printing in the Brava Client.
FALSE
EnableRotate TRUE – Default Turns on/off the ability to rotate the views of
FALSE files.
EnableSaveView TRUE – Default Turns on/off the Save/Publish menu button
FALSE option. This option takes priority over the
following parameter’s settings:
EnableSaveViewasJPG, EnableCSFPublishing,
and EnablePDFPublishing.
EnableSaveViewAsJPG TRUE Prevents/allows viewers from creating JPG
FALSE– Default snapshots of the currently viewed CSF file.
EnableThumbnails TRUE – Default Turns the Page Thumbnails feature on/off.
FALSE
EnableZoomWindow TRUE – Default Turns on/off the Zoom Window Tool.
FALSE
HyperlinkLaunch one - All documents Determines how Brava handles hyperlinks in
launch in a single files being viewed by the Brava Client.
separate window from
Brava! (2 windows).
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.
PaperViewSize Entered as Width, Height, Scale an image to a particular paper size. The
inches or meters Brava client’s render engine can then map the
Default value is 22 x 36 document’s world space coordinates to real
inches (entered as world coordinates. This value affects the
22,36,i) zoom percentage and size of print banners
relative to the overall size of the published
PDF file.
SaveViewQuality Any whole number Adjusts the quality of the jpeg created with the
between 1 and 100 (100 Save View As JPEG function.
is best, 1 is poorest, 75 is
default)
SearchTextAtStartup Any Valid Word, Phrase Performs a search of the file loaded in the Client
or Alpha Numeric String using the Value as the search string.
(as no default value)

25
TimeZone The valid syntax to use is: Specifies a single common Time zone for
all time/date stamps used by the Brava
tzn[+ | –]hh[:mm[:ss] ][dzn] system.
Where:
tzn = Three-letter time-zone
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)
WatermarkBannerFontName Any valid font (font must exist Specifies the default font name for
on all systems or the font will Watermarks and ISO Banners.
revert back to the default font
if specified font in not
available)
WatermarkBannerFontStyle Valid values are: Specifies the default font style to use for
0 – Plain 2 – Italic Watermarks and ISO Banners.
1 – Bold 3 – Bold Italic
WatermarkLineSpacing Valid values are 0, 1, Specifies the print density of the print
2(default), or 3 watermark. A value of 0 prints the
most opaque watermark, while 3 prints
the most transparent.
Enablereviewchangemarks TRUE – Default Turns on/off the markup menu option to
FALSE Review all Changemarks.
SecurityOptionsFromServer TRUE Turns on/off getting the CSF security
FALSE – Default options (the security.xml file) from the
Brava Server and not interactively from
the user.
EnableCSFPublish TRUE – Default Turns on/off the Publish as CSF option in
FALSE the Save/Publish Menu.
EnableSaveCSFFile TRUE – Default Turns on/off the ability to save a CSF file
FALSE as a new to the local system.
EnableSaveCSFEmail TRUE – Default Turns on/off the ability to save a CSF file
FALSE as an attachment to an email message (MS
Outlook or MS Exchange).
EnableSaveCSFRendition TRUE – Default Turns on/off the ability to save a CSF file
FALSE as a Rendition of the file in the Docbase.
EnableSaveCSFNewDocFile TRUE – Default Turns on/off the ability to save a CSF file
FALSE as a new file to the user’s home cabinet.

26
EnableSaveAsMajVersionCSF TRUE – Default Turns on/off the ability to save a CSF file as
FALSE 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.
AutoNameCSFImport TRUE Turns on/off the ability to have the CSF file
FALSE – Default automatically name itself when saved.
DefaultCSFPublishOption Valid values: Sets the Default Publish/Save method for
File – New file to local the CSF 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 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
EnablePDFPublish TRUE – Default Turns on/off the Publish as PDF option in
FALSE the Save/Publish Menu.
EnableSavePDFFile TRUE – Default Turns on/off the ability to save a PDF file as
FALSE a new to the local system.
EnableSavePDFEmail TRUE – Default Turns on/off the ability to save a PDF file as
FALSE an attachment to an email message (MS
Outlook or MS Exchange).
EnableSavePDFRendition TRUE – Default Turns on/off the ability to save a PDF file as
FALSE a Rendition of the file in the Docbase.
EnableSavePDFNewDocFile TRUE – Default Turns on/off the ability to save a PDF file as
FALSE a new file to the user’s home cabinet.
EnableSaveAsMajVersionPDF TRUE – Default Turns on/off the ability to save a PDF file as
FALSE 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.
AutoNamePDFImport TRUE Turns on/off the ability to have the PDF file
FALSE – Default automatically name itself when saved.
DefaultPDFPublishOption Valid values: Sets the Default Publish/Save method for
File – New file to local the PDF 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 AutonamePDFImport 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

27
 Major Version to the
original file
UsePdfRendition TRUE – Default If set to TRUE Brava will use the PDF
FALSE 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.

The following parameters control markup behavior.

EnableMarkup TRUE – Default Turns on/off the Markup option.

AddChangemarkInfoPageToPub
lishedPDF
PDFMarkupType
EnablePrivate
EnableVersion
EnableCopyMarkupToAllPages
EnableMarkupChangeOwner
DisableConsolidateIfMarkupOp
enedForEdit
MarkupRasterDirectory
PreloadReadOnlyMarkupNames
FALSE
TRUE Determines whether to append pages listing
FALSE - Default the contents of Changemarks (if they exist
on the current file) when publishing to PDF.
Comment (Default) Indicates how Brava will handle Brava Markup
Burnin Changemarks when publishing a file to PDF
Choice with open markup(s) that contains Changemarks.
TRUE – Default Turns on/off the Save Markup as Private
FALSE function
TRUE – Default Turns on/off the Save Makeup with all versions
FALSE function. Note that in order for the permissions
to work properly, you must have performed the
installation step in section 3.1.
TRUE Turns on/off the ability to copy most markup
FALSE - Default objects to all pages of a file that has an active
markup in Brava. (Non copy able entities include
strikethrough, Changemarks, and block-out.)
TRUE Turns on/off the ability to transfer ownership
FALSE - Default of a markup entity. If set to True, when a
user shift-clicks on a markup entity (in a
markup open for edit) using the markup
select tool, the author information of that
entity changes to the current author.
TRUE If set to True, this disables the Consolidate
FALSE - Default Markups item on the Markup menu if a
markup is open for edit, regardless of the
EnableMarkupConsolidate value.
Default value is Sets the default path for the Markup Raster tool.
%USERPROFILE%\\ The path must be set using double back slashes
IGC\\StampImages to work properly. It is recommended that you use
a path relative to and within the user’s profile.
The path starting point of “%USERPROFILE%\\
should help to ensure that the user has the proper
permissions to the raster image files.
Name (or names, Preloads the specified markup(s) as read only
separated by a (Opened for Review)
comma) of a valid If markup does not exist no markup is opened or
markup file in the created).
Docbase for the file
28
 being opened or ALL
(to open all the
markups related to
that file).
PreLoadMarkupName Name of a markup in Opens a specific mark file name as editable if
the Docbase, if the allowed.
markup does not exist
one will be created
for saving with that
name.
Enablemarkuparrowtool TRUE – Default Turns on/off the markup toolbar arrow tool.
FALSE
Enablemarkuptexttool TRUE – Default Turns on/off the markup toolbar text tool.
FALSE
Enablemarkupchangemarktool TRUE – Default Turns on/off the markup toolbar Changemarks
FALSE tool.
Enablemarkupcloudgrouptool TRUE – Default Turns on/off the markup toolbar cloud tools
FALSE group.
Enablemarkupsketchgrouptool TRUE – Default Turns on/off the markup toolbar sketch tools
FALSE group.
Enablemarkuplineargrouptool TRUE – Default Turns on/off the markup toolbar lines tools
FALSE group.
Enablemarkupshapegrouptool TRUE – Default Turns on/off the markup toolbar shapes tools
FALSE group.
Enablemarkupblockouttool TRUE – Default Turns on/off the markup toolbar CSF Blockout
FALSE tool.
Enablemarkupabcgrouptool TRUE – Default Turns on/off the markup toolbar text scratch out,
FALSE Highlight, Underline tools group.
EnableMarkupHyperlinkTool TRUE – Default Turns on/off the markup toolbar markup object
FALSE Hyperlink tool.
EnableMarkupRasterTool TRUE – Default Turns on/off the markup toolbar raster tool.
FALSE
EnableMarkupClose TRUE – Default Turns on/off the markup menu option to close
FALSE open (for editing) markups.
EnableMarkupCloseForReview TRUE – Default Turns on/off the markup menu option to close
FALSE markups open for review.
MarkupColor Any valid color. Sets the default markup color to the value
Color name or Hex specified.
Values (#RRGGBB
or Windows Web
Safe Recommended)
EnableMarkupBurnin TRUE – Default Turns on or off Brava’s ability Burn-in Markups
FALSE and output a CSF file.
EnableMarkupColorPalette TRUE – Default Turns on or off Brava’s markup color palette.
FALSE
EnableMarkupSaveAsDXF TRUE Saves Markups to Docbase as DXF file.
FALSE – Default Currently offers no benefit for Webtop users.

29
DefaultTextMarkupFont
AutoNameMarkup
Any valid font (font Sets the Default Markup Font for the Markup
must exist on all Text Tool. Effects Markup Text Tools default
systems or the font font.
will revert back to the
default font if
specified font in not
available).
TRUE Turns (automatically) naming of all markup files
FALSE – Default saved to the Docbase on or off. If set to true, the
name of the markup file will be the same as the
name of the document.

The following parameters control markup permissions and default markup permissions for users
with READ access.

EnableMarkupNew TRUE Turns on/off the ability to create a new markup.

FALSE – Default
EnableMarkupReview TRUE Turns on/off the ability to Review a markup.
FALSE – Default
EnableMarkupSaveAs TRUE Turns on/off the ability to Save a markup as…
FALSE – Default
EnableMarkupOpen TRUE Turns on/off the ability to open a markup for edit.
FALSE – Default
EnableMarkupSave TRUE Turns on/off the ability to save a markup without
FALSE – Default giving a markup open for editing a new name.
EnableSingleEditableMarkup TRUE When enabled, only one markup can be created for
FALSE - Default each user for each file. It will open the existing
markup created by the user for edit when one exists or
it will 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:

RELATE_EnableMarkupSaveAs TRUE – Default Turns on/off the ability to Save a Markup As…
FALSE
RELATE_EnableMarkupNew TRUE – Default Turns on/off the ability to create a new markup.
FALSE
RELATE_EnableMarkupReview TRUE – Default Turns on/off the ability to Review a markup.
FALSE
RELATE_EnableMarkupSave TRUE Turns on/off the ability to save a markup without
FALSE– Default giving a markup open for editing a new name.
RELATE_EnableMarkupOpen TRUE Turns on/off the ability to open a markup for
FALSE– Default edit.

HRELATE (higher than relate) grants you the following:

30
HRELATE_EnableMarkupSaveAs TRUE – Default Turns on/off the ability to Save a markup
FALSE as…
HRELATE_EnableMarkupNew TRUE – Default Turns on/off the ability to create a new
FALSE markup.
HRELATE_EnableMarkupReview TRUE – Default Turns on/off the ability to Review a
FALSE markup.
HRELATE_EnableMarkupSave TRUE Turns on/off the ability to save a markup
FALSE– Default without giving a markup open for editing
a new name.
HRELATE_EnableMarkupOpen TRUE Turns on/off the ability to open a markup
FALSE– Default for edit.
Printing_Control_For_Groups TRUE Turns on/off print control for groups.
FALSE– Default
Printing_Control_For_Users TRUE Turns on/off print control for users.
FALSE– Default
int As written DO NOT EDIT THIS LINE !!!
NONE=1;BROWSWE=2:RELA…
int Document_permission_check NONE The value corresponds to the Permission
BROWSE on a file that will disable printing for a
READ (Default) user or group listed in disabled list.
RELATE Disables printing only if the permission
VERSION level matches the value.
WRITE
DELETE
disable_These_Groups_For_Printi Coma separated list of Controls printing functionality of all valid
ng valid Documentum listed groups.
Groups
disable_These_Users_For_Printing Coma separated list of Controls printing functionality of all valid
valid Documentum Users listed users.

* 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.

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.

31
 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.
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. It’s 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! 5.3 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 5.0/webapps/webtop/custom. (See NOTE
below for existing customizations)

For WebLogic:

1. Expand the webtop. war file found in your <bea home>/user_projects/<webtop

domain>/Applications directory to a temporary folder. For our demonstration, name it
webtop_archive. Place a backup copy of the webtop.war file into another directory and
then delete the original from the /Applications directory.
2. If no current customizations/configurations are present, copy the Brava! 'custom' folder
to replace the current custom folder in your
\bea\user_projects\ServerDomainName\applications\webtop_archive\custom directory.
Warning dialogs should pop up stating that "a folder of the name 'custom' already exists
do you wish to overwrite it?". Select YES. (If current customizations exist, see NOTE
below.)
3. Re-War this temp directory. This step requires the 'jar' tool found in Java 's jdk located in
the bin directory of the JDK. (For example, if you have installed jdk1.4 on your D drive

32
 its location would be: D:\jdk1.4\bin). Type the following in at a DOS prompt that is
currently in your temp directory, such as webtop_archive from step #1 above:
d:\jdk1.4\bin\jar cvf webtop.war .
(Be sure to include the <space>dot after .war ( .))
4. This will begin the war'ing of this complete directory (for our example, the
webtop_archive directory) which will include all of Webtop - INCLUDING the Brava!
customizations you copied into this location from step #2.
5. Once this process has completed, ensure Weblogics is shut down, and copy this
webtop.war file back into your location from step #1 above (<bea
home>/user_projects/<webtop domain>/Applications) Again, your directory
home>could differ depending on your Weblogic installation choices.
6. Restart your Weblogic Webtop server and the Brava! customizations/configuration
changes should be present.

Tech Tip: As the Documentum install guide instructs, it is important to start Weblogic
from StartWebtop.cmd. If you mistakenly start from StartWeblogic.cmd you will need to
set the following classpath in your path or in the StartWeblogic.cmd file to start
WebLogic properly.

set PRE_CLASSPATH=C:\Program
Files\Documentum\Shared\dfc.jar;C:\Program
Files\Documentum\Shared\bsf.jar;C:\Program
Files\Documentum\Shared\log4j.jar;C:\Program
Files\Documentum\Shared\xalan.jar;C:\Program
Files\Documentum\Shared\xml-apis.jar;C:\Program
Files\Documentum\Shared\dmworkflow.jar;C:\Program
Files\Documentum\Shared\dmsubscriptions.jar
__________________________________________________________________________________

*NOTE: If the Webtop product has previously undergone a customization, cautiously merge both
the current customization and the Brava! customization files together as outlined below in section
3.4.1. If no customizations are present, you can simply copy the custom folder from the Brava!
installation directory into your webapps\webtop directory.

3.4.1 Copying Integration Components When Previous Customizations Exist

Note: This section is intended for Administrators. Placements of menu items are suggestions and
can be moved if so chosen.

1. Copy the entire Markup directory from C:\Program Files\Igc\Brava! WDK Webtop
5\Custom\Component\ to \<AppServer>\...\Webtop\Custom\Component directory. If a
Component directory does not exist create one.
2. If a custom theme folder exists, you can enable custom CSF icons in Documentum by
copying the f_igc_csf_format_16.gif and f_igc_csf_format_32.gif files from the
webtop/custom/<theme name>/documentum/icons/format/ directory. Paste these files in the

33
 corresponding directory of the theme you would like. For example, to add the CSF icons to
the coolblue theme, simply copy the two gif files to the
webtop/custom/theme/coolblue/icons/format directory.
3. Additionally, if a custom theme folder is being used, perform the following steps to ensure
that the custom brava formats icon and markup indicator icon is properly displayed.
Copy the markup indicator into your theme by copying the markup_exists.gif icon, located
by default in the Brava custom/theme/documentum/icons directory, and paste it into your
Webtop custom/theme/documentum/icons directory.
Copy the custom Brava Format icons into your custom theme by copying the format folder,
located by default in the Brava custom/theme/documentum/icons, and paste the folder into
your Webtop custom/theme/documentum/icons directory.
4. If a custom menubar.jsp file exits in
\<AppServer>\...\Webtop\Custom\Component\Menubar, paste the bolded Brava! text below
underneath the MSG_IMPORT_RENDITION action as shown below.

<dmfx:actionmenuitem dynamic='singleselect' name='doc_importrendition'

nlsid='MSG_IMPORT_RENDITION' action='importrendition' showifinvalid='true'
showifdisabled='false'/>
</dmf:menu>
<dmfx:actionmenuitem dynamic='singleselect' name='view_brava'
nlsid='MSG_BRAVA' action='brava' showifinvalid='true'/>
</dmf:menu>

Note: If no custom menubar.jsp file exists, copy the menubar.jsp from C:\Program
Files\Igc\Brava! WDK Webtop 5\Custom\Component\Menubar to
\<AppServer>\...\Webtop\Custom\Component\Menubar

5. If a custom dm_sysobject_actions.xml file exits in

\<AppServer>\webtop\custom\config\actions, paste the bolded Brava! text below underneath
the MSG_CHECKIN action id as shown below.

<action id="checkin" nlsid="MSG_CHECKIN"/>

<action id="brava" nlsid="MSG_BRAVA"/>

Note: If no custom dm_sysobject_actions.xml file exists, copy the

dm_sysobject_actions.xml from C:\Program Files\Igc\Brava! WDK Webtop 5\Custom\
Config\Actions to \<AppServer>\...\Webtop\Custom\Config\Actions

In the dm_sysobject_actions.xml file, if you have a custom doc type you must edit the line:
<scope type="dm_sysobject"> to <scope type="<custom_doc_type>">.

Note: See section 3.6.1.1 for instructions on how to enable annotations through Brava! on your own
custom document type.

6. If a custom dmr_content_actions.xml exits in <AppServer>\webtop\custom\config\actions,

paste the bolded Brava! text below just above the MSG_DELETE action id as shown below.
34
 <action id="brava" nlsid='MSG_BRAVA'/>
<action id="delete" nlsid='MSG_DELETE'/>

Note: If no custom dmr_content_actions.xml file exists, copy the

dmr_content_actions.xml from C:\Program Files\Igc\Brava! WDK Webtop 5\Custom\
Config\Actions to \<AppServer>\...\Webtop\Custom\Config\Actions

7. Copy menubar_component.xml & brava_component.xml from the C:\Program

Files\Igc\Brava! WDK Webtop 5\Custom\Config directory to the
\<AppServer>\...\Webtop\Custom\Config directory.

8. If a custom GenericActionNlsProp.properties file exists in

\<AppServer>\...\Webtop\ Custom\strings\com\documentum\webcomponent, open the file in
a text editor and add the following action to the bottom of the file.

#Custom Brava! Annotate Action

MSG_BRAVA=Annotate

9. If you want to include your own CUSTOM doctype to be a brava enabled document, add the
following to your brava_actions.xml file (located in the /custom/config/actions/ directory):
<scope type = "<your custom doc type">
<action id="brava">
<params>
<param name="objectId" required="true"></param>
</params>
<execution
class="com.documentum.web.formext.action.LaunchComponentWithPermitCheck">
<permit>read_permit</permit>
<component>bravaview</component>
<navigation>jump</navigation>
</execution>
</action>
</scope>
10. Copy the \Program Files\IGC\Brava! 5.3 Webtop\custom\strings\com\infograph directory
and it's entire contents to \<App Server>\\webapps\webtop\custom\strings\com

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:
 Net-It Enterprise
 Net-It Enterprise Queue Server
 Brava! Enterprise Server
 Black Ice EMF Printer Drivers
 Black Ice EMF Driver for TS (if Terminal Services is installed)

35
The Brava! Client and customizations can be removed (reversed) from the Webtop server.
o If no configuration customizations have occurred:
Delete all items in the custom/component directory, custom/config directory, custom/strings
directory.
o If you had previous configuration customizations, carefully back out edits that had to be
made for Brava! as described in the following section.

36
PART II – Core Brava User’s Guide
1.0 Overview
The following sections in Part II of this install guide are provided for advanced Brava Webtop users
who may wish to know much more detail about how Brava Enterprise works in general. It is also the
initial resource needed to begin to customize Brava beyond the scope of the Webtop integration. For
the average Brava Webtop Administrator, this information is a convenience, but not a necessity in
the operation or configuration of Brava for Webtop. Some information in Part II may appear to
conflict with information provided in Part I. Information presented in Part I will always take
precedence over any information presented in Part II.

1.1 Brava!® Enterprise for Webtop

Brava!® Enterprise software for Webtop is a Web application that is seamlessly integrated
with Documentum 5 for Webtop, enabling users to view and annotate nearly all file types
including raster, engineering formatted, PDF, and office documents from within
Documentum 5. Together, they automate the production, exchange, and personalization of all
types of content - making it easier to gain a competitive advantage by connecting employees,
business partners, and customers worldwide
End-users simply access the Brava! Client through their browser each time they choose to
annotate a document contained in the Documentum Docbase.

How does Brava! Enterprise work?

Brava! Enterprise is composed of three major components:

 Brava! Client
 Brava! Server
 Net-It Enterprise

The Brava! Client provides the GUI for viewing and marking up files. The Client
communicates with the Brava! Server, via http or https, to receive site configuration
information, to access files, and to retrieve and save markups. The primary component of the
Brava! Client is an ActiveX control that is embedded in a container such as the Internet
Explorer browser.

The Brava! Server is a servlet-based application that responds to Brava! Client requests to
access files and to retrieve and save markups. Brava! Server sends requests, via http, to
publish native files to Net-It Enterprise (see Section 1.2). Brava! Server maintains a cache of
the published files to speed up retrieval for subsequent requests for the files.

The following diagram depicts a typical Brava! Enterprise configuration and the standard
information flow for accessing a native document (i.e., pdf, dwg, doc) Note: This diagram
assumes a default Brava! Server configuration where session.manager is on (see section
1.1.2 for more information):
37
A. The end-user clicks on a URL link that returns an HTML page referencing the Brava
Client control. The URL specifies the document to open.
B. The URL references a page that dynamically generates HTML to return to the client;
assume an ASP page for this example. Based on session information sent during the
initial client request, the ASP page determines whether the user is authorized to view the
requested document ID. If authorized, the ASP page issues a request to the Brava!
Server for a session ID (see the sample.asp file in your client install directory for an
example). The session ID establishes a session for each document loaded by the client.
The use of session IDs is optional; see section 1.1.2.2 "Preventing Unauthorized Access
to the Brava! Services" for more information. The ASP page then generates an HTML
page to return to the client for loading the Brava! Client control. The html page contains
the sessionid parameter.
C. The .jsp page referencing the Brava! Client Control and document information to be
loaded is downloaded to the Client. If the Brava! Client ActiveX control is not installed
on the end-user client machine, it is then downloaded from the Web Server hosting the
client components. This download will only happen once per version of the client
components.
D. The Brava! Client Active X control parses the html parameter information and sends a
request to the Brava! Server to return the published document.
E. The Brava! Server checks to see if it already has the document cached in IGC published
format. If so, the cached version is returned to the client. If not, a request is made to Net-
It Enterprise to publish the document to IGC's published format. Note that for some
document types, (specified in the single.page.publish.allowed property of the
server.properties file located in the Brava! Server install directory) in addition to sending
a request to publish the whole document, a request is sent to publish just the initial page
so that the client can receive published information sooner.

38
 F. Net-It Enterprise receives the request, converts the native document to IGC's published
format, and writes it to the Brava! Server's document cache directory. A notification
message is then sent to the Brava! Server.
G. The native document, converted to IGC's published format, is transmitted to the Client
for display.
Note: This diagram depicts a standard production configuration. Depending on the customer
environment, other configurations may be desirable. For instance, if using JSP pages to
serve Brava! Client web pages, it may be desirable to combine the Client and Server
components on the same machine. To expedite a large number of publishing requests,
multiple Net-It Enterprise servers can be configured.

1.1.1 Customizing and Integrating Brava! Enterprise

There are several ways to integrate with Brava! Enterprise:

 Various configuration options are available to customize the state of Brava!

Enterprise application. For instance, most of the toolbar buttons and sub-menu
options, with their associated functionality, can be enabled or disabled. Date
format, initial page to load, initial search text, and banners and watermark text are
some examples of other states that can be preconfigured. It is possible to set
configuration properties for an entire site (see section 3.2.1 “Editing the Server
Parameter Files”) or at file level (see section 3.1.3 “Optional Brava ActiveX
Parameters”.
 Custom functionality can be invoked when particular events happen within Brava!
Enterprise. See the Notification Listener html parameter for instruction on how to
establish this. Also see the Brava! Enterprise Programmer's Guide and the
Advanced Publisher User Guide.htm for further information on performing custom
processing for various events.
 The Brava Client ActiveX control exposes various methods that can be
manipulated through HTML scripting language such as JavaScript and VBScript.
See the Brava! Enterprise Programmer's Guide for more information.

1.1.2 Security
In previous versions, the Brava! Server received requests via propriety protocol over a socket
connection. In Brava! Enterprise 5.3, the Server is composed of a set of servlets which
respond to HTTP URL requests with HTTP responses. As communication with the server is
more open than in previous versions, this section discusses some of the ways to protect the
information served from the Brava! Server. It also discusses protecting the machines running
the Brava! components.

1.1.2.1 Protecting Transmitted Information

When opening a native file, Brava! Enterprise does not send the original native file to the
Client. Instead, it sends IGC's proprietary published format to the Client, requiring the Brava!
Client or another IGC viewing product to view the image stream. If you require all the
information transmitted between the client and the server to be protected, use a Web Server
39
that supports SSL (secure socket layer) and HTTPS. To further protect content, native files
can be pre-published to IGC's CSF (Content Sealed Format) via IGC's client side Net-It
publishing products. CSF allows various rights to be established on the published file, such
as the ability to print the file or copy text. It also allows you to set a file access password and
an expiration date.

1.1.2.2 Preventing Unauthorized Access to the Brava! Services

This section discusses various methods for preventing unauthorized access to the Brava!
Services.

Session Manager
Brava! Server has a session manager which maintains a unique session for each
document request. The switch for the session manager is set as a property in the
server.properties file and defaults to ON. The following steps describe how the Brava!
Server and Client use session IDs to help prevent unauthorized access to server
resources.
 The client makes a call to an URL which generates a web page (e.g. JSP/ASP).
The client passes the docID to be published as a parameter.
 The JSP/ASP page makes a call to the Brava! Server to obtain a valid session ID
for a specified length of time. The Brava! Server checks to make sure the request
for the session ID comes from a machine with the IP set in the
legal.ip.to.get.sessionid property in the Brava! Server server.properties file. The
JSP/ASP then returns an HTML page which loads the Brava! Client control that
includes the sessionID as a parameter within the BravaXParams element value.
See the sample.jsp and sample.asp pages installed in the Brava! Client directory
for examples.
 The Client browser loads the returned HTML page which in turn loads the client
viewer control. The viewer communicates a request to the server to return the
published document. It passes all parameters specified in the HTML page as part
of the request.
 Since the session.manager is set to "on", the Brava! Server validates that the
session ID is still valid for the docID sent from the client. An error is returned if
the ID is invalid.

In summary, the session ID prevents an end-user from accessing a document he hasn't

been issued a session ID for. For example, if the end-user modified a downloaded
Brava! Client HTML page to change the docID value to point to a different document,
he would not be able to access that document. The JSP/ASP that receives the initial
request to display a document is the logical spot to authenticate the user and to make
sure the user is authorized to view the specified document before the JSP/ASP returns
an HTML page with a valid session ID.

The disadvantage of using the Brava! Server's session.manager is that the Brava! Client
control requires reloading with each new document. This is not a major concern since
the ActiveX client control loads very quickly; nevertheless, it is possible to use HTML
based scripting (e.g. JavaScript, VBScript) to load a new document into the existing
40
 viewer control. If this is desired, the following two sections describe alternative
methods for ensuring that the Brava! Server only returns authorized information.

Using the haspermission Property

Haspermission is a property that can be configured in the server's
server_precedence.properties file. See the Brava! Programmer’s Guide for more information
on haspermission. This URL is invoked every time a document load is attempted. Its value is
an URL that returns "TRUE" if the user is authorized to load the requested document. For
example, if the administrator simply wanted to ensure that users are authenticated before
granting access to view documents, the haspermission URL could point to a restricted HTML
page (only users that have been authenticated are granted access), that just contains the word
"true". Or, the haspermission URL can be more sophisticated, checking cookie information
and returning a true or false string based on the user's permission set.

Security-Constraints
As an alternative to using session.manager or the haspermission property, the Brava! Server
web application can be configured to restrict access to its servlets via the security-constraint
tag in its web.xml configuration file. Refer to
http://java.sun.com/webservices/docs/1.0/tutorial/doc/WebAppSecurity.html and
http://java.sun.com/webservices/docs/1.3/tutorial/doc/Security2.html for more information on
how to protect web application resources via its configuration file.

1.1.2.3 Protecting the Brava! Server Machine

It's important to restrict access to the Brava! Server since it contains markup data and
published files – some of which may be confidential information. Putting the Brava! Server
machine behind a firewall reduces the chance that unauthorized access will occur. If the
Brava! Clients need access to the Brava! Server over the Internet, one safe configuration
option is to route all Brava! Server requests through an Internet-accessible Web Server. The
Brava! Server machine then sits behind a firewall and is configured to just receive HTTP
requests from the Web Server and the Job Processor machines. For further information on
routing requests to the Tomcat servlet engine through a Web server, see
http://jakarta.apache.org/tomcat/tomcat-5.0-doc/config/ajp.html. Also, please see the
supplemental document Using the IIS JK Connector.doc located in your Brava! Server's
Docs directory for detailed information about configuring Tomcat and IIS.

Another alternative for using IIS as the front-end Web Server is to use an ASP page to direct
traffic between IIS and the servlet engine. The redirect.asp page (located in the Client
installation directory) serves this purpose. This page, although not certified by IGC, is
provided as an example. To use an intermediate ASP page, all server integration properties
located in either the generated client html or in the client_precedence.properties file located
on the server need to be directed to the ASP page initially. For example, the
ServerProperties parameter would change from:
serverproperties=methodurl,http://BravaServerBox:8080/BravaServer/Properties
to:
serverproperties=methodurl,http://IISMachine/redirect.asp,serverurl,http://BravaServerBox:
8080/BravaServer/Properties.

41
 1.1.2.4 Other Considerations

Brava! Enterprise provides the capability (enabled by default) for end-users to publish CSF
files from native loaded files. Also, all Visual Rights permissions (i.e. printing) retrieved
from the server and applied to the output CSF file are enabled by default. If this presents a
security issue for your setup, specific rights can be disabled by returning a custom
security.xml file. This is accomplished by configuring the getsecurityxml property (see the
Brava Programmer's Guide for more information).

Additionally, be aware that Brava! Enterprise provides the ability for the end-user to
interactively set the Visual Rights when they are publishing a CSF file. This capability is off
by default. If this feature is enabled, there is no way to restrict which Visual Rights end-
users may apply to their published CSF files.

1.2 Net-It ® Enterprise

Net-It ® Enterprise software is a scalable conversion solution that is used with Brava!
Enterprise to publish drawings and documents to IGC’s common display list format.

Net-It Enterprise can publish a wide variety of formats by directly reading the native file, or
it can publish virtually any format by converting the output of the associated application's
print command. Net-It Enterprise extracts and retains hyperlink, bookmark, and file link
information from Microsoft Word, Excel, PowerPoint, and Visio documents.

In the context of Brava! Enterprise, Net-It Enterprise receives requests to publish files from
the Brava! Server. Net-It Enterprise publishes the files to the location specified in the
request, and then notifies Brava! Server that the publishing has completed. The Brava! Server
stores the published file in a cache to speed up subsequent requests for the file. Net-It
Enterprise has two basic pieces, the Queue Server and the Job Processor which are described
in the following sections.

42
The figure below illustrates the communication between the User, Queue Server, and Job Processor.

1.2.1 The Net-It Enterprise Queue Server

The Queue Server tracks the publishing requests, or jobs, on an event basis. The Queue
Server is made up of a push servlet that listens for publishing requests. When it receives
them, it gives them to the pop servlet for submission to the Job Processor(s). The pop
servlet receives notification from the Job Processor(s) when it is ready to receive a new job.
If no Job Processor is currently available, the job requests are put into a queue, in the order
the requests were received, to await an available Job Processor. All jobs are processed in the
order received.
The Queue Server has a monitor that can be used by an Administrator to monitor the current
print jobs awaiting publishing. The monitor provides information about the status of each
Job Processor and publish job. If the Queue Server is rebooted while jobs are in the queue no
publish jobs should be lost; the Queue Server will reinitialize to the state it was in before the
reboot. For information on configuring the Queue Server, see 3.3 Configuring the Queue
Server.

1.2.2 The Net-It Enterprise Job Processor

The machine where you actually install Net-It Enterprise is the Job Processor machine and
must be a Windows machine. The Job Processor performs the actual conversion process.
There can be more than one Job Processor per Queue Server. The Job Processor lets the
Queue Server know it is ready for a new job through an HTTP call. If there are no current
jobs, the Job Processor waits for a specified amount of time (the amount of time is
configurable through the JobProcessor.properties file) then sends another request for a job.
The Job Processor publishes files in one of two ways. If the file being converted is one of the
natively supported files (see section 1.3 Supported File Formats for a list of supported
formats), the Job Processor performs the conversion internally and requires no other
application. If the file being converted is not one of the natively supported formats, an
application must be registered on the Job Processor to perform a Print to action for that file

43
 type. See section 3.4.5 Publishing Using Other Applications for more information on how to
setup applications to publish file types not natively supported by Net-It Enterprise.
For more information on configuring the Job Processor, see 3.4 Configuring the Job
Processor(s)

1.3 Supported File Formats

Brava! Enterprise does not require a separate (native) application to publish the file formats listed
below. To publish other formats not on this list, Net-It Enterprise and the native applications are
required. The Job Processor machine must have a Print to command available in the native
application for that extension. This is accomplished simply by installing the native application (such
as Word, Excel, or any other application that uses a Print command) on the Job Processor machine.
See section 3.4.5 Publishing Using Other Applications for information on how to setup applications
to publish file types that do not have a Print or Print to action and are not on the following supported
file types list.

Brava! Enterprise Supported Formats

In addition to the formats below, Brava! can also view any format viewable by an application
supporting the Windows Print command via Net-It Enterprise. Alternatively, Net-It Enterprise can
use Stellent's Outside In driver technology to process an extensive list office and image formats,
some of which are listed under Additional Office and Image Formats below. Click here for the
complete list of Outside In formats.

Neutral Formats Extension

Portable Document Format PDF
Content Sealed Format CSF
Tagged Image Format TIFF/TIF

CAD Formats Extension

000 HPGL Plot File 000
906/907 Plot File 906/907
AutoCAD Drawing (2D) (through version 2006) DWG
AutoCAD DXF ( through version 2006) DXF
AutoCAD Web Format (through version 2006) DWF
Auto-trol Raster DX
Auto-trol Vector DG
CADKEY PRT
CAD Overlay RLC
Computer Graphics Metafile CGM
EDMICS EDM
GTX Group III, IV G3, G4, CG4
GTX Runlength RNL
HP CAD ME10 (through version 12) CMI, MI
HPGL Plot File PLT
IGES (2D) (version 5.2) IGS, IGES
Inventor (2D) (versions 5.3 - 10) (requires Inventor View) IDW
MicroStation Drawing (through version 8.0) DGN
MicroStation Group IV CIT
MicroStation Runlength RLE
MYRIAD 3D View Sets MVS
OrCad (version 10) DSN
Solid Edge Drawings (2D) (versions 8 - 16) DFT
SolidWorks Drawings (2D) (versions 97 - 2006) SLDDRW
Wavesoft MOT

44
Imaging Formats (additional formats available*) Extension
CALS (Group IV) CAL, CG4, GP4, MIL
DCX (multipage) DCX
EDCARS EDC
Formtek Raster FTK
ISO 8613/CALS ISO, CAL
JPEG Compressed Image JPG, JPEG
PC Paintbrush PCX
Portable Network Graphic PNG
Raytheon G4 / Navy DIF DIF
Tagged Image File TIF, TIFF
Windows Bitmap BMP

Additional Document and Image Formats * Extension

Corel Draw CDR
Corel Presentations SHW
DataBase Formats DBF
DocuWorks XDW
Excel XLS
FAX CITT Group 3 Fax FAX
Hyper Text Markup Language HTML, HTM
Microsoft Excel WK1, WK3
Microsoft PowerPoint PPS, PPT
Microsoft Project MPP
Microsoft Visio VSD
Microsoft Word DOC
Microsoft Works WDB
PageMaker P65
QuattroPro WB1, WB2, WQ1
Rich Text Format RTF
Samna Word SAM
Windows Write WRI
WordPerfect WP5, WP6, WPD, WPF
WordStar WS

* Requires CAMCAD software by Router Solutions, Inc.

** Requires Net-It Enterprise (formerly called Brava! Publisher); extensive office and image format support available through Outside In
driver technology

Outside In Formats

The following formats are available via Stellent Corp.'s Outside In technology as an add-on
purchase for Brava! Enterprise. (Please contact Informative Graphics to purchase and
download the add-on.) These formats require Net-It Enterprise to be installed.

By default, Net-It Enterprise uses the supporting application (Word, Excel, etc.) print drivers
to publish the following Outside In formats. You can manually set each extension to use Net-
It Enterprise’s Outside In drivers instead – thus eliminating the need to install the supporting
application on the job processor machine. Outside In formats will open and view correctly in
Brava! Enterprise without the supporting application. See section 1.3.1 Publishing with
Outside In Drivers for instructions on how to set these extensions.

Word Processing Formats

Generic Text
ANSI Text (7 & 8 bit) All versions
ASCII Text (7 & 8 bit versions available) All versions
HTML Versions through 3.0

45
IBM FFT All versions
IBM Revisable Form Text All versions
Microsoft Rich Text Format (RTF) All versions
Text Mail (MIME) No specific version
Unicode Text All versions
WML Version 5.2
Word Processing - DOS:
DEC WPS Plus (DX) Versions through 4.0
DEC WPS Plus (WPL) Versions through 4.1
DisplayWrite 2 & 3 (TXT) All versions
DisplayWrite 4 & 5 Versions through Release 2.0
Enable Versions 3.0, 4.0 and 4.5
First Choice Versions through 3.0
Framework Version 3.0
IBM Writing Assistant Version 1.01
Lotus Manuscript Versions through 2.0
MASS11 Versions through 8.0
Microsoft Word Versions through 6.0
Microsoft Works Versions through 2.0
MultiMate Versions through 4.0
Navy DIF All versions
Nota Bene Version 3.0
Novell WordPerfect Versions through 6.1
Office Writer Version 4.0 to 6.0
PC-File Letter Versions through 5.0
PC-File+ Letter Versions through 3.0
PFS:Write Versions A, B, and C
Professional Write Versions through 2.1
Q&A Version 2.0
Samna Word Versions through Samna Word IV+
SmartWare II Version 1.02
Sprint Versions 1.0
Total Word Version 1.2
Volkswriter 3 & 4 Versions through 1.0
Wang PC (IWP) Versions through 2.6
WordMARC Versions through Composer Plus
WordPerfect Versions through 6.1
WordStar Versions through 7.0
WordStar 2000 Versions through 3.0
XyWrite Versions through III Plus
Word Processing - Windows:
Adobe FrameMaker (MIF) Version 6.0

46
Hangui
JustSystems Ichitaro
JustWrite
Legacy
Lotus AMI/AMI Professional
Lotus WordPro
Microsoft Windows Write
Microsoft Windows Word
Microsoft WordPad
Microsoft Works
Novell Perfect Works
Novell/Corel WordPerfect
Professional Write Plus
Q&A Write for Windows
Star Office/Open Office Writer
WordStar for Windows
Spreadsheet Formats
Enable
First Choice
Framework
Lotus 1-2-3 (DOS & Windows)
Lotus 1-2-3 for SmartSuite
Lotus 1-2-3 Charts (DOS & Windows)
Lotus 1-2-3 (OS/2)
Lotus 1-2-3 Charts (OS/2)
Lotus Symphony
Microsoft Excel Macintosh
Microsoft Excel Windows
Microsoft Excel Charts
Microsoft Multiplan
Microsoft Windows Works
Microsoft Works (DOS)
Microsoft Works (Mac)
Mosaic Twin
Novell Perfect Works
QuattroPro for DOS
QuattroPro for Windows
PFS:Professional Plan
SuperCalc 5
SmartWare II
Version 97 and 2002 (text only)
Version 5.0, 6.0, 8.0 – 13.0, 2004
Versions through 3.0
Versions through 1.1
Versions through 3.1
Versions 96 through Millennium Edition
9.6, text only
Versions through 3.0
Versions through 2003
All Versions
Versions through 4.0
Version 2.0
Versions through 12.0
Version 1.0
Version 3.0
Star Office Versions 5.2, 6.x, and 7.x
Open Office Version 1.1 (text only)
Version 1.0
Versions 3.0, 4.0 and 4.5
Versions through 3.0
Version 3.0
Versions through 5.0
SmartSuite 97and Millennium 9.6
Versions through 5.0
Versions through 2.0
Versions through 2.0
Versions 1.0,1.1 and 2.0
Versions 3.0 through 4.0, 98 - 2004
Versions 2.2 through 2003
Versions 2.x through 7.0
Version 4.0
Versions through 4.0
Versions through 2.0
Versions through 2.0
Version 2.5
Version 2.0
Versions through 5.0
Versions through 12.0
Version 1.0
Version 4.0
Version 1.02
47
VP Planner 3D Version 1.0
Star Office/Open Office Calc Star Office Versions 5.2, 6.x, and 7.x
Open Office Version 1.1 (text only)

Database Formats
Access Versions through 2.0
dBASE Versions through 5.0
DataEase Version 4.x
dBXL Version 1.3
Enable Versions 3.0, 4.0 and 4.5
First Choice Versions through 3.0
FoxBase Version 2.1
Framework Version 3.0
Microsoft Windows Works Versions through 4.0
Microsoft Works (DOS) Versions through 2.0
Microsoft Works (Mac) Versions through 2.0
Paradox (DOS) Versions through 4.0
Paradox (Windows) Versions through 1.0
Personal R:BASE Version 1.0
R:BASE 5000 Versions through 3.1
R:BASE System V Version 1.0
Reflex Version 2.0
Q&A Versions through 2.0
SmartWare II Version 1.02

Standard Graphic Formats

Adobe Photoshop (PSD) Version 4.0
Adobe Illustrator Versions through 7.0, 9.0
Adobe FrameMaker graphics (FMV) Versions through 5.0
Adobe Acrobat (PDF) Versions 2.1, 3.0-6.0, Japanese
Ami Draw (SDW) Ami Draw
AutoCAD Interchange and Native Drawing formats DXF and DWG
AutoCAD Drawing Versions 2.5 – 2.6, 9.0 – 14.0, 2000i and
2002
AutoShade Rendering (RND) Version 2.0
Binary Group 3 Fax All versions
Bitmap (BMP, RLE, ICO, CUR, OS/2, DIB & WARP) All versions
CALS Raster (GP4) Type I and Type II
Corel Clipart format (CMX) Versions 5 through 6
Corel Draw (CDR) Versions 3.x – 8.x
Corel Draw (CDR with TIFF header) Versions 2.x – 9.x
Computer Graphics Metafile (CGM)- ANSI, CALS, NIST, Version 3.0
Encapsulated PostScript (EPS) TIFF header only

48
GEM paint (IMG) No specific version
Graphics Environment Mgr (GEM) Bitmap & vector
Graphics Interchange Format (GIF) No specific version
Hewlett Packard Graphics Language (HPGL) Version 2
IBM Graphics Data Format (GDF) Version 1.0
IBM Picture Interchange Format (PIF) Version 1.0
Initial Graphics Exchange Spec (IGES) Version 5.1
JFIF (JPEG not in TIFF format) All versions
JPEG (including EXIF) All versions
Kodak Flash Pix (FPX) All versions
Kodak Photo CD (PCD) Version 1.0
Lotus PIC All versions
Lotus Snapshot All versions
Macintosh PICT1 & PICT2 Bitmap only
MacPaint (PNTG) No specific version
Micrografix Draw (DRW) Versions through 4.0
Micrografix Designer (DRW) Versions through 3.1
Micrografix Designer (DSF) Windows 95, version 6.0
Novell PerfectWorks (Draw) Version 2.0
OS/2 PM Metafile (MET) Version 3.0
Paint Shop Pro 6 (PSP) Windows only, versions 5.0-6.0
PC Paintbrush (PCX and DCX) All versions
Portable Bitmap (PBM) All versions
Portable Graymap (PGM) No specific version
Portable Network Graphics (PNG) Version 1.0
Portable Pixmap (PPM) No specific version
Postscript (PS) Level II
Progressive JPEG No specific version
Sun Raster (SRS) No specific version
Star Office/Open Office Draw Star Office 5.2, 6.x, and 7.x OpenOffice
version 1.1 (text only)
TIFF Versions through 6
TIFF CCITT Group 3 & 4 Versions through 6
Truevision TGA (TARGA) Version 2
Visio Versions 5, 2000-2003
WBMP No specific version
Windows Enhanced Metafile (EMF) No specific version
Windows Metafile (WMF) No specific version
WordPerfect Graphics (WPG & WPG2) Versions through 2.0, 7 and 10
XBM - X-Windows Bitmap x10 compatible
XPM - X-Windows Pixmap x10 compatible
XWD - X-Windows Dump x10 compatible

49
 Presentation Formats
Corel/Novell Presentations Version through 12.0
Harvard Graphics for DOS Versions 2.x & 3.x
Harvard Graphics Windows versions
Freelance for Windows Versions through Millennium 9.6
Freelance for OS/2 Versions through 2.0
Microsoft PowerPoint for Windows Versions 3.0 through 2003
Microsoft PowerPoint for Macintosh Version 4.0, 98 through 2004
StarOffice/ OpenOffice Impress StarOffice 5.2, 6.x, and 7.x OpenOffice
1.1 (text only)

Compressed and Encoded Formats

GZIP No specific version
LZA Self Extracting Compress No specific version
LZH Compress No specific version
Microsoft Binder Version 7.0, Binder 97
MIME (text mail) No specific version
UUEncode No specific version
UNIX Compress No specific version
UNIX TAR No specific version
ZIP PKWARE versions through 2.04g

Other
Executable (EXE, DLL) No specific version
Executable for Windows NT No specific version
vCard Electronic Business Card Version 2.1
Microsoft Outlook Express (EML) No specific version
Microsoft Outlook Folder (PST) Versions 97,98, 2002, and 2003
Microsoft Outlook Message (MSG) All versions
Microsoft Project Versions 98-2003 (text only)

1.3.1 Publishing with Outside In drivers

Net-It Enterprise can be configured to publish the Outside In formats listed in the tables above.
You can manually set each format extension to use Net-It Enterprise’s Outside In drivers which
will eliminate the need to install the format’s supporting application on the job processor
machine. You will need to contact Informative Graphics to obtain a valid license for publishing
with Outside In drivers.
Use the following procedure to set up each extension type to use Outside In drivers for
publishing:

1. Locate and open in a text editor the job processor myrdrv.ini file.
(<drive>\IGC\Brava!\Jobprocessor\myrdrv.ini)

50
 2. Search for and uncomment (delete the #) the file types that you wish to load with
Brava!’s Outside In drivers. If the file type does not exist, add it to the [idrivers] section
in the following format:
[idrivers]
xxx=G,inso2dl, “XXX Name of file type”
(example: cdr=G,inso2dl, “CDR Corel Drawing”)
3. Edit the JobProcessor.properties file in the JobProcessor directory and add extensions
(i.e., .cdr, .doc) to the bdlgen.extensions property for every extension to be converted by
INSO.

1.4 New Features in the Core 5.x Release

New to 5.3

 The default pan tool can now detect and follow hyperlinks.
 A native file (non-CSF) that contains markups with blockout entities loaded and that is
published to PDF will now have those blockouts redacted in the output PDF file.
 Simplified redaction process. The user is no longer prompted for whether to burn-in a
markup for redaction or for review. Instead, blockout entities being burned into a published
CSF or PDF file are always redacted.
 Ability to control the darkness of a print watermark through a new parameter.
 A third mode has been added to the magnifier window. When selected, it allows the user to
click on an area of the page that will stay "docked" in the magnifier window. If the user
scrolls the current page, the view that's in the magnifier stays the same.
 Improved capability to convert Outlook msg files.
 Extra parameters have been added to control viewer state (i.e. Animation, Enhanced
Display).
 Redaction enhancements - Find and Redact and Redact to Phrase List added (including new
parameters and markup toolbar buttons).
 Scrollable paging available (for documents only) via the mouse wheel or by using the vertical
scroll buttons when the document reaches its pan limits. The mouse wheel performs zoom
in/out functionality with drawing files.
 Term hit highlighting. All words specified in the Highlight Terms parameter are highlighted
in yellow on all pages of the document.
 A thumbnail panel can be opened by the user providing an alternative way to navigate the
document.
 Scaleability improvments - Instead of converting files on the server, some file types may be
converted locally (e.g. tif, pdf), resulting in a reduction of server processing requirements.
 Ability to establish a nightly truncation of the displaylistcache which reduces the need to
truncate during the day, resulting in improved server performance.

51
 Markup enhancements – Added a markup item “Consolidate Markups” to allow those with
the proper rights to consolidate all open markups into a single new consolidated markup file.

New to 5.2

 Support for Markup Raster Entities via new markup toolbar button.
 New parameters MarkupRasterDirectory and MarkupRasterFile facilitate specifying which
markup raster entities to select.
 Ability to copy markups to all pages. When editing a markup, a user can select one or more
copyable markup entities to all pages of the multi-page document.
 Support for PDF publishing. Features are similar to CSF publishing.
 Support for applying markups on published PDF files as either PDF Comments or as burned
in markups.
 Print Screen functionality is disabled when a CSF file is loaded that has Save As, Print, or
Copy Text disabled by Visual Rights.
 Improved measurement features. Snap feature automatically snaps to midpoints of line
segments, and center points of arcs and circles. New polyline measurement added.
 System audit tool available to provide basic diagnostics on the target system and report
potential problems. Available as a separate download.
http://www.infograph.com/support/BravaDiagnosticsTool.htm

1.4.1 Major Differences between (Java) Brava! 5.0 and (ActiveX) Brava!5.3
Releases

Technical Differences
Brava! 5.3 X is functionally very similar to Brava! 5.0 J. The major difference is the
implementation of a different technical architecture. Major architectural changes consist of
the following:
 The Brava! Enterprise Client has been re-engineered as an ActiveX control rather
than a Java applet. As a result, the response time for loading files has been greatly
improved. This also means that the installation of a Java Plug-in is no longer
needed.
 The Brava! Server is now primarily servlet based rather than being a standalone
Java application. The primary communication protocol is now http
communication rather than straight TCP/IP sockets.
 Net-It Enterprise, an option with prior versions of Brava!, now comes bundled. It
is now responsible for all file conversion to IGC’s display list format.

Functional Differences
The following functional differences exist between Brava! 5.0 J and 5.3 X releases. With 5.3
X:
52
  If a markup is opened for edit, the Markup Open menu item is enabled with 5.3 X.
If opening a new markup and the existing markup has been modified but not
saved, the user is prompted to save the markup before the current markup is
closed and the new markup is opened.
 The background color functionality is changed from being a toggle between three
states (gray, white, and black) to being a popup menu selections plus a “default”
selection.
 The background color setting is persisted as a user preference.
 The Print toolbar button now invokes a submenu that includes Print, Print Region,
and ISO Banners/Watermarks.
 The full set of Brava! 5.0 parameters are no longer supported. See 5.3 Migration
Notes for details.
 The customer now has more control on setting the precedence of parameters
specified on the Client and the Server.
 The Brava ActiveX control has no menu. All functions are available through
toolbar buttons, the right-mouse-button menu, and hotkeys.
 The 5.3X viewer includes additional features and functionality that is not in the
java version (includes most features added to 5.2x and 5.3x versions).
 The 5.3 X Viewer does not have the concept of running in its own frame. It must
be in a container such as Internet Explorer. If there is a need to maximize the size
of the viewed document or drawing in a separate window, a new IE window
(without the toolbars) can be launched via JavaScript which embeds the BravaX
control.

1.4.2 Migration Notes

If you are migrating from Brava 5.0 to 5.3:
 Web pages will need to be updated to refer to the ActiveX control instead of the
Java Plugin and Brava! Java applet. The installation includes a sample ASP page,
JSP page, and HTML pages.
 Server side configuration settings formerly established in the jmyriadserver.ini
file are now established in server.properties file. Optional parameters that could
be set Server side in jmyriadserver.ini are now set in either the
client_precedence.properties file or the server_precedence.properties file. These
files are located in the Brava! Server installation directory.
 A few of the supported HTML parameter names have changed. DocFile is now
DocID and the Banner parameters no longer have the line number appended to the
end. If banners need to be on more than one line, then line break delimiters, the
character set <\n>, are added to the banner property. IntegrationClassName has
essentially been replaced by IntegrationUrl.
 For the parameters PreloadMarkupName and PreloadReadonlyMarkupNames,
the specified values need to be just the markup name(s) relative to the
MarkupDirectory and not the complete paths to the markup file(s) as was the case
in previous versions.
 The valid values for DateFormat and TimeZone have changed.
 In addition to the parameter name changes noted above, the following parameters
are no longer supported: CheckMarkupSubDirectories, URLPath,

53
 EnableFileOpen, EnableMenuBar, EnableOffline, DllPath, CustomAction,
SupportFilesURL, HelpFilesURL, and LoadingFromBravaServer.
 Due to the technical architecture changes, custom integrations with Brava!
Enterprise has changed. See the Brava! Enterprise Programmer’s Guide for more
information.

2.0 Install
2.1 Install Requirements

See section 1.0 Brava Webtop Installation for specific integration install screens and
requirements.

Installing Brava! Enterprise components requires some knowledge of web server/servlet engine
technology. Note that Brava! Enterprise maintenance support for execution on tested platforms
and components is limited to the period that those platforms and components are supported by
their vendors.

2.2 Installing Brava! Enterprise Components

Please refer to Part I of this document for step by step instructions guiding you through the Brava
Webtop installation screens. The location of the components depends on the requirements for the
Brava! Enterprise application. For help in determining the best configuration for your
environment, contact IGC.

**IMPORTANT**
Brava! Licensing: By default, the Brava! Enterprise product installs a 5-user 30 day
evaluation key stored in the IGCkey.lic file (located in the Brava! Server directory). Once
you obtain a permanent key from Informative Graphics, you must copy it to the Brava!
installation directory to replace the 30 day evaluation key. Similarly, the Net-It Enterprise
JobProcessor component is installed with a 30-day license. It is stored in the IGCKey.lic file
located in the JobProcessor\LicenseKey directory and it must also be updated once an
extended license has been purchased from IGC.

2.2.1 Permissions to install the Brava! Client Control

Steps to installing the Client Control

The following activities happen automatically on the end-user's machine when they access a
web page referencing the Brava Client ActiveX control:

 If the machine does not have the specified version of the control installed, it will
download the BravaClientX.cab.

54
  The cab is downloaded to the Window system's "Downloaded Program Files" sub-
directory (e.g. C:\WINDOWS\Download Program Files), and the cab components are
installed (in a sub-directory). As part of this installation, the BravaClientX.dll is
registered, updating registry keys under the HKEY_CLASSES_ROOT key.
 Internet Explorer loads the Brava! Client control into the web page.
 The Brava! Client control checks to see that the proper version (based on the
IntegrationVersion parameter) of the Brava "integration" DLL is installed. This DLL
handles client communication with the Brava! Server. It looks for this DLL in the
IGC sub-directory of the user's HOMEPATH (i.e. C:\Documents and
Settings\<user>\IGC). If it is not found there, the client control downloads the DLL
from on the URL specified in the IntegrationURL parameter to the local directory.
 The client then proceeds to communicate with the Brava! Server to download the
specified document (set via the DocID parameter).

Required Permissions

The Brava! Client is a signed ActiveX control. In order for an end-user to install the client
control, their Internet Explorer browser needs to be configured to accept signed ActiveX
controls, and must be enabled to run ActiveX controls. Select the "Custom Level..." option
from the Internet Explorer Options Security tab to view the various IE security settings.

The end-user must also have the appropriate permissions to download and install the control.
By default, most versions of Window's come with the Standard User and Restricted User
roles. A user assigned to a group with the "Standard User" permission set will be able to
install the Brava! Client control, however, an end-user with just the "Restricted User" role
will not.

To see what type of an account a user has:

1. From the Control Panel, double-click Users and Passwords (User Accounts
in Windows XP).
2. Select the user account and click the Properties button.
3. In the Properties dialog, select the Group Membership tab for the user’s
group.

To allow an end-user to install the Brava Client ActiveX control, a couple of alternatives are:

 Set the end-user's Group Membership to one that has the appropriate rights (i.e. the
Power User's Group). This is set from the Group Membership panel described in the
preceding paragraph.
 A user with appropriate rights can log on to the end user's machine and hit a sample
page that references the Brava! Client control. Once this has been successfully
downloaded by this "power" user, the restricted user will be able to use the Brava!
control on the machine.

55
  On Windows networks, another alternative is to deploy an MSI package; this
provides a mechanism for the Brava ActiveX client control to be installed to end-
users that do not have administrator privileges on their machine. See
http://support.microsoft.com/kb/816102 for further information. The MSI package for
the BravaX client is located in the Brava! CD installation image in the Brava
directory. Note that the deployment of this MSI package on a Windows network has
not been certified by IGC.

2.2.2 Installing Brava! Enterprise Components as a Service

Brava! Enterprise has three server components. Two of the components – the Brava! Server
and the Net-It Enterprise Queue Server – run as web applications within a host servlet
engine. To run these components as services, the hosting servlet engine should be set up to
run as a service.
If using Apache Tomcat as your servlet engine, a script is provided to setup Tomcat as a
service in the Brava! Server/ TomcatServiceScript directory. Before running the script, the
CATALINA_HOME and JDK_HOME variables defined in the script need to be updated
based on your machine's configuration.
The third server component, the Net-It Enterprise JobProcessor, runs as its own application.
During the install for the Net-It Enterprise Job Processor, the Installer will ask you if you
would like to install the component as a service. To do so, select Yes. Follow the on screen
prompts to complete the installation. If you decide later to install Net-It Enterprise as a
service, you must run the install again two times. The first time to uninstall the component,
the second time to reinstall the component as a service.

To Start the Net-It Enterprise JobProcessor Service:

1. The first time you start the Net-It Enterprise Service, a one-time update to the
services Log On properties is required. Click the Services icon from your Windows
Control Panel.
2. Select Net-It Enterprise Service from the Service list.
3. Open the Properties dialog through the menu bar or by right-clicking on the Net-It
Enterprise Service. Select the Log On tab.
4. Click the "This account" button and enter a network user account with Administrator
privileges that has write access to the Brava! Server's displaylistcache share directory.
Be sure to enter the user account's domain (i.e. <domain>\<user>). Enter the
Password and Confirm Password fields and click OK.
5. The install sets the Net-It Enterprise Service to be automatic and will launch each
time the machine boots up. If you change the Net-It Enterprise Service to manual
instead of automatic, you can start the service by highlighting the Net-It Enterprise
Service in your Services list and clicking Start.

2.2.3 Installing Autodesk Inventor View for Inventor Support

You must install Autodesk Inventor View in order for Net-It Enterprise to publish Inventor
files. Net-It Enterprise supports Inventor natively using the Myriidw.dll driver with Autodesk

56
 Inventor View and you do not have to use the Inventor Application print driver to publish the
.IDW file format.

1. Log on to the machine where the Net-It Enterprise JobProcessor is installed.

2. Browse to http://www.infograph.com/support/bravaInventor.htm
3. Download Autodesk Inventor View version 10. Autodesk Inventor View version 10
supports Inventor version 6 through version 10 files.
4. Install Autodesk Inventor View version 10, accepting all of the default values.
5. If you have one or more Net-It Enterprise Job Processors installed on different
servers, repeat steps 1 through 4 for each Net-It Enterprise Job Processor server. It is
not necessary to restart Net-It Enterprise.

2.3 Test and Verify Your Installation

2.3.1 Verify the Brava! Server is installed

There are two parts to the Brava! Server installation. The first part is the BravaServer.war
file that is deployed to the target servlet engine’s web application directory (e.g., C:\Program
Files\Apache\Tomcat\webapps). The second part is a directory structure that contains
configuration files and directory holders for log files, markups, and published files that are
cached. The default installation directory for this is C:\Program Files\IGC\Brava!. Make sure
that the war file is deployed as specified during the installation process and that the Brava!
Server install directory was created in the location specified during installation.

2.3.2 Verify the Net-It Enterprise Queue Server installation

A running servlet engine that can deploy a WAR (web application) file must be installed on
the machine used as the Queue Server. A servlet engine with a Servlet 2.2 container and JSP
1.1 container meets this requirement (JRun 4.0 (with SP5 recommended) and Jakarta Tomcat
3.2.1 or Apache Tomcat 4.x, 5.0). Perform the following setup on the machine where the
Queue Server resides. You can have the Queue Server on the same or a separate machine as
the Job Processor(s). Follow the instructions below depending on your setup:

Tomcat on Windows Install

Install Tomcat. From the installation screen of your Brava! Enterprise installation program,
click the Install Queue Server button and follow the on-screen prompts.

Any Other Servlet Engine Install

Any other non-Informative Graphics qualified Servlet Container 2.2 and JSP 1.1 product.

1. From the installation screen of your Brava! Enterprise installation program,

click the Install Queue Server button and follow the on-screen prompts. Do not
install Tomcat.
2. Verify your Servlet Engine installation. Test a sample servlet and JSP included
with your servlet installation.

57
 Examples: http://<hostname:port>/servlet/<sampleServlet>
and http://<hostname:port>/JSP/<sampleJSP>

3. Deploy BravaPublisher.war in the Servlet Engine

Please see your Servlet Engine's documentation for the proper deployment of
war files. The BravaPublisher.war file is located in the installed Queue Server
directory (e.g.,<Tomcat directory>/webapps/)

2.3.3 Verify the Net-It Enterprise Job Processor installation

You can have multiple Job Processors in use with Net-It Enterprise. Complete the following
setup on the machine(s) where you want the Job Processor to reside. These steps need to be
performed for each Job Processor machine.

 Install Job Processor

 Verify Launch

Run the Net-It Enterprise install on the machine(s) where you want the Job
Processor(s) to reside.
Note: These machines can be set to periodically reboot (see sections 3.4.4
Configuring for Auto Restart and 3.4.1 Editing the JobProcessor.properties File for
more information on the periodic reboot) by the Job Processor, so these should be low
use machines.

Job Processor requires the logged in user to be an "Administrator".

1. From the installation screen of your Brava! Enterprise installation program,

click the Install Job Processor button and follow the on-screen prompts. By
default, the Job Processor installs to the following location: <Windows
Drive>:\Program Files\IGC\Brava!\JobProcessor. This is your installed Job
Processor directory.

The IGC program group should now appear in the Windows Start menu under
Programs (Start -> Programs -> IGC -> Brava!). It contains shortcuts for
launching Net-It Enterprise and Brava! Server (if installed on the same machine).

2. To verify that your Job Processor will launch successfully, on each Job Processor
machine, go to the Net-It Enterprise program group in the Windows Start menu
and select ProgramsIGCBrava!Start Net-It Enterprise. This runs the
file StartPublisher.bat in the installed Net-It Enterprise directory. (Note: Not
needed if Net-It Enterprise is installed to run as a service.)

A command window appears. If the launch is successful, you will see script similar to
the following and ending with “PublisherController Starting”:

58
 If the launch was unsuccessful, you might need to edit the StartPublisher.bat file in a
text editor to point to the correct path to java.exe. Use <Ctrl>+C to close the
command window.

2.3.4 Verify Net-It Enterprise is working

 Start your Servlet Container
 Start the Job Processor
 Verify Web application deployment
 Test your installation

1. Start your Servlet Container.

Make sure that your servlet engine is up and running. For Tomcat users, go to the
Apache Tomcat program group on the Windows Start menu and select
ProgramsApache TomcatStart Tomcat - or you can double-click the file
Startup.bat located in <Apache Tomcat 5.0 location>/bin directory. (Note: Not
needed if Tomcat is installed to run as a service. Instead, go to your Services Panel to
verify that Tomcat has started.)
If Tomcat does not start, you might need to set your JAVA_HOME variable to point
to JDK. To do this: From your Control Panel select Systems and click the Advanced
tab. Click Environmental Variables and edit JAVA HOME to your Java home
folder. If you don’t have this variable set, click NEW to create a new variable.
Example:
Variable: JAVA_HOME Value: C:\jdk1.4.2

2. Start the Job Processor

a) On each Job Processor machine, go to the Net-It Enterprise program group on the
Windows Start menu and select Start Net-It Enterprise (Start -> Programs ->
IGC->Brava! -> Start Net-It Enterprise). This runs the file StartPublisher.bat in
the installed Net-It Enterprise directory. (Note: If the Job Processor is installed as a
service, go to your Services Panel to verify that the Job Processor has started.)

A DOS window appears. If the launch is successful, you will see a script similar to
the following and ending with “PublisherController Starting”:

59
 b) Minimize, but do not close the command window. Closing the command window
shuts down the Job Processor. You must have the Job Processor running anytime you
wish to publish files.

3. Verify web application deployment

Net-It Enterprise can display status information and can be used as a monitor tool.
See section 3.5 Monitoring Net-It Enterprise.
a) On each Job Processor machine, open a web browser and go to
http://<hostname>/BravaPublisher, where <hostname> is replaced by the IP address
or name of your servlet engine machine. You should see the directories monitor and
resources in your browser window.
b) Go to http://<hostname>/BravaPublisher/monitor/OverallStatus.jsp. The
information should compile and display in your browser window.

2.3.5 Verify Brava! Enterprise is working

1. Start the Net-It Enterprise components which include the servlet engine where the Queue
Server web application has been deployed, and the Net-It Enterprise JobProcessor
application.
2. Start the servlet engine where the Brava! Server web application has been deployed (if
different from the Queue Server’s servlet engine).
3. From within Internet Explorer, launch the Sample.htm page that was installed in to your
client installation directory (e.g., http://<localhost:8080>/IGC/Sample.htm). You should
see a document successfully loaded into your browser. (Note – this sample page does not
work with and is not included in your Webtop integration installation)

If you experience any problems during your testing and verification, you can gather more
information by doing the following:
 For Net-It Enterprise, in the JobProcessor installation directory, update the log.level
parameter in the JobProcessor.properties file to a value of 4. To capture the output of
the JobProcessor to a file, change the final class name of the log.class.name
parameter from ConsoleLog to FileLog. By default, the output will go to the
log/igcpublish.log file under the JobProcessor installation directory. After updating
any parameter values, the JobProcessor must be restarted.
 The Brava! Server logs information to the serverlog.txt file located in the Brava!
Server installation directory by default (e.g., C:\Program Files\IGC\Brava!).
 The Brava! Client sets the parameters clientlogfile and ClientLogging. ClientLogging
should be set to 0 or 1 to receive as much data as possible. See 3.1.3 Optional Brava
ActiveX Parameters for more details.

60
3.0 Core User’s Guide
3.1 Configuring Brava! ActiveX

3.1.1 Encoding of Double Byte Characters

To process and display double byte (e.g., Asian) characters properly, the html page contents
should be UTF-8 encoded. Additionally, the character set encoding used by the IE browser to
display the contents of the web page should be set to UTF-8. To find the encoding used for
your currently loaded web page from IE, select View->Encoding and check to see which
encoding scheme is selected. The IE browser sets the encoding for a web page based on the
following (listed in order of precedence):

1. If a Unicode byte order mark (a set of bytes at the beginning of a file that specifies the
file's encoding) is set for the html page, IE will set the encoding appropriately when it
loads that page. The byte order mark for UTF-8 consists of the three bytes "EF BB
BF". This can be achieved simply by opening an html file with Notepad and saving it
with UTF-8 encoding.

2. The charset specified in the content type of the HTTP header. Apache defaults to
ISO-8859-1 for static pages it serves (set in conf/httpd.conf). For dynamic web page
generation, this header can be dynamically set. For example, a JSP can set it with the
following line -> response.setContentType("text/html; charset=UTF-8"). See the
view.jsp in the Brava Server's BravaServer.war file for an example.

3. If the byte order mark or the content type's charset isn't set in the http response
header, then IE looks for the <meta> tag to see if it specifies a charset for the content
type. An example line that sets the encoding to UTF-8 is:

<meta http-equiv="Content-Type" content="text/html; charset=utf-8">

This line must be the first line within the html <head> tag.

If using a form to submit information with double byte characters, then the submitted form
elements will use the encoding specified in the web form page's <meta> tag if it exists (see
point #3 above). The encoding set in the meta tag should match the encoding of the text in
the form, and the web server that receives the form submission must be able to deal with that
encoding scheme. choosefile.html, in the Brava Client Installation directory, is an example
form page that submits docID information to the view.jsp page (located in the Brava Server's
web application) for processing. The character set used for this processing is UTF-8, which
is the recommended encoding.

61
 3.1.2 Brava ActiveX Control Parameters

As previously mentioned, parameters are conveyed to the Brava! Client ActiveX control via
the HTML parameter BravaXParams. Each parameter is located on its own line, with the
parameter name located to the left of an “=” sign and the value to the right. If a parameter
value is several lines long, new lines are specified with the character set “<\n>” The key
specified on each line of the BravaXParams value will be referred to as a BravaX param.

The following Brava ActiveX parameters are required:

IntegrationURL The URL to the Integration.dll which provides the Brava! Client
ActiveX control with the functionality to connect to the server for
file and markup access.

Integration Version Specifies the version of the Integration.dll. This lets the Brava!
ActiveX control know when a new Integration.dll file needs to be
downloaded.

ServerProperties The URL of the Brava! Server servlet that provides initialization
information.

GetLastError The URL of the Brava! Server servlet that provides error information
on server failures.

DocID The path and filename of the file to be viewed. The location must be
accessible by the Net-It Enterprise Server, preferably by an NTFS
share or absolute path. UNC, http, and ftp paths are supported. If the
DocID parameter is a URL, it must be UTF-8 URL encoded (i.e.
http://localhost/IGC/test%20file.jpg). When referencing hybrid files,
the DocID parameter must be in the form of a directory path and not
an http or ftp reference.
The DocID value for prepublished files (i.e., .csf, .xdl) may be
relative. This path is assumed to be relative to the current URL of
the loaded web page.

Similar to the ServerProperties and GetLastError properties, there are several other
properties that specify where clients make calls for various server functionalities. These are
specified in the client_precedence.properties file that is installed in the Brava! Server
installation directory. These properties are described in more detail in the Brava! Enterprise
Programmer’s Guide.

3.1.3 Optional Brava ActiveX Parameters

The Webtop optional parameters are described above in section 3.3 Customizing
brava_parameters.jsp. The following section describes all parameters in core Brava Enterprise and
are provided for reference.

62
The optional Brava ActiveX parameters affect the state of the Brava! Client, with the exception of
the MarkupDirectory and MarkupDirectoryType parameters, which affect the state of the server. The
following table lists the optional parameter tags. The bolded word in the left margin is the parameter
name that precedes the “=” sign within the BravaXParams value. The descriptive text in the right
column describes the parameter’s function, and the appropriate value for the parameter.

In addition to being able to establish these parameters on a per-file basis by adding them to the
HTML that is rendered on the client, it is possible to establish parameter values that affect all files
on a site. This is accomplished by setting properties in the server_precedence.properties or
client_precedence.properties files located in the Brava! Server installation directory. A particular
property may be set in one of three places – the client-side HTML, or in one of the two server-side
precedence properties files. If a property is set in multiple places, the order of resolution is (from
highest to lowest):

 server_precedence.properties
 HTML BravaXParams
 client_precedence.properties

IMPORTANT NOTES: If a parameter value in one of the server side precedence files contains a
file or directory path, then all backslashes must be escaped with another backslash. Also, to
designate a quote in the value of a parameter, use the term &quot;

Param Name Value

Determines whether to append pages listing the contents of

AddChangemarkInfoPage
Changemarks (if they exist on the current file) when publishing to
ToPublishedPDF
PDF. The default value is False.

Specifies the default font size to use for ISO Banners.

BannerFontSize Example:
BannerFontSize =12

Specifies the client license which controls whether markup or print

ClientLicense
capability is enabled.

ClientLogging allows debug messages to be displayed in the Java

console.
Valid string values are as follows:
"0" - ALL- designates all levels of messages are to be logged
"1" - DEBUG - designates fine-grained informational events that
are most useful to debug an application
ClientLogging
"2" - INFO- designates informational messages that highlight the
progress of the application at coarse-grained level
"3" - WARN- designates potentially harmful situations
"4" -ERROR- (default) designates error events that might still allow
the application to continue running
"5" -FATAL- designates very severe error events that will cause the

63
 application to abort
Only ERROR and FATAL messages are logged when the default log
level is set to ERROR.

ClientLogFileLength The maximum length of the file in bytes. If the file grows past this
size, the current information in the log file is removed before new
information is written to the log.

ClientLogFile The file path and name on the end user’s machine where a log
file containing Client information can be saved.
Example:
clientlogfile=c:/temp/clientlog.txt

ClientLoadedMaxFileSize This setting determines the maximum file size (in kilobytes) allowed
for client side publishing. 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 Server.
Default:
ClientLoadedMaxFileSize=2000

ClientRetrieved This setting determines whether the client or server will retrieve the
source file from the location specified by the DocSource param (or
DocID param if DocSource not specified).
The default is False, meaning the server will retrieve the file. If
ClientStandAlone = true, then ClientRetrieve is presumed to be true
and the client retrieves the source file. See the Brava! Programmer's
Guide for more information.

The default value is False. True specifies no connection at all with

ClientStandAlone
the Brava! Server. Markup capability is disabled in this case.

Determines the display mode in Brava Veiwer for files being

compared (as specified by DocId and CompareDocId parameters).
CompareViewMode Possible values for this parameter are Overlay Differences, Overlay,
Side-By-Side (default), Deletions, Additions, Unchanged, Open
File, and Compare File.

The default value is False indicating whether the client converts the
file to IGC's DisplayList format (CSF/XDL). If the file to be loaded is
already in this format then this parameter should be set to True since
the Server will not need to convert the file. This value should only be
ConvertOnClient set to True for formats the client is capable of converting (i.e. pdf, tif).
Setting this value to true for the appropriate formats reduces the load
on the server by shifting conversion to the client. An integration may
want to set this value to false for very large files to eliminate the large
initial client download time.

64
 Determines user-defined pattern for date and time formatting.
Time Format Syntax: To specify the time zone see the TimeZone
setting. The formatting codes are preceded by a percent sign (%).
Characters that do not begin with % are copied unchanged as text.
The formatting codes for DateFormat are listed below:
%a Abbreviated weekday name
%A Full weekday name
%b Abbreviated month name
%B Full month name
%c Date and time representation appropriate for locale
%d Day of month as decimal number (01 – 31)
%H Hour in 24-hour format (00 – 23)
%I Hour in 12-hour format (01 – 12)
%j Day of year as decimal number (001 – 366)
DateFormat
%m Month as decimal number (01 – 12)
%M Minute as decimal number (00 – 59)
%p Current locale's A.M./P.M. indicator for 12-hour clock
%S Second as decimal number (00 – 59)
%U Week of year as decimal number, w/ Sunday as first day of week (00 – 53)
%w Weekday as decimal number (0 – 6; Sunday is 0)
%W Week of year as decimal number, w/ Monday as first day of week (00 – 53)
%x Date representation for current locale
%X Time representation for current locale
%y Year without century, as decimal number (00 – 99)
%Y Year with century, as decimal number
%z, %Z Either the time-zone name or time zone abbreviation, depending on
registry settings; no characters if time zone is unknown
%% Percent sign

This parameter can be used to specify the background color for

Brava! Enterprise to use by default (choices include white, gray (or
grey), black, or default). If the EnableBackground parameter is set to
true, the user can still change the background color via the
DefaultBackgroundColor Background Color tool on the toolbar. A value of default means that
the background color will display as determined by the file format
driver on conversion.
Example:
DefaultBackgroundColor=white

This setting can be added to specify whether Brava! Enterprise loads

color vector files in monochrome mode or in color. The monochrome
mode can still be changed using the Monochrome tool on the toolbar.
DefaultMono
The default setting is false, indicating for Brava! Enterprise to load
the files in color.

65
 Example:
DefaultMono=true

Determines the default font to use for the markup text. Valid values
are any font name on the Brava! Client machine operating system.
You can view the available font names from the font drop down box
DefaultTextMarkupFont
of the markup text properties bar with markup text as the active tool.
Example:
DefaultTextMarkupFont =Times New Roman

If set to True, this parameter disables the Consolidate Markups item

DisableConsolidateIfMark
on the Markup menu if a markup is open for edit, regardless of the
upOpenedForEdit
EnableMarkupConsolidate value. The default value is True.

This parameter allows you to restrict the file's directory path shown at
the top of the Brava! Enterprise window. This parameter has no
DisplayFullPathOfFile default setting.
A value of True displays the file's full directory path and filename,
and a value of False displays the filename only.

When present, this parameter’s string value is displayed in Brava!

DisplayName Enterprise’s status bar. If present, this parameter takes precedence
over the DisplayFullPathOfFile parameter.

If the file is to be converted on the client, the DocID or DocSource

value must end with an extension (i.e. .pdf, .tif) so the client can
determine how to convert the file. If the DocID/DocSource does not
DocExtension have an extension, then the DocExtension parameter must be set to
the extension corresponding to the file type.
Example:
DocExtension=pdf

This value can be set to a file system or URL path. As with the DocID
param, URLs must be UTF-8 URL encoded. If set, Brava! will use
DocSource this path, as opposed to the value of the DocID param, to retrieve the
file to be loaded. Typically this is just set if the DocID is set to a
unique ID.

This is an optional parameter that indicates the version of the

document being accessed. This parameter is typically used with
custom integrations. If the DocVersion of a document has changed
DocVersion for example, the document will be re-published. By default, to
determine if a document has been updated, the Brava! Server looks at
the time stamp of the file (for DocID or DocSource at file locations)
or at the document size (for DocID or DocSource at URL locations).

66
 This setting can be added to allow users to download the original
document to their desktop and controls whether the Download
Original button is displayed in Brava! Enterprise. Users must have the
file's native application registered and installed on their system to
launch the file.
If this button should be displayed, this parameter must be defined
DownloadOriginal with a valid value of the URL pointing to the original document (dwg,
etc.).
If not specified, the download button does not display and
downloading is thereby disabled. Valid values can only be a URL,
file, or http protocol.
Example:
DownloadOriginal =http://localhost/test.pdf

The following parameters are used by the Brava! Client viewer to

download specified files.

download.url.{name} - A URL pointing to a file to be downloaded to

the user's "\IGC" directory. If the file is a zip file, it is unzipped.
{name} can be any value.

download.version.{name} - The version of the file to be

downloaded. This information is stored in the version.txt file located
in the user's "\IGC" directory. The version number is used to
determine whether an updated file needs to be downloaded. The value
of {name} needs to match o the value used for the corresponding
download.url.{name} parameter.
An example of using the download parameters are:

download.url.Pdf2DL=http://Server/IGC/Pdf2DL.bin
Download.<specified file> download.version.Pdf2DL=1.5.0.23

If the file specified by the download.url.Pdf2DL parameter has not yet

been downloaded, or if it has and its version is less that 1.5.0.23, then
the Brava! Client will download the file
(http://Server/IGC/Pdf2DL.bin). Since this is a zip file, its contents
will be unzipped to the user's "\IGC" directory, and the version.txt file
will be updated to reflect version 1.5.0.23.

download.strictversionmatch.{name} - If set to "true" then if the

value of the corresponding download.version.{name} parameter does
not match the version listed in the local version.txt file, then the file
specified by download.url.{name} is downloaded. If set to false (the
default), the client viewer only downloads the file if the version
number in the corresponding download.version.{name} parameter is
greater than the value in the local version.txt file.

67
 download.destinationname.{name} - If the file specified by the
corresponding download.url.{name} parameter is not a zip file, then
the file will be renamed to the value of this parameter on the local
machine once it has been downloaded.

This parameter enables the Enable Animation item in the right

EnableAnimationSetting
mouse button menu. The default value is True.

Determines the default state of the Enable Animation setting when

EnableAnimationSetting is true. Valid values are On, Off, and Last
AnimationSetting
(the default). Last indicates the state of the setting when the user
exited the last Brava! session (either on or off).

This parameter enables the Background Color item in the View

EnableBackground
menu. The default value is True.

This parameter controls whether copying of text is allowed in Brava!

EnableCopyText Enterprise. The default is True, which permits text copying. Use
False to disable text copying.

The default is False. If set to True and a multi-page document is

being viewed, the “Copy to all Pages” button appears when one or
EnableCopyMarkupToAll more copy able markup entities are selected. (Non copy able entities
Pages include strike-through, Changemarks, and block-out.) Note that
altering the markup entities after they have been copied to all pages
does not affect the copied entities.

Enables/disables the Publish To CSF menu item from the toolbar

EnableCSFPublish Save button. Default is True. If EnableSaveView is set to false, this
setting is ignored.

This parameter enables the Enable Enhanced Display item in the

EnableEnhancedDisplay
right mouse button menu. The default value is True.

Determines the default state of the Enable Enhanced Display setting

when EnableEnhancedDisplay is true. Valid values are On, Off, and
EnhancedDisplaySetting
Last (the default). Last indicates the state of the setting when the user
exited the last Brava! session (either on or off).

This parameter controls whether you can view CAD layers on a

EnableLayers drawing file. Default is True to allow the viewing of layers. Use
False to disallow the viewing of layers.

This parameter controls whether the Magnifier tool is available in

EnableMagnifier Brava! Enterprise. The default is True. Use False to disable the
Magnifier tool.

68
 This parameter controls whether markup capabilities are
EnableMarkup available in Brava! Enterprise. The default is True, which
permits markups to be created. Use False to disable markups.

This parameter enables the Burn-in Markup item in the

File/Markup menu. The default is True.
EnableMarkupBurnin
Note that if the Publish to CSF menu option is still enabled, it is
still possible for users to burn-in markups to a CSF file.

This parameter enables the Close item in the File/Markup

EnableMarkupClose
menu. The default value is True.

This parameter enables the Close Review item in the

EnableMarkupCloseForReview
File/Markup menu. The default value is True.

This parameter enables the color palette for markups. If

EnableMarkupColorPalette disabled (False), the user can only use the default color to
create markup entities. The default value is True.

This parameter enables/disables the Consolidate Markups

EnableMarkupConsolidate item on the markup menu if at least two markups are open (for
edit or for review). The default value is True.

This parameter enables the New markup item in the

EnableMarkupNew
File/Markup menu. The default value is True.

This parameter enables the Open item in the File/Markup

EnableMarkupOpen
menu. The default value is True.

This parameter enables the Open for Review item in the

EnableMarkupReview
File/Markup menu. The default value is True.

This parameter controls whether markup Save item is available

EnableMarkupSave from the File/Markup menu. The default is True, which permits
markups to be saved. Use False to disable saving markups.

This parameter enables the Save As item in the File/Markup

EnableMarkupSaveAs
menu. The default value is True.

This parameter enables the Save As DXF item in the

EnableMarkupSaveAsDXF
File/Markup menu. The default value is True.

This parameter enables the Line Arrow markup tool on the

EnableMarkupArrowTool
markup toolbar. The default is True.

This parameter enables the Text markup tool on the markup

EnableMarkupTextTool
toolbar. The default is True.

69
 This parameter enables the Changemark markup tool on the
EnableMarkupChangemarkTool
markup toolbar. The default is True.

This parameter enables the Cloud group of markup tools on the

EnableMarkupCloudGroupTool markup toolbar (Cloud and Polygonal Cloud). The default is
True.

This parameter enables the Sketch group of markup tools on

EnableMarkupSketchGroupTool the markup toolbar (Sketch and Sketch Polygon). The default is
True.

This parameter enables the Linear group of markup tools on

EnableMarkupLinearGroupTool the markup toolbar (Line, Polyline, Arc, Crossout, and
Scratchout). The default is True.

This parameter enables the Shapes group of markup tools on

EnableMarkupShapeGroupTool the markup toolbar (Rectangle, Polygon, and Ellipse). The
default is True.

This parameter enables the Blockout tool on the markup

EnableMarkupBlockoutTool
toolbar. The default is True

This parameter enables the ABC text group of markup tools on

EnableMarkupAbcGroupTool the markup toolbar (Strikeout, Highlight, and Underline). The
default is True.

This parameter enables the Hyperlink tool on the markup

EnableMarkupHyperlinkTool
toolbar. The default is True

This parameter enables the markup Raster Entities tool in the

Markup toolbar. The markup status bar will also contain a
EnableMarkupRasterTool browse button allowing the user to select a raster image for
insertion into the markup layer. The browse button does not
display if MarkupRasterFile parameter is set.

This parameter controls whether measurement capabilities are

available in Brava! Enterprise. The default is True, which
EnableMeasurement
permits measurements to be created. Use False to disable
measurement.

This parameter controls whether the Mirror feature is available

EnableMirror in Brava! Enterprise The default is True. Use False to disable
the Mirror tool.

This parameter enables the Monochrome item in the View

EnableMono
menu. The default value is True.

70
 If set to True, scrolling causes the Brava! Client to change pages. If
EnablePageChangeOnScroll set to False, pages do not change when scrolling beyond the current
page limits. Default value is True.

This parameter enables/disables the Publish To PDF menu item

EnablePDFPublish
from the toolbar Save button. Default is True.

This parameter controls whether printing is available in Brava!

EnablePrinting Enterprise. The default is True, which permits printing. Use False
to disable printing.

This parameter enables the Review Changemarks item in the

EnableReviewChangemarks
File/Markup menu. The default value is True.

This parameter enables the Rotate90 item in the View menu. The
EnableRotate
default value is True.

This parameter enables/disables the Save button from the toolbar.

The default is True. If set to False, then the values of
EnableSaveView
EnableCSFPublish and EnableSaveViewAsJPG are ignored since
the submenu of the toolbar button will not be available.

Prevents/allows viewers from creating JPG snapshots of the

EnableSaveViewAsJPG currently viewed CSF file. Default is True to allow capturing JPG
snapshots. If EnableSaveView is set to false, this setting is ignored.

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
EnableThreadedXdlLoad
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.

This parameter enables/disables the Page Thumbnails button from

the toolbar and menu. If set to true (the default), the button is
available and when clicked, opens a thumbnails panel of the current
EnableThumbnails
documents pages on the right side of the Brava viewing area (same
area as the Changemarks List). Users can navigate through the
document pages by clicking on a thumbnail image of that page.

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
EnableThumbnailsResize
Thumbnails, or Enlarge Page Thumbnails from the menu. If false,
the right mouse menu is disabled and images remain at the default
size.

71
 This parameter controls whether the Zoom Window feature is
EnableZoomWindow available in Brava! Enterprise. The default is True. Use False to
disable the Zoom Window feature.

This parameter controls whether Brava will open a new viewer

FireEventOnBookmarkEn instance when a bookmark entity is clicked. If the value is set to
titySelected True, the document opens with the referenced bookmark page
displayed in a new browser window. If the value is set to False, the
current page changes to the targeted bookmark referenced page in
the same window. The default value is False.

If set to true (the default), the viewer will spawn a thread to retrieve
the fully converted file. If no operations (i.e. viewing thumbnails,
ForcePublishCompletion publishing to pdf, publishing to CSF, applying markups to all
pages) are being done that require the full document to be
published, this can be set to false.

If the param SecurityOptionsFromServer is set to true, the value of

this parameter is examined to determine where to retrieve the xml
file used to apply rights to a file that is to be published to CSF.
This value may be set to a URL path.
GetSecurityXml If this parameter is not set, then the security.xml file located in the
Brava! Server directory is retrieved.

Example:
getsecurityxml=methodurl,http://server/site/doc.xml

Any terms defined in this parameter (defined as a continuous string

of non-space characters) are highlighted in the loaded documents. It
is possible to highlight multiple terms in a document, but it is not
possible to define a term that includes spaces.
HighlightTerms
Example:
HighlightTerms="black white"

The above example will highlight all instances of the individual

words "black" and "white"

This setting determines how hyperlinks launch in Brava!

Enterprise. The valid values are:
one - All documents launch in a single separate window as Brava!
(two windows).
default (default value) –All documents launch in multiple separate
HyperlinkLaunch
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.

72
 Example:
HyperlinkLaunch =one

These optional parameters for the ISO print banner and watermark
information are specified here. If these parameters are specified in
the server_precedence.properties file in the Brava! Server as well
as in the HTML pages, the server settings take precedence. The
information below this heading (RightTop, etc.) indicates the area
on the page. New lines within an area are delimited by the
characters <\n>. The screenwatermark and screenbanner settings
provide the ability to set a watermark and banner on screen that is
independent of the watermark and banners defined for the print
settings. An on screen watermark or banner will be visible to users
when viewing the document.
Leave these settings blank to allow users to determine their own
print and on-screen banners; however, any modifications made by
the users to these fields will not be saved. Specifying banner
information here will force the banners for all users. They will not
be able to modify them at print time.

See the on-line help file in the Brava! Client for tag values (e.g.,
inserting system time and date at print time).
ISOBanner and Watermark
settings
Example:
topright =The date is %Date
watermark =RELEASED
Parameter names are:
watermark
screenwatermark
screenbanner
topleft
topcenter
topright
bottomleft
bottomcenter
bottomright
righttop
rightcenter
rightbottom
lefttop
leftcenter
leftbottom

This optional parameter is used to specify the default markup color.

Valid values are the word descriptions of the color, or the hex
MarkupColor
number for red, green, and blue components #RRGGBB. Below is
the list of valid colors. For example, a valid parameter setting

73
 would be:
MarkupColor =yellow or MarkupColor =#FFFF00

white or #FFFFFF
yellow or #FFFF00
magenta or #FF00FF
red or #FF0000
cyan or #00FFFF
green or #00FF00
blue or #0000FF
darkGrey or #666666
grey or #999999
olive or #666600
purple or #660066
maroon or #660000
teal or #006666
pine or #006600
darkBlue or #000066
black or #000000

MarkupDirectory An optional setting used to specify the parent directory where

markup files are stored. Markups are stored below the
MarkupDirectory. If the setting is not set, the markups will be
stored under the installed Brava! Server’s sub-directory.
To change this setting, use either UNC paths
(\\ServerMachine\Markups) or drive letter designations
(C:\Brava\Markup).
When entering the path as values in either the
server_precedence of client_precedence property files (as
opposed to the html file), use two slashes for every one.

Example:
MarkupDirectory=\\\\ServerMachine\\Markup
The directory specified must be as it appears to the Brava! Server
machine, not to the Brava! Client machine.

Note: Where markups are stored beneath the MarkupDirectory

depends on the value of the MarkupDirectoryType parameter. Also
note that if you have markups in the default directory and you
specify a new markup directory, the markups in the old location
will no longer be available. You must copy the old markups to the
new markup directory to access them.

This parameter specifies whether markups are stored directly in the

MarkupDirectory, or in a subdirectory of the MarkupDirectory. If
MarkupDirectoryType
MarkupDirectoryType is set to parent (the default), then markups
are saved to a subdirectory that is encoded from the original file’s

74
 path. Note that the maximum length of a directory name on
Window’s system is 255 characters, which may present a problem
when saving/accessing markups for files whose path is longer than
255 characters.

If set to absolute, then markups are stored directly beneath the

MarkupDirectory. When set to absolute, you are responsible for
specifying a unique directory name for each document.

Example:
markupdirectory=C:\\ProjectX\\UserFiles\\John\\Markups
MarkupDirectoryType=absolute
In this example, a markup would be saved to the file:
C:\ProjectX\Userfiles\John\Markups\markup1

If set, when a user clicks the Browse button on the Markup status
bar, an Open Raster dialog displays to the directory set in this
parameter. Users can select PNG and JPG raster files to be placed
MarkupRasterDirectory and sized within a Brava! markup layer. This parameter overrides
the last directory browsed preference saved for the user.
Example:
markuprasterdirectory=C:\ProjectX\RasterFiles

If set, this parameter supersedes the MarkupRasterDirectory

parameter. This parameter points to a particular raster file to be
used (either an absolute path,UNC path, or HTTP URL can be
used). When a user clicks on the markup raster toolbar button, the
MarkupRasterFile
image in the reference file is loaded and the user can place and size
that raster image on the Brava! canvas. If set, list of recently used
raster images and the raster Browse button are not displayed on the
markup status bar.

This parameter allows the user to specify a URL that will receive
notification of integration application events.

The events are:

 DOC_CLOSED
 DOC_LOADED
 MARKUP_CLOSE_TOOL
 MARKUP _OPEN_COMPLETE
NotificationListener  MARKUP _OPEN_FOR_REVIEW_COMPLETE
 MARKUP _SAVE_COMPLETE
 MARKUP _SAVE_AS_COMPLETE
 VIEWER_CLOSED

The URL should take three parameters, Event, Data, and User. The
Event parameter will contain one of the events listed above. The
data will contain the file path of the file that the event is acting on.
Example:

75
 NotificationListener= http://localhost/<notificationservlet>
The call would be:
http://localhost/NotificationListener?Event=value&Data=value&Us
er=value
Please refer to the NotificationListenerCustomParams setting
below for additional information about this parameter.

This parameter allows you to specify parameters to be returned to

you on notification events when used in conjunction with the
NotificationListener parameter.
The usage format is:
notificationlistenercustomparams=custom1=value1&custom2
=value2
The value can also be written as
&custom1=value1&custom2=value2
Or
Custom1=9999&Custom2=C:/hello world
This parameter must be used in addition to:
notificationlistener=http://localhost:9090/NotificationServlet
NotificationListener
The resulting call would be:
CustomParams
http://<hostname>/test.asp?Event=value&Data=value&User=
value&custom1=value1&custom2=value2

Example:
NotificationListenerCustomParams=Name1=Value1&Name2
=Value2&Name3=Value3
NotificationListener=http://MYMACHINE/ProjectWeb/Mar
kupNotification.asp
The query string returned would be:
Name1=Value1&Name2=Value2&Name3=Value3&Event=MARK
UP_SAVE_COMPLETE&Data=%5Canother+red+cloud&User=Joh
n+Johnson

Specifies which page of a multi-page document to initially load into

the viewer. Valid value is 1 or higher, and cannot exceed the actual
PageNumber number of pages in the document.
Example:
PageNumber =1

PaperViewSize provides the ability to establish paper space for

format types that either do not have a paper space concept or for
display list files that are in non-modelspace: CGM, DWF, DGN, and
the model page of DWG documents.
PaperViewSize
Use this optional parameter to scale an image to a particular paper
size. The renderer can then map the document’s world space
coordinates to real world coordinates. This value affects the zoom
percentage and size of print banners relative to the overall size of the

76
 published PDF file.

Enter the paper size value as “paper width, paper height, measurable
units”. Valid values for measurable units (indicating inches or
meters) are i, I, m, or M
Example:
PaperViewSize=8.5,11,i

The last value (i or m) must be present in order to convert the first

two fields to numbers. If not set, or if this parameter does not exist,
the default value is “22,36,i” indicating a paper size of 22 x 36
inches.

Determines the type of burn-in performed on a markup layer when

publishing a PDF file. Valid values are:

Comment – the default value saves markups as PDF Comments

Burnin – markups are burned into the PDF document and become
PDFMarkupType part of the document image (not PDF Comments). Note that Brava
Changemarks cannot be burned in, and are saved as PDF notes.

Choice – if this option is set, when a user publishes a PDF file

containing markups, he is presented with a dialog allowing him to
choose how markups are applied to the published document (as
either PDF Comments or Burned in markups)

The markup file name to be loaded with the source file. The
location of the markup file is determined by the values of the
MarkupDirectory and MarkupDirectoryType params. The markup
PreloadMarkupName file will be loaded as editable. If the file does not exist, it will be
created for you.
Example:
PreloadMarkupName=InitialReview

This specifies the markup file(s) to be loaded in review mode (read

only) with the source file. Multiple markup files need to be delimited
by a comma. To load all markup files associated with the source
PreloadReadOnly file, the use the value All. The location of the markup file(s) is
MarkupNames determined by the values of the MarkupDirectory and
MarkupDirectoryType parameters.
Example:
PreloadReadOnlyMarkupNames=InitialReview,FinalReview

The following parameters apply to the Redact to Phrase List

functionality of Brava! Viewer.
RedactList<>
RedactListDirectory - If this parameter is set, then when a user

77
 clicks the "..." button on the Redact to List dialog, a file browse
dialog pops up defaulting to the directory specified by this
parameter. If this parameter is not set, the directory defaults to the
directory of the last file selected from this dialog.

RedactListFile - This parameter points to a particular markup list

file to be used (either absolute or UNC or http URL). If set, then
when the user clicks the Redact to Phrase List toolbar button, then
the file referenced in this parameter is opened, and the redact list
terms are applied to the current document. Note that if the
RedactListFromServer parameter is set to true, then this parameter is
ignored even if set.

RedactListFromServer - Defaults to false. If set to true, the list of

redact terms in the file returned from the GetRedactListFile URL
service will be applied to the current document.

GetRedactListFile - URL invoked by the integration dll when the

parameter RedactListFromServer is set to true. This URL returns a
redact list file from the server.

This parameter sets the amount of JPG compression to be used when

the Save View as JPG option is executed. The value is entered as a
percentage and can range from 1 (poorest quality) to 100 (highest
SaveViewQuality
quality).
Default:
SaveViewQuality=75

Specifies the term to search to when the document is initially loaded

SearchTextAtStartup
into the viewer.

Determines if security settings come from the server, or can be set

interactively by the user. If set to false, the viewer displays the
Visual Rights options dialog when publishing a CSF file from a
SecurityOptionsFromServer
native file via the "Burn-In Markup" or "Publish to CSF" menu
items. The default is true, which means the rights applied to the
CSF are returned from the Brava! Server's security.xml.

This setting determines how the thumbnail panel displays on

document load. Valid values are open, close, and last (default). If
EnableThumbnails is set to False, this setting is ignored.

Assuming that EnableThumbnails is set to true, on document load, if

ThumbnailPanel
ThumbnailPanel is set to open, then the thumbnail panel is opened
at document load time. If set to close, the panel does not open on
document load. If set to last, then thumbnail pages are loaded
depending on the last state of the thumbnail panel in the previously
loaded document.

78
 If this setting is true, the markup consolidation action will change the
TakeOwnershipOnM
ownership of ALL consolidate markups entities associated with the drawing
arkupConsolidation
to the current user. The default is false.

Determines the time zone to use for the date and time stamp. For example, if
you are working in one time zone on a project that is located in another time
zone and would like to have all time stamps recorded on project time.

The default value is empty meaning the DateFormat will take the local time
zone on the client machine. If the TimeZone value is present, it overrides the
client side local time zone.

The valid syntax to use is:

TimeZone=tzn[+ | –]hh[:mm[:ss] ][dzn]

Where:
tzn = Three-letter time-zone 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, set TimeZone without a value for dzn. The C
TimeZone run-time library assumes the United States' rules for implementing the calculation
of Daylight Saving Time (DST).
For example, to set the TimeZone parameter to correspond to the current
time zone in Germany, you can use the following statement:
TimeZone=GST-1GTD
This string uses GST to indicate German standard time, assumes that
Germany is one hour ahead of UTC, and assumes that daylight savings time
is in effect.

To set the TimeZone parameter for New York (Eastern Time) or California
(Pacific Time), you can use:

TimeZone=EST5EDT
(Eastern Standard Time is 5 hours behind UTC time)
or
TimeZone=PST8PDT
(Pacific Standard Time is 8 hours behind UTC time)
If TimeZone is not set, the time zone information specified by the client’s
operating system (in the Control Panel’s Date/Time application) is used.

This is an optional parameter that can be added to specify a name to be used

as the author name for markups. This value is normally set when Brava!
Username
Enterprise is integrated with a document management system. The default
is the operating system login username.

79
 Specifies the default font name to use for Watermarks and ISO Banners.
WatermarkBanner
Example:
FontName
WatermarkBannerFontName=Arial

Specifies the default font style to use for Watermarks and ISO Banners.

Valid values are:

0 – Plain 2 – Italic
WatermarkBanner
1 – Bold 3 – Bold Italic
FontStyle
Example:
WatermarkBannerFontStyle=1

Specifies the darkness of the printed watermark. Valid values are:

1 – Opaque
2 – Dark
3 – Medium
4 – Light
WatermarkLineSpacing
Note that a setting of 1 results in a large increase to the print spool size.
Default:
WatermarkLineSpacing=2

3.2 Configuring the Brava! Server

Once the Brava! Server and Client are installed, you need to configure the Brava! Server. You
configure the server by adjusting settings in the server.properties file, located in the installed Brava!
Server directory (C:\Program Files\IGC\Brava! by default). Read the server.properties settings in
the table below and make any adjustments necessary.

Important Note: The configuration values in the parameters displaylist.cache.root and

queue.server.push.url are used to communicate information between the Brava! Server and Net-It
Enterprise. Check these parameter values if you experience problems viewing files. Refer also to
section 3.5 Configuring Net-It Enterprise for Brava! Server.

3.2.1 Editing the Server Parameter Files

The server.properties file resides in the installed Brava! Server directory. The settings are
described in the table below.

Param Name Description

The IP address of the machine that is allowed to request

legal.ip.to.get.sessionid session IDs from the Brava! Server web application
(BravaServer). This value needs to be updated from its

80
 default value to reflect the IP addresses of the machines
with the ASP, JSP, or server side code that generates the
Brava! viewer html .

This key can take a comma separated list of IP addresses, or

any of the four quadrants can be replaced by a wildcard
(‘*’).

Example: legal.ip.to.get.sessionid=192.168.*.*

This property sets the maximum number of megabytes

allowed in the display list cache. See “How Displaylistcache
Works” at the end of this table.

Note: When this number is exceeded, Brava! Server deletes

entries in displaylistcache and properly republishes those
documents when needed. Do not manually delete cache
displaylist.cache.maximum.size when Brava! Server is running, or those documents will not
load or publish correctly.

This determines the total number of megabytes that the

displaylist cache will be truncated to.

Default:
displaylist.cache.maximum.size=10000

If the number of megabytes exceeds the value of

displaylist.cache.minimum.size, then displaylistcache is
truncated to be less than that size upon Server startup - at
displaylist.cache.minimum.size the time specified by the displaylist.cleanup.time parameter.

Default:
displaylist.cache.minimum.size=450

The minimum number of seconds between periods that the

displaylistcache tables are saved to disk.
displaylist.cache.save.interval
Default:
displaylist.cache.save.interval=40

The minimum number of minutes between backups of the

displaylistcache tables (i.e., fileList, t_location, t_size,
t_mainName). Backups are used in case the tables currently
displaylist.cache.backup.interval
under the local.displaylist.cache.root become corrupt.
Default:
displaylist.cache.backup.interval=30

81
 The maximum number of backup copies of the
displaylistcache tables to keep.
displaylist.cache.max.backups
Default:
displaylist.cache.max.backups=50

Indicates the location where the published (cached) files

reside within the Brava! Server

This setting must be absolute. Any directory path delimeters

should be two backslashes \\ as opposed to a single forward
displaylist.cache.root and slash /. If the Job Processor is NOT on the same machine as
local.displaylist.cache.root the Server, this path should be a UNC share that is accessible
to the Job Processor.

Example:
displaylist.cache.root=%MACHINE%\\displaylistcache
local.displaylist.cache.root=%LOCAL%\\displaylistcache

Specifies the periodic time that the server will clean up the
displaylistcache when size is exceeded. Value is the time of
day in 24 hour format – hours:minutes. The displaylistcache
will be truncated at this time every 24 hours after that.
displaylist.cleanup.time
12:00 midnight = 00:00, 11:59 pm = 23:59, etc.

Default:
displaylist.cleanup.time=22:00

URL of the "push" servlet of Net-It Enterprise

Default:
queue.server.push.url queue.server.push.url=http://localhost:8080/BravaPu
blisher/Push
Note: The URL used must be UTF8 URL encoded.

The maximum amount of time (in minutes) that the client

will wait for a file to get published.
check.cache.blocking.timeout
Default:
check.cache.blocking.timeout=2

The time (in milliseconds) intervals between querying the

displaylist cache for publish completion.
check.cache.block.sleeptime
Default:
check.cache.block.sleeptime=1500

The URL that Net-It Enterprise will hit when it completes

done.servlet.url
publishing of the requested file.

82

docretriever.classname
jp.copies.file.local
session.life
session.manager
single.page.published.allowed
single.page.publish.cleanup.delay
integration.manager.class
log.level
publish.request.timeout
publish.request.types
The server side Java class name to retrieve the original
document. Customers can create a custom class for their
specific integration needs. See the Brava! Enterprise
Programmer’s Guide for more information.
File extensions where the Job Processor copies the file locally
before publishing for performance reasons. Do not use with
file types that have xrefs. PDF and TIF files with many pages
may benefit from having their extensions added to this
property.
Specifies the time, in minutes, that the server will live from the
time the last server interaction occurs. The default is 480.
Controls whether session tracking is on in the Server. Having
session.manager on provides additional security controls on
access to Server functionality.
This setting contains a list of file extensions that Net-It
Enterprise has the ability to publish a single page at a time.
Example:
single.page.publish.allowed=cgm,cmi,dcx,dft,dwf,dwg
,edc,hpgl,igs
Delay in minutes before cleaning up single page publishes
from the displaylistcache directory. Default is 2.
This is the server-side Java class that handles markup
operations. You can create a custom class for your specific
integration needs. See the Brava! Enterprise Programmer's
Guide for more information
Indicates one of the java.util.logging log levels to use in debug
mode. Values from highest to lowest include:
all, finest, finer, fine, config, info, warning, severe, off
Specifies the time (in minutes) that the server will wait for a
publish request to be completed. Defaults to 7 minutes.
This setting contains a list of the types supported by Net-It
Enterprise. The list should match the values for the
jobprocessor.thread.manager.thread.types property in the
JobProcessor.properties file with the exception that the
default type prq does not need to be listed here.
Example:
publish.request.types=doc,drw,pdf
83

publish.request.extensions.*
If a file has an extension listed in one of these properties, the
type (specified in place of the * ) is used in sending publishing
requests to Net-It Enterprise.
Example:
publish.request.extensions.doc=doc,xls,ppt

Time (in miliseconds) to delay sending a full document

publishing request after a single page request has been sent to
the publisher. On configurations that have a machine dedicated
whole.document.publish.delay to single page publishing, this value should be set to 0.

Example:
whole.document.publish.delay=500

How DisplayListCache Works

The display list cache is where the files published by Net-It Enterprise are stored by the Brava!
Server to speed up subsequent requests for the file.

Brava’s cachesize is maintained between the displaylist.cache.minimum.size parameter and the

displaylist.cache.maximum.size parameter. The displaylist.cleanup.time parameter calls the truncate
logic to reduce the size of the cache to less than or equal to the value of the minimum size parameter.

During run-time operation, if a file is not in the displaylistcache and needs to be published, the
maximum.size parameter is checked. If the displaylistcache has gone over 90% of that size
(maximum.size * .90) then the displaylistcache is reduced below that limit. This is a backup check
and is not intended to be the primary mode of truncation. If this parameter is reached during normal
operation, it is an indication that the the maximum.size parameter should be increased or both
the disk size and the maximum.size parameter should be increased.

Note that at Brava! Server startup time and the daily off-hour truncation (displaylist.cleanup.time),
the Brava! Server performs a consistency check between its internal tables and the files in the
displaylistcache folder. During this check, the Brava! Server will not be highly responsive. The
length of this delayed response period depends on the size of the displaylistcache.

The files are deleted from the oldest last-accessed time first. For example, files that were published a
long time ago, but accessed today will not get deleted before a file that was published a few days ago
and not accessed since.

Brava has single page publishing jobs in addition to the whole document publishing job. The single
page publishing jobs will get deleted from the cache based on the
"single.page.publish.cleanup.delay=2" parameter.

84
 3.2.2 Editing the Precedence Properties file
By default, the client_precedence.properties file has a list of properties specifying (by value)
which Brava! Server servlets to hit to execute various functions. These values can be
overwritten to invoke custom functionality (see the Brava! Enterprise Programmer's Guide for
more information). The URLs specified here are invoked from the end-user machines, so the
server and port need to be reachable from those machines (some network administrators restrict
outbound access to a few very standard ports). Upon installation, these properties are put into
the client_precedence.properties file, or alternatively, they can be set in the
server_precedence.properties file.

As mentioned in section 3.1.3 Optional Brava ActiveX Parameters, BravaX parameters can be
set in either server_precedence.properties (higher precedence than HTML set property values) or
the client_precedence.properties file (lower precedence than HTML set property values). Note
that any directory paths entered as values should have the backslash directory delimiter escaped
with an extra backslash.

3.3 Configuring Net-It Enterprise Queue Server

3.3.1 Editing the HttpQueueServer.properties File (Optional)

The HttpQueueServer.properties file is installed to the servlet engine (the Servers\Default

directory in the JRun installed directory or the /webapps/BravaPublisher/properties directory
within the installed Apache Tomcat directory). The following parameters control various
variables in Net-It Enterprise and define how the Queue Server runs. The default values are
shown in the given examples. Changing any of these values requires a restart of Net-It
Enterprise.

Indicates the current version of Queue Server. Do not modify this setting.
queue.server.version
Example: queue.server.version=3.0.4

Indicates the path where the Queue Server will store incoming requests
that await processing by the Job Processor. Any directory that the Queue
queue.server.queue.fo Server machine has access to is valid. UNC paths may be used. Note that
lder slashes are all forward slashes.
Example: queue.server.queue.folder=c:/igcprq

Defines which type of queue is used. Currently

FileBackedPublishingRequestQueue is the only valid option. Do not
queue.server.queue. modify this setting.
class.name Example: queue.server.queue.class.name=com.infograph.
igcpublisher.queueserver.filequeue.
FileBackedPublishingRequestQueue

85
 This specifies the maximum size, in bytes, the queue folder can achieve.
queue.server.maximu Once it reaches the maximum byte size, it stops accepting new publishing
m. requests.
queue.size
Example: queue.server.maximum.queue.size=10000

The following parameters are used for the Brava! Monitor pages.

Indicates the drive letter location of the drive the Queue Server
queue.server.monitor.drive monitor should gather statistics on.
.to.monitor
Example: queue.server.monitor.drive.to.monitor=c:

Indicates for the monitor to keep track of the number of times the
number in queue exceeds this threshold.
queue.server.monitor.number
.in.queue.threshold Example:
queue.server.monitor.number.in.queue.threshold=10

Indicates for the monitor to keep track of the number of times the
seconds in queue exceeds this threshold.
queue.server.monitor.seconds
.in.queue.threshold Example:
queue.server.monitor.seconds.in.queue.threshold=60

Indicates the interval (in milliseconds) at which the Monitor will

sample system resource statistics.
monitor.thread.sleep.time
Example: monitor.thread.sleep.time=1000

Indicates the class name to call to obtain values for system

resources.
Example:
Windows
monitor.system.resources.class.name=
monitor.system.resources
com.infograph.igcpublisher.monitor.WindowsSystem
.class.name
Resources.
Non-Windows
monitor.system.resources.class.name=
com.infograph.igcpublisher.monitor.DummySystem
Resources

Indicates for the monitor to keep track of the number of times the
requests per minute exceeds this threshold.
monitor.publishing.requests
.per.minute.threshold Example:
monitor.publishing.requests.per.minute.threshold=10

86
 Indicates for the monitor to keep track of the number of times the
available physical memory exceeds this threshold (in bytes).
monitor.available.physical
.memory.bytes.threshold Example: monitor.available.physical.memory.bytes.
threshold=2300000

Indicates for the monitor to keep track of the number of times the
available virtual memory exceeds this threshold (in bytes).
monitor.available.virtual
.memory.bytes.threshold Example: monitor.available.virtual.memory.bytes.
threshold=23000

Indicates for the monitor to keep track of the number of times the
total physical memory exceeds this threshold (in bytes).
monitor.total.physical
.memory.bytes.threshold Example: monitor.total.physical.memory.bytes.
threshold=23000000

Indicates for the monitor to keep track of the number of times the
total virtual memory exceeds this threshold (in bytes).
monitor.total.virtual.memory
Example:
.bytes.threshold
monitor.total.virtual.memory.bytes.
threshold=2300000000

Indicates for the monitor to keep track of the number of times the
available disk space exceeds this threshold (in bytes).
monitor.available.diskspace
.bytes.threshold Example:
monitor.available.diskspace.bytes.threshold=23000

Indicates for the monitor to keep track of the number of times the
total disk space exceeds this threshold (in bytes).
monitor.total.diskspace
Example:
.bytes.threshold
monitor.total.diskspace.bytes.threshold
=230000000000

Indicates the amount of time (in milliseconds) that must elapse

from the last Pop before the Monitor decides that a Job Processor
monitor.timeout.threshold
is dead.
.seconds
Example: monitor.timeout.threshold.seconds=60

Indicates the IP addresses that the Queue Server will accept

requests from in addition to the local machine. Wild cards can be
used for various segments of the IP address. Multiple IP addresses
legal.ip
may also be specified by delimiting the IP addresses with commas.

Example: legal.ip=192.168.*.*

87
3.4 Configuring Net-It Enterprise Job Processor(s)

3.4.1 Editing the JobProcessor.properties File (Optional)

This section describes the various parameters in the JobProcessor.properties file, located in your
installed Net-It Enterprise directory (<Windows Drive>:\Program
Files\IGC\Brava!\JpbProcessor\JobProcessor.properties by default). This file controls various
variables in the Net-It Enterprise software product. The default values are shown in the given
examples. Changing any of these values requires a restart of the Job Processor.

Indicates the current version of the Job Processor. Do not modify

jobprocessor.version
this setting.

Future parameter that allows the use of various queue ‘plugins’

jobprocessor.job.queue.class. depending on the needs of the client. Currently only
name HTTPPublishingRequestQueue is valid. Do not modify this
setting.

Allows the number of Maximum threads to be declared. This is the

number of threads that can be concurrently active in Net-It
Enterprise.
jobprocessor.thread.manager
.maximum.threads Example:
jobprocessor.thread.manager.maximum.threads=6

Defines the thread type for published format types and allows you
to set maximum threads to declare when used in conjunction with
the parameters below
(jobprocessor.thread.manager.max.threads.<type>)

Valid values are prq, doc, drw, and pdf

PRQ – the default type used if no type is specified on a publishing
request
DOC – used for files that are published by a print process (usually
office documents and can only be processed one at a time).
jobprocessor.thread.manager DRW – used for files that are published by Brava!’s native drivers
.thread.types (multiple files can be processed at a time).
PDF – used for .pdf files. More than one can be processed at a
time, but files can sometimes be large and occupy several CPU
cycles while processing.
Example:
jobprocessor.thread.manager.thread.types=drw

You can also set up custom types by specifying a custom type in

the JobProcessor.properties file:
jobprocessor.thread.manager.thread.types=cust
jobprocessor.thread.manager.max.threads.cust=5

88
 In this example, a URL request to Net-It Enterprise is made with
the type “cust”:

http://webhost/BravaPublisher/Push?task=task&source=source&ta
rget=target&type=cust

The defaults for the

jobprocessor.thread.manager.max.threads.<type> are set up for
optimum processing using Net-It Enterprise in conjunction with
Brava! Server. These values can be optimized depending on the
jobprocessor.thread.manager file types, number of each type being processed, and number of
.max.threads.prq Job Processors being used.

PRQ type requests are not sent by Brava! Server but are for any
request sent without a type specified
jobprocessor.thread.manager.max.threads.prq=5

Only one DOC type request can be processed at a time. This

jobprocessor.thread.manager setting should be 1 if more then one JobProcessor is used.
.max.threads.doc
jobprocessor.thread.manager.max.threads.doc=2

Preset to 5 so up to 5 DRW type request can be processed at one

jobprocessor.thread.manager
time.
.max.threads.drw
jobprocessor.thread.manager.max.threads.drw=5

Preset to 2 to prevent the JobProcessor from taking too many

requests and slowing down the processing with large PDF files.
jobprocessor.thread.manager
This setting should be set to 1 if more than one JobProcessor is
.max.threads.pdf
used.
jobprocessor.thread.manager.max.threads.pdf=2

dlautopublish.generate. Valid values are true or false. Specifies whether to generate

search.index search index files.

dlautopublish.compress. Valid values are true or false. Specifies whether to compress

published.files displaylist files.

The number of jobs to publish before restarting the

dlautopublish.jobs.before dlautopublish.exe process.
.restart Example:
dlautopublish.jobs.before.restart=5

Specifies path and file name for log files to record CDL errors
dlautoputlish.log.file (should be used for debugging purposes only).
Example: dlautopublish.log.file=C:\\log.txt

89
dlautopublish.generate.text. Valid values are true or false. Specifies whether to generate files
files containing the text from the published file for searching.

The file types to be converted by IGC native drivers via bdlgen.

bdlgen.extension File types not listed here are converted through the application's
printing process via DLAutoPublish.

The maximum amount of time in milliseconds that files converted

bdlgen.timeout by bdlgen are allowed to process before they are terminated by the
JobProcessor. The largest possible value is 2147483647 which is
596.5 hours

File extensions listed here (that are not already in the

preconvert.to.pdf
bdlgen.extensions list) will be pre-published to PDF using a PDF
print driver instead of the default Black Ice print driver, before
they are converted to XDL/CSF.
Example:
preconvert.to.pdf=xfd

Indicates the message level of the output log file (log.file) in

relation to the ConsoleLog.class or FileLog.class file as indicated
in log.class.name.

log.level Values are 1 to 4:

1 - Fatal errors occurred, Job Processor is shutting down
2 - Error occurred in the publishing process and it failed
3 - Warning that something undesirable could have occurred
4 - Debug level

Indicates the type of log file to be created. This is where output

(errors, etc.) print to. Currently, the only valid values are the
ConsoleLog class and the FileLog class.

ConsoleLog – use this value to write all JobProcessor error

information to the JobProcessor console window. The debug
information is written to the output log file indicated by the
log.class.name log.file parameter. By default:
\Program Files\IGC\Brava!\JobProcessor\log\igcpublish.log

FileLog (default) – use this value to write all JobProcessor output

information to a text file. This information is written to the output
log file indicated by the log.file parameter which is , by default:
\Program Files\IGC\Brava!\JobProcessor\log\igcpublish.log
If you have set up the Job Processor as a Windows Service, ensure
that the value is set to write to the FileLog.

90
 Example for Console output:
log.class.name=com.infograph.igcpublisher.
publisher.log.ConsoleLog

Example for text file output:

log.class.name=com.infograph.igcpublisher.
publisher.log.FileLog

Indicates the name and location of the output log file. If file
logging is active, all output goes to this file. (See above
log.file log.class.name parameter to activate the log file).
Example: log.file=./log/igcpublish.log

Indicates the maximum byte size of the above log file in bytes.
After this limit is reached, the log file is cleared and logging
log.max.bytes
continues.
Example: log.max.bytes=60000

Indicates the URL of the publishing request queue.

Example:
jobprocessor.job.queue.http.
publishing.request.queue.http.url=http://localhost:80/
url
servlet/com.infograph.igcpublisher.queueserver.
http.PopServlet

The number of milliseconds that a Job Processor will sleep while

jobprocessor.job.queue.http waiting for a Queue Server that is down to come back online.
.sleep.time
Example: jobprocessor.job.queue.http.sleep.time=15000

The number of milliseconds that a Job Processor will sleep

jobprocessor.job.queue.sleep. between checks to see if there are any publishing jobs to process.
time Example:
jobprocessor.job.queue.sleep.time=1500

The number of minutes past local time that this machine should be
rebooted. This parameter is required but, if you would like to
jobprocessor.minutes.after
essentially disable this feature, you can enter a very high number
.midnight.utc.to.restart
such as the number of minutes in a year (525600).
The default value is 31536000000.

The number of minutes past midnight that this machine should be

rebooted. This parameter is required, but if you would like to
jobprocessor.minutes.after
essentially disable this feature it can be set to the default value off.
.midnight.to.restart
Example:
jobprocessor.minutes.after.midnight.to.restart=60

91
 Indicates the directory file path to temporarily hold a document
jobprocessor.document.temp
for publishing. Use forward slashes in the path (/).
orary.directory
Example: jobprocessor.document.temporary.directory=./temp

Indicates the amount (in bytes) of the maximum size of memory to

jobprocessor.document
.maximum.memory.bytes
use for holding a document. If the document to be manipulated
exceeds this, it will be saved to disk throughout its life cycle.
(NOTE: currently this item is not enabled and the document
always resides on disk.)
Example: jobprocessor.document.maximum.memory.
bytes=10000

Jobprocessor.shutdown.port The port the JobProcessor listens on for shutdown requests.

Indicates the name of the XML document that is used for

configuring Net-It Enterprise. This will be configurable in the
future. Do not modify this setting.
jobprocessor.task.definitions
.file.name Example:
jobprocessor.task.definitions.file.name=
TaskDefinitions.xml

This parameter is used for the Myriad3dView task in the

Advanced Publisher User Guide.htm and indicates the absolute
path to the myrcom32.exe file. This file is installed with a typical
myrcom.directory
MYRIAD installation. Note the forward slashes.
Example: myrcom.directory=C:/IGC/Myriad/myrcom32

The absolute path to the root Net-It Enterprise directory. This

parameter is used for the Myriad3dView task in Advanced
Publisher User Guide.htm. Note the forward slashes.
brava.publisher.root
Example:
brava.publisher.root=D:/BravaPublisher/

These settings affect the Net-It Enterprise monitor. See section 3.5 for descriptions of each.
monitor.thread.sleep.time=1000
monitor.system.resources.class.name=com.infograph.IGC
Publisher.monitor.WindowsSystemResources
monitor.publishing.requests.per.minute.threshold=10
monitor.available.physical.memory.bytes.threshold=2300000
monitor.available.virtual.memory.bytes.threshold=23000
monitor.total.physical.memory.bytes.threshold=23000000
monitor.total.virtual.memory.bytes.threshold=2300000000
monitor.available.diskspace.bytes.threshold=23000
monitor.total.diskspace.bytes.threshold=230000000000

92
 Myrdrv.ini
The Net-It Enterprise drivers use the configuration information in myrdrv.ini (located in the
JobProcessor directory) to publish files. The myrdrv.ini file contains general sections and
loader or driver specific sections that control the processing of cross referenced files, the
fidelity of raster images, handling of fonts, clip regions, extent processing, and several other
properties. For additional information on how to update this file, see myrdrv_userguide.rtf,
located in the JobProcessor's Docs sub-directory.

3.4.2 Configuring JobProcessor to Process Particular Request Types

The Brava! Server publishing requests that are sent to Net-It Enterprise are divided into
various types. These types are primarily defined by the publish.request.types property in the
server's server.properties file (by default drw, doc, and pdf). There are two other types of
publishing requests the Brava! Server will send to Net-It Enterprise beyond those listed in
this property; prq and single. Prq is assigned to any publishing request for file types not
listed in the server's publish.request.extensions.* properties. With single, Brava sends a
single page publishing request (as opposed to the standard full document publishing request)
for any file type that it has a native driver for that may be more than one page in length (these
types are defined in the server property single.page.publish.allowed). Single page requests
are sent in order to expedite a response to the client for a requested page.

It is possible to configure a particular JobProcessor to listen only for particular publishing

request types. For instance, to improve client response time, a separate JobProcessor
machine can be configured that listens only for publishing requests of type single. This is
accomplished by setting the JobProcessor.properties
jobprocessor.thread.manager.thread.types property value to "single". Similarly, if only one
machine is licensed with a particular set of applications used for print-publishing those
applications' formats, that machine would be configured to listen for request types configured
for that application’s extensions, while a second JobProcessor machine would exclude that
request type.

3.4.3 Using Xrefs with Job Processor (Optional)

You can use Xref files in conjunction with Job Processor. Xrefs are files that are referenced
by any number of DWG files and allow you to add common information to just one file. This
eliminates the repetitive task of adding identical information to multiple files. In order to use
Xrefs with Net-It Enterprise, you will need to modify the Xref path setting in the Net-It
Enterprise installation:

1. Browse to the installed Net-It Enterprise directory (C:\Program

Files\IGC\Brava!\JobProcessor by default).
2. Locate the file myrdrv.ini and open it in a text editor such as Notepad.
3. In the [DWG2DL] section of the file, edit the following line to point to your
Xref file directory:
XrefPath=c:\ACAD\xref

93
 4. Save and close the file.

Note: Refer to the document myrdrv_userguide.rtf located in the JobProcessor's Docs sub-
directory for information about the editable driver sections available for Net-It Enterprise and
Net-It Central.

3.4.4 Configuring for Auto-Restart (Optional)

Why might I need to periodically reboot the Job Processor machine?

The Job Processor must periodically reboot to eliminate leftover memory (memory
leaks) created by any third party applications used to perform the file conversion
(e.g., when publishing formats not supported natively by Net-It Enterprise). In
particular, Microsoft Office has known memory leak issues (see
http://support.microsoft.com/support/kb/articles/Q170/6/26.ASP for the Microsoft
article regarding this problem) that cause the Job Processor machine to behave
erratically or even crash after a certain number of jobs. The reboot is not because of
any instability of Net-It Enterprise or the Job Processor.

The machine that is running the Job Processor (the machine where the Net-It
Enterprise install was run) will be automatically rebooted at the time specified in the
jobprocessor.minutes.after.midnight.to.restart parameter in the
JobProcessor.properites file (see section 3.4.1 Editing the JobProcessor.properties
File). If the value is set to 43200 (roughly the number of minutes in one month), the
Job Processor will count that many minutes after midnight of the first reboot, reboot
the machine, then start the count again after the first midnight since the reboot. If the
machine gets rebooted for some other reason during the count time, the clock is reset
and it will wait another month from that reboot to reboot again.

By default, the jobprocessor.minutes.after.midnight.to.restart parameter is set the

value off, so the Job Processor will never automatically reboot. To change the
parameter, set it for the number of minutes after midnight, that you wish the machine
to reboot (e.g., if you want the machine to reboot daily at 1:00 AM set it to 60).

Note: If you feel you may need to use this setting to periodically reboot the machine,
the only software running on the Job Processor machine should be the Job Processor
and any applications used to perform the conversions. Other software is neither shut
down safely nor restarted pending the reboot (excluding any services that might be
installed and set to start automatically). Also, if the Brava! Server is installed on the
same machine, be sure to have it running as a service so it restarts automatically.

After the machine restarts, the Job Processor automatically restarts and continues
processing requests from the Queue Server. This reboot is done safely (as far as the
Job Processor is concerned) and will only do so upon completion of its current
operation (any applications used to perform conversion are shut down properly before
the reboot). No requests are lost during this reboot. Any pending requests are stored
in the queue until the Job Processor is back online.

94
 When do I NOT need to reboot the Job Processor machine?
If you are only publishing formats that are natively supported by Net-It Enterprise
(see section 1.3 Supported File Formats) or if leaving the parameter at a high enough
value that it effectively will never reboot the machine, you do not need to adjust the
default jobprocessor.minutes.after.midnight.to.restart parameter and do not need to
configure Windows for automatic restart.

To configure Windows for automatic restart:

1. Ensure that current user login for the Net-It Enterprise machine has
Administrative privileges.
2. Right click on startpublisher.bat and create a shortcut. Place the shortcut in
C:\Documents and Settings\All Users\Start Menu\Programs\Startup.
3. From the Windows Start menu, select Run and type REGEDIT.EXE in the Open
field. Click OK to launch the registry editor.
4. Navigate to and open the following registry key:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\WindowsNT\Curre
nt__Version\Winlogon

5. Find DefaultDomainName and verify that the domain name is correct for the
Net-It Enterprise machine.
6. Double-click DefaultUserName. In the Value text box, type the login name you
wish to use as the default. This is the login account that will be used when the
machine reboots.
7. From the Edit menu, select New -> String Value. Type DefaultPassword as
one word (case sensitive).
8. Double-click DefaultPassword. In the Value text box, type the password for the
login name that you specified in step 5.
9. From the Edit menu, select New -> String Value and type AutoAdminLogon as
one word (case sensitive).
10. Double-click AutoAdminLogon. In the Value text box, type 1.
11. Close Regedit. The next time the computer restarts, Windows will automatically
login the user specified in step 5.

Note: It may be necessary for your network administrator to create a special network
configuration for this machine to allow for an auto boot sequence.

3.4.5 Publishing Using Other Applications

To publish file formats not on the Supported File Format list (see section 1.3
Supported File Formats), an application that can print the format you wish to publish
must be available to the Job Processor. Generally, it is best to install the
application(s) directly on the Job Processor machine, since most applications register
a Print and/or Print to command with the operating system for their file format(s). If
the application is shared on another machine, you must register the Print to action on
the Job Processor machine to point to that application. The application(s) does not

95
 have to be running; the Job Processor will automatically launch the application to
perform the conversion and shut it down when the job is complete.

Note: If the native application is not installed or if the installed native

application does not have a Print or Print to action, then and only then do you
need to create a jdocprint action.

Follow the steps below to register a Print to action in Windows. The example given
in the steps sets up Informative Graphics' MYRIAD viewer application to publish
Microsoft Word documents.

1. Open Windows Explorer.

2. From the Tools menu, select Folder Options..
3. In the Options dialog, click the File Types tab.
4. In the Registered File Types list box, find and highlight the format you wish
to create a Print to action for. (If it is not there, follow the steps below to
create a new type.)

a) Click New ....

b) In the File Extension text box, type the extension for the format
(e.g., DOC) and click OK.

5. Click Advanced
6. Click New....to add an action and type jDocPrint in the Action Name field.
7. In the Application used to perform action text box, type the full path to the
application's executable. Some applications require additional command line
switches or commands in this line. See the documentation for the application
you are using for information on setting up this command (e.g., "C:\Program
Files\IGC\Myriad32\Myrcom32.exe" -dde ff_load("%1") -dde
print(EXECUTE_PRINT_QUICK) -dde delete_item("%1")).
8. If necessary, check Use DDE and fill in the necessary text boxes according to
the application's instructions.
9. Click OK, then click Close.

Publishing Microsoft Outlook msg files

Since DLAutoPublish may forcefully close Outlook during the print publishing process, there
should be no email accounts configured in the Outlook application on the JobProcessor
machine as there's a chance those accounts can become corrupted. If the JobProcessor is
having problems converting msg files, do the following:

1. Shut down the JobProcessor.

2. Make sure DLAutoPublish and Outlook are not running (go to the Windows Task
Manager and end the processes if they show up there).
3. Manually attempt to open Outlook and make sure it can launch without reporting
errors.
4. Close Outlook.

96
 5. Restart the JobProcessor.

Publishing Multiple Excel Worksheets

In order for Net-It Enterprise to publish all worksheets of an Excel document (instead of only
the first sheet), the following two registry settings need to be modified:

HKEY_CLASSES_ROOT\Excel.Sheet.8\shell\printto\ddeexec
Should be modified from:
[open("%1")][print(1,,,,,,,,,,,2,"%2")][close()]
To
[open("%1")][print(1,,,,,,,,,,,3,"%2")][close()]

and

HKEY_CLASSES_ROOT\Excel.Sheet.8\shell\printto\ddeexec\ifexec
Should be modified from:
[open("%1")][print(1,,,,,,,,,,,2,"%2")][quit()]
To
[open("%1")][print(1,,,,,,,,,,,3,"%2")][quit()]

WARNING: Extreme care should be taken when modifying the Registry as incorrect changes can
cause serious problems that may require reinstallation of Windows. Your Registry settings can be
backed up by clicking on 'My Computer' in Regedit and choosing 'Export Registry File' from the 'File'
menu.

3.4.6 Configuring DLAutoPublish for the Net-It Enterprise Job Processor

DLAutoPublish contains the API through which Net-It Enterprise accesses and
publishes documents. There are registry settings for DLAutoPublish that enhance the
performance of publishing various file formats. The registry keys are listed below
along with the default settings. The values represent seconds. All of the keys are
located in the following registry location.

HKEY_LOCAL_MACHINE\\SOFTWARE\\Net-It Software Corp.\\Net-It

Central\\DocProps

PrintJobTimeout REG_DWORD 120

The wait time for a document format associated with a print action to print and be
converted to an IGC display list document.
ConversionTimeout REG_DWORD 300
The wait time for a document format that has a native IGC driver to be converted to
an IGC display list document.
LinksExtractionTimout REG_DWORD 600
The wait time for link extraction in Microsoft office documents – per document.

97
 PDFConversionTimeout REG_DWORD 1200
The wait time for a PDF document to be converted to an IGC display list document.
KillPrintingApp REG_DWORD 0
If value is not 0, the last Windows Application that has been called in
DLAutoPublish to print through the Net-It® Enterprise printer driver will be
terminated if display list conversion has failed, or if an exception has been thrown at
the next call to DLAutoPublish. “New” method will terminate it.
NoVisioLinks REG_DWORD 0
A value of 0 processes Visio links. Any other value means do not process Visio links.
NoExcelLinks REG_DWORD 0
A value of 0 processes Excel links. Any other value means do not process Excel
links.
NoWordLinks REG_DWORD 0
A value of 0 processes Word links. Any other value means do not process Word
links.
NoPPTLinks REG_DWORD 0
A value of 0 processes PowerPoint links. Any other value means do not process
PowerPoint links.
TerminalServicesRunning
A value of 0 installs with the non-Terminal Services Black Ice printer. A value of 1
calls the Terminal Services Black Ice installation.
RestartSpooleronNDocs
A value of 0 or not set does nothing. A value of 1 restarts Spooler services upon
DLAutoPublish exit only on Windows 2003 systems. If the value is set to another
number (n), DLAutoPublish resets the Spooler service after every (n) number of
documents printed.
TraceLevel REG_DWORD 0
A value of 0 or not set records the lowest level of detail in DLAutoPublish.log
(produced in diagnostics mode) if the log file exists at C:\DLAutoPublish.log. The
highest value of 5 writes the highest level of detail to the log file. Note that when the
log file size reaches 2MB, separate log files will begin to be saved by date and time,
formatted as DLAutoPublish.log_<Monthnamedd_yyyy_hhmmss> (for example:
DLAutoPublish.log_August23_2005_113852). These log files should be moved from
C periodically if disk usage becomes too large.

Handling External Dialogs

The manner in which DLAutoPublish responds to dialogs popped up by the native
applications can be configured through the ExternalCloseDialogs.xml configuration
file (located in the JobProcessor directory). For information on how to configure this
file, refer to the included document “Automated Dialog Closing in
DLAutoPublish.doc.”

Note: Office applications should have their macro security setting set to "High". If you need
macros to run and are presented with macro pop up dialogs, you will need to adjust your
macro setting to “Low” and adjust how DLAutoPublish responds to the pop up dialogs. To
adjust how DLAutoPublish responds, refer to the document Automated Document Closing in
DLAutoPublish.doc located in the JobProcessor/Docs directory.

98
3.5 Monitoring Net-It Enterprise

Net-It Enterprise provides a status state monitor. The monitor is a series of JSP pages that
interpret information from the Job Processors and Queue Server. The resulting information
displays as an html page allowing the administrator to keep track of the current state. A wide
variety of information can be obtained from these pages ranging from disk usage to current
memory states. The JSP pages can be called from a browser and are installed in the default
location of jsp/igc/monitor subdirectory of your web root. The OverallStatus.jsp page shows
a general overview of the current system. If any number in any of the sub pages has hit its
threshold (as defined in the properties file), the entire line on this page will display in red.
This indicates a potential problem has developed and further investigation should occur. On
this page, all of the current Job Processors along with their current Queue Server are shown
as links on the right hand side of the page. Clicking on the Job Processor name or Queue
Server name links reveal a more detailed page of the system's current status.

The QueueServerStatus.jsp page yields the Queue Server status monitor. This page shows
information pertaining only to this Queue Server. Any numbers in red indicate that a
threshold has been reached and the cause should be investigated. If any number is red, it
causes the entire line of this Queue Server to show up red in the OverallStatus view.

The PublisherStatus.jsp page yields the status of this Job Processor. This page shows
information pertaining only to this Job Processor. Any numbers in red indicate that a
threshold has been reached and the cause should be investigated. If any number is red, it will
cause the entire line of this Job Processor to show up red in the OverallStatus view.

Please refer to the Net-It Enterprise Advanced User Guide for additional information.

3.6 Tips and Troubleshooting

3.6.1 Brava! Enterprise

3.6.1.1 Tips:

 The internal Brava! markup file format version has been updated in the 5.3 SR 1
release. This means that markups created with version of Brava! for Webtop 5.3 SR
1 and later will not be viewable within any previous versions of Brava! Enterprise
for Webtop (5.3 or earlier).
 The following MIME Types will need to be added to your Web server’s MIME text
file if you are running Windows 2003 with IIS 6.0 so that IIS 6.0 will pass the
.XDL, .ZDL and .CSF files to the Brava! Client. This does not apply if you are
running Apache Tomcat as the Web server. MIME type is what tells your browser
what kind of file you are trying to load and if not set, the file will open as text in IE.

99
 Extension MIME Type
 .xdl application/x-bravax
 .zdl application/x-bravax
 .dl application/x-bravax
 .csf application/x-bravax
 .idx application/x-bravax
 .icr application/x-bravax
 .irl application/x-bravax
 .fd application/x-bravax
 .ig4 application/x-bravax
 Ensure that the HTML page to launch the Brava! Control is configured properly
(see 3.1 Configuring Brava! ActiveX).
 Ensure that the Brava! Server is configured properly (see 3.2 Configuring Brava!
Server).
 Ensure that the servlet engine that hosts the Brava! Server war (BravaServer.war) is
restarted when changes are made to the server.properties file. Changes to the
server_precedence.properties or client_precedence.properties do not require this
restart.
 The following hotkeys are available for navigating CAMCAD (*.cc) files with the
Brava! Viewer (when Select tool is active):
 [mouse click] = "select entire geometry assembly and display it's
attributes"
[mouse click] + [CTRL key] = "select specific geometry and display
it's attributes"
[mouse click] + [SHIFT key] = "select a specific piece of a geometry
and display it's attributes"
 To enable annotations through Brava! on your own custom doc type, open the
brava_action.xml file (located in the /custom/config/actions/ directory) and edit it
by adding the following to support your custom doc type:

<scope type = "<your custom doc type>">

<action id="brava">

<params>
<param name="objectId" required="true"></param>
</params>

<execution
class="com.documentum.web.formext.action.LaunchComponentWithPermitCheck
">
<permit>read_permit</permit>
<component>bravaview</component>

100
 <navigation>jump</navigation>
</execution>

</action>

</scope>

3.6.1.2 Troubleshooting:
 When viewing CAMCAD files converted with the Brava! Viewer, strings of
inverted text in the original file remain inverted.
 If you would like to be able to edit your markups, verify the following parameters
in brava_parameters.jsp are set as follows:
Set the EnableMarkupSave = true; and EnableMarkupOpen = true; as shown
in the below code from brava_parameters.jsp if (myPermit == 4) {
EnableMarkupSaveAs = true;
EnableMarkupNew = true;
EnableMarkupReview = true;
} else if (myPermit > 4) {
EnableMarkupSaveAs = true;
EnableMarkupNew = true;
EnableMarkupReview = true;
EnableMarkupSave = true;
EnableMarkupOpen = true;

 When using multiple instances of Brava! Viewer through Webtop, you may receive
the following warning after successfully launching a file in a new Brava! window:
Warning: Page has Expired The page you requested was created using
information you submitted in a form. This page is no longer
available. As a security precaution, Internet Explorer does not
automatically resubmit your information for you. To resubmit your
information and view this Web page, click the Refresh button.

 This error can be corrected by clearing your temporary internet files through
ToolsInternet Options of your browser window. From the General Tab, click
Delete Files in the Temporary Internet Files section and click OK.

3.6.2 Net-It Enterprise

3.6.2.1 Tips:
 You can increase publishing performance and fidelity in some cases by changing
the value forcetojpg to TRUE. This setting is contained in the [cdl_section] section
of the myrdrv.ini file and is described in the document myrdrv_userguide.rtf which
is located in the JobProcessor's Docs sub-directory.
 The default dpi value of embedded raster images is 600 dpi when published to
CDL. If you require greater resolution, you must edit the value of MaxRasterDPI
in the [cdl_section] of the mrydrv.ini. (See myrdrv_userguide.rtf for details.)
 Ensure all needed values are entered into the properties files (this includes both the
HttpQueueServer.properties and JobProcessor.properties files).

101
 Always use UNC paths for the source and target locations on requests.
 Use correct capitalization/spelling on requests. This value must match the
corresponding task/variable in the XML file.
 The push URL path used for pre-publishing must be UTF8 URL encoded; therefore
a push URL that contains Korean or other double-byte characters in the path must
first be UTF8 URL encoded before it will work.
 Ensure the Queue Server and/or Job Processor are restarted when changes are made
to the properties files.
 If you have set up the Job Processor as a Windows Service, ensure that the value of
the JobProcessor.properties file parameter log.class.name is set to
"log.class.name=com.infograph.igcpublisher.publisher.log.FileLog". This location
is where any errors or debug information will be logged.
 If Terminal Services is installed on the Job Processor, and you wish to uninstall
and/or reinstall the Job Processor, you must also manually uninstall the Black Ice
print driver through the Control Panel's Add/Remove Programs dialog. This can be
done either before or after uninstalling Net-It Enterprise.

3.6.2.2 Troubleshooting
 Microsoft Word will leave behind temporary working files. If the number of
temporary files becomes too large, Microsoft Word will not launch and Net-It
Enterprise will not be able to convert Word documents via its DLAutoPublish
executable. To clean up temporary Word files, the utility DirCleanup.exe, located
in the Net-It Enterprise JobProcessor directory, can be run. It can take one or more
paths as arguments, and cleans up the temporary Word files in those directories. A
log file is written out to C:\NetItDirCleanup.log. Example usage:
 DirCleanup.exe "C:\WINDOWS\Temp" "%userprofile%\Local Settings\Temp”
 The JobProcessor is not supported on machines running anti-virus software. If you
have this configuration and you're experiencing problems, turn the anti-virus
software off on the JobProcessor machine and restart the JobProcessor.

If you must run virus protection software on the JobProcessor server, the following
directories should be excluded from scanning:

C:\Windows\system32\spool\PRINTERS
C:\Windows\Temp
C:\Documents And Settings\{user}\Local Settings\Temp
C:\Program Files\IGC\Brava!\JobProcessor

If you are experiencing issues with excluding C:\Windows\Temp, you can update the
system output path of the Black Ice Print driver. To do this:

1. In the Control Panel’s “Printers and Faxes” panel, right-click on the "Black Ice
EMF" printer and select Properties.
2. Select the Advanced tab.

102
 3. Click the "Printing Defaults..." button.
4. Select the "Filename Generation" tab.
5. Change the Output Directory path to the following:
 On the Queue Server machine (which is typically the same as the JobProcessor
machine), the suggested path is:
C:\igcprq

On the Brava! Server machine, the suggested path is:

C:\Program Files\IGC\Brava!

6. Click OK to save your settings.

 When using Net-It Enterprise, a “DLAutoPublish error code -60” is an indication
that the timeout values set in registry for DLAutoPublish are not set high enough. If
the files require longer to publish than the timeout settings this error will appear. To
fix this adjust to a longer timeout value (see 3.4.6 Configuring DLAutoPublish for
the Net-It Enterprise Job Processor).
 To publish the XFD file format, you’ll need to install the PureEdge Viewer. In the
jobprocessor.properties file, add or edit the parameter preconvert.to.pdf to include
the XFD file. After installing the PureEdge Viewer on the JobProcessor machine,
the printto action needs to be removed from the list of actions for the XFD file type:
 From Windows Explorer, select Tools->Folder Options
 Click the File Types tab and highlight XFD in the Registered file types list
 Click the Advanced button
 Highlight printto in the Actions list and click the Remove button
 If you experience memory usage problems, there are a couple of preventative
options you can take. One is to turn off hyperlink extraction on Word documents.
To do this, set the NoWordLinks registry entry (documented in section 3.4.6) to 1.
Another option is to lower the number of jobs that the DLAutoPublish.exe runs
before it restarts itself. To do this, set or lower the value of the
dlautopublish.jobs.before.restart parameter in the JobProcessor.properties file.
This parameter is documented in section 3.4.1.
 If the JobProcessor is set up to run as a service, the Net-It Enterprise service must
have an administrative account specified in the Properties dialog of the Services
panel. If not set, you may receive a -21 error.
 You can check to see if a -21 error is a publishing error or services error by shutting
off the Net-It Enterprise service in the Service panel and then starting Net-It
Enterprise manually through Window’s StartAll ProgramsIGCStart Net-It
Enterprise command. If publishing is successful, the problem is the service
configuration (see above bullet).
 If you have uninstalled a previous version of Net-it Enterprise and are receiving -21
errors when attempting to publish a document, then try uninstalling the Black Ice
drivers and clean up the associated files:

103
  Uninstall the containing product (i.e. Net-It Enterprise)
 Uninstall the Black Ice Driver if it is listed in the Control Panel’s “Add or Remove
Programs” panel (listed as “Black Ice EMF Printer Driver).
 Reinstall Net-It Enterprise.
 If the three above steps do not solve the problem, repeat steps 1 and 2 and continue
with the following steps.
 Unzip the BlackIceCleaner.zip file located in the JobProcessor directory.
 Copy the resulting BClean.exe file to your machine’s C: drive.
 Boot the machine into safe mode and launch BClean.exe.
 Reboot your machine, and then reinstall Net-It Enterprise.

3.6.2.3 Workaround Macros

Several workarounds are included in your Net-It Enterprise/Workarounds installation directory that
help with a variety of issues regarding the interaction between Net-It Enterprise and third party
applications that can not be solved by modification of Net-It Enterprise. Below explains these
workarounds as well as other third party software compatibility issues.

Microsoft Excel: OneJob.xla

A workaround macro is available called OneJob.xla that can be used with products from
Informative Graphics to prevent a problem that can occur when publishing Excel files that
contain more than one Worksheet. If Worksheets contained in one Excel file have differing
resolution quality settings, Excel will start more than one print job, resulting in incomplete
published documents. This effect is a know Excel issue and is documented further in this
Microsoft Knowledge Base article: http://support.microsoft.com/default.aspx?scid=kb;en-
us;168563

The workaround macro sets the resolution of each Worksheet to 600 dpi every time before
printing.

To use the macro:

1. Copy OneJob.xla from your Net-It Enterprise directory \Workarounds folder and paste it
into your Excel auto start folder (usually called XLStart and is located in your Excel
application directory within the Microsoft Office directory). An example path would be:
C:\Program Files\Microsoft Office\Office10\XLStart. If you use a customized location,
copy the macro to that location.
2. After you have copied the macro into this folder a toolbar named "IGC Workaround" is
created when Excel is started. The macro works automatically and the single button on
the toolbar shows a short explanation about the Workaround when moused over. It is
only present to show that the macro is active and is deleted again every time you close
Excel.
3. If you choose to deactivate the macro, simply delete the OneJob.xla file from your
XLStart directory.
104
Microsoft Excel: DPI Tools.xls
Another workaround tool is available in the \Workarounds directory, similar to OneJob.xla,
called DPI Tools.xls. This tool can be used if you are not able to run the Add-in when using the
Excel Viewer for conversion. This tool lets you select a folder that contains Excel files and then
opens each selected file and sets the PrintQuality to 600 dpi for each Worksheet. No install
required, simply open the file DPI Tools.xls.

Microsoft Excel: RemovePersonalInfo.xla

If Excel files republish on every build. Net-It Enterprise checks the CRC's of files to determine if
they have changed and therefore need to be republished. A macro is available called
RemovePersonalInfo.xla that enables the "Remove personal information from file properties on
save" option. When this option is disabled (on the Security tab of the Options dialog), this causes
Excel files to be changed when opened and therefore republished. To use the macro:
 Copy the file RemovePersonalInfo.xla into your Excel startup folder (XLStart) to force
the macro to load each time Excel starts up. An example path would be: C:\Program
Files\Microsoft Office\Office10\XLStart. If you use a customized location, copy the
macro to that location.
 To uninstall the macro, simply delete it from your XLStart directory.

Microsoft PowerPoint: PrintColor.ppa

When using certain versions of the third party virtual printer Black Ice EMF, some PowerPoint
versions (such as PowerPoint XP) automatically set the Grayscale option in the printer dialog
each time a document is printed. An Add-in called PrintColor.ppa is available that, when active,
sets the option to Color each time a document is printed. To install the Add-in, open PowerPoint
and click Tools, then Add-Ins. Click the Add New button and browse to the location of
PrintColor.ppa in your installed Net-It Central/Workarounds folder. Select it and click OK. The
Add-in is now active. In this dialog, you can also Unload and Load the Add-in if you need to
deactivate it regularly.

Microsoft PowerPoint: FitToPage.ppa

When using certain versions of the third party virtual printer Black Ice EMF, some PowerPoint
slides are clipped at the edges. An Add-in called FitToPage.ppa is available that, when active,
sets the Fit To Page option each time a document is printed. To install the Add-in, open
PowerPoint and click Tools, then Add-Ins. Click the Add New button and browse to the
location of FitToPage.ppa in your installed Net-It Central/Workarounds folder. Select it and
click OK. The Add-in is now active. In this dialog, you can also Unload and Load the Add-in if
you need to deactivate it regularly.

105
4.0 Contacting Informative Graphics
If you need information on integrating and customizing Brava! Enterprise or if you
experience any problems or have any general inquiries, please feel free to contact us.

Informative Graphics Corp

4835 E. Cactus Road, Suite 445
Scottsdale, Arizona 85254-3548
Phone: (602) 971-6061
E-mail: info@infograph.com
Support: http://www.infograph.com/support/
M - F 5am to 5pm, Arizona time
Brava! Technical Information and Driver Updates:
http://www.infograph.com/support/BravaTechnicalSupport.htm
Web: www.infograph.com
ftp: ftp://ftp.infograph.com/

Acknowledgment: This product includes software developed by the Apache Software

Foundation http://www.apache.org/.

106