Вы находитесь на странице: 1из 31

Brava 7.

1 for TaskSpace Integration

Brava! Enterprise 7.1


For TaskSpace 6.7 SP2 Integration

INSTALLATION AND ADMINISTRATION GUIDE


LAST UPDATED, WEDNESDAY, JUNE 26, 2013

Brava 7.1 for TaskSpace Integration

Table of Contents
For TaskSpace 6.7 SP2 Integration .................................................................................. 1
Table of Contents .............................................................................................................. 2
1.0 Preparing to Install Brava for TaskSpace ................................................................... 3
1.1 Supported configurations and Hardware Requirements: ................................................... 3
1.1.1 End-User Machine that Runs the Client Control ......................................................... 3
1.1.2 Application Server Environments for Brava! Enterprise for TaskSpace .......................... 3
1.1.3 Brava! Enterprise Job Processor and Brava! Enterprise Licensing Services .................... 4
1.1.4 Brava TaskSpace Client System Requirements .......................................................... 4
1.2 Hardware Requirements ............................................................................................... 5
1.2.1 Brava Server ........................................................................................................ 5
1.2.2 See Requirements of Application Server ................................................................... 5
1.3 Documentum TaskSpace Setup Requirements ................................................................. 5
1.4 New Integration Features ............................................................................................. 5
2.0 Installing Brava! Enterprise for TaskSpace................................................................. 7
3.0 Configuring your Installation ................................................................................... 18
3.1 Editing the ivf_config.xml File ..................................................................................... 19
3.1.1 Enabling Server Side Publishing ............................................................................ 19
3.1.2 Loading Paths ..................................................................................................... 20
3.1.3 Brava TaskSpace Parameters Used in the ivf_config.xml file ..................................... 23
3.2 Tips and Troubleshooting ........................................................................................... 29
3.2.1 Uninstalling Brava TaskSpace Components ............................................................. 29
3.2.2 Tips: .................................................................................................................. 29
3.2.3 Troubleshooting: ................................................................................................. 30
4.0 Contacting Informative Graphics .............................................................................. 31

Brava 7.1 for TaskSpace Integration

1.0 Preparing to Install Brava for TaskSpace


This guide is provided for the installation and configuration of the Brava for TaskSpace
integration. In addition, a BravaEnterprise_AdminGuide.pdf is provided for advanced Brava
TaskSpace 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 TaskSpace integration. For the average Brava TaskSpace Administrator, this information is a
convenience, but not a necessity in the operation or configuration of Brava for TaskSpace. Some
information in the Core guide may appear to conflict with information provided in this guide.
Information presented in this guide will always take precedence over any information presented
in the Core guide.

1.1 Supported configurations and Hardware Requirements:


(See the Documentum TaskSpace Install Guide for TaskSpace supported configurations)
Installing Brava Enterprise components requires some knowledge of web server/servlet engine
technology.

1.1.1 End-User Machine that Runs the Client Control


Typically, the end-user machine downloads the Brava ActiveX Control for viewing and marking
up of TIFF, PDF, JPEG, CAD formats (DWG, DXF, DWF, DGN) and other Imagining files that are
supported by Brava.
With the introduction of Brava! Enterprise for TaskSpace 7.1, MS Office formats can be viewed
(using server side conversion) when the Job Processor is enabled. (Note that MS Office will need
to be installed on the server where the Job Processor is installed). The purchase of additional
Optional Office Drivers is not needed.
Support for client side viewing of Office files is provided through the Optional Office Drivers,
purchased separately.

1.1.2 Application Server Environments for Brava! Enterprise for TaskSpace


Supported Environments
Documentum TaskSpace 6.7 SP2 Environments:
Windows Server 2008 R2 SP1 (x64 Edition)
Oracle WebLogic Server 12c (12.1.1)*
Sun Java JDK 1.6.0_29*
Windows Server 2008 R2 SP1 (x64 Edition)
Apache Tomcat 7.0.33*
Sun Java JDK 6.0_31*
3

Brava 7.1 for TaskSpace Integration

*32-bit Version for Microsoft Windows Only


