13

Click here to load reader

Brava For Taskspace 6.0.12 Install Guide

  • Upload
    jazarja

  • View
    1.227

  • Download
    0

Embed Size (px)

DESCRIPTION

Uploaded By MyDocumentum

Citation preview

Page 1: Brava For Taskspace 6.0.12 Install Guide

1

Brava!® Enterprise TaskSpace Integration

Installation and Configuration Guide (ActiveX) Version 6.0

Table of Contents

1.0 Preparing to Install Brava TaskSpace ................................................................................................ 2 1.1 Supported configurations and Hardware Requirements: ............................................................... 2

End-User Machine that Runs the Client Applet .............................................................................. 2 Brava! Server ................................................................................................................................... 2 Recommened Hardware Requirements............................................................................................ 3

2.0 Installing Brava for TaskSpace.......................................................................................................... 3 3.0 Configuring your Installation........................................................................................................... 10

3.1 Uninstalling Brava! TaskSpace Components............................................................................... 12 3.2 Tips and Troubleshooting ............................................................................................................ 12

4.0 Contacting Informative Graphics.................................................................................................... 13

Page 2: Brava For Taskspace 6.0.12 Install Guide

2

1.0 Preparing to Install Brava TaskSpace This guide is provided for the installation and configuration of the Brava for TaskSpace integration. In addition, a CoreInstallguide.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.

End-User Machine that Runs the Client Applet Typically, the end-user machine downloads the Brava ActiveX Control for viewing and marking up of TIFF, PDF and JPEG files in the TaskSpace environment. Certified OS: Windows XP Professional SP2, Windows 2000 Professional SP4 Browser: Internet Explorer 6.0 SP2 and 7.0

Brava! Server This component consists primarily of a Java application and various Windows dlls. It also consists of the web server where the Brava! for TaskSpace Client and dependent components are hosted. A client end-user machine downloads these components the first time it accesses a Brava! Web page through a TaskSpace link

Certified Operating System OS: Windows 2003 Server Certified Java JRE: 1.5.0_10 Certified Application Servers: For Windows, Tomcat 5.5 20, Weblogic 9.2.1, and WebSphere 6.1.9

Page 3: Brava For Taskspace 6.0.12 Install Guide

3

Recommended Hardware Requirements At least a Pentium 3 (or equivalent) 1.5GHX with1024MB RAM (1536MB or higher

recommended). 125MB available hard disk space to install Brava 6.0 for TaskSpace files.

2.0 Installing Brava for TaskSpace

1. Run the Installation CD or double-click on the web package file that you downloaded. A Demo Shield installation browser launches automatically. Select the Install Brava! for TaskSpace button.

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

Page 4: Brava For Taskspace 6.0.12 Install Guide

4

3. From the installation screen, you can launch this install guide. Click the Install Brava! 6.0 for TaskSpace link to begin the installation.

4. On the Welcome screen, click Next.

Page 5: Brava For Taskspace 6.0.12 Install Guide

5

5. Select a language for Brava Localization. Menus, dialogs, and tooltips will display in the chosen language. Current localization options include English, French (standard), or German.

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

Page 6: Brava For Taskspace 6.0.12 Install Guide

6

7. Select the setup type of install. The Brava installer will detect and display the Tomcat version

currently installed or you may select “Use different servlet engine”. 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. It’s best to select a common default location for your application server. With an application server such as BEA Weblogic, it is recommended that WAR or EAR files be placed in a common, accessible place such as the C:\bea\user_Projects\Domains directory to ensure that the files (WAR and EAR) are located in a common default location for deployment. Click Next

Page 7: Brava For Taskspace 6.0.12 Install Guide

7

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 server’s 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

Page 8: Brava For Taskspace 6.0.12 Install Guide

8

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

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

Page 9: Brava For Taskspace 6.0.12 Install Guide

9

11. Click Install to begin the installation.

12. The installation will complete and prompt you to restart the system. You may be prompted to reboot your system at this time.

Page 10: Brava For Taskspace 6.0.12 Install Guide

10

3.0 Configuring your Installation After completing the component installation, you will need to configure your installation for your specific environment.

Required: You must edit or add the correct value to the bravaServerProperties parameter in the ivf_config.xml file (located in the deployed TaskSpace application at ..\taskspace\wdk\config\imaging\ivf_config.xml)

The value of the parameter may look like this:

http://<localhost:port>/BravaServer/Properties

Replace localhost with the fully qualified domain name of the system 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 in.

Optional: The following table lists the parameters (and possible values) contained in the ivf_config.xml page that you can customize. Many of these parameters determine which features will be available to viewers using the Brava! ActiveX Client. You can choose to enable or disable a feature by setting its value to true or false. See Optional Brava ActiveX Parameters in the CoreInstallguide.pdf for a detailed list of all the Brava Enterprise parameters. Brava TaskSpace Parameters Used in the ivf_config.xml file Parameter Value Description ClientLog Valid string values are as

follows: All or 0 designates all levels of messages are logged. Debug or 1 designates fine-grained informational events that are most useful to debug an application. Info or 2 designates informational messages that 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

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.

Page 11: Brava For Taskspace 6.0.12 Install Guide

11

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%/Application Data/BravaTaskspace/Logs/Clientlog.txt – Default

The path the Brava Client will attempt to write the client log file.

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

Turns the Page Thumbnails feature on/off.

SecurityOptionsFromServer

TRUE FALSE – Default

Turns on/off getting the CSF security options (the security.xml file) from the Brava Server and not interactively from the user.

The following parameters control markup behavior. EnableMarkup TRUE – Default

FALSE Turns on/off the Markup option.

MarkupRasterDirectory Default value is %USERPROFILE%\\IGC\\StampImages

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 user’s profile. The path starting point of “%USERPROFILE%\\ should help to ensure that the user has the proper permissions to the raster image files.

EnableMarkupClose TRUE – Default FALSE

Turns on/off the markup menu option to close open (for editing) markups.

EnableMarkupCloseForReview

TRUE – Default FALSE

Turns on/off the markup menu option to close markups open for review.

EnableMarkupBurnin TRUE – Default FALSE

Turns on or off Brava’s ability Burn-in Markups and output a CSF file.

Page 12: Brava For Taskspace 6.0.12 Install Guide

12

EnableMarkupSaveAsDXF TRUE FALSE – Default

Saves Markups to Docbase as DXF file. Currently offers no benefit for TaskSpace users.

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

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

EnableMarkupReview TRUE FALSE – Default

Turns on/off the ability to Review a markup.

EnableMarkupSaveAs TRUE FALSE – Default

Turns on/off the ability to Save a markup as…

EnableMarkupOpen TRUE FALSE – Default

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

EnableMarkupSave TRUE FALSE – Default

Turns on/off the ability to save a markup without giving a markup open for editing a new name.

3.1 Uninstalling Brava! TaskSpace Components At some point, you may choose to uninstall Brava! TaskSpace. To do this, run the Add or Remove Programs command from your Control Panel. Remove:

Brava! Enterprise

3.2 Tips and Troubleshooting

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.

Troubleshooting:

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.

Page 13: Brava For Taskspace 6.0.12 Install Guide

13

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-3548 Phone: (602) 971-6061 E-mail: [email protected] Support: http://www.infograph.com/support/ M - F 5am to 5pm, Arizona time Brava! Technical Information and Driver Updates: http://www.infograph.com/support/BravaTechnicalSupport.htm Web: www.infograph.com ftp: ftp://ftp.infograph.com/