You are on page 1of 56

Brava!

ActiveX
Parameters
FOR DOCUMENTUM TASKSPACE INTEGRATION
LAST UPDATED, MONDAY, MAY 20, 2013

Table of Contents
Brava! ActiveX Parameters Guide ................................................................................ 1
Introduction .......................................................................................................... 1
Product Version Information ....................................................................................... 1
Brava ActiveX Params Overview .................................................................................. 2
Integration Specific Parameters .................................................................................. 3
General Integration Parameters ...................................................................................... 3
TaskSpace Integration Parameters .................................................................................. 4
TaskSpace Custom Parameters ....................................................................................... 5
Download File Parameters ....................................................................................... 13
TaskSpace Document Options ...................................................................................... 15
CSF Options ........................................................................................................ 15
PDF Options ........................................................................................................ 17
TIFF Options........................................................................................................ 19
TaskSpace Permissions Parameters................................................................................ 21
TaskSpace Licensing Parameters ................................................................................... 25
ActiveX Client Optional BravaXParams ....................................................................... 28
General Control Parameters ......................................................................................... 28
Toolbar and Menu Item Controls ................................................................................... 37
Markup and Redaction Parameters ................................................................................ 44
Publishing Parameters ............................................................................................... 52
Output Options ..................................................................................................... 52
PDF Export .......................................................................................................... 52
TIFF Export ......................................................................................................... 53
CSF Export .......................................................................................................... 54
JPG Export .......................................................................................................... 54

ii

BRAVA! ACTIVEX PARAMETERS GUIDE

INTRODUCTION
This document details the Brava! ActiveX parameters that can be used to customize your
Brava product configuration. The Brava ActiveX parameters affect the state of the Brava
ActiveX Client. The audience for this document includes developers, programmers, and
integrators with a solid knowledge of COM API programming and ActiveX technology who
are configuring and customizing their implementations for the specific needs of their
environment.

PRODUCT VERSION INFORMATION


Brava! Enterprise 7.1 for TaskSpace Integration
Copyright 2013. All rights reserved.
If you need information on integrating and customizing Brava or if you experience any
problems or have general inquiries, please feel free to contact us.
Informative Graphics Corp
4835 E. Cactus Road, Suite 445
Scottsdale, Arizona 85254
Phone: (602) 971-6061
E-mail: info@infograph.com
Support: http://www.infograph.com/support/
Web: http://www.infograph.com

BRAVA ACTIVEX PARAMS OVERVIEW


This document details the Brava ActiveX Client and Server parameters that can be used to
customize your Brava configuration . The optional Brava ActiveX parameters affect the state
of the Brava ActiveX Client and can be used to enable or disable (remove) specific features
and functionality from the user interface.
For the Brava Enterprise to TaskSpace integration, parameters that control the Brava Client
are stored in the brava_parameters.properties file which can be edited to meet your
requirements. It should be noted that the brava_parameters.properties file contains
parameters for setting behaviors that are unique to Brava TaskSpace. Core Brava Enterprise
Parameters that are not listed in the brava_parameters.properties file are not applicable to
the TaskSpace integration.

INTEGRATION SPECIFIC PARAMETERS

GENERAL INTEGRATION PARAMETERS

The Integration Brava Server parameters in the following table are used only when Brava
Enterprise component is integrated with another 3rd party product.
IntegrationHttpProxyServer
Value

Example/default

Name:servername:port
number

integrationhttpproxyserver=name:CARL:8080:8888

Description
Sets HTTP proxy configuration for Brava ActiveX client. This parameter encodes two pieces of data:
name and bypasslist. For example,
"name:someproxyhostname:8888bypasslist:host1;host2;host3" configures Brava to use
port 8888 on port "someproxyhostname" as a proxy while bypassing the proxy for domains "host1",
"host2", and "host3".

IntegrationName
Value

Example/default

<unique name>

integrationname=exampleintegration

Description
Identifies the prefix for custom integration parameter names. If
integrationname=exampleintegration, custom integration parameters are specified with
"exampleintegration.XYZ=ABC" where XYZ is the custom parameter name and ABC is the parameter
value.

IntegrationVersion
Value

Example/default

<version number>

integrationversion=7.0.0.5

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

TaskSpace BravaXParams Guide

TASKSPACE INTEGRATION PARAMETERS

The Integration parameters in the following table are used only when Brava Enterprise
component is integrated with Documentum TaskSpace .
Follow the steps below to setup brava_parameters.properties to fit your configuration.
Note: The Brava TaskSpace Server install must be complete prior to customizing the Brava
TaskSpaceServer parameters via the brava_parameters.properties file. In the install steps
above, you copied the contents of the TaskSpace version-appropriate Custom Directory that
contains the integration components into TaskSpace custom directory. It is very important
that you modify the deployed brava_parameters.properties file and not the default file
located in the Brava TaskSpace Server install location. Modifying the un-deployed copy will
result in no changes taking place to the active deployed Brava TaskSpace configuration.
Some application servers may require a restart or redeployment the Web Application before
the changes in the brava_parameters.properties will take effect.
1. Using a text editor such as Notepad, open brava_parameters.properties, located in
the deployed TaskSpace directory
<drive>: \<jakarta install directory>\webapps\taskspace \custom\config\brava or
\bea\user_projects\dctm\applications\taskspace\custom\config\brava
3. Parameters contained in the section below must be edited with the correct
parameter values as dictated by your specific environment and needs.
4. Save and close the .properties file.
The following TaskSpace XX tables list the TaskSpace specific parameters (and possible
values) contained in the brava_parameters.properties page that you can customize for the
Brava ActiveX client. Many of these parameters determine which features will be available
to viewers using the Brava ActiveX Client. You can choose to enable or disable a feature by
setting its value to TRUE or FALSE.
Note that blank values for parameters will cause the BravaX Client to use the default value
in cases were values are defined values other then TRUE or FALSE, or where a Blank value
has the effect of turning the parameter off.
TaskSpace Custom Parameters
TaskSpace Document Publishing Options
TaskSpace Permission Parameters
TaskSpace Licensing Parameters
Brava Client General Parameters
Brava Client Toolbar and Menu Controls
Brava Client Markup Parameters
Brava Client Publishing Parameters

Integration Specific Parameters

TASKSPACE CUSTOM PARAMETERS

Include appropriate links to other topics by writing a list of links or by adding a related
topics button:
ServerHostName
Value

Example/default

http://<your_server>:Port

ServerHostName=http://TOMCAT20:8080

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

ServerHostNameFromTaskSpace
Value

Example/default

http://<your_server>:Port

ServerHostNameFromTaskSpace =

Description
This parameter adds a hostname for Methods in Class file, adding the ability to specify the brava
server parameter for external users. If this parameter is set, Brava will use this brava server
hostname to get a Brava session and publish a file (URL calls are made from the TaskSpace server to
the brava server).
For example, the BravaComponent class (which executes on the webapp, TaskSpace , server) makes
calls to the BravaServer. This is valuable when the Brava server has a different name or ip address
when it exists outside of a firewall and can be used in cases when the outside users cannot access the
Brava server and TaskSpace cannot communicate with the Brava server based on param value. The
server_precedence file will not override the url in this situation.

TaskSpaceURL
Value

Example/default

http://localhost:8080/TaskSpace

URL=http://TOMCAT20:8080/TaskSpace

Description
This parameter tells Brava the default root URL to your TaskSpace webapp. NOTE: this is used by the
client machines to talk to the TaskSpace Server so firewalls/routers might affect this value.

UseBrowserURL
Value

Example/default

true/false

UseBrowserURL=FALSE

TaskSpace BravaXParams Guide

Description
If set to true, this parameter uses the browser URL to make requests to the JSP pages. This
parameter removes the requirement that users must access TaskSpace using the same URL that is
specified in the brava_parameters.properties file, allowing alternate URLs to be used for clients to
connect to TaskSpace .

brava_cab_version
Value

Example/default

<version number>

brava_cab_version=7,1,0,19

Description
Indicates the version number of the brava cab file. brava_cab_version numbers are separated by
commas.

LaunchBravaInNewWindow
Value

Example/default

true/false

LaunchBravaInNewWindow=FALSE

Description
Setting this parameter to TRUE will force Brava to launch in a new Browser window or tab.
To have Brava launch in new tabs instead of new windows, adjust the following in IE:

1. From the Internet Options dialog, select Settings.


2. Select "Always open Pop-ups in a new tab" from the When a pop-up is encountered
section.
3. Optionally, you can select "Always switch to new tabs when they are created" if you
want to adjust focus to the Brava window when it is launched.

AuditBravaView
Value

Example/default

true/false

AuditBravaView=TRUE

Description
A value of TRUE logs a "brava_view" event to the audit trail of the document when Brava is launched.
This enables some basic auditing events such as opening a file and saving a markup file. When set to
FALSE, no audit trail is logged. Set to TRUE to enable additional audit events. See "Enabling additional
Brava audit events" in the TaskSpace administrator's guide.

AutoNameMarkup
Value

Example/default

true/false

AutoNameMarkup=FALSE