Note that if you are using both Brava for Webtop and Brava for TaskSpace, these two
integration packages cannot be installed on the same server. Doing so is unsupported and
if attempted, you will need to revert the machine back to a state prior to the installations to
run the installs on two separate servers.

1.1.3 Brava! Enterprise Job Processor and Brava! Enterprise Licensing Services
Windows XP Professional SP3 (32\64 bit)
Windows 2003 Server SP2 (32\64 bit)
Windows Server 2008 (32\64 bit)
Windows Server 2008 R2 (64 bit)
Windows Server 2008 R2 SP1 (64 bit)
.NET Framework: 4.0

Office version: Microsoft Office 2010 (32 and 64 bit), Microsoft Office 2007 SP2, or
Microsoft Office 2003 with 2007 compatibility pack*
*Although Office 2003 is supported, some JobProcessor features, such as XPS publishing
(SaveAsXPS), are not available with this version.
*If using Microsoft Office 2007 or 2007 SP1, you should have SaveAsXPS installed on your
system prior to installing the Brava Enterprise Job Processor. To do this, you can download
the Microsoft Save As XPS add-in from:
http://www.microsoft.com/downloads/en/details.aspx?familyid=BCE8F991-F0A4-47A0866B-2FD84A329E02&displaylang=en or update your Office version to 2007 SP2 or Office
2010.
*When installing to a Japanese environment only, please follow the instructions provided
through this link for switching Office IME 2007 and Legacy MS IME:
http://support.microsoft.com/kb/932104/ja

1.1.4 Brava TaskSpace Client System Requirements


Windows 7 Professional (64-bit) with Internet Explorer 8.0**
Windows 7 Professional (64-bit) with Internet Explorer 9.0**
Supported Client Browser (Brava ActiveX Client)
Internet Explorer 8.0**
Internet Explorer 9.0**
**Internet Explorer 32-bit Version Only

Brava 7.1 for TaskSpace Integration

1.2 Hardware Requirements


1.2.1 Brava Server
At least a Pentium 3 (or equivalent) 1.5GHZ with1024MB RAM (1536MB or higher
recommended).
125MB available hard disk space to install Brava 7.1 for TaskSpace files.

1.2.2 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)

1.3 Documentum TaskSpace Setup Requirements


The following post-installation steps are required to use the Brava for TaskSpace Integration:
1. In Forms Builder, open or create a document view template. For detailed instructions,
refer to the Documentum Forms Builder User Guide.
2. Install the Document Image Services DAR. For instructions, refer to the Documentum
Document Image Services Deployment Guide.

1.4 New Integration Features


The following features and enhancements have been added to the Brava/TaskSpace integration.
Integration with Brava 7.1 new features include:

Support TaskSpace 6.7 SP2

Integration with Brava 7.0 SR1 new features include:

Support TaskSpace 6.6 patch 14


Support TaskSpace 6.7 SP1
Compare of two files from TaskSpace (with TaskSpace 6.7 SP1 Only)
Support Stamp directory location
DRL Link - support Weblink (with TaskSpace 6.7 SP1 Only)
Support for %dbupdatestring (with TaskSpace 6.6 Patch 14 & 6.7 SP1)

Integration with Brava 7.0 new features include:

Brava 7.1 for TaskSpace Integration

Support of the Brava! Job Processor for server side conversion of files
Support %dbstring
Printing based on User or Group
Stamp Template based on User or Group

Brava 7.1 for TaskSpace Integration

2.0 Installing Brava! Enterprise for TaskSpace


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

If you have purchased more than one IGC product or integration, installing these various
products on the same server (or using one instance with multiple products or integrations)
is not supported.
Multiple product integration components cannot be installed on the same Brava Server or
Job Processor: Although various integrations use the same Brava components (Brava
Enterprise Server, Brava Enterprise Job Processor, and Brava Enterprise License Server),
the actual versions of these Brava Components are not identical and therefore must be
installed on separate servers and cannot be shared between the two.
This restriction also applies to the Brava ActiveX control that is used with various
integrations. The integrations include different versions of the Brava ActiveX control and
therefore both cannot be installed at the same time on a single client machine.

Brava 7.1 for TaskSpace Integration

1. Run the Installation by clicking on the web package file that you downloaded. A Demo
Shield installation browser launches automatically. Select the Install Brava! for
TaskSpace button to begin the installation.

