Professional Documents
Culture Documents
Brava! Enterprise
Webtop 6.5 Integration Brava! Client/Brava! Webtop Server/JobProcessor Installation and Configuration Guide
(ActiveX) Version 6.2
Table of Contents
1.0 Preparing to Install Brava Webtop ........................................................................... 2 1.1 Supported configurations: ............................................................................................ 2 1.2 Hardware Requirements ............................................................................................... 4 1.3 Planning Considerations ............................................................................................... 4 1.4 New Integration Features ............................................................................................. 5 2.0 Installing Brava! Enterprise for Documentum Webtop ............................................. 6 3.0 Configuring your Installation ................................................................................. 19 3.1 Copy Custom Contents ............................................................................................... 19 3.2 Installing the DAR File................................................................................................ 21 3.3 Customize Brava JSP Pages ........................................................................................ 22 3.4 Customizing the Webtop Integration components .......................................................... 45 3.4.1 Adding Custom Stamps (Raster Images) ............................................................... 47 3.4.2 Configuring Brava for Webtop in Multi-select Launch Mode ...................................... 47 3.4.3 Enabling additional Brava audit events .................................................................. 48 3.4.4 Disabling the Brava! Flash Viewer ......................................................................... 49 3.5 Uninstalling Brava Webtop Components ........................................................................ 49 4.0 Integration Users Guide ........................................................................................ 50 4.1 Launching Brava Viewer from within Webtop................................................................. 50 4.2 Saving Markups to the Docbase .................................................................................. 50 4.3 Using Term Hit Highlighting ........................................................................................ 51 4.4 Using the Webtop Compare Feature ............................................................................. 51 4.5 Using the External Bookmark Feature .......................................................................... 52 4.6 Using the Watermark Folder Feature ............................................................................ 54 4.7 Bi-directional Stamp Feature Overview ......................................................................... 54 4.8 Brava 6.2 Startup Debugging ...................................................................................... 56 5.0 Troubleshooting Tips .............................................................................................. 57
Brava Webtop Flash Viewer Requirements Flash Version 9 and up Windows XP Professional with Internet Explorer 7 or 8 Windows Vista Professional with Internet Explorer 7 or 8 Windows 7 Professional with Internet Explorer 8 Mac OS X.6 with most up-to-date Flash version Note that ACS must be enabled on the Content Server for Brava Flash Viewer support. Supported Client Browser (Brava ActiveX Client) Internet Explorer 6 SP2 Internet Explorer 7 Internet Explorer 8 Supported Client Browser (Brava Flash Viewer) Internet Explorer 7 (Windows Only) Internet Explorer 8 (Windows Only) Firefox 3.6 (Windows, Mac OS) Safari 4.0.4 and 4.0.5 (Windows, Mac OS) Supported Repositories Federated Content Servers Replicated Content within the Content Server Brava Webtop Support for Documentum BOCS Brava Webtop supports Documentum Branch Office Cashing Server (BOCS) in the following modes: Pull: read only Push: read only Note: While write maybe enabled for the BOCS server, the Brava Webtop integration does not utilize writing to the BOCS server. All writing of Markups and Published Content (PDF, TIFF & CSF Files) can only be written directly to the content server that the file resides in (main Content Server or Federated Content Servers). Caution should therefore be used in Firewall and Routing to allow clients to write Markups and/or Published Content back to the Content Server if such operations are to be permitted in a BOCS' Zone. Failure to permit such traffic in the BOCS Zone will result in failure errors for the Save Markup operation and the Publish File Operations if the Published Content's target is an operation that requires writing the published content to the Content Server. This includes operations such as Save as Major Version, Save to User's Home Cabinet, and Save as Rendition. Publishing Content that does not write content to the Content Server (operations such as Save to Local Path and Attach to Email) are not affected by network configurations in most cases. Seek the advice of your Local Network administrators for Firewall and routing configuration concerns and to plan for a successful deployment of BOCS with Brava for Webtop.
Step 2: From the Brava Enterprise Webtop Welcome screen, click Next>.
Step 3 On the License Agreement screen, click I accept.. if you have read and agree to the terms contained in the product license.
Step 4 Select which Brava Enterprise components you would like to install on this machine. You can install the components on the same or different machines, depending on your scaling requirements. Having multiple Job Processor machines increases scalability.
Step 5 Setup will detect if the IGC Writer Printer Driver is installed, which is a required component for use with Brava Enterprise.
Step 6 IGC Writer Installation If setup did not detect the correct version of IGC Writer, the IGC Writer Printer Driver installation begins. Note that Terminal Services cannot be used to install the Brava IGC writer components for Brava Webtop. You must install the components at the physical machine that the Net-It Enterprise Job Processor is being installed to.
If you already have the correct version installed, skip to Step #11 below. On the Welcome screen, click Next> then click Yes on the license agreement screen after you have read and agreed to the terms of use.
Step 7 In the Choose Destination Location screen, set the desired destination folder or accept the default location. (IGC strongly recommends accepting all the defaults.) Click Next
10
Step 10: Continue with Brava Enterprise Installation The Brava Enterprise installation should now detect the correct version of IGC Writer and continue the installation. Select Use Tomcat, or, if you will be using a different Application Server simply select Use different servlet engine. Click Next
11
If you have elected NOT to use Tomcat, you are prompted to select a location to write the Brava Enterprise WAR file. Its best to select a common default location for your application server. With an application server such as BEA Weblogic, it is recommended that WAR file be
12
placed in a common, accessible place such as the C:\bea\user_Projects\Domains directory to ensure that the file (WAR) is located in a common default location for deployment. Click Next. Step 11 In the Edit Data screen, the default servlet port 8080 is shown. This is the default port to use for Tomcat. If your application server is not Tomcat, or if you have configured Tomcat to use a non-default port, enter the application servers communication port number.
Complete the three fields provided for the Brava Enterprise Webtop Server and click Next: URL Prefix: Enter either HTTP:// or HTTPS:// depending on whether the servers are configured to communicate using SSL and https. Machine: Enter the fully qualified domain name of the server that is used for communicating with the Brava Server. Port: Enter the port number that your application server is using (where Brava Server is running/deployed to). Examples: Tomcat (Default): 8080 Weblogic (Default) 7001 Websphere (Default) 9080 Step 12 In the Enter Webtop Server Information screen, the default server port 80 is shown.
13
Step 13 In the Choose Destination Location screen, browse to or enter the path to install the Brava Enterprise Webtop files. Click Next.
14
Step 14 Click Install to begin the installation of the Brava Enterprise files.
15
During the Brava Server install the Webtop Client portion gets installed to the custom<version>\custom directory. Copy those customizations over to the Webtop machine as per section 3.1. Copying Custom Contents. Step 15 The Job Processor files are installed. Upon completion, you are asked if you would like to install Brava Enterprise JobProcessor as a Service. Select Yes to install the service or No to skip the service setup and complete the Job Processor installation.
Step 16 Enter the Webtop Alias. The Alias is the context path where you installed Documentum Webtop. For example, if the URL used to log in to Webtop is http://<Your Server Name>/webtop, then the application servers context path for Webtop is webtop. By default, this value will be webtop in the Alias screen. Click Next to complete the Brava Webtop Server installation
16
Step 17 Brava Licensing: Choose YES to install the Brava Enterprise License Server as a service. Note that choosing No will require you to run the License Server as a console application inside a login session, which is available on the Start menu (StartAll ProgramsIGCBrava! License ServerStart Brava! License Server).
By default, the Brava Enterprise product installs a 5-user 30 day evaluation key. Once you obtain permanent keys from Informative Graphics, you must copy them to the installation directories to replace the 30 day evaluation keys. These three keys are included in the following two files, which will need to be updated separately:
o The Job Processor IGCKey.lic file (located in your installed \Brava! Enterprise
JobProcessor directory)
o The Brava Server and Brava Client keys contained in the IGCKey.lic file (located in
your \Brava! License Server directory)
Step 18 Youll be prompted to enter the service username and password information for the Brava Enterprise JobProcessor. Click Next.
17
You will be prompted whether to start the Brava Enterprise JobProcessor and License Server services.
Step 19 At the InstallShield Wizard Complete screen, click Finish to complete the installation.
18
Markup Indicator and Term Highlighting Component Installation REQUIRED STEP **IMPORTANT** The Brava 6.2 Webtop Integration requires the following custom class files to be placed in the correct folder in order for the Brava Integration to function correctly and not return errors when Webtop is started. In addition, these steps are required to ensure that the markup indicator and Term Hit Highlighting components are installed for these features to function. 1. Ensure your webapp server is shutdown. 2. In the Brava Server install directory there should exist custom650sp1, or custom650sp2 directory containing a classes sub-folder. Copy the contents of the /brava/classes folder into your Webtop (or Webtop app name) directory /WEB-INF/classes folder. These custom files consist of the following Brava class files (along with their package names): com.infograph.LaunchBravaPrecondition.class This class ensures the object selected has a defined format. If no format is defined for this object, annotation is not allowed. com.infograph.MarkupIndicator.class This class holds the functionality for displaying the markup indicator.
19
com.infograph.drl.DRLComponent.class This class allows Brava to be integrated into Documentum web-links. com.infograph.search.AdvSearchEx.class,com.infograph.search.Search60.class These classes allow Brava's Term Hit Highlighting to be integrated into Webtops Advance search capabilities. Note: Adding these classes may require you to explode/rewar the webtop.war file. Please refer to your webapps documentation for instruction. 3. Once installed, it is recommended that you now redeploy the Webtop application in the application server (or restart the application server completely).
Configure the No Launch Properties File In addition to the class files listed above, a custom properties file is located in the webapp/<webtop>/custom/strings/com/infograph folder called bravaformats.properties. Webtop will check this file when the menus are initialized. Based on the formats found in this properties file, the 'annotation' feature will be disabled if the format is found to match a file type listed in this file. The bravaformat.properties file is formatted as follows: formats=<format> For example: formats=avi,mpg,quicktime,zip,java,win32shrlib,unknown There is no limit to how many formats you can have in this file as long as they are named uniquely. This file should be copied in during the class file copy (outlined above) for the integration installation. The current default formats restricted from annotation include: quicktime mpg avi java (jar) zip win32shrlib (plugins, windows shared library) unknown Note that because this file is read each time the menu is initialized, altering it does not require a restart of the webapp server for Webtop to see your changes.
Configure for the Save Markups with all Versions option (EnableVersions) An additional installation step must be performed to allow the Save Markups with all Version feature to recognize the proper security permissions and work properly:
20
Execute the following DQL line through the administration console, or from the DQL editor in Webtop http://<server>/webtop/component/dql: update dm_relation_type objects set security_type='PARENT' where relation_name='DM_ANNOTATE'; Notes: You must be the docbase owner to execute the above command. If a file with Markups is present and is published as a new Rendition, the markups will be disassociated with the main document unless the markups are saved with the Save with all Versions check box enabled. The parameter EnableVersion must be set to TRUE in the brava_parameters.properties file to make this feature active. Additional Notes for IBM WebSphere Users If you are using IBM WebSphere 6.1.07 (6.1 Fix Pack 7) as the application server servlet engine for the Brava Server, you may need to edit the Brava Servers Properties file to change the parameter check.cache.blocking.timeout= from the default value of 3 to a value of 4 or higher. This should only be needed if you are viewing large files of 12.5MB or larger. If viewing files in excess of 30MB, this value may need to be increased to 5. Changing the Brava Server timing resolves a (500 error) message cache issue (related to how WebSphere works) that may occur when launching large files in Brava from the Webtop Annotate option.
21
inputfile localesFolder
No No
1. Retrieve the DAR file from the workspace or a source control repository and store the file in a directory local to the install script. 2. Create the build file, as described in Creating a build file, page 235. 3. Create the batch file, as described in Creating a batch file, page 236. 4. Open the command line editor on your local machine. 5. Run the Ant task, as follows:
C:\><batch file name>.bat <build file name>.xml
22
Retrieve_content.jsp This is the page that is called by the Brava client to retrieve the document for client side publishing. It uses DFC calls to extract the document and stream it back to the client. Brava_parameters.properties This file, used in combination with markup.jsp, contains all of the Brava viewer parameters that can be customized (such as enable markup, enable printing, etc.) Contained in the custom/config/brava directory, this file can be edited to meet your custom requirements. Customizing Brava for DCTM to launch non-dm_document types in Brava Add the following code to the brava_actions.xml file and alter the <insert their custom type here> to your custom type: <scope type = "<insert their custom type here>"> <action id="brava"> <params> <param name="objectId" required="true"></param> </params> <preconditions> <precondition class="com.infograph.LaunchBravaPrecondition"/> <nlsbundle>com.infograph.bravaformats</nlsbundle> </preconditions> <execution class="com.documentum.web.formext.action.LaunchComponentWithPermi tCheck"> <permit>read_permit</permit> <component>bravaview</component>
<container>brava_container</container>
</execution>
Editing Brava_parameters.properties Follow the steps below to setup brava_parameters.properties to fit your configuration. Note: The Brava Webtop Server install must be complete prior to customizing the Brava Webtop Server parameters via the brava_parameters.properties file. In the install steps above, you copied the contents of the Webtop version-appropriate Custom Directory that contains the integration components into Webtops custom directory. It is very important that you modify the deployed brava_parameters.properties file and not the default file located in the Brava Webtop Server install location. Modifying the un-deployed copy will result in no changes taking place to the active deployed Brava Webtop configuration. Some application servers may require a restart or redeployment the Web Application before the changes in the brava_parameters.properties will take effect. 1. Using a text editor such as Notepad, open brava_parameters.properties, located in the deployed Webtop directory <drive>: \<jakarta install directory>\webapps\webtop\custom\config\brava or \bea\user_projects\dctm\applications\webtop\custom\config\brava. 2. Parameters contained in the section below must be edited with the correct parameter values as dictated by your specific environment and needs. 3. Save and close the .properties file.
23
The following table lists the parameters (and possible values) contained in the brava_parameters.properties page that you can customize for the Brava ActiveX client. Many of these parameters determine which features will be available to viewers using the Brava ActiveX Client. You can choose to enable or disable a feature by setting its value to TRUE or FALSE. It should be noted that the brava_parameters.properties file contains parameters for setting behaviors that are unique to Brava Webtop. Some Brava Enterprise parameters that have no functional behavior for Brava Webtop are not in the brava_parameters.properties so they will not be covered in this section. See the Brava Enterprise core installation guide (Brava_6.2_AdministrationGuide.pdf) for a detailed list of all the Brava Enterprise Client and Server parameters. Note that blank values for parameters will cause the BravaX Client to use the default value in cases were values are defined values other then TRUE or FALSE, or where a Blank value has the effect of turning the parameter off. Brava Webtop Parameters Used in the brava_parameters.properties file
Parameter ServerHostName Value http://<your_server>:Port 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. This parameter adds a hostname for Methods in Class file, adding the ability to specify the brava server parameter for external users. If this parameter is set, Brava will use this brava server hostname to get a Brava session and publish a file (URL calls are made from the webtop server to the brava server). For example, the BravaComponent class (which executes on the webapp, webtop, server) makes calls to the BravaServer. This is valuable when the Brava server has a different name or ip address when it exists outside of a firewall and can be used in cases when the outside users cannot access the Brava server and webtop cannot communicate with the Brava server based on param value. The server_precedence file will not override the url in this situation. 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
ServerHostNameFromWebtop
http://<your_server>:Port
ClientLoadedMaxFileSize
24
Server.
PublishCheck
Turns advanced Brava Enterprise JobProcessor publishing version checking on/off. Sets the ISO Banner Font Size This setting tells Brava which Brava server it should use when using the associated BOCs Server. Pairing allows the use of a local Brava server to cache files rather than to cache them on a remote Brava Server. Example: BOCSBravaServerPairing=BocsServer1|htt p://BravaServer1:8080,BocsServer2|http:// BravaServer2:8080 In this case, if the user was assigned to use 'BocsServer1' from their current login, the Brava Client would be directed to hit the 'BravaServer1' Brava Server which would be local to them and the BOCs server.
BannerFontSize BOCSBravaServerPairing
Any Valid Font Size Possible values: <BocsServer>|http://<BravaS erver>:8080,<BocsServer2>| http://<BravaServer2>:8080,. ....
UseBOCsIfAvailable
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. This is the Level of Logging that can be done by the Brava Webtop Client. With a default logging level set to Error, both Error and Fatal Messages are logged.
ClientLog
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. Info or 2 designates informational messages that highlight the progress of the application at coarse-grained level. Warn or 3 designates potentially harmful situations. Error or 4 (default)
25
designates error events that might still allow the application to continue running. Fatal or 5 designates very severe error events that will cause the application to abort. ClientLogFile Any valid path on the Brava Client Systems %USERPROFILE%/Applicati on Data/BravaWebtop/Logs/Clie ntlog.txt Default Any whole integer value 100000 Default The path the Brava Client will attempt to write the client log file.
ClientLogFileLength
The Number of bytes the log file will allow to before the contents are overwritten.
CompareViewMode
Possible values for this parameter are Overlay Differences, Overlay, SideBy-Side (default), Deletions, Additions, Unchanged, Open File, and Compare File. TRUE - Default FALSE
Determines the display mode in Brava Veiwer for files being compared (as specified by DocId and CompareDocId parameters).
ConvertOnClient
This setting determines whether the Client or Server will convert the native source file to IGC's display list format which is required by the Brava Client. If set to TRUE, the Client converts all TIFF and PDF formats. The default is TRUE, meaning the Client loads and converts native files. Setting this value to TRUE for the appropriate formats reduces the load on the server by shifting conversion to the client. Note that conversion of password protected PDF files is not supported on the Server (when convertonclient=false).
ConvertOnClientCADExtensions
List of CAD document extensions to be converted on the client. Default value is: 000,906,907,bmp,cal,cg4,cg m,cit,cmi,mi,dcx,dft,dg,dgn,d gn7,dif,dwf,dwg,dx,dxf,edc,e dm,ftk,g3,g4,gp4,igs,iso,jpg,j peg,mil,mot,mvs,pcx,plt,prt,p s,rlc,rle,rnl,slddrw,tif,tiff,dsn,rt l,txt,png,hgl,idw,axp,gif,cc,ps d
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.
26
ConvertOnClientOfficeExtension s
List of Office document extensions to be converted on the client. Default value is: cdr,dbf,doc,drw,fax,flw,fmt,fw k,htm,html,img,mpp,msg,pcd ,pct,pic,pict,ppt,pps,ppt,prs,p rz,rnd,rtf,sam,shw,vsd,vw,wb 1,wb2,wdb,wk1,wk3,wp,wp5, wp6,wpd,wpf,wpg,wq1,wri,w s,xbm,xls
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.
ConvertOnClientImageExtension s
List of image format extensions to be converted on the client. Default value is: tif,pdf,bmp,png,gif,jpg,cal, csf A valid path location where all Dll files downloaded for the Brava Client will be placed. (Note that DllPath cannot be a user-specific dynamic location)
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. Users can edit the DllPath BravaXParam within the server_precedence.properties, the HTML page, or client_precendence.properties file (listed in descending order of precedence). All files that are installed from the .cab need to be in the path location specified in DllPath Enables/disables Convert on Client for Office Document formats. Enables/disables Convert on Client for CAD formats. Enables/disables Convert on Client for Image formats.
Allows the documents default background color be overridden (effects all file types).
DllPath
TRUE FALSE - Default TRUE FALSE - Default TRUE Default FALSE DEFAULT Default* BLACK WHITE GRAY (or GREY) TRUE Default FALSE
EnableFileExtensions
Enables/disables the default use of adding the original format file extension to CSF and PDF output from Brava. Turns on/off the Background Color Options.
EnableBackground
EnableBookmarkPanel
When set to true, Brava will display the Bookmark panel in the right side of the viewing window. If set to false, the panel will not display in the viewer, nor will its corresponding menu items and hotkeys.
27
EnableExternalBookmarks
This parameter controls whether the External Bookmarks functionality is enabled. True allows setting session based external bookmarks and enables a bookmarks button on the main toolbar. Use False to disallow setting external bookmarks.
BookmarkTitle<n>
<category>|<title> Category and title can be any valid word, phrase or alpha numeric string
This setting is used to pre-populate the settings listed in the drop down list in the Add Bookmark dialog. Format: BookmarkTitlen=<category>|<title> Where n is any integer (>=1) Examples: bookmarktitle1=mycategory|mytitle bookmarktitle2=my second category|my other title bookmarktitle3= my second category|my newer title In this example, when Brava is launched and a bookmark is added, you will have two categories for selection in the drop down list ('mycategory' and 'my second category'). 'Mycategory' will have only one title option ('mytitle') while 'my second category' will have two titles ('my other title' and 'my newer title')
CapitilizeDbUpdateLabel
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. 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. 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
DbUpdateStringNotRetrieved
HideStampDialogOnPlacement
TRUE FALSE
28
RefreshStampOnCancel
TRUE FALSE
If set to True, when a user cancels out of the bi-directional stamp dialog, the stamp is updated with the most current values from the server. On an initial stamp placement (there must be at least one token that is not a dbupdatestring for the integration to detect initial stamp placement), the stamp is always populated with the latest values from the server, regardless of whether the user selects Cancel. Turns on/ off the users ability to copy text from documents viewed in the Brava Client.
EnableCopyText
EnableDefaultPrivate
Sets the Private option in the markup Save As dialog to be enabled by default.
EnableDefaultVersion
Sets the Version option in the markup Save As dialog to be enabled by default. Note that the Markup Save As dialog does not display at all if EnablePrivate and EnableVersion are set to FALSE, and AutoNameMarkup is set to TRUE.
EnableLayers
Turns on/off Bravas ability to show a documents layers. Turns on/off Bravas Magnifier tool item so it no longer appears on the toolbar.
EnableMagnifier
EnableMeasurement
Turns on/off Bravas Measurement tools and functionality. Turns on/off Bravas ability to mirror raster files (such as Tiff). If the option is on when the user right clicks a raster image in the Brava client, a mirror context menu item will be available.
EnableMirror
EnableMono
29
EnablePrinting
Turns on/off printing in the Brava Client. See also: disable_printing_for_these_formats printing_control_for_users/groups
EnableRotate
Turns on/off the ability to rotate the views of files. Turns on/off the Save/Publish menu button option. This option takes priority over the following parameters settings: EnableSaveViewasJPG, EnableCSFPublishing, and EnablePDFPublishing.
EnableSaveView
EnableSaveViewAsJPG
Prevents/allows viewers from creating JPG snapshots of the currently viewed CSF file.
EnableThumbnails
TRUE Default FALSE TRUE Default FALSE one - All documents launch in a single separate window from Brava (2 windows). default (default value) All documents launch in multiple separate windows (multiple windows). self Documents launch in the frame (if frameset present) that the Brava Viewer is in. top Documents launch in the same instance of the browser window replacing its current contents.
EnableZoomWindow
HyperlinkLaunch
Determines how Brava handles hyperlinks in files being viewed by the Brava Client.
LaunchBravaInNewWindow
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. 2. From the Internet Options dialog, select Settings. Select "Always open Pop-ups in a new tab" from the When a pop-up is
30
encountered section. 3. Optionally, you can select "Always switch to new tabs when they are created" if you want to adjust focus to the Brava window when it is launched. Controls the initial values of the measurement settings dialog. The first integer is the measurement system. Valid values are: 0 = ENGLISH_ARCHITECTURAL 1 = ENGLISH 2 = METRIC 3 = UNITLESS The second integer is the units. Valid values are: 0 = INCHES 1 = FEET 2 = METERS 3 = MILIMETERS 4 = CENTMETERS 5 = MILES 6 = KILOMETERS 7 = UNITLESS 8 = YARDS The third integer is the distance precision. Valid values are: 0 = MEAS_PREC_1 1 = MEAS_PREC_2 2 = MEAS_PREC_3 3 = MEAS_PREC_4 4 = MEAS_PREC_5 5 = MEAS_PREC_6 The fourth integer is the architectural distance precision. Valid values are: 0 = ARCH_PREC_ONE 1 = ARCH_PREC_ONEHALF 2 = ARCH_PREC_ONEQUARTER 3 = ARCH_PREC_ONEEIGHTH 4 = ARCH_PREC_ONESIXTEENTH If the format is incorrect or if the values are inconsistent (i.e. system is English and units are meters), the parameter value is ignored. Example: MeasurementSettings=0|0|0|0 PrintMeasurementSystem 0 = English 1 = Metric Controls the measurement system initially displayed in the print dialog
MeasurementSettings
This is a string of four integers, separated by a |. Integer values are listed in the next column.
31
PaperViewSize
Entered as Width, Height, inches or meters Default value is 22 x 36 inches (entered as 22,36,i)
Scale an image to a particular paper size. The Brava clients render engine can then map the documents world space coordinates to real world coordinates. This value affects the zoom percentage and size of print banners relative to the overall size of the published PDF file.
SaveViewQuality
Any whole number between 1 and 100 (100 is best, 1 is worst, 75 is default) Any Valid Word, Phrase or Alpha Numeric String (has no default value) The valid syntax is: 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, no dzn value.(Default is blank, which local client system time zone) TRUE Default FALSE
Adjusts the quality of the jpeg created with the Save View As JPEG function.
SearchTextAtStartup
Performs a search of the file loaded in the Client using the Value as the search string.
TimeZone
Specifies a single common Time zone for all time/date stamps used by the Brava system.
UseACSIfAvailable
Setting this to False causes Brava to not use ACS (even when Webtop notifies that ACS is working) when Brava is launched. Sometimes Webtop/WDK sends a response that ACS is functioning but will fail to provide a valid ACS URL. This setting provides a means to get past this issue without requiring any code changes. 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.
UseBravaSession
32
WatermarkBannerFontName
Any valid font (font must exist on all systems or the font will revert back to the default font if specified font in not available)
Specifies the default font name for Watermarks and ISO Banners.
WatermarkBannerFontStyle
Valid values are: 0 Plain 2 Italic 1 Bold 3 Bold Italic Valid values are 0, 1, 2(default), or 3
Specifies the default font style to use for Watermarks and ISO Banners.
WatermarkLineSpacing
Specifies the print density of the print watermark. A value of 0 prints the most opaque watermark, while 3 prints the most transparent. 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. 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. Turns on/off getting the CSF security options (the security.xml file) from the Brava Server and not interactively from the user. Turns on/off the Publish as CSF option in the Save/Publish Menu. Turns on/off the ability to save a CSF file as a new to the local system. Turns on/off the ability to save a CSF file as an attachment to an email message (MS Outlook or MS Exchange).
WatermarkFolders
WatermarkFolderName
SecurityOptionsFromServer
EnableCSFPublish
EnableSaveCSFFile
EnableSaveCSFEmail
EnableSaveCSFRendition
Turns on/off the ability to save a CSF file as a Rendition of the file in the Docbase. Turns on/off the ability to save a CSF file as a new file to the users home cabinet.
EnableSaveCSFNewDocFile
33
EnableSaveAsMajVersionCSF
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.
EnableSaveAsMinorVersionCSF
Turns on/off the ability to save a CSF file as the next logical minor version of the original file. 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. 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. 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. Sets the Default Publish/Save method for the CSF Publish Option. Hint: Setting a default method and turn 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.
EnableSaveAsSameVersionCSF
AutoNameCSFImport
AuditBravaView
DefaultCSFPublishOption
Valid values: 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
34
TiffExportOutputMonochrome
If set to TRUE, all published output will be monochrome. If set to FALSE, all published output will be the color of the current document/drawing. This parameter affects the UI state of the radio buttons controlling color output found in the TIFF Publish Options dialog. If set to TRUE, a dialog displays allowing the end-user to set publishing output options. If set to FALSE, no options dialog displays and documents will publish with default options and/or options set by the TIFF Export parameters.
DisplayTIFFExportOptions
DisplayPDFExportOptions
If set to TRUE, a dialog displays allowing the end-user to set publishing output options. If set to FALSE, no options dialog displays and documents will publish with default options and/or options set by the PDF Export parameters.
EnablePDFPublish
Turns on/off the Publish as PDF option in the Save/Publish Menu. This parameter enables/disables the Publish To TIFF menu item from the toolbar Save and Publish button. If EnableSaveView is set to false, this setting is ignored. Turns on/off the ability to save a PDF file as a new to the local file system. Turns on/off the ability to save a TIFF file as a new to the local file system. Turns on/off the ability to save a TIFF file as an attachment to an email message (MS Outlook or MS Exchange). Turns on/off the ability to save a TIFF file as a Rendition of the current file in the Docbase. Turns on/off the ability to save a TIFF file as a new file to the users home cabinet. Turns on/off the ability to save a TIFF file as a new major version of the original file. Note that the user needs to have at least
EnableTIFPublish
EnableSavePDFFile
EnableSaveTIFFile
EnableSaveTIFEmail
EnableSaveTIFRendition
EnableSaveTIFNewDocFile
EnableSaveAsMajorVersionTIF
35
WRITE privileges on the object for the Publish as Major Version option to be available as a publishing option. EnableSaveAsMinorVersionTIF TRUE FALSE Default Turns on/off the ability to save a TIF file as the next logical minor version of the original file.
EnableSaveAsSameVersionTIF
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. Turns on/off the ability to have the TIF file automatically name itself when saved. Sets the Default Publish/Save method for the TIF Publish Option. Hint: Setting a default method and turn 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.
AutoNameTIFImport
TRUE FALSE Default Valid values: 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
DefaultTIFPublishOption
EnableSavePDFEmail
Turns on/off the ability to save a PDF file as an attachment to an email message (MS Outlook or MS Exchange). Turns on/off the ability to save a PDF file as a Rendition of the current file in the Docbase. Turns on/off the ability to save a PDF file as a new file to the users home cabinet. 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.
EnableSavePDFRendition
EnableSavePDFNewDocFile
EnableSaveAsMajVersionPDF
36
EnableSaveAsMinorVersionPDF
Turns on/off the ability to save a PDF file as the next logical minor version of the original file.
EnableSaveAsSameVersionPDF
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. Turns on/off the ability to have the PDF file automatically name itself when saved. Sets the Default Publish/Save method for the PDF Publish Option. Hint: Setting a default method and turn 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.
AutoNamePDFImport
TRUE FALSE Default Valid values: 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 TRUE Default FALSE
DefaultPDFPublishOption
UsePdfRendition
If set to TRUE Brava will use the PDF Rendition of a file is available. If set to FALSE Brava will use the original file. This setting is ignored (disabled) if launching Brava Viewer through the renditions screen. See also: PDF_Rendition_Control_For_Groups and _Users
EnableThreadedXdlLoad
If set to TRUE (the default), the Brava Client control loads documents in a separate thread and does not allow focus to be set to the IE browser during the loading process. If set to FALSE, the document loading process happens in the IE browser's main thread, which can cause conflicts with other applications that need to receive events from Windows main event loop.
37
EnableThumbnailsResize
Controls whether the Page Thumbnails can be resized. If set to TRUE (the default), the images can be resized by clicking the right mouse button (over the Thumbnails panel) and selecting Reduce Page Thumbnails, or Enlarge Page Thumbnails from the menu. If FALSE, the right mouse menu is disabled and images remain at the default size.
EnableMarkup
Turns on/off the Markup option. This is a markup entity GUID. If a changemark 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 will be "executed" upon load of the document if set to TRUE. If set to True and any Changemarks exist in the currently open document or in any preloaded markup file(s), the Changemark panel will be displayed upon load of the document. If the Changemark panel is auto loaded, the Changemark panel will display and override any Thumbnail panel display setting. Determines whether to append pages listing the contents of Changemarks (if they exist on the current file) when publishing to PDF. Indicates how Brava will handle Brava Markup Changemarks when publishing a file to PDF with open markup(s) that contains Changemarks. Only 'Comment' burns in Changemarks as Adobe style annotation entities. Turns on/off the Save Markup as Private function
AutoloadChangemark
AutoloadChangemarkPanel
AddChangemarkInfoPageT oPublishedPDF
PDFMarkupType
EnablePrivate
EnableVersion
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 installation step in section 3.1.
EnableCopyMarkupToAllPa ges
Turns on/off the ability to copy most markup objects to all pages of a file that has an active markup in Brava. (Non copy able entities include strikethrough, Changemarks, and block-out.)
38
EnableMarkupChangeOwne r
Turns on/off the ability to transfer ownership of a markup entity. If set to TRUE, when a user shiftclicks 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.
EnableReviewChangemarks
EnableMarkupConsolidate
This parameter enables/disables the Consolidate Markups item on the Markup menu if at least two markups are open (for edit or for review).
EnableMarkupStampTempl ate
This parameter controls whether the user can create/edit markup stamp templates. Set to False by default (can't create new stamps). This feature will be enabled (True) if the user has Delete access on an object, regardless of the parameter setting in the brava_parameters.properties file.
TakeOwnershipOnMarkupC onsolidate
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.
EnableConsolidateIfMarkup OpenedForEdit
If set to TRUE, this enables the Consolidate Markups item on the Markup menu if a markup is open for edit, regardless of the EnableMarkupConsolidate value.
MarkupRasterDirectory
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 ensure that the user has the proper permissions to the raster image files.
39
PreloadReadOnlyMarkupNa mes
Name (or names, separated by a comma) of a valid markup file in the Docbase for the file being opened or ALL (to open all the markups related to that file).
Preloads the specified markup(s) as read only (Opened for Review) If markup does not exist no markup is opened or created).
PreLoadMarkupName
Name of a markup in the Docbase, if the markup does not exist one will be created for saving with that name.
Enablemarkuparrowtool
TRUE Default FALSE TRUE Default FALSE TRUE Default FALSE TRUE Default FALSE TRUE Default FALSE TRUE Default FALSE TRUE Default FALSE TRUE Default FALSE TRUE Default FALSE TRUE Default FALSE TRUE Default FALSE TRUE Default FALSE TRUE Default FALSE TRUE Default FALSE Any valid color. Color
Enablemarkuptexttool Enablemarkupchangemarkt ool Enablemarkupcloudgroupto ol Enablemarkupsketchgroupt ool Enablemarkuplineargroupto ol Enablemarkupshapegroupt ool Enablemarkupblockouttool
Turns on/off the markup toolbar text tool. Turns on/off the markup toolbar Changemarks tool.
Turns on/off the markup toolbar cloud tools group. Turns on/off the markup toolbar sketch tools group. Turns on/off the markup toolbar lines tools group. Turns on/off the markup toolbar shapes tools group.
Turns on/off the markup toolbar text scratch out, Highlight, Underline tools group. Turns on/off the markup toolbar markup object Hyperlink tool. Turns on/off the markup toolbar raster tool. This parameter controls whether the markup stamp button is displayed on the markup toolbar. Turns on/off the markup menu option to close open (for editing) markups. Turns on/off the markup menu option to close markups open for review. Sets the default markup color to the value specified.
EnableMarkupStampTool
40
name or Hex Values (#RRGGBB or Windows Web Safe Recommended) EnableMarkupBurnin EnableMarkupColorPalette TRUE Default FALSE TRUE Default FALSE TRUE FALSE Default Turns on or off Bravas ability Burn-in Markups and output a CSF file. Turns on or off Bravas markup color palette. Saves Markups to the Docbase as a DXF file. This setting is useful if you want to save markups locally to be opened in AutoCAD. Currently, the file cannot be checked into the Documentum Content Server.
EnableMarkupSaveAsDXF
DefaultTextMarkupFont
Any valid font (must exist on all systems or will revert back to the default font if specified font is not available).
Sets the Default Markup Font for the Markup Text Tool. Effects Markup Text Tools default font.
AutoNameMarkup
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. This parameter controls whether the user can create/edit markup stamp templates. The default value is FALSE for creating new stamps
EnableMarkupStampTempl ate
The following parameters control markup permissions and default markup permissions for users with READ access.
EnableMarkupNew EnableMarkupReview EnableMarkupSaveAs EnableMarkupOpen TRUE FALSE Default TRUE FALSE Default TRUE FALSE Default TRUE FALSE Default TRUE FALSE 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 Save a markup as Turns on/off the ability to open a markup for edit. Turns on/off the ability to save a markup without giving a markup open for editing a new name. If TRUE, only one markup can be created for each user for each file. It will open the existing markup 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.
EnableMarkupSave
EnableSingleEditableMarkup
The markup permissions above are overwritten depending on the permission settings below. These can be modified to fit your needs. RELATE permission grants you the following:
41
TRUE Default FALSE TRUE Default FALSE TRUE Default FALSE TRUE Default FALSE TRUE FALSE Default
Turns on/off the ability to Save a Markup As 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 save a markup without giving a markup open for editing a new name. Turns on/off the ability to open a markup for edit.
RELATE_EnableMarkupOpen
HRELATE_EnableMarkupSave
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.
DO NOT EDIT THIS LINE !!!
Disable_printing_for_these_formats
int NONE=1;BROWSWE=2:RELA
As written
42
disable_These_Groups_For_Printin g
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. String disable_These_Groups_For_Printing = "Standard \"Group\" One " ;
disable_These_Users_For_Printing
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. String disable_These_Users_For_Printing = "Standard \"User\" One " ;
PDF_Rendition_Control_For_Group s
Turns on/off PDF rendition viewing access for groups when UsePDFRendition is enabled
PDF_Rendition_Control_For_Users
Turns on/off PDF rendition viewing access for users when UsePDFRendition is enabled
Disable_These_Groups_For_Viewin g_PDF_Rendition
Controls group access to viewing the PDF Rendition of a file when UsePDFRendition is enabled.
Disable_These_Users_For_Viewing_ PDF_Rendition
Controls user access to viewing the PDF Rendition of a file when UsePDFRendition is enabled.
Allow_These_Groups_To_Control_S tamp_Templates
Allow_These_Users_To_Control_St amp_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
43
PDF_Rendition_Control_For_Groups=FALSE PDF_Rendition_Control_For_Users=TRUE
The following parameters control licensing behavior: Turns on license checking based on groups. If this value is set to true, when Brava is launched, it checks to see if the current user is listed in the groups for the License_These_Groups_For_CAD parameter. If found, the user is given a CAD license. Turns on license checking based on users. If this value is set to true, when Brava is launched, it checks to see if the current user is listed in the License_These_Users_For_CAD parameter. If found, the user is given a CAD license. Turns on license checking based on groups. If this value is set to true, when Brava is launched, it checks to see if the current user is listed in the groups for the License_These_Groups_For_Documents parameter. If found, the user is given a Document license. Turns on license checking based on users. If this value is set to true, when Brava is launched, it checks to see if the current user is listed in the License_These_Users_For_Documents parameter. If found, the user is given a Document license. 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. 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.
Licensing_Control_For_CAD_Group s
Licensing_Control_For_CAD_Users
Licensing_Control_For_Documents _Groups
Licensing_Control_For_Document_ Users
License_These_Groups_For_CAD
License_These_Groups_For_Docum ents
44
License_These_Users_For_Docume nts
List of users that Brava checks to see if the current user is part of. If the user is listed as one of these defined users, he receives a Document license. The users should be comma deliminated. Assuming Licensing_Control_For_Document_Users is set to TRUE. Note that this parameter uses the Users short login name (e.g., Login name = johnd), and not the full Webtop name (e.g., Full Webtop name = John Tester Doe) List of users that Brava checks to see if the current user is part of. If the user is listed as one of these defined users, he receives a CAD license. The users should be 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 Webtop name (e.g., Full Webtop name = John Tester Doe)
License_These_Users_For_CAD
Note: Based on the above permission sets, if the user/group falls into more than one possible user/group slot they will receive the better license. For instance, if Licensing_Control_For_Documents_Groups is set to TRUE and the current user falls into one of the defined groups in the parameter License_These_Groups_For_Documents while at the same time Licensing_Control_For_CAD_Users is set to TRUE and the user also falls into that slot, the user will receive a CAD license and NOT a Document license.
45
5. Test the generic Brava integration, Default Webtop, and <Your Custom Webtop Integration>. All three should work as expected. 6. In the directory that contains the default Webtop application, combine the directories, sub-directories, and the unique (xml, jsp, or properties) files they contain. If both <Your Custom Webtop Integration> and the Brava Webtop Integration contain the same files, you will need to carefully combine the contents of the two files to create a single file. Its important to remember that some of the content will be the same and some will be unique. When combining files with the same name in both integrations, be sure to include all of the unique code and not copy the duplicate code.
Follow the set of instructions below depending on whether you built your Webtop server on Tomcat or WebLogic. For Tomcat: 1. In a text editor, open the web.xml file (located at the root of your application server e.g., webapps\webtop\WEB-INF folder). Verify that you have the top-level application folder set to custom. For example: <context-param> <param-name>AppFolderName</param-name> <param-value>custom</param-value> </context-param> 2. If no current customizations/configurations are present, copy the contents of the entire IGC/Brava! 6.2 Webtop/custom directory from your Brava! Server install into your <webserver directory>/webtop/custom directory in the Webtop install location. The install location would be: //..Apache Tomcat 6.0/webapps/webtop/custom. (See NOTE below for existing customizations) For WebLogic: 1. If no current customizations/configurations are present, copy the contents of the Brava 'custom' folder to replace the current contents of the custom folder in your \webtop\custom directory. Warning dialogs should pop up stating that "some folders already exists do you wish to overwrite them?". Select YES. (If current customizations exist, see Note below.) 2. Restart your Weblogic Webtop server, update the webtop web app in the BEA Weblog console and the Brava! customizations/configuration changes should be present. _____________________________________________________________________ *NOTE: If the Webtop product has previously undergone a customization, cautiously merge both the current customization and the Brava customization files together as outlined in the Brava Webtop Developers guide (contact IGC). If no customizations are present, you can simply copy the custom folder from the Brava! installation directory into your webapps\webtop directory.
46
47
<taken from markup.jsp> .... <SCRIPT language="javascript" type="text/javascript" for="BravaXClient" event="XDLIsComplete()"> //doAuditEvent("XDLIsComplete:", "", objectid); </SCRIPT> <SCRIPT language="javascript" type="text/javascript" for="BravaXClient" event="PrintJobComplete()"> //doAuditEvent("PrintJobComplete:", " ", objectid); </SCRIPT> .... The below example will enable the auditing of a completed print job thru the Brava Interface. Simply remove the '//' on the line where the printjobcomplete event is caught: <SCRIPT language="javascript" type="text/javascript" for="BravaXClient" event="PrintJobComplete()"> doAuditEvent("PrintJobComplete:", " ", objectid); </SCRIPT> Now the following would be added to this object audit trail: PrintJobComplete: You can change what is added to the audit trail by modifying the first string in the doAuditEvent call. So, to add 'print done' instead of 'PrintJobComplete:' it would look like this: <SCRIPT language="javascript" type="text/javascript" for="BravaXClient" event="PrintJobComplete()"> doAuditEvent("print done", " ", objectid); </SCRIPT> You can also add additional information in the 2nd string if needed. This is typically where extra information returned from the Brava Event is stored.
48
49
50
a. The default security option is to grant everyone access to your markup. Select the Private check box to allow only the owner to view and edit this markup. b. The default behavior is for the saves markup to stay only with the specific file version. If you would like your markup to be saved with all versions of the document, select the Save with all Versions check box. You can view where a documents annotations are stored: 1. Right click on a document that displays the markup exists indicator 2. Select ViewRelationships from the pop up menu. 3. Annotation relationship information displays. The path for the markup file, by default, is the /Resources/<login name> folder. Note: See section 3.1 for steps to enable the markups save with all versions feature.
4. Brava launches and displays the two file versions in Compare mode. View the Brava
51
2. In the Add Bookmark dialog, the Category options defined in bookmarktitles will be available from the Categoies drop down. If a category is defined with more than one Title, those selections will be available from the Titles drop down.
52
If you select the special Free-Text category, instead of a drop down field with predefined titles, the Titles field will be a text entry field where you may type in any title of your choosing. All users will be able to view the free text bookmark that you entered and saved to the docbase.
3. The bookmark will be added to the list of docbase bookmarks available for selection when you choose the Open Bookmark command from the Bookmark menu in step #1.
4. To delete a bookmark, simply select Delete Bookmark from the Bookmark menu, highlight the bookmark you wish do delete, and click OK.
53
54
The values to the %dbstring and %dbupdatestring fields are case insensitive in terms of client processing. For example, %dbupdatestring(Project) is considered to be the same as %dbupdatestring(project). If the server value for a particular token is set to a null or blank value, then the stamp will display a blank as opposed to the term <no value>. If the parameter CapitilizeDbupdateLabel is set to true, the labels for the dialog items will be equal to the %dbupdatetoken string value - except that underscores will be replaced with spaces, and the first letter of every word will be capitalized. The default for this parameter is false. If the %dbupdatestring string is prefaced by _readonly: than the field will be disabled in the dialog (i.e. %dbupdatestring(_readonly:document_id). When a stamp is initially placed, or if it is double clicked, values for the dbupdatestring fields are retrieved from the server. The server's values (displayed in the "bi-directional" stamp dialog) may be more current than what is currently displayed in the stamp. If the user selects cancel on the "bi-directional" stamp dialog and if the parameter RefreshStampOnCancel is set to true, the values on the stamp are still updated with the latest values retrieved from the server in order to reflect the current status. There must be at least one token that's not a dbupdatestring for the integration to detect initial stamp placement. On an initial stamp placement, the stamp's dbupdatestring fields (unless the field is prefaced with _populateStampOnUpdateOnly, see next bullet) are always populated with the latest values from the server regardless of whether the user selects cancel. If the %dbupdatestring string is prefaced by _populateStampOnUpdateOnly, the corresponding field on the stamp will not be updated until the user selects "Update To Server". Note that the _populateStampOnUpdateOnly prefix may be combined with the _readOnly prefix (e.g. %dbupdatestringtoken(_populateStampOnUpdatePrefix,_readOnly:responsible_person). The prefixes are order independent and case insensitive. If the stamp contains a %dbupdatstring starting with "_rowHeight:", the height of each row will be set to the value after this prefix (i.e. %dbupdatestring(_rowHeight:45). If this token isn't set, the param DbUpdateStringRowHeight sets the row height. If set to a value of less than 30 or is not set at all, its value will be set to 30. If the stamp contains a %dbupdatstring starting with "_labelWidth:", the width of the label column will be set to the value after this prefix (i.e. %dbupdatestring(_labelWidth:65). If this token isn't set, the parameter DbUpdateStringLabelWidth sets the width of the label column. If not set, then its width is calculated based on the longest token string. If the stamp contains a %dbupdatstring starting with "_editWidth:", the width of the edit control column will be set to the value after this prefix (i.e. %dbupdatestring(_editWidth:170). If this token isn't set, the parameter DbUpdateStringEditControlWidth sets the width of the edit control column. If not set, then its width is calculated based on the longest value retrieved for the %dbupdatestring fields. The minimum length for the field is 85, and the maximum is 220. If the stamp contains a %dbupdatstring starting with "_function:", then the value after the colon is passed as a http parameter to all server calls. For example, for %dbupdatestring(_function:marketing) would add the parameter &dbupdatefunction=marketing to the query string for HTTP GET server calls. For POST calls, this is added to the header. If the server does not recognize a field as one it can update, the field does not need to be returned in the response to the client. If a field is not returned in the client response, and the
55
param DbupdatestringNotRetrieved is set to Hide then the client will not display that field in the DbUpdateString dialog. If this parameter is not set, the default is to show the field in the dialog with a blank value.
56
57
Problem: I am not able to get the Brava ActiveX control to download on my Vista machine. Solution: In IE (or Internet Options), add the Web site's URL as a Trusted Site. This should allow the Brava Client ActiveX control to download and install on your Windows Vista system. Problem: I am not able to get the Brava ActiveX control to download on first click with IE 7.0 set with medium-high or high security enabled. It works if I hit the link twice. Solution: The Active X control will install after you click the IE information bar about installing the Brava ActiveX Control. However, the screen is refreshed and the Webtop browse screen is shown. This is normal behavior of this security level and the launching of the Brava ActiveX control. Selecting 'Annotate' after this action should result in normal Brava operation. Problem: When I publish a file with markups to a Rendition, the markups are removed. Solution: Note that if a file with Markups is present and is published as a new Rendition, the markups will be disassociated with the main document unless the markups are saved with the Save with all Versions check box enabled. Problem: How do I turn on Brava logging? Solution: Client, Server, and JobProcessor logging can be set in following three locations, depending on the error: 1. In brava_parameters.properties (Brava Client control logging), set the parameters ClientLogging=DEBUG and ClientLogFileLength=100000 (adding a few extra 0s ensures that everything gets written to the log file). The file will be written to your Web Server application log, for example C:\Program Files\Apache Software Foundation\Tomcat 6.0\documentum\logs. 2. In Server.properties (Brava Server logging), set log.level=all. The file will be written to the C:\Program Files\IGC\Brava! Webtop\Brava! Webtop Server\log. 3. To turn on the JobProcessor logging, go to http://localhost:7070/config and set the log parameter to ON. Select Update server and restart the service. To view the logs, go to http://localhost:7070/log.
Notes on Vista Compatibility: The User Account Control (UAC), depending on the User's Permission level and rights, may prevent the user from being able to perform some functions with the Brava Client: When installing the Brava Client, UAC (if on) can prevent the Brava Client from being installed as UAC blocks the user's ability to write files being downloaded by the browser (Internet Explorer). With the Brava Client installed, UAC (if on) can prevent the Brava Client from saving/writing files to the local file system.
58
During Brava's client side loading/processing, UAC (if on) can prevent Brava's client side loading/processing by preventing the Brava Client from writing the temporary output CDL files to the user's temp directory. To turn off UAC: 1. From the Control Panel, open User Accounts. 2. Click the Turn User Account Control on or off link. 3. In the Turn on User Account Control (UAC) to make your computer more secure options screen, un-check Use User Account Control (UAC) to help protect your computer check box. 4. Click OK and restart the system. Note: The User's permissions level/rights will effect how the UAC works. Internet Explore Security settings and Automated direct Brava Client install on Vista Client Systems: Provided the user has the underlying permissions and rights, the Brava Client may install without an administrator deploying the Brava Client MSI install package. Add the site to the Internet Options Security Trusted sites list. On the Trusted Sites Security level settings, set the Zone to Medium or Lower (assuming you're using the default settings for the zone). Make sure the Enable Protected Mode is not checked. Select OK in the Internet Options Control Panel and restart IE Access the Brava website and attempt to open the file using Brava (in Webtop, select Annotate from the menu after you are logged in). The Brava Client will install as it does on Windows XP. If you have attempted to automatically install the Brava Client without following these steps, you may need to clean-up files that were installed in the failed attempt. Check the following locations and delete the listed files before attempting the install again: C:\Users\<logged in user>\IGC Delete the entire IGC directory and its contents. Delete the class file: 1. Open the Internet Options Control Panel and on the General tab, locate the Browsing history section. 2. Click on the Settings button to open the Temporary Internet Files and History Settings dialog. 3. Click the View objects button. This will open the Downloaded Program Files folder in a new window. 4. In the file list, check to see if the BravaClientXView 6.2 Class is present. If so, delete it and then close all the open windows and control panels. 5. Restart the system and try the installation again. Note: A User account with very limited rights will not have the permissions needed for the Brava Client Automatic Install process when running Vista. In this case, a manual install will be needed.
59
Additional Resources For additional information on customizing the Brava Client for your integration, please see the Brava_6.2_AdministrationGuide.pdf included in this integration. Please note that any installation and configuration information contained in this integration guide takes precedence over any seemingly conflicting information found in the Core guide Brava_6.2_AdministrationGuide.pdf.
60