Description
Turns (automatically) naming of all markup files 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.

Integration Specific Parameters

PublishCheck
Value

Example/default

true/false

PublishCheck=TRUE

Description
Turns advanced Brava Enterprise JobProcessor publishing version checking on/off.

UseACSIfAvailable
Value

Example/default

true/false

UseACSIfAvailable=FALSE

Description
Setting this to FALSE causes Brava to not use ACS (even when TaskSpace notifies that ACS is
working) when Brava is launched. Sometimes TaskSpace /WDK sends a response that ACS is
functioning but will fail to provide a valid ACS URL. This setting provides a means to get past this
issue without requiring any code changes.

UseBOCsIfAvailable
Value

Example/default

true/false

UseBOCsIfAvailable=FALSE

Description
If set to TRUE, Brava checks the user's current network location and if an associated BOC Server is
found, this is used as the location from which to retrieve files.

BOCSBravaServerPairing
Value

Example/default

<Location>|http://<BravaServer>:8080,<
Location
>|http://<BravaServer2>:8080,.....

BOCSBravaServerPairing=
<Location1>|http://<BravaServer>:8080,<Location2>|ht

Description

This setting tells Brava which Brava server it should use when using the associated BOCs Server Location name. Pairing
server to cache files rather than to cache them on a remote Brava Server.
In this case, if the user was assigned to use ' Location 1' from their current login, the Brava Client would be directed to
Server which would be local to them and the BOCs server location name.

UseBravaSession
Value

Example/default

true/false

UseBravaSession=TRUE

Description

TaskSpace BravaXParams Guide

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

WatermarkFolders
Value

Example/default

true/false

WatermarkFolders=FALSE

Description
Turn on/off the ability to create watermarks based on the folder name where the content resides.
Brava checks the folder name set in WatermarkFolderName and compares it to the current folder to
see if Brava should display this folder name as a watermark.

WatermarkFolderName
Value

Example/default

Any valid document folder


name

WatermarkFolderName=

Description
If the document being viewed is in this folder and the WatermarkFolders parameter is set to TRUE,
the watermark will be set to be the folder name. Multiple values are allowed, but need to be separated
by a comma (i.e. folder1,folder2,folder3). Note: The watermark will be seen both on-screen and when
printed.

WatermarkLineSpacing
Value

Example/default

0, 1, 2, or 3

WatermarkLineSpacing=2

Description
Specifies the print density of the print watermark. A value of 0 prints the most opaque watermark,
while 3 prints the most transparent.

EnableSingleEditableMarkup
Value

Example/default

true/false

EnableSingleditableMarkup=FALSE

Description
If TRUE, only one markup object is created for each file. Brava will open the existing markup created
by the user for edit when one exists or will create a new markup for editing when none exists. To use
this feature, RELATE_ and HRELATE_EnableMarkupNew must be set to FALSE.

EnableConvertOnClientOfficeFormats
Value

Example/default

true/false

EnableConvertOnClientOfficeFormats=FALSE

Integration Specific Parameters

Description
Enables/disables Convert on Client for Office Document formats. Additional purchase required to
license Office formats.

ConvertOnClientOfficeFormats
Value

Example/default

List of Office
document
extensions to
be converted
on the client.

ConvertOnClientOFFICEFormats=
pptx,docx,xlsx,cdr,dbf,doc,drw,fax,flw,fmt,fwk,htm,html,img,mpp,
msg,pcd,pct,pic,pict,pps,ppt,prs,prz,rnd,rtf,sam,shw,vsd,vw,wb1,
wb2,wdb,wk1,wk3,wp,wp5,wp6,wpd,wpf,wpg,wq1,wri,ws,xbm,xls

Description
This parameter tells Brava what Office formats can be converted on the client. If ConvertOnClient
is set to true and the document extension is listed here, Brava will try to convert the file on the client
by passing the publishing event. Use of this parameter requires special licensing.

EnableConvertOnClientCADFormats
Value

Example/default

true/false

EnableConvertOnClientCADFormats=FALSE

Description
Enables/disables Convert on Client for CAD formats.

ConvertOnClientCADFormats
Value

Example/default

List of CAD format


extensions to be converted
on the client.

ConvertOnClientCADFormats=000,906,907,bmp,cal,cg4,
cgm,cit,cmi,mi,dcx,dft,dg,dgn,dgn7,dif,dwf,dwg,dx,
dxf,edc,edm,ftk,g3,g4,gp4,igs,iso,jpg,jpeg,mil,mot,
mvs,pcx,plt,prt,ps,rlc,rle,rnl,slddrw,tif,tiff,dsn,
rtl,txt,png,hgl,idw,axp,gif,cc,psd

Description
This parameter tells Brava what CAD formats can be converted on the client. If ConvertOnClient is
set to true and the document extension is listed here, Brava will try to convert the file on the client by
passing the publishing event.

EnableConvertOnClientImageFormats
Value

Example/default

true/false

EnableConvertOnClientImageFormats=TRUE

Description
Enables/disables Convert on Client for Image formats.

TaskSpace BravaXParams Guide

ConvertOnClientImageFormats
Value

Example/default

List of Image format


extensions to be
converted on the client.

ConvertOnClientImageFormats=tif,pdf,bmp,png,gif,jpg,csf

Description
This parameter tells Brava what image formats can be converted on the client. If ConvertOnClient
is set to true and the document extension is listed here, Brava will try to convert the file on the client
by passing the publishing event.

ClientLoadedMaxFileSize
Value

Example/default

Any whole integer value

ClientLoadedMaxFileSize=204800

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

HideStampDialogOnPlacement
Value

Example/default

true/false

HideStampDialogOnPlacement=FALSE

Description
If set to TRUE, when the stamp is initially placed, the bi-directional stamp dialog will not display. Note
that the stamp must contain at least one token besides a dbupdatestring token to be able to detect
whether stamp placement is occurring. In order to enable this functionality, an integration may want
to add a dbstring token in the stamp, and have the integration display a blank string for that dbstring
token.

RefreshStampOnCancel
Value

Example/default

true/false

RefreshStampOnCancel=TRUE

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

CapitalizeDbupdateLabel
Value

Example/default

true/false

CapitalizeDbupdateLabel=FALSE

10

Integration Specific Parameters

Description
If set to TRUE, the labels for the dialog items will be equal to the DbUpdateToken string value, except
that underscores will be replaced with spaces, and the first letter of every word will be capitalized.

DbUpdateStringNotRetrieved
Value

Example/default

"hide" or not set

DbupdatestringNotRetrieved=hide

Description
If set to Hide, then the client will not display that field in the DbUpdateString dialog. If not set, the
default behavior is to show the field in the dialog with a blank value. In future releases, this parameter
may be updated to accept additional values other than Hide.

BookmarkTitles<n>
Value

Example/default

category|title

bookmarktitles1=Authority|Temporary Authority
bookmarktitles2=Authority|Power of Attorney
bookmarktitles3=Home Loan Control Documents|Title
Search

Description
This feature enables the end-user or administrative user to create a bookmark to an item currently
displayed in the Brava client. Users can select a category and title from public bookmarks, including
free text public bookmarks.
To enable this feature, EnableExternalBookmarks must be TRUE. To make public bookmarks
available, define your desired bookmark titles and categories via the bookmarktitles parameters in
the format bookmarktitlesn=category|title, where n is any integer.

Theme_Version
Value

Example/default

<version number>

theme_version=1.0

Description
Used with theme, the version number determines if the theme needs to be updated and downloaded
again to the client if it has already been installed.

Theme
Value

Example/default

Predefined or custom theme


file name

theme=

Description

11

TaskSpace BravaXParams Guide

Determines the theme used by the Brava Client. Several predefined themes are defined and available
for the default TaskSpace installation. If you would like to design custom themes to use with
TaskSpace , please see the Brava Extensible Interface Reference.pdf guide, for custom theme design
definitions.

1. The XML theme file should be zipped and renamed to <theme name>.bin and placed in
your custom/brava/component/markup directory.
2. Add your custom theme name to the theme parameters. For example, if your custom
theme xml file was zipped and renamed to my_custom_theme.bin, then you would add
the following parameters:
theme=my_custom_theme
theme_version=1.1
If you change the theme name in the theme parameter, you will also need to increment and update
the theme _version parameter so the new theme gets downloaded.

EnablePrivate
Value

Example/default

true/false

EnablePrivate=TRUE

Description
Turns on/off the Save Markup as Private function.

EnableDefaultPrivate
Value

Example/default

true/false

EnableDefaultPrivate=FALSE

Description
Sets the Private option in the markup Save As dialog to be enabled by default.

EnableVersion
Value

Example/default

true/false

EnableVersion=TRUE

Description
Turns on/off the Save Makeup with all versions function. Note that in order for the permissions to
work properly, you must have performed the required installation step (see TaskSpace installation
guide).

12

Integration Specific Parameters

EnableDefaultVersion
Value

Example/default

true/false

EnableDefaultVersion=FALSE