2. On the Welcome screen, click Next.

3. On the License Agreement screen, click I accept.. If you have read and agree to the
terms contained in the product license. Click Next.

Brava 7.1 for TaskSpace Integration

4. Select which Brava Enterprise components you would like to install on this machine. You
can install the components on the same or different machines. Click Next.

5. Microsoft .NET Framework 4.0 is a requirement of Brava! Enterprise If .Net Framework


4.0 and Microsoft Visual C++ 2008 and 2010 Redistributable Packages are not detected
on the TaskSpace server you will receive the following screen. These installations will
run if not detected, and a system and setup restart will be required. If these
components are installed skip to step #6.

Brava 7.1 for TaskSpace Integration

6. At this point, Brava will check to see that IGC writer is installed, and is the correct version.
If not detected, the IGC Writer installation begins or updates to the correct version. The
Brava Enterprise installation should now detect the correct version of the IGC Writer printer
driver and continue with the installation.
(Skip to step #7 if IGC Writer is already installed)
a. IGC Writer Installation: If the setup did not detect the correct version, the IGC Writer
installation begins to install the IGC Writer printer driver. If you already have the correct
version installed, skip this section. On the Welcome screen, click Next>, then click Yes
on the license agreement screen after you have read and agreed to the terms of use.

10

Brava 7.1 for TaskSpace Integration

b. In the Choose Destination Location screen, set the desired destination folder or accept
the default location. (IGC strongly recommends accepting all the defaults.) Click Next.

c. In the Ready to Install the Program screen, click Install

11

Brava 7.1 for TaskSpace Integration

d. When installation has completed, click Finish at the InstallShield Wizard Complete
screen. The Brava Enterprise installation continues.

Note: It is recommended that the IGC Writer be installed under the same user
account as the Job Processor. If you are running the Job Processor under a different
account, you may have to manually set the CSF Writer properties for print-publishing
to work correctly, but this setup is not recommended, nor has it been certified.

12

Brava 7.1 for TaskSpace Integration

7. If detected, the Brava installer will display the Tomcat version currently installed and
make it available for selection, or you may select Use different or undetected servlet
engine. Select the setup type of install and click Next.

Notes:
If you have elected NOT to use Tomcat (e.g. WebLogic or Websphere), you are
prompted to select a directory to deploy the Brava Server WAR file from. Its best to
select a common default location for your application server. With an application
server such as BEA WebLogic, it is recommended that WAR 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.
If Tomcat is installed on the installation machine, but is undetected by the
installation (due to the existence of a Tomcat service), choose Use different or
undetected servlet engine. Do not install Tomcat on top of the currently installed
Tomcat instance.
8. The Edit Data screen displays the URL that will be used for communication by the
Brava Client. The URL is broken down into its parts: The default servlet port to use for
Tomcat is 8080. If your application server is not Tomcat, or if you have configured
Tomcat to use a non-default port, enter the application servers communication port
number. Click Next.
URL Prefix: Enter either HTTP:// or HTTPS:// depending on whether the servers are
configured to communicate using SSL and https.
Hostname: 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

13

Brava 7.1 for TaskSpace Integration

Note: If you selected Use different or undetected servlet engine in the previous step,
the following screen will appear during the install so you can input the Destination
Folder.

9. Browse to the location in the deployed TaskSpace from where the Brava Client files are
to be hosted and click Next. The default location will be
C:\<myservletengine>\webapps\taskspace\wdk\imageviewer\

14

Brava 7.1 for TaskSpace Integration

10. Select an installation location for the Brava Server files and click Next.

11. Click Install to begin the installation.

15

Brava 7.1 for TaskSpace Integration

12. Choose YES to install the Brava Enterprise Job Processor and License Server as
a service. Note that choosing No will require you to run the License Server and Job
Processor as console applications inside a login session, which is available on the Start
menu (StartAll ProgramsIGCBrava! License ServerStart Brava! License
Server and StartAll ProgramsIGCBrava! Job ProcessorStart Brava! Job
Processor)

13. Youll be prompted to enter the service username and password information for the
Brava Enterprise License Server and Job Processor Services. Click Next.

16

Brava 7.1 for TaskSpace Integration

14. You will be prompted whether to start the Brava Enterprise License Server and Job
Processor services.

15. The installation is complete. You may be prompted to reboot your system at this time.

17

Brava 7.1 for TaskSpace Integration

3.0 Configuring your Installation


The only file that needs to be edited is the ivf_config.xml file to turn on or off the Brava option you
desire to use.
Note that any changes to ivf_config.xml file will require a restart of the TaskSpace Application
Server for these changes to take effect.
Installing Brava with TaskSpace 6.7 SP2
1. Create a backup of your TaskSpace deployed webapp as a precautionary measure.
2. Manually copy and paste the Brava custom files from your install location to Webapps,
overwriting any files.
IGC:
C:\Program Files (x86)\IGC\Brava!\Taskspace\Custom67sp2
WebLogic:
C:\Oracle\Middleware\user_projects\domains\base_domain\autodeploy\taskspace
Tomcat:
C:\Program Files (x86)\Apache Software Foundation\Tomcat 7.0\webapps\taskspace
Folders custom, wdk, and WEB-INF can be copied to WebLogic's parent directory, but the strings
folder must be placed one directory lower into the parent directory (i.e.,
...\autodeploy\taskspace\taskspace).
For example:
C:\Program Files (x86)\IGC\Brava!\Taskspace\Custom67sp2\custom
TO

C:\Oracle\Middleware\user_projects\domains\base_domain\autodeploy\taskspace\custom
C:\Program Files (x86)\IGC\Brava!\Taskspace\Custom67sp2\strings
TO

C:\Oracle\Middleware\user_projects\domains\base_domain\autodeploy\taskspace\taskspa
ce\strings
C:\Program Files (x86)\IGC\Brava!\Taskspace\Custom67sp2\wdk
TO

C:\Oracle\Middleware\user_projects\domains\base_domain\autodeploy\taskspace\wdk
C:\Program Files (x86)\IGC\Brava!\Taskspace\Custom67sp2\WEB-INF
TO

C:\Oracle\Middleware\user_projects\domains\base_domain\autodeploy\taskspace\WEB-INF
3. In order to publish to CSF format, ensure that the dar (igc_csf_format_67sp2.dar) file is
installed on the content server. The dar file is located in the Brava!\Taskspace\dar
directory.
4. To use Brava in TaskSpace, you must deploy TaskSpace with Document Image Services.

18

Brava 7.1 for TaskSpace Integration

3.1 Editing the ivf_config.xml File


The brava server parameter is populated automatically with the server and port information during
the install. If Brava Server is running a different application server than the one where TaskSpace
is running, the below parameter of the ivf_config.xml file (located in the deployed TaskSpace
application at ..\taskspace\wdk\config\imaging\ivf_config.xml) must be edited to change
the URL to this different TaskSpace server location.
<param>
<name>bravaServer</name>
<value>
http://localhost:port
</value>
<description>Brava Server Hostname</description>
</param>
Edit the file to replace localhost:port with the fully qualified domain name of the system and ort
number that the Brava Server is running on. Replace port with the port configured for the port the
Application Server that the Brava Server is running on.

3.1.1 Enabling Server Side Publishing


Server side publishing can be enabled so that all file conversions of native documents can occur
on a server publishing machine. This is particularly useful when dealing with office documents
which would require the purchase of Optional Office Drivers.
Notes:
With this method enabled (Server Side Publishing), Office documents will be processed on
the Server and therefore not requiring the Optional Office Drivers. The Only requirement
is a server side install of Office.
The publisher, (Job Processor) must be installed when running the Brava for TaskSpace
install in order to use this feature.

To enable this mode alter the following parameters in the ivf_config.xml file:
#EnableConvertOnClientOfficeFormats requires additional purchase
EnableConvertOnClientOfficeFormats=FALSE
EnableConvertOnClientCADFormats=TRUE
EnableConvertOnClientImageFormats=TRUE
ClientLoadedMaxFileSize=2048
ConvertOnClientOFFICEFormats=pptx,docx,xlsx,cdr,dbf,doc,drw,fax,flw,fmt,fwk,htm,h
tml,img,mpp,msg,pcd,pct,pic,pict,pps,ppt,prs,prz,rnd,rtf,sam,shw,vsd,vw,wb1,wb2,w
db,wk1,wk3,wp,wp5,wp6,wpd,wpf,wpg,wq1,wri,ws,xbm,xls
ConvertOnClientCADFormats=906,slddrw,cgm,prt,cit,dwf,dgn,igs,dwg,dxf
ConvertOnClientImageFormats=txt,tif,tiff,pdf,bmp,png,gif,jpg,csf

19

Brava 7.1 for TaskSpace Integration

Optional Steps: The following table lists the parameters (and possible values) contained in the
ivf_config.xml page that you can customize to meet your requirements. 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.
See the Optional Brava ActiveX Parameters in the BravaForTaskSpace_BravaXParamsGuide.pdf
for a detailed list of all possible Brava Enterprise parameters. Note that many of the Brava
ActiveX Parameters that are specified in the ivf_config.xml file, are only used when the file is
viewed in Brava when selecting the TaskSpace "View" command. When a file is viewed in Brava
using the TaskSpace Preview feature, the parameters are pre-set and cannot be changed.

3.1.2 Loading Paths


The path Brava Client takes to load and render a file are determined by the values of the following
parameters:
EnableConvertOnClientOfficeFormats
EnableConvertOnClientCADFormats
EnableConvertOnClientImageFormats
These parameters then use the corresponding formats in their format lists
(ConvertOnClientOFFICEFormats, ConvertOnClientCADFormats, ConvertOnClientImageFormats)
to see if the current document falls into the corresponding EnableConvertOnClient<> parameter.

The format of the file is checked and compared against the 'ConvertOnClientXXXFormats'
parameter. If the format is found as a value of one of those parameters, the parameter
'EnableConvertOnclientXXXXFormats' is checked to see if Brava should load and render the file on
the client:
1. If the format is found and the 'EnableConvertOnClientXXXFormats' is set to TRUE, Brava
checks the file size to determine if it is larger or smaller than the value set for
ClientLoadedMaxFileSize:
a. If the file is smaller, Brava loads the file on the Client and renders it.
b. If the File is larger, Brava then checks to see if page serving is enabled on the
Content Server:
i. If page serving is enabled Brava loads and renders the file on the client.
ii. If page serving is disabled, Brava server/publisher renders the file:
1) If the Content Server is able to provide Brava with an ACS URL (with
no page serving), then Brava sends that ACS URL to the Brava Server.
Brava Server will then use that ACS URL to retrieve the file and publish
it.

