Readme

PURPOSE
HOW IT WORKS
CONFIGURING BRAVA
 

Purpose of the new parameter

We have added an applet parameter to Brava! 2.3.  It is CheckMarkupSubdirectories.  The purpose of this parameter is to allow some users to view and edit markups created by other users who do not have access priveledges to eachothers redlines. The example in this document is a Buyer/Seller directory structure.  The sellers have markup directories defined by the MarkupDirectory parameter and do not have access to each other’s markups.  The buyer has the CheckMarkupSubdirectories parameter set to True and the MarkupDirectory parameter value set to a directory which is above the sellers’ markup directories within the directory tree structure. This allows the buyer to view the markups created by himself and all the sellers without allowing the sellers to access each other’s markups.
 

How it works

This new parameter will enable Brava! to do a recursive search for any markup files that may exist for a specific file in a given directory structure.  This directory structure would be defined within the MarkupDirectory parameter value.  If the CheckMarkupSubdirectories parameter is set to True, the MarkupDirectory parameter must have a value. If the MarkupDirectory parameter is missing or empty, Brava! will ignore the CheckMarkupSubdirectories parameter.

Description:
Brava! will create a unique folder name based on the file that is opened for view. The algorithm for the unique name is not published and is subject to change at any time. That folder will be created under the markup directory defined by the MarkupDirectory parameter. That folder name cannot be changed and is created to ensure that Brava! puts the markups for a document in a location that is unique for that document.
When the CheckMarkupSubdirectories parameter is used, only the markups for the document being viewed will appear in the list. Manually editing the markup directory structure is not recommended.

Example:
Here is an example of a Buyer/Seller directory structure for ProjectX:
 

 ProjectX

  Seller 1
           Folder that is determined by the filename
                    Seller1.mrk

  Seller 2
           Folder that is determined by the filename
                    Seller2.mrk

  Seller 3
          Folder that is determined by the filename
                   Seller3.mrk

Sellers:
The sellers will have their own markup directory.  When they launch  Brava!, they will only have access to view/edit their own redlines.

Buyers:
The buyers will  have the opportunity to open/open for review all the redlines that may have been made against any given image.   Their markup directory will be defined on a higher level than the sellers thus allowing Brava! to do its recursive search and display the appropriate redlines.  To enable this search, the value for parameter CheckMarkupSubdirectories will need to be True and the MarkupDirectory parameter needs to be defined.

Here is the html parameters showing the possible configuration for a seller. This code should be placed inside the <applet> tag.
<param name="MarkupDirectory" value="d:\Brava!\markup\projectx\seller1">
 

Here is the html parameters showing the possible configuration for a buyer. This code should be placed inside the <applet> tag.

<param name="CheckMarkupSubdirectories" value="True">
<param name="MarkupDirectory" value="d:\Brava!\markup\projectx">
 

Configuring Brava!

Refer to section 5.0 Sample HTML Pages of the Brava! Installguide.htm (located in your Brava! client directory) for instructions on editing your html page parameters. The following chart shows Brava!'s custom Markup directory parameter tags and their corresponding values. The bolded word on the left margin is the parameter name that follows param name= in the example code above. The descriptive text to the right describes the value for that parameter name, which follows value= in the example above.  Note that the actual param name and value must be enclosed in double quotation marks, as shown in the example above.