Description
Sets the Version option in the markup Save As dialog to be enabled by default. Note that the Markup
Save As dialog does not display at all if EnablePrivate and EnableVersion are set to FALSE, and
AutoNameMarkup is set to TRUE.

DOWNLOAD FILE PARAMETERS


The following parameters are used by the TaskSpace Client to download specified files.
Download.<specified file>
Value

Example/default

<see below>

download.url.{name}=
download.version.{name}=
download.strictversionmatch.{name}=
download.destinationname.{name}=

Description

13

TaskSpace BravaXParams Guide

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 "<user profile>\IGC\x7_0" directory. The version number is
used to determine whether an updated file needs to be downloaded. The value of {name} needs to
match the value used for the corresponding download.url.{name} param.
Examples of using the download params are:

download.url.Pdf2DL=http://<Server>/IGC/Pdf2DL.bin
download.version.Pdf2DL=2.5.7.2
If the file specified by the download.url.Pdf2DL parameter has not yet been downloaded, or if it has
and its version is less than 2.5.7.2, 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\x7_0" directory, and the version.txt file will be updated to reflect version 2.5.7.2.

download.url.RedactionScripts=http://<server>/IGC/RedactionScripts.bin
download.version.RedactionScripts=7.0.0.3
The above example specifies location and version of Redaction Scripts bin file that can be downloaded
from the web server and installed to the local client machines. Allows distribution of script files from
server.

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.

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.
The following downloads the Changemarks configuration file used for setting type and state options of
the Changemarks dialog.

download.destinationname.ChangemarkConfig=ChangemarkConfig.xml
The following example downloads the current version of the standard reason codes used for setting
redaction entities.

download.version.ReasonCode=1.0.0.1
The following example downloads the standard theme file used for the Brava ActiveX client, setting
"Blue-Theme" as the default theme:

download.url.Theme=http://<server>/IGC/Themes/Blue-Theme.xml
download.version.Theme=1.0.0.1
download.destinationname.Theme=BravaClientTheme.xml

14

Integration Specific Parameters

EnableFileExtensions

TASKSPACE DOCUMENT OPTIONS

Value

Example/default

true/false

EnableFileExtensions=TRUE

Description
Enables/disables the default use of adding the original format file extension to PDF, TIF, and CSF
output from Brava.

CSF OPTIONS
EnableSaveCSFFile
Value

Example/default

true/false

EnableSaveCSFFile=TRUE

Description
Turns on/off the ability to save a CSF file as a new file to the local system.

EnableSaveCSFEmail
Value

Example/default

true/false

EnableSaveCSFEmail=TRUE

Description
Turns on/off the ability to save a CSF file as an attachment to an email message (MS Outlook or MS
Exchange).

EnableSaveCSFRendition
Value

Example/default

true/false

EnableSaveCSFRendition=TRUE

Description
Turns on/off the ability to save a CSF file as a Rendition of the file in the Docbase.

EnableSaveCSFNewDocFile
Value

Example/default

true/false

EnableSaveCSFNewDocFile=TRUE

Description
Turns on/off the ability to save a CSF file as a new file to the users home cabinet.

15

TaskSpace BravaXParams Guide

EnableSaveAsMajorVersionCSF
Value

Example/default

true/false

EnableSaveAsMajorVersionCSF=TRUE

Description
Turns on/off the ability to save a CSF file as 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.

EnableSaveAsSameVersionCSF
Value

Example/default

true/false

EnableSaveAsSameVersionCSF=FALSE

Description
Turns on/off the ability to save a CSF file as the same version of the original file, overwriting the
current version. Use with care.

EnableSaveAsMinorVersionCSF
Value

Example/default

true/false

EnableSaveAsMinorVersionCSF=FALSE

Description
Turns on/off the ability to save a CSF file as the next logical minor version of the original file.

AutoNameCSFImport
Value

Example/default

true/false

AutoNameCSFImport=FALSE

Description
Turns on/off the ability to have the CSF file automatically name itself when saved. If set to true, user
is not allowed to manually enter a name.

DefaultCSFPublishOption
Value

Example/default

FILE, EMAIL, RENDITION, NEWDOCFILE,


MAJORVERSION, MINORVERSION,
SAMEVERSION

DefaultCSFPublishOption=

Description

16

Integration Specific Parameters

Sets the Default Publish/Save method for the CSF Publish Option.
Hint: Setting a default method and turning off the individual options will allow you to restrict the
Publish Option to a single option. Set AutonameCSFImport to TRUE will allow for only 1 method and
without prompting.

File New file to local system


Email New file as email attachment (Exchange or Outlook only)
Rendition To Docbase as a CSF rendition
NewDocFile New File to Docbase Home Cabinet
MajorVersion As a New Major Version to the original file
MinorVersion As the next logical minor version of the original file
SameVersion Overwrites current file version

PDF OPTIONS
UsePDFRendition
Value

Example/default

true/false

UsePDFRendition=FALSE

Description
If set to TRUE Brava will use the PDF Rendition of a file is available. If set to FALSE Brava will use the
original file. This setting is ignored (disabled) if launching Brava Viewer through the renditions screen.
See also: PDF_Rendition_Control_For_Groups, PDF_Rendition_Control_For_Users

EnableSavePDFFile
Value

Example/default

true/false

EnableSavePDFFile=TRUE

Description
Turns on/off the ability to save a PDF file as a new file to the local system.

EnableSavePDFEmail
Value

Example/default

true/false

EnableSavePDFEmail=TRUE

Description
Turns on/off the ability to save a PDF file as an attachment to an email message (MS Outlook or MS
Exchange).

EnableSavePDFRendition
Value

Example/default

true/false

EnableSavePDFRendition=TRUE

Description

17

TaskSpace BravaXParams Guide

Turns on/off the ability to save a PDF file as a Rendition of the file in the Docbase.

EnableSavePDFNewDocFile
Value

Example/default

true/false

EnableSavePDFNewDocFile=TRUE

Description
Turns on/off the ability to save a PDF file as a new file to the users home cabinet.

EnableSaveAsMajorVersionPDF
Value

Example/default

true/false

EnableSaveAsMajorVersionPDF=TRUE

Description
Turns on/off the ability to save a PDF file as 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.

EnableSaveAsSameVersionPDF
Value

Example/default

true/false

EnableSaveAsSameVersionPDF=FALSE

Description
Turns on/off the ability to save a PDF file as the same version of the original file, overwriting the
current version. Use with care.

EnableSaveAsMinorVersionPDF
Value

Example/default

true/false

EnableSaveAsMinorVersionPDF=FALSE

Description
Turns on/off the ability to save a PDF file as the next logical minor version of the original file.

AutoNamePDFImport
Value

Example/default

true/false

AutoNamePDFImport=FALSE

Description
Turns on/off the ability to have the PDF file automatically name itself when saved. If set to true, user
is not allowed to manually enter a name.

DefaultPDFPublishOption
Value

18

Example/default

Integration Specific Parameters

FILE, EMAIL, RENDITION,


NEWDOCFILE, MAJORVERSION,
MINORVERSION, SAMEVERSION

DefaultPDFPublishOption=

Description
Sets the Default Publish/Save method for the PDF Publish Option.
Hint: Setting a default method and turning off the individual options will allow you to restrict the
Publish Option to a single option. Set AutonamePDFImport to TRUE will allow for only 1 method and
without prompting.

File New file to local system


Email New file as email attachment (Exchange or Outlook only)
Rendition To Docbase as a PDF rendition
NewDocFile New File to Docbase Home Cabinet
MajorVersion As a New Major Version to the original file
MinorVersion As the next logical minor version of the original file
SameVersion Overwrites current file version

TIFF OPTIONS

EnableSaveTIFFile
Value

Example/default

true/false

EnableSaveTIFFile=TRUE

Description
Turns on/off the ability to save a TIF file as a new file to the local system.

EnableSaveTIFEmail
Value

Example/default

true/false

EnableSaveTIFEmail=TRUE

Description
Turns on/off the ability to save a TIF file as an attachment to an email message (MS Outlook or MS
Exchange).

EnableSaveTIFRendition
Value

Example/default

true/false

EnableSaveTIFRendition=TRUE

Description
Turns on/off the ability to save a TIF file as a Rendition of the file in the Docbase.

19

TaskSpace BravaXParams Guide

EnableSaveTIFNewDocFile
Value

Example/default

true/false

EnableSaveTIFNewDocFile=TRUE

Description
Turns on/off the ability to save a TIF file as a new file to the users home cabinet.

EnableSaveAsMajorVersionTIF
Value

Example/default

true/false

EnableSaveAsMajorVersionTIF=TRUE

Description
Turns on/off the ability to save a TIF file as 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.

EnableSaveAsSameVersionTIF
Value

Example/default

true/false

EnableSaveAsSameVersionTIF=FALSE

Description
Turns on/off the ability to save a TIF file as the same version of the original file, overwriting the
current version. Use with care.

EnableSaveAsMinorVersionTIF
Value

Example/default

true/false

EnableSaveAsMinorVersionTIF=FALSE

Description
Turns on/off the ability to save a TIF file as the next logical minor version of the original file.