20

Brava 7.1 for TaskSpace Integration

2) If the content server is NOT able to provide Brava with an ACS URL,
the Brava component on the webapp server will HTTP POST the file to
Brava Server for publishing.
3) After 1) or 2) above, the file is send back to the Brava client in Brava's
native form for viewing.
2. If the format is not found or the 'EnableConvertOnclientxxxFormats' parameter is set to
FALSE for this format, server side publishing is enabled (see 3.1.1).
a. If the content server is able to provide Brava with an ACS URL (with no page
serving) then Brava sends that ACS URL to the Brava Server. Brava Server will then
use that ACS URL to retrieve the file and publish it.
b. If the content server is NOT able to provide Brava with an ACS URL, the Brava
component on the webapp server will HTTP POST the file to Brava server for
publishing.
c. After a. or b. above, the file is send back to the Brava client in Brava's native form
for viewing

Advanced TaskSpace Loading Paths


Convert On Client

Max Load Size Hit(2mb default)

ACS/BOCS

Load Path*

Yes
Yes
No
Yes
Yes
No

Yes
No
n/a
Yes
No
n/a

No
No
No
Yes
Yes
Yes

A
B
A
C
D
C

*Load Path Legend:


A - File is PUSHed (via a HTTP post call) to the Brava Server. This is executed from the Brava
Component that is running on the TaskSpace Server.
B - File is retrieved and rendered on the client. The client makes a HTTP GET request to image
services that sends back the file.
C - Brava Server directly loads the file using the ACS/BOCS URL (no page serving) that is set in the
Brava Launch Page.
D - Brava Client directly loads the file using the ACS/BOCS URL (using page serving if available)
that is set in the Brava Launch Page.
Important Notes:

If an administrator changes the global parameter useContentServer to FALSE, Brava will


not use any of the ACS/BOCS URLs. If you are processing very large files, ACS/Page serving
must be enabled.

If image page serving is on, Brava will always try to client side load the file.

21

Brava 7.1 for TaskSpace Integration

3.1.2.1 TaskSpace Load Diagrams

22

Brava 7.1 for TaskSpace Integration

3.1.3 Brava TaskSpace Parameters Used in the ivf_config.xml file


The following are required integration parameters. Please see the Brava Enterprise parameters
guide (BravaForTaskSpace_BravaXParamsGuide.pdf) included in your installation for a complete list
of optional Brava parameters which can all be configured through the ivf_config.xml file.
Parameter
IntegrationDllName

Description
This parameter should always be

IntegrationDllName=TaskSpaceIntegration
IntegrationUrl
IntegrationVersion
TaskSpaceMultiSourceCheck

This parameter should be set to the URL of the TaskSpaceIntegration.bin


This parameter should be set to the current Brava for TaskSpace version.
For TaskSpace, this parameter should always be
TaskSpaceMultiSourceCheck=true. This setting tells Brava to do the
following:
a) Perform an HTTP HEAD request using the DocID URL +
&transient=getpagecount::true.
b) Look for the X-Custom-Param1 header.
c)