AutoNameTIFImport
Value

Example/default

true/false

AutoNameTIFImport=FALSE

Description
Turns on/off the ability to have the TIF file automatically name itself when saved. If set to true, user is
not allowed to manually enter a name.

DefaultTIFPublishOption
Value

Example/default

FILE, EMAIL, RENDITION, NEWDOCFILE,


MAJORVERSION, MINORVERSION,
SAMEVERSION

DefaultTIFPublishOption=

20

Integration Specific Parameters

Description
Sets the Default Publish/Save method for the TIF Publish Option.
Hint: Setting a default method and turning off the individual options will allow you to restrict the
Publish Option to a single option. Set AutonameTIFImport to TRUE will allow for only 1 method and
without prompting.

File New file to local system


Email New file as email attachment (Exchange or Outlook only)
Rendition To Docbase as a TIF rendition
NewDocFile New File to Docbase Home Cabinet
MajorVersion As a New Major Version to the original file
MinorVersion As the next logical minor version of the original file
SameVersion Overwrites current file version

TASKSPACE PERMISSIONS PARAMETERS


MARKUP PERMISSIONS

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

Example/default

true/false

enablemarkupreview=false

Description
Turns on/off the ability to Review a markup.

EnableSingleEditableMarkup
Value

Example/default

true/false

enablesingleeditablemarkup=false

Description
If TRUE, only one markup can be created for 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.

RELATE_<>
Value

21

Example/default

TaskSpace BravaXParams Guide

RELATE_EnableMarkupNew=true
RELATE_EnableMarkupSaveAs=true
true/false

RELATE_EnableMarkupReview=true
RELATE_EnableMarkupSave=true
RELATE_EnableMarkupOpen=false

Description
The markup permissions in the section above are overwritten depending on the permission settings of
the RELATE permission: RELATE_EnableMarkupXX. These can be modified to fit your needs.
RELATE_EnableMarkupNew - Turns on/off the ability to create a New markup.
RELATE_EnableMarkupSaveAs -Turns on/off the ability to Save a Markup As..
RELATE_EnableMarkupReview-Turns on/off the ability to Review a markup.
RELATE_EnableMarkupSave - Turns on/off the ability to save a markup without giving a markup
open for editing a new name.
RELATE_EnableMarkupOpen - Turns on/off the ability to Open a markup for edit.

HRELATE_<>
Value

Example/default

true/false

HRELATE_EnableMarkupNew=true
HRELATE_EnableMarkupSaveAs=true
HRELATE_EnableMarkupReview=true
HRELATE_EnableMarkupSave=true
HRELATE_EnableMarkupOpen=false

Description
The HRELATE permissions override the RELATE permissions, if set.

PRINT, PDF RENDITION, AND STAMP TEMPLATE PERMISSIONS


Disable_printing_for_these_formats
Value

Example/default

Coma separated list of


supported document formats

disable_printing_for_these_formats=

Description
Adding a format to this comma delimitated list disables printing through Brava if the current
document's format is in this list.
Note that if printing is disabled for PDF files, then printing of PDF renditions will also be disabled. For
example, if UsePdfRendition is TRUE, then all files that have PDF renditions will have the PDF
rendition loaded for viewing in Brava and not the original file format. Because these are PDF files,
which may not be obvious to the end-user, the disable printing for PDF format will be active.

Printing_Control_For_Groups
Value

22

Example/default

Integration Specific Parameters

true/false

Printing_Control_For_Groups=FALSE

Description
Turns on/off print control for groups.

Printing_Control_For_Users
Value

Example/default

true/false

Printing_Control_For_Users=FALSE

Description
Turns on/off print control for users.

Disable_These_Groups_For_Printing
Value

Example/default

Coma separated list of valid


Documentum Groups

disable_These_Groups_For_Printing = "Standard
\"Group\" One " ;

Description
Controls printing functionality of all valid listed groups. If you use the ( ) character for a value in this
parameter, it must be encoded. For example, if Group Name: Standard "Group" One needs to have
printing disabled. The correct value would be Standard \"Group\"One.

Disable_These_Users_For_Printing
Value

Example/default

Coma separated list of valid


Documentum Users

disable_These_Users_For_Printing = "Standard
\"User\" One " ;

Description
Controls printing functionality of all valid listed users. If you use the ( ) character for a value in this
parameter, it must be encoded. For example, if User Name: Standard "User" One needs to have
printing disabled. The correct value would be Standard \"User\"One.

PDF_Rendition_Control_For_Groups
Value

Example/default

true/false

PDF_Rendition_Control_For_Groups=TRUE

Description
Turns on/off PDF rendition viewing access for groups when UsePDFRendition is enabled

PDF_Rendition_Control_For_Users
Value

Example/default

true/false

PDF_Rendition_Control_For_Users=FALSE

Description

23

TaskSpace BravaXParams Guide

Turns on/off PDF rendition viewing access for users when UsePDFRendition is enabled

Disable_These_Groups_For_Viewing_PDF_Rendition
Value

Example/default

Coma separated list of valid


Documentum Groups

disable_These_Groups_For_Viewing_PDF_Rendition=

Description
Controls group access to viewing the PDF Rendition of a file when UsePDFRendition is enabled.

Disable_These_Users_For_Viewing_PDF_Rendition
Value

Example/default

Coma separated list of valid


Documentum Users

disable_These_Users_For_Viewing_PDF_Rendition=

Description
Controls User access to viewing the PDF Rendition of a file when UsePDFRendition is enabled.

Allow_These_Groups_To_Control_Stamp_Templates
Value

Example/default

Coma separated list of valid


Documentum Groups

Allow_These_Groups_To_Control_Stamp_Templates=

Description
Controls group access to creating stamp templates.

Allow_These_Users_To_Control_Stamp_Templates
Value

Example/default

Coma separated list of valid


Documentum Users

Allow_These_Users_To_Control_Stamp_Templates=

Description
Controls user access to creating stamp templates.

Note: Based on the above permission sets with Printing, Stamp Templates, and Disabling
PDF Renditions where Permissions can be set based on Groups and Users, setting control to
both (by Group and User) will result in the default (User) overriding the Group setting.
Example:
Printing_Control_For_Groups=TRUE
Printing_Control_For_Users=FALSE
PDF_Rendition_Control_For_Groups=FALSE
PDF_Rendition_Control_For_Users=TRUE

24

Integration Specific Parameters

TASKSPACE LICENSING PARAMETERS

The following parameters control licensing behavior:


Licensing_Control_For_CAD_Groups
Value

Example/default

true/false

licensing_control_for_cad_groups=false

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

Licensing_Control_For_CAD_Users
Value

Example/default

true/false

licensing_control_for_cad_users=false

Description
Turns on license checking based on users. If this value is set to true, when Brava is launched, it
checks to see if the current user is listed in the License_These_Users_For_CAD parameter. If
found, the user is given a CAD license.

Licensing_Control_For_Documents_Groups
Value

Example/default

true/false

licensing_control_for_document_groups=false

Description
Turns on license checking based on groups. If this value is set to true, when Brava is launched, it
checks to see if the current user is listed in the groups for the
License_These_Groups_For_Documents parameter. If found, the user is given a Document
license.

Licensing_Control_For_Documents_Users
Value

Example/default

true/false

licensing_control_for_document_users=false

Description
Turns on license checking based on users. If this value is set to true, when Brava is launched, it
checks to see if the current user is listed in the License_These_Users_For_Documents parameter.
If found, the user is given a Document license.

License_These_Groups_For_CAD
Value

Example

Any valid group in Document.


Default is empty.

license_these_groups_for_cad=group1,group2,group3

25

TaskSpace BravaXParams Guide

Description
List the groups that Brava checks to see if the user is a part of. If the user is found in one of these
defined groups, the user receives a CAD license. The groups should be comma deliminated. Assuming
Licensing_Control_For_CAD_Groups is set to TRUE.
The following table lists the name Brava is checking for with the various options:
stamp users

user_name

markup ownership

login_user_name

printing control
users

user_name

license_control user

login_user_name

Rendition view user

user_name

License_These_Groups_For_Documents
Value

Example

Any valid group in


Document. Default is
empty.

license_these_groups_for_documents=group4,group5,group6

Description
List the groups that Brava checks to see if the user is a part of. If the user is found in one of these
defined groups, the user receives a Document license. The groups should be comma deliminated.
Assuming Licensing_Control_For_Document_Groups is set to TRUE.
The following table lists the name Brava is checking for with the various options:
stamp users

user_name

markup ownership

login_user_name

printing control
users

user_name

license_control user

login_user_name

Rendition view user

user_name

License_These_Users_For_Documents
Value

Example

Any valid user in Document.


Default is empty.

license_these_users_for_documents=user1,user2,user3

Description

26

Integration Specific Parameters

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

License_These_Users_For_CAD
Value

Example

Any valid user in Document.


Default is empty.

license_these_users_for_cad=user1,user2,user3