If present, consider the document to be page-served and set the

23

Brava 7.1 for TaskSpace Integration

page count to whatever follows pagecount= in the X-CustomParam1 header.


If no pagecount is found in the X-Custom-Param1 header, the document
is treated normally, rather than as a page-served document.

The following are optional integration specific parameters.


Parameter
ClientLogging

Value
Valid string values are as follows:
All or 0 designates all levels of
messages are logged.
Debug or 1 designates finegrained informational events that
are most useful to debug an
application.

Description
This is the Level of Logging that can be done
by the Brava TaskSpace Client.
With a logging level set to Error only, Error and
Fatal Messages are logged.

Info or 2 designates informational


messages that highlight the
progress of the application at
coarse-grained level.
Warn or 3 designate 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.
ClientLogFile

Any valid path on the Brava Client


Systems

The path the Brava Client will attempt to write


the client log file.

%USERPROFILE%\\IGC\\x7_1\C
lientlog.txt Default
ConvertOnClient

TRUE - Default
FALSE

This setting determines whether the Client or


Server will convert the native source file to
IGC's display list format which is required by
the Brava Client. If set to true, the Client
converts all TIFF, PDF and JPG formats by
default, plus any licensed CAD and Office
formats. The default is true, meaning the
Client loads and converts native files.
Setting this value to true for the appropriate
formats reduces the load on the server by
shifting conversion to the client.

EnableThumbnails

TRUE Default
FALSE
TRUE
FALSE Default

Turns the Page Thumbnails feature on/off.

SecurityOptionsFro
mServer

Turns on/off getting the CSF security options


(the security.xml file) from the Brava Server
and not interactively from the user.

24

Brava 7.1 for TaskSpace Integration

TaskSpaceSuppress
Messages

A delimited list of IDs

A delimited list of IDs for info and error


messages to suppress. The delimiter is "<|>".
For example, to suppress messages with IDs 5,
10, and 15, the parameter value would be
"5<|>10<|>15". (A list of supported message
IDs is documented in the Brava Enterprise
ActiveX Client API Guide.)

EnableChangeMark
Panel

TRUE Default
FALSE

When true, Brava displays the Changemarks


panel in the right side of the viewing window.
When false, the Changemarks panel does not
display in the viewer, nor does its
corresponding menu items and hotkeys.

EnableBookmarkPa
nel

TRUE Default
FALSE

When set to true, Brava will display the


Bookmark panel in the right side of the viewing
window. If set to false, the Bookmark panel will
not display in the viewer, nor will its
corresponding menu items and hotkeys

EnableRedactVerify
Panel

TRUE Default
FALSE

When set to true, Brava will display the Verify


redactions panel in the right side of the viewing
window. If set to false, the Verify panel will not
display in the viewer, nor will its corresponding
menu items and hotkeys

EnableTakeoffPanel

TRUE
FALSE Default

When set to true, Brava will display the Takeoff


panel in the right side of the viewing window. If
set to false, the Takeoff 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

EnableDisplayPanel
Bar

TRUE Default
FALSE

When set to false, the narrow vertical bar used


to show/hide the panels is not displayed.

PanelToDisplay

1 (no panel)

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 = Changemarks Panel
5= Verify Panel

EnableCopyText

TRUE Default
FALSE

This parameter controls whether copying of


text is allowed in Brava. True permits copying
of highlighted text. Use false to disable text
copying functionality.

EnableThumbnailsR
esize

TRUE Default
FALSE

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 Page
Thumbnails, or Enlarge Page Thumbnails from

25

Brava 7.1 for TaskSpace Integration

the menu. If false, the right mouse menu is


disabled and images remain at the default size.
EnablePDFPublish

TRUE Default
FALSE

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.

EnableTIFFPublish

TRUE Default
FALSE

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.

UserSettingsPath

Default value is

Specifies the path a user's persisted settings


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

PersistUserSettings

Default value is

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
configuration files, located in the directory
specified by UserSettingsPath.

%USERPROFILE%\IGC\x7_1\

%USERPROFILE%\IGC\x7_1\

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 configuration settings are
not read and current settings are not saved
(persisted) in these files at the end of the
session.

The following parameters control markup and redaction behavior.


MarkupRasterDirectory

Default value is

%USERPROFILE%
\IGC\x7_1\Stamp
Images

Sets the default path for the Markup Raster tool. The
path must be set using double back slashes to work
properly. It is recommended that you use a path
relative to and within the users profile. The path
starting point of %USERPROFILE%\\ should help to

26

Brava 7.1 for TaskSpace Integration

EnableMarkupClose
EnableMarkupBurnin
RedactionScriptsDirectory

UIEditRedlineText

ensure that the user has the proper permissions to the


raster image files.
Turns on/off the markup menu option to close open
(for editing) markups.
Turns on or off Bravas ability Burn-in Markups and
output a CSF file.

TRUE Default
FALSE
TRUE Default
FALSE
Default value is

%USERPROFILE%
\IGC\x7_1\Redac
tionScripts

TRUE
FALSE

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

The following parameters control markup permissions and default markup permissions for users
with READ access.
EnableMarkupNew
EnableMarkupReview
EnableMarkupOpen
EnableCopyMarkupTo
AllPages

TRUE
FALSE
TRUE
FALSE
TRUE
FALSE
TRUE
FALSE

Default
Default
Default
Default

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


Turns on/off the ability to Review a markup.
Turns on/off the ability to open a markup for edit.

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 Changemarks. Note that
altering the markup entities after they have been
copied to all pages does not affect the copied entities.

The following parameters control printing and stamp template permissions for users.
Printing_Control_For_Gro
ups
Printing_Control_For_Use
rs

TRUE
FALSE Default

Turns on/off print control for groups.

TRUE
FALSE Default

Turns on/off print control for users.

27

Brava 7.1 for TaskSpace Integration

Disable_These_Groups_Fo
r_Printing

Diable_These_Users_For_
Printing

Allow_These_Groups_To_
Control_Stamp_Templates
Allow_These_Users_To_C
ontrol_Stamp_Templates
EnableNewMarkupStampT
emplate
EnableOpenMarkupStamp
Template
EnableSaveMarkupStampT
emplate
EnableSaveAsMarkupStam
pTemplate
EnableCloseMarkupStamp
Template

Coma separated
list of valid
TaskSpace
Groups
Coma separated
list of valid
TaskSpace Users
Coma separated
list of valid
TaskSpace
Groups
Coma separated
list of valid
TaskSpace Users
TRUE
FALSE Default

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.
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.
Controls group access to creating stamp templates.

Controls user access to creating stamp templates.


These stamp template parameters may be set to
TRUE only if one or both of the Allow parameters
have been defined with at least one group or user
name:

Allow_These_Groups_To_Control_Stamp_Temp
lates=
Allow_These_Users_To_Control_Stamp_Templ
ates=

* The following parameters are set by the integration and should not be altered. Changing them
has no effect on how markups behave.