Description
List of users that Brava checks to see if the current user is part of. If the user is listed as one of these
defined users, a CAD license is issued. The users should be comma deliminated. Assuming
Licensing_Control_For_CAD_Users is set to TRUE. Note that this parameter uses the Users short
login name (e.g., Log-in name = johnd), and not the full TaskSpace name (e.g., Full TaskSpace name
= John Tester Doe)

LICENSING CONTROL PRECEDENCE


Based on the above permission sets, if the user/group falls into more than one possible
user/group slot, they will receive the last checked license. For instance, if
Licensing_Control_For_Documents_Groups is set to TRUE and the current user falls into
one of the defined groups in the parameter License_These_Groups_For_Documents
while at the same time Licensing_Control_For_CAD_Users is set to TRUE and the user
also falls into that slot, the user will receive a CAD license and NOT a Document license.
The order or precedence when license control is enabled for both Groups and Users is as
follows:
License_These_Groups_For_Documents
License_These_Groups_For_CAD
License_These_Users_For_Documents
License_These_Users_For_CAD
The user receives the license for the last slot where found.

27

ACTIVEX CLIENT OPTIONAL BRAVAXPARAMS

GENERAL CONTROL PARAMETERS

BravaClientXResourceVersion
Value

Example/default

<URL>

BravaClientXResourceVersion=

Description
This parameter controls whether the BravaClientXResource_XYZ.bin component needs to be
downloaded to a particular client or not, depending on version match. The default value is the value
specified by the required parameter IntegrationVersion.

ClientLogging
Value

Example/default

0-5

ClientLogging=4

Description

ClientLogging determines the level of logging that can be done by the Brava Client.
"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
"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 application to abort
Only ERROR and FATAL messages are logged when the default log level is set to (4) ERROR.

ClientLogFileLength
Value

Example/default

<bytes>

ClientLogFileLength=1000

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

28

ActiveX Client Optional BravaXParams

ClientLogFile
Value

Example/default

<file path>

ClientLogFile=%USERPROFILE%/Application
Data/BravaTaskSpace/Logs/Clientlog.txt

Description
The file path and name on the end users machine where a log file containing Client information can be
written to.

CompareViewMode
Value

Example/default

see string value below

CompareViewMode=Overlay Differences

Description
Determines the display mode in Brava Viewer for files being compared . Possible values for this
parameter are:
OVERLAY DIFFERENCES
OVERLAY
SIDE-BY-SIDE
DELETIONS
ADDITIONS
UNCHANGED
OPEN FILE
COMPARE FILE
TEXT COMPARE

DateFormat
Value

Example/default

<date codes>

DateFormat=%x %H:%M

Description

29

TaskSpace BravaXParams Guide

Determines user-defined pattern for date and time formatting. Note that the DateFormat only applies
to places where the date and time are shown together, such as the Changemark display, the
appended redaction and Changemark notes pages, etc. DateFormat does not apply to the %date
and %time tokens in the banners and watermarks since %date shows only date and %time shows
only time.
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)
%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, with 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, with 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

DefaultBackgroundColor
Value

Example/default

WHITE, GRAY (or GREY),


BLACK, or DEFAULT

DefaultBackgroundColor=DEFAULT

Description
This parameter can be used to specify the background color for Brava to use by default. If the
EnableBackground parameter is set to true, the user can still change the background color via the
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.

DefaultMono
Value

Example/default

true/false

DefaultMono=FALSE

30

ActiveX Client Optional BravaXParams

Description
This setting can be added to specify whether Brava loads color vector files in monochrome mode or in
color. The monochrome mode can still be changed using the Monochrome tool on the toolbar. False
indicates for Brava to load the files in color.

EnableThreadedXdlLoad
Value

Example/default

true/false

EnableThreadedXdlLoad=TRUE

Description
When true, 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. When false, the document loading process
happens in the IE browser's main thread, which can cause conflicts with other applications that need
to receive events from Windows main event loop.

HyperlinkLaunch
Value

Example/default

ONE, DEFAULT, SELF, or TOP

HyperlinkLaunch=DEFAULT

Description
This setting determines how hyperlinks launch in Brava . The valid values are:
one - All documents launch in a single separate window as Brava (two windows).
default 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.
Note: To use the "top" and "self" values for this parameter on a Windows Vista machine, the
site the hyperlink is accessing must be in an IE Security zone (Tools--> Internet Options-->
Security tab) that does not have Protected Mode enabled.

NotificationListener
Value

Example/default

<URL>

NotificationListener=http://localhost/<notificationservlet>

Description

31

TaskSpace BravaXParams Guide

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
MARKUP_OPEN_FOR_REVIEW_COMPLETE
MARKUP_SAVE_COMPLETE
MARKUP_SAVE_AS_COMPLETE
DOC_SENT_TO_PRINTER
MARKUPSTAMPTEMPLATE_CLOSE_TOOL
MARKUPSTAMPTEMPLATE_OPEN_COMPLETE
MARKUPSTAMPTEMPLATE_SAVE_COMPLETE
MARKUPSTAMPTEMPLATE_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.
In the example above, the call would be:

http://localhost/NotificationListener?Event=value&Data=value&User=value
Please refer to the NotificationListenerCustomParams setting below for additional information
about this parameter.

NotificationListenerCustomParams
Value

Example/default

<URL>

NotificationListenerCustomParams=

Description

32

ActiveX Client Optional BravaXParams

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
The resulting call would be:

http://<hostname>/test.asp?Event=value&Data=value&User=value&custom1=value1&cu
stom2=value2
Example:

NotificationListenerCustomParams=Name1=Value1&Name2=Value2&Name3=Value3
NotificationListener=http://MYMACHINE/Project1/MarkupNotification.asp
The query string returned would be:

Name1=Value1&Name2=Value2&Name3=Value3&Event=MARKUP_SAVE_COMPLETE&Data=%5Canot
her+red+cloud&User=John+Johnson

PanelToDisplay
Value

Example/default

0-6, LAST, or NONE

paneltodisplay=4

Description
This parameter controls which of the five available task pane panels display on startup. Valid values
are:
0= Last Panel
1= No Panel
2= Thumbnail Panel
3= Bookmark Panel
4 = Changemark Panel
5= Verify Panel
6= Takeoff Panel
Last = displays the panel that was open when the last Brava session ended
None = starts a Brava session with the Task Pane closed

TabbedPanelWidth
Value

Example/default

<positive whole integer>

tabbedpanelwidth=300

Description

33

TaskSpace BravaXParams Guide

This parameter is an integer that indicates the number of pixels wide to initially display the right-side
tabbed panels (Thumbnail, Bookmark, Changemark, Verify, and Takeoff) when open. The panel can
then be re-sized by the user. Note that this parameter does not cause the panel to be displayed or not
displayed - it only controls the initial width when open.

PersistUserSettings
Value

Example/default

true/false

persistusersettings=TRUE

Description
When true , user settings (markup color, print settings, measurement settings, redaction reasons,
etc) are saved at the end of the session. If false, the settings will not be saved. Settings are stored in
the applications ViewerConfig.xml file and two .ini files, located by default to <user application data
directory>\IGC\<product name>\(ViewerConfig.xml, reason.ini, and measure.ini), or where specified
by UserSettingsPath.
Note that any settings that are specified through the BravaXParams will override any locally persisted
settings. All persistence files for the Brava! Client will either be in the default location as specified
above, or in the directory as specified in UserSettingsPath, but NOT BOTH.
If set to false, the viewerconfig.xml, reason.ini, and measure.ini settings are not read and current
settings are not saved (persisted) in these files at the end of the session.

UserSettingsPath
Value

Example/default

<folder path>

UserSettingsPath=%USERPROFILE%\Application Data\IGC\Brava!
Client
UserSettingsPath=C:\Users\heidim.IGC\AppData\Roaming\IGC\Brava!
Desktop

Description
Specifies the path a user's persisted settings (contained in reasons.ini, measure.ini, and
ViewerConfig.xml) are read from and written to (when PersistUserSettings=true). Brava must
find these files in the directory where the Brava! Client is installed to, or a sub-directory below it,
however, Brava can use the UserSettingsPath setting to specify a custom location of where to find
the Persistence Files. In this case, the custom location of persistence files must be specified in the
UserSettingsPath for this feature to work.
Examples: In this sample, a full path is used to identify a custom ini location:

UserSettingsPath=C:\Program Files\IGC\Brava!\Brava! Client\x7_2\


In this sample, a custom environment identifies this location:

UserSettingsPath=%BRAVACLIENT_HOME%\x7_0\
Note that the persistence files can only be shared amongst multiple users on a machine if the
UserSettingsPath is specified the same for all users.

34

ActiveX Client Optional BravaXParams

SearchTextAtStartup
Value

Example/default

<search term>

searchtextatstartup=

Description
Specifies the term to search to when the document is initially loaded into the viewer. Can be any valid
word, phrase, or alpha numeric string.
Below are the Brava escape codes that can be used with HighlightTerms and
SearchTextAtStartup:
" (quote) is %26quot%3B
' (apostrophe) is %26apos%3B
& (ampersand) is %26amp%3B
< (less than) is %26lt%3B
> (greater than) is %26gt%3B
For example, to search a term at start up such as "Law the parameter would be:

SearchTextAtStartup=%26quot%3BLaw
Where %26 and %3B are typical URL escape codes for ampersand and semi-colon.
When using the prefix-style search string commands (see Brava Online help), you can highlight and
search for multiple terms using the following syntax with the BravaXParams HighlightTerms and
SearchTextAtStartup:
To highlight multiple terms:

HighlightTerms=anyof:wi:&quot;poor dog&quot; cupboard


This example highlights both the phrase "poor dog" and the word cupboard. Each term (i.e. "poor
dog") is highlighted in its own color.
To search for multiple terms:

SearchTextAtStartup=anyof:wi:&quot;poor dog&quot; cupboard


This example will highlight the first of occurrence of either "poor dog" or cupboard, and will allow the
user to go to the next occurrence of either of these terms when they search for the next term.

SecurityOptionsFromServer
Value

Example/default

true/false

securityoptionsfromserver=FALSE

Description
Determines if security settings come from the server, or can be set interactively by the user. When set
to false, the viewer displays the Visual Rights options dialog when publishing a CSF file from a native
file via the "Publish to CSF" menu item. The default is true, which means the rights applied to the CSF
are returned from the Brava Server's security.xml.

TimeZone
Value

Example/default

<see below>

timezone=

Description

35

TaskSpace BravaXParams Guide

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 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 clients operating system (in the
Control Panels Date/Time application) is used.

WatermarkBannerFontName
Value

Example/default

<font name>

WatermarkBannerFontName=Arial

Description
Specifies the default font name to use for Watermarks and Banners. Any valid font can be used (font
must exist on all systems or the font will revert back to the default font if specified font is not
available).

BannerFontSize
Value

Example/default

<font size>

BannerFontSize=12

Description
Specifies the default font size to use for banners.

36

ActiveX Client Optional BravaXParams

WatermarkBannerFontStyle
Value

Example/default

0-3

WatermarkBannerFontStyle=1

Description
This parameter controls the default style used for the Watermark and Banner font. Valid values are:
0= Regular
1= Bold
2= Italic
3= Bold Italic

WatermarkTileSize
Value

Example/default

0-3

WatermarkTileSize=2,3,i

Description
Use these settings to create multiple "tiled" watermarks in printed output or exported PDF and TIFF as
opposed to just the standard single watermark.
The parameter WatermarkTileSize specifies the width and height of the watermark. The format is
"[tilewidth],[tileheight],[unit]" where Unit can be equal to i (for inches) or m (for
millimeters).
In the above example, the watermark should have a width of 2 inches and a height of 3 inches. The
actual watermark tile may be wider and/or taller than the specified parameter value since the
watermark tiles will be stretched so that the page is covered with the watermarks. The number of
watermarks placed along the horizontal or vertical axis will be equal to the size of the output page
along one axis divided by the parameter value for that axis. (The value is truncated to the closest
whole number and is equal to or greater than one).

TOOLBAR AND MENU ITEM CONTROLS

EnableAnimationSetting
Value

Example/default

true/false

EnableAnimationSetting=TRUE

Description
This parameter enables the Enable Animation item in the right mouse button menu.

AnimationSetting
Value

Example/default

ON, OFF, or LAST

AnimationSetting=last

Description

37

TaskSpace BravaXParams Guide

Determines the default state of the Enable Animation setting when EnableAnimationSetting is
true. Last (the default) indicates the state of the setting when the user exited the last Brava session
(either on or off).

EnableBackground
Value

Example/default

true/false

EnableBackground=TRUE

Description
This parameter enables the Background Color item in the right mouse button menu and bottom
toolbar.

EnableBannerEdit
Value

Example/default

true/false

EnableBannerEdit=TRUE

Description
When set to true, this parameter enables the Watermark/Banners menu item from the Print toolbar
button. When false, the menu item is removed and the Watermark/Banners button of the Print dialog
does not open the Banner dialog.

EnableCopyRegion
Value

Example/default

true/false

EnableCopyRegion=TRUE

Description
When set to false, all UI and functionality associated with ability to copy view regions as bmp data to
the Window's clipboard is removed. Copy Region is disabled from the right mouse button menu.

EnableCopyText
Value

Example/default

true/false

EnableCopyText=TRUE

Description
This parameter controls whether copying of text is allowed in Brava. True permits copying of
highlighted text. Use false to disable text copying functionality.

EnableExternalBookmarks
Value

Example/default

true/false

EnableExternalBookmarks=TRUE

Description
Reserved for integrations, this parameter controls whether the External Bookmarks functionality is
enabled. True allows setting session based external bookmarks and enables a bookmarks button on
the main toolbar. Use false to disallow setting external bookmarks.

38

ActiveX Client Optional BravaXParams

EnableEnhancedDisplay
Value

Example/default

true/false

EnableEnhancedDisplay=TRUE

Description
This parameter enables the Smooth Edges (Slower) item in the right mouse button menu. This feature
controls the GDI plus rendering and edge smoothing.

EnhancedDisplaySetting
Value

Example/default

ON, OFF, or LAST

EnhancedDisplaySetting=Last

Description
Determines the default state of the Enable Enhanced Display setting when EnableEnhancedDisplay
is true. Last indicates the state of the setting when the user exited the last Brava session (either on
or off).

Enable<*>Panel
Value

Example/default

true/false

EnableBookmarkPanel=TRUE
EnableThumbnailPanel=TRUE
EnableRedactVerifyPanel=TRUE
EnableTakeoffPanel=TRUE
EnableCheckviewPanel=TRUE

Description
When set to true, Brava will display the specified panel in the right side of the viewing window. If any
of these parameters are set to false, the corresponding panel will not display in the viewer, nor will its
corresponding menu items and hotkeys.
Note that when EnableMeasurement=false, features are disabled within the measurement takeoff
panel regardless of the EnableTakeoffPanel setting value.

EnableChangemarkPanel
Value

Example/default

true/false

EnableChangemarkPanel=TRUE

Description
When true, Brava displays the Changemark panel in the right side of the viewing window. When false,
the Changemark panel does not display in the viewer, nor does its corresponding menu items and
hotkeys. If AutoloadChangemarkPanel or AutoloadChangemark are set, the value of
EnableChangemarkPanel is ignored.

EnableDisplayPanelBar

39

TaskSpace BravaXParams Guide

Value

Example/default

true/false

EnableDisplayPanelBar=TRUE

Description
When set to false, the narrow vertical bar used to show/hide the panels is not displayed.

EnableLayers
Value

Example/default

true/false

EnableLayers=TRUE

Description
This parameter controls whether you can view CAD layers on a drawing file. True allows the viewing of
layers. Use false to disallow the viewing of layers. Note that if set to false, exporting to PDF/CSF will
publish to a single (flat) layer.

EnableMagnifier
Value

Example/default

true/false

EnableMagnifier=TRUE

Description
This parameter controls whether the Magnifier tool is available in Brava. Use false to disable the
Magnifier tool.

EnableMeasurement
Value

Example/default

true/false

EnableMeasurement=TRUE

Description
This parameter controls whether measurement tools and capabilities are available in Brava. True
permits measurements to be created. Use false to disable measurement.

EnableMirror
Value

Example/default

true/false

EnableMirror=TRUE

Description
This parameter controls whether the Mirror feature is available in Brava. ). 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.
Use false to disable the Mirror tool.

EnableMono
Value

Example/default

true/false

EnableMono=TRUE

Description

40

ActiveX Client Optional BravaXParams

This parameter enables/disables the Monochrome tool button. Use false to disable the Monochrome
tool.

EnablePageChangeOnScroll
Value

Example/default

true/false

EnablePageChangeOnScroll=TRUE

Description
When true, scrolling causes the Brava Client to change pages. When false, pages do not change when
scrolling beyond the current page limits.

EnablePrinting
Value

Example/default

true/false

EnablePrinting=TRUE

Description
This parameter controls whether printing is available in Brava. Use false to disable printing.
See also: disable_printing_for_these_formats, printing_control_for_users/groups

EnableRightMouseButtonMenu
Value

Example/default

true/false

EnableRightMouseButtonMenu=TRUE

Description
When false, the menu that normally appears when the right mouse button is clicked (while the cursor
is in the drawing/document viewing window) is suppressed.

EnableThumbnailsResize
Value

Example/default

true/false

EnableThumbnailsResize=TRUE

Description
Controls whether the Page Thumbnails can be resized. When true, the images can be resized by
clicking the right mouse button (over the Thumbnails panel) and selecting Reduce Thumbnail Size, or
Increase Thumbnail Size from the menu. If false, the right mouse menu is disabled and images remain
at the default size.

ThumbnailSize
Value

Example/default

integer

ThumbnailSize=100

Description
Indicates the width in pixels of the largest dimension of individual thumbnail images. Must be an
integer value between 20 and 700.

41

TaskSpace BravaXParams Guide

EnableRotate
Value

Example/default

true/false

EnableRoate=TRUE

Description
This parameter enables/disables the Rotate90 toolbar button.

EnableUserPlacekeepers
Value

Example/default

true/false

EnableUserPlacekeepers=TRUE

Description
When set to false, all UI and functionality associated with PlaceKeepers (listed below) will be removed.
Right Mouse Button or Marks Menu items:
"Add Placekeeper"
"GoTo Placekeepers "
"Remove Added Placekeepers "
Ctrl Keys:
Add PlaceKeeper - Ctrl + K
GoTo PlaceKeepers - Ctrl + Alt + K

DisableClipboardImages
Value

Example/default

true/false

DisableClipboardImages=FALSE

Description
This parameter enables/disables copying images to the Windows Clipboard. If set to TRUE, and the
Viewer control holding this parameter has a print-screen-protected file open, Brava will attempt to
remove any bitmap data contained in the Clipboard.

EnableZoomWindow
Value

Example/default

true/false

EnableZoomWindow=TRUE

Description
This parameter controls whether the Zoom Window feature is available in Brava . Use false to disable
this feature.

ShowExitButton
Value

Example/default

true/false

ShowExitButton=FALSE

Description
When true, an exit button appears in the upper right corner of the Brava viewer. Intended for use
when the viewer is integrated as a component embedded in a browser page.

42

ActiveX Client Optional BravaXParams

PrintMeasurementSystem
Value

Example/default

0 or 1

PrintMeasurementSystem=0

Description
Controls the measurement system initially displayed in the print dialog.
0 = English
1 = Metric

MeasurementSettings
Value

Example/default

<see below>

MeasurementSettings=0|0|0|0

Description
Controls the initial values of the measurement settings dialog. This is a string of four integers,
separated by a |.
The first integer is the measurement system. Valid values are:

0
1
2
3

=
=
=
=

ENGLISH_ARCHITECTURAL
ENGLISH
METRIC
UNITLESS

The second integer is the units. Valid values are:

0
1
2
3
4
5
6
7
8

=
=
=
=
=
=
=
=
=

INCHES
FEET
METERS
MILLIMETERS
CENTIMETERS
MILES
KILOMETERS
UNITLESS
YARDS

The third integer is the distance precision (number of decimal places to display). Valid values are:

0
1
2
3
4
5

=
=
=
=
=
=

MEAS_PREC_1
MEAS_PREC_2
MEAS_PREC_3
MEAS_PREC_4
MEAS_PREC_5
MEAS_PREC_6

The fourth integer is the architectural distance precision (accuracy). Valid values are:

0
1
2
3
4

=
=
=
=
=

ARCH_PREC_ONE
ARCH_PREC_ONEHALF
ARCH_PREC_ONEQUARTER
ARCH_PREC_ONEEIGHTH
ARCH_PREC_ONESIXTEENTH

If the format is incorrect or if the values are inconsistent (i.e. system is English and units are meters),
the parameter value is ignored.

43

TaskSpace BravaXParams Guide

MARKUP AND REDACTION PARAMETERS


AutoloadChangemark
Value

Example/default

GUID

AutoloadChangemark=GUID

Description
This is a markup entity GUID. If a Changemark note having this GUID exists in the currently open
document (i.e. a CSF with burned in markups) or any preloaded markup file(s), that Changemark note
will be "executed" upon load of the document. Note that if this parameter is specified but the GUID
doesn't exist in any preloaded markup, the Changemark panel will be opened as if the
AutoloadChangemarkPanel parameter has been set to true and override any startup panel set in
paneltodisplay. If GUID is set to "<|suppress|>", the changemark will not be loaded.

AutoloadCheckview
Value

Example/default

GUID

AutoloadCheckview=GUID

Description
This is a markup entity GUID, similar to AutoloadChangemark. If it is a valid GUID string of an
existing Checkview, the viewer will activate that Checkview. If it is set to anything that is not a valid
GUID and is not "<|void|>", AutoloadCheckview will activate the first Checkview in the document
(if any exist). If GUID is set to "<|suppress|>", the checkview will not be loaded.

AutoloadChangemarkPanel
Value

Example/default

true/false

AutoloadChangemarkPanel=FALSE

Description
If set to true and any Changemark notes exist in the currently open document or in any preloaded
markup file(s), the Changemark panel is displayed upon load of the document. If the Changemark
panel is auto loaded, the Changemark panel displays and overrides the panel set by the
paneltodisplay setting .

CustomTextHeights
Value

Example/default

<list of text heights to use, in


inches>

CustomTextHeights=0.01|0.05|0.1|0.2|0.3

Description

44

ActiveX Client Optional BravaXParams

This setting defines the list of text heights available in the markup text heights drop-down menu. If
specified, this list will replace the default list of text heights available in Brava. If this parameter is
unspecified, left blank, or is improperly formatted, the text heights menu will be populated with the
default list of options. The flexibility of this parameter allows heights to be defined in increments as
small as one hundredth (.01).
Text heights passed in the parameter will be delimited by the "|" symbol, so for example, the setting
CustomTextHeights=0.01|0.05|0.1|0.2|0.3 will configure the text heights menu to present the
options 0.01, 0.05, 0.1, 0.2, 0.3.
Text annotation size: Font size values are a scale factor relative to the actual size of the drawing or
document currently being viewed. This scaling allows the same font size value to work similarly in
documents that are 8.5 x 11 inches and drawings that may be 200 miles wide in world-space height.

DefaultTextMarkupFont
Value

Example/default

<font name>

DefaultTextMarkupFont=Arial

Description
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
of the markup text properties bar with markup text as the active tool.

EnableConsolidateIfMarkupOpenedForEdit
Value

Example/default

true/false

EnableConsolidateIfMarkupOpenedForEdit=False

Description
If set to false, this parameter disables the Consolidate Markups item on the Markup menu if a markup
is open for edit, regardless of the EnableMarkupConsolidate value. If set to true, the
EnableMarkupConsolidate value must also be true, or this parameter value is ignored.

EnableCopyMarkupToAllPages
Value

Example/default

true/false

EnableCopyMarkupToAllPages=False

Description
If set to true and a multi-page document is being viewed, the "Copy Entities to Designated Pages"
button appears (which prompts an option dialog for copying) when one or more copy able markup
entities are selected. Entities that cannot be copied include edit text entities and Changemark notess.
Note that altering the markup entities after they have been copied to all pages does not affect the
copied entities.

EnableMarkup
Value

Example/default

true/false

EnableMarkup=True

Description

45

TaskSpace BravaXParams Guide

This parameter controls whether markup capabilities are available in Brava. True permits markups to
be created. Use false to disable markups.

EnableMarkupClose
Value

Example/default

true/false

EnableMarkupClose=True

Description
This parameter enables/disables the Close item in the Markup menu.

EnableMarkupCloseForReview
Value

Example/default

true/false

EnableMarkupCloseForReview=True

Description
This parameter enables/disables the Close Review item in the Markup menu and Review button menu.

EnableMarkupColorPalette
Value

Example/default

true/false

EnableMarkupColorPalette=True

Description
This parameter enables/disables the color palette for markups. If disabled (false), the user can only
use the default color to create markup entities.

EnableMarkupChangeOwner
Value

Example/default

true/false

EnableMarkupChangeOwner=False

Description
This parameter enables/disables the ability to transfer ownership 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.

EnableMarkupConsolidate
Value

Example/default

true/false

EnableMarkupConsolidate=True

Description
This parameter enables/disables the Consolidate Markups item on the Markup menu if at least two
markups are open (for edit or for review).

EnableMarkupFontAutosize
Value

46

Example/default

ActiveX Client Optional BravaXParams

true/false

EnableMarkupFontAutosize=True

Description
This parameter controls whether the markup text is resized when the bounding box changes height.
When set to true, text will not resize and will remain at the last text size that was established. When
set to false, the markup text size gets larger as the bounding box is resized taller.

EnableMarkupSaveAsDXF
Value

Example/default

true/false

EnableMarkupSaveAsDXF=True

Description
This parameter enables/disables the Save As DXF item in the Markup menu.

EnableMarkup<toolname>Tool
Value

Example/default

true/false

EnableMarkup<toolname>Tool=True

Description

The following parameters enable/disable specific toolbar buttons from the Markup toolbar.
While the default value for all EnableMarkup<toolname>Tool parameters is true, a value of
false disables the tool or group of tools.
EnableMarkupAbcGroupTool

This parameter enables/disables the ABC text group of


markup tools (Strikeout, Highlight, and Underline).

EnableMarkupArrowTool

This parameter enables/disables the Line Arrow


markup tool.

EnableMarkupBlockoutTool

This parameter enables/disables the Blockout Redact Area


tool.

EnableMarkupBlockoutCarverTool

This parameter enables/disables the Blockout Allow


Area tool.

EnableMarkupChangemarkTool

This parameter enables/disables the Changemark note


markup tool.

EnableMarkupCloudGroupTool

This parameter enables/disables the Cloud group of


markup tools (Cloud and Polygonal Cloud).

EnableMarkupHyperlinkTool

This parameter enables/disables the Hyperlink tool.

EnableMarkupLinearGroupTool