EnableMarkup=
EnableMarkupSave=
PreloadReadOnlyMarkupNames=
WarnOnUnsavedMrkClose=
EnableSaveAsDXF=
EnableMarkupSaveAs=
EnableMarkupNew=
GetMarkup=
MarkupList=
CreateMarkup=
UpdateMarkup=
UserName=
PreloadMarkupName=

28

Brava 7.1 for TaskSpace Integration

3.2 Tips and Troubleshooting

3.2.1 Uninstalling Brava TaskSpace Components


To uninstall individual components of Brava! for TaskSpace:
1. Run Control Panel, Programs and Features. Click Brava! Enterprise and then click
Change.
2. The Brava! Enterprise InstallShield Wizard displays. Select Modify Brava Components and
then click Next.
3. Uncheck the component(s) that you would like to uninstall and click Next. If you are
uninstalling the Brava! Enterprise JobProcessor, you will also need to separately uninstall
the IGC Writer.
4. Restart your TaskSpace server.
To completely uninstall Brava! for TaskSpace:
1. Run Control Panel, Programs and Features. Click Brava! Enterprise and then click
Uninstall.
2. If during the Brava! Enterprise for TaskSpace install you installed the Brava! Enterprise
JobProcessor option, in addition to uninstalling Brava! Enterprise, you will also need to
uninstall the IGC Writer.
3. Manually copy the original backup ivf_config.xml file from the saved backup location and
copy it into the \taskspace\wkd\config\imaging directory.
4. Restart your TaskSpace server.

3.2.2 Tips:
Ensure that the ivf_config.XML is configured properly
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.
For Brava 7.1 for TaskSpace, the Client MSI packages can be found in the root of the Brava!
folder: C:\Progam Files (x86)\IGC\Brava!\Client MSI The default location for the
extraction is %userprofile%\IGC\x7_1
Where are the markups stored for Brava for TaskSpace? Markups created within Brava for
TaskSpace are stored within the annotations folder in the root folder defined for the

29

Brava 7.1 for TaskSpace Integration

TaskSpace folder tab. If you create a TaskSpace Folder tab whose root folder path is defined
as: /Demo Files/Brava for TaskSpace, when a user views a file from this TaskSpace folder
tab, the markups saved will be stored in the "annotations" folder within the repository under
/Demo Files/Brava for TaskSpace/annotations

3.2.3 Troubleshooting:
If an administrator changes the global parameter useContentServer to FALSE, Brava will not
use any of the ACS/BOCS URLs. If you are processing very large files, ACS/Page serving must
be enabled.
When "Checking-In" another file type using "Upload From the File System" (for the purpose of
comparing two files), it is important to pick the proper format type of the checked-in file.
Failure to do so, may display a different extents of one of the files.
If you are using the Preview Panel and are searching for files using the Search Tab, you will
need to set the Preferences of the Document Preview to one of the following settings:
View expanded
Show the document in a pop-up window
The framework does not support custom viewers. Because of this, Renditions are not
supported.
The ClientLoadedMaxFileSize parameter in the ivf_config.xml file is not honored when using
the "Compare To Version", to compare two files. The size of the compare file will determine if
both files are cached by the Brava! Enterprise JobProcessor.
If you did not install the Brava! Enterprise JobProcessor, you will need to increase the value of
the ClientLoadedmaxFilesSize parameter. It is recommended to increase the size to that of
largest file size in your repository.
When adding a stamp that uses %dbupdatestring(), in order to update the associated
attribute in the repository, you must close Brava in one of these two ways:
1. If the file was opened in Brava using the TaskSpace View command, you must close the
Brava window using the red X in the upper right corner or the Close menu from the window
(also Alt+F4).
2. If the file was opened in Brava using the TaskSpace Open command, you must close the
TaskSpace Open Item by clicking on the small X that appears next to the Object Name for
the tab associated with the opened item.
When using multiple instances of Brava Viewer through TaskSpace, 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.

30

Brava 7.1 for TaskSpace Integration

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

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-354
Phone: (602) 971-6061
E-mail: info@infograph.com
Support: http://www.infograph.com/support/
M - F 5am to 5pm, Arizona time
Web: www.infograph.com
ftp: ftp://ftp.infograph.com/

31