This parameter enables/disables the Linear group of


markup tools (Line, Polyline, Arc, Crossout, Arrrow
Pointer, and Scratchout).

EnableMarkupRasterTool

This parameter enables/disables the markup Raster Entities


tool in the Markup toolbar. The markup status bar will also
contain a 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.

47

TaskSpace BravaXParams Guide

EnableMarkupShapeGroupTool

This parameter enables/disables the Shapes group of


markup tools (Rectangle, Rounded rectangle,
Polygon, and Ellipse).

EnableMarkupSketchGroupTool

This parameter enables/disables the Sketch group of


markup tools (Sketch and Sketch Polygon).

EnableMarkupStampTool

This parameter controls whether the markup stamp


button is displayed on the markup toolbar.

EnableMarkupTextTool

This parameter enables/disables the Text markup tool.

EnableMarkupSelectTool

This parameter enables/disables the Markup Select tool.

MarkupToolbarType
Value

Example/default

0, 1, 2, or 3

MarkupToolbarType=0

Description
Sets which markup toolbar displays by default (when preloadmarkupname is set). Possible values
are:
0 = Standard
1 = Redaction
2 = Measure
3 = Measure Takeoff

MarkupColor
Value

Example/default

<color name or RGB value>

MarkupColor=black
MarkupColor=#000000

Description

48

ActiveX Client Optional BravaXParams

This optional parameter is used to specify the default markup color. Valid values are the word
descriptions of the (Web Safe) color, or the hex number for red, green, and blue components
#RRGGBB. Below is the list of valid colors. For example, a valid parameter setting would be:
White

#FFFFFF

Yellow

#FFFF00

Magenta

#FF00FF

Red

#FF0000

Cyan

#00FFFF

Green

#00FF00

Blue

#0000FF

DarkGrey

#666666

Grey

#999999

Olive

#666600

Purple

#660066

Maroon

#660000

Teal

#006666

Pine

#006600

DarkBlue

#000066

Black

#000000

MarkupBlockoutColor
Value

Example/default

<color name or RGB value>

MarkupBlockoutColor=#000000

Description
This optional parameter is used to specify the default redaction blockout color. Valid values are the
word descriptions of the color, or the hex number for red, green, and blue components #RRGGBB.
Please see the list of valid colors listed for MarkupColor.

DisableRedactionBorder
Value

Example/default

true/false

DisableRedactionBorder=False

Description
This parameter enables/disables the drawing of a thin border around redaction areas. The setting
applies to all redactions drawn.

MarkupRasterDirectory
Value

Example/default

<folder path>

Markuprasterdirectory=C:\Documents and
Settings\<user_name>\IGC\StampImages

49

TaskSpace BravaXParams Guide

Description
This is the default path for the raster images used with the Insert Raster Image markup tool. If set,
when a user clicks the Browse button on the Markup properties bar, an Open Image dialog displays to
the directory set in this parameter. Users can select PNG and JPG raster files to be placed and sized
within a Brava markup layer. This parameter overrides the last directory browsed preference saved for
the user. It is recommended that you use a path relative to and within the users profile. The path
starting point of "%USERPROFILE%\\ should help to ensure that the user has the proper permissions
to the raster image files.

MarkupTextBackgroundColor
Value

Example/default

<color name or RGB value>

MarkupTextBackgroundColor=white

Description
This parameter is used to specify the default markup text background color. Accepts the same syntax
values as the MarkupColor parameter.

MarkupTextBackgroundType
Value

Example/default

TRANSPARENT,
BACKGROUNDFILL, or SOLID

MarkupTextBackgroundType=solid

Description
This parameter determines the type of background for the markup text. Valid values are Transparent,
BackgroundFill (Match Display Background Color), and Solid (custom color selection).

PreloadMarkupName
Value

Example/default

<name>

PreloadMarkupName=InitialReview

Description
This parameter specifies 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 file will be loaded as editable. If the file does not exist, it will be created for you.

PreloadReadOnlyMarkupNames
Value

Example/default

<name(s)> or ALL

PreloadReadOnlyMarkupNames=InitialReview,FinalReview

Description
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
file, use the value ALL. The location of the markup file(s) is determined by the values of the
MarkupDirectory and MarkupDirectoryType parameters.

50

ActiveX Client Optional BravaXParams

RedactionScriptsDirectory
Value

Example/default

<name(s)>

RedactionScriptsDirectory=%USERPROFILE%\\IGC\\x7_0\\RedactionScripts

Description
If a directory path value for this parameter is set, any redaction script files (.xrs) contained in this
directory display in Bravas Redact Using Scripts dialog for selection when a user clicks on the Redact
using script(s)/List(s) button. This parameter overrides the last directory browsed preference that was
saved for the users. A directory of sample files contained in RedactionScripts.bin can be downloaded from
the web server via the download.url.RedactionScripts parameter and placed on Brava Clients.

TakeOwnershipOnMarkupConsolidation
Value

Example/default

true/false

TakeOwnershipOnMarkupConsolidation=False

Description
If this setting is true, the markup consolidation action will change the ownership of ALL consolidate
markups entities associated with the drawing to the current user.

UIEditRedlineText
Value

Example/default

true/false

UIEditRedlineText=False

Description
If set to true, when a user edits or creates a new entity with the Markup Text tool, a dialog box
containing an edit box will appear. The user can edit the markup text directly through the dialog. If
the user's system is using a right to left language (such as Japanese or Arabic), the edit box will allow
right to left editing. If set to false, the text edit box is not available and editing/creating right to left
markup text is not possible.

ForceDocViewBehavior
Value

Example/default

true/false

ForceDocViewBehavior=False

Description

51

TaskSpace BravaXParams Guide

If set to true prior to loading a document, the viewer will load the file as a "Document". This means:

1. The document will be opened in Fit Width.


2. The vertical scroll bar will cause page changes when the document is scrolled above the
top or below the bottom of the page area.
3. The mouse wheel will cause scrolling instead of zooming.
4. Text searches only look for single spaces rather than series of spaces.
5. Text search results are panned to include result, rather than panned to center on result.
The value is NOT persisted. Note that setting the forcedocviewbehavior to FALSE or not setting
does NOT cause a file that would normally be treated like a Document to be treated like a Drawing.
This parameter permits the Verify Entire Document viewing mode to work for both drawings and
documents. More specifically, to allow documents that are shaped like drawings to be handled
correctly. All integrations can force the behavior through this parameter.

PUBLISHING PARAMETERS
OUTPUT OPTIONS
EnableSaveView
Value

Example/default

true/false

EnableSaveView=TRUE

Description
This parameter enables/disables the Publish button from the toolbar. If set to false, then the values of
EnableCSFPublish, EnableSaveViewAsJPG, EnablePDFPublish, and EnableTIFFPublish are
ignored since the submenu of the toolbar button will not be available.

PDF EXPORT
EnablePDFPublish
Value

Example/default

true/false

EnablePDFPublish=TRUE

Description
This parameter enables/disables the Publish To PDF menu item from the toolbar Publish button. If
EnableSaveView is set to false, this setting is ignored.

52

ActiveX Client Optional BravaXParams

PDFExportOutputChangemarkInfo
Value

Example/default

true/false

PDFExportOutputChangemarkInfo=FALSE

Description
If set to true, any Changemarks existing on the current document/drawing will have their
Changemarks information appended to the end of the published file.

PDFExportOutputChangemarkInfo affects the UI state of the "Append Changemarks notes"


check box in the PDF Publish Options dialog.

PDFMarkupType
Value

Example/default

BURNIN, COMMENT, or
CHOICE

PDFMarkupType=BURNIN

Description
Determines the type of burn-in performed on a markup layer when publishing a PDF file.
BurnIn - markups are burned into the PDF document.
Comment publishes any markup entities existing on the current document/drawing as PDF
Annotation entities (Comments).
Choice - if this option is set, or if the value is set to anything other than "Comment", markups are
burned into the PDF document and become part of the document image (not PDF Comments). Note
that Brava Changemarks cannot be burned in, and are saved as PDF comments.

TIFF EXPORT
EnableTIFFPublish
Value

Example/default

true/false

EnableTIFFPublish=TRUE

Description
This parameter enables/disables the Publish To TIFF menu item from the toolbar Publish button. If
EnableSaveView is set to false, this setting is ignored.

53

TaskSpace BravaXParams Guide

CSF EXPORT

EnableCSFPublish
Value

Example/default

true/false

EnableCSFPublish=TRUE

Description
This parameter enables/disables the Publish To CSF menu item from the toolbar Publish button. If
EnableSaveView is set to false, this setting is ignored.

JPG EXPORT
EnableSaveViewAsJPG
Value

Example/default

true/false

EnableSaveViewAsJPG=TRUE

Description
This parameter prevents/allows viewers from creating JPG snapshots of the currently viewed CSF file.
Default is true to allow capturing JPG snapshots. If EnableSaveView is set to false, this setting is
ignored.

SaveViewQuality
Value

Example/default

<percentage from 1 to 100>

SaveViewQuality=75

Description
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 quality).

54

You might also like