The Deployment Process | Revu 2018

2. The Deployment Process | Revu 2018

This article applies to:

  • Revu 2018

Jump to other versions:

Best Practices

An Important Note About Revu Upgrades from Revu 2015

If you’re upgrading from Revu 2015.x, you should not run the “Uninstall Previous Versions” script included in the MSI Deployment Package. In this instance, the Revu 2018 installer will detect, unregister and uninstall the older software.

Microsoft Windows Installer

Regardless of which package or deployment vehicle you use, your Command Line script will launch the Windows Installer (msiexec.exe) during the course of your installations. There are various deployment tools which utilize the command line for running an MSI or MSP installer, such as System Center Configuration Manager (SCCM), Dell KACE, and Group Policy. However, it is important to note that we only provide support for the use of command line scripts, and not the deployment tools themselves.

Working with the MSI

Although it is possible to directly edit the MSI (or MSP) file and save it, Bluebeam does not support doing so, as it will invalidate the files’ digital signature. The supported method for applying configuration options to an MSI (or MSP) is using an MSI editor such as InstEd or Orca to create a Transforms (MST) file, that is applied to the MSI during the installation process.

Authorization

To make sure your software is successfully authorized, your firewall or proxy server must be configured to allow access to our licensing servers listed below, via HTTPS on port 443.

Authorization Servers
Activation Server


Delayed Authorization

Delayed Authorization is the supported registration method when using deployment software such as SCCM, and/or in situations where the System account does not have access to the internet. In this instance, Revu will not try to communicate with the licensing servers until the end-user opens Revu post-installation and tries to save a document. The registration process runs “silently” in the background and requires Administrator access.

To enable Delayed Authorization you will need to use the DA property found in the MSI Properties Table.

The MSI Properties Table

The MSI Properties table lists the properties that allow you to configure and customize the Revu installation.

Required Properties

These properties are needed for successful authorization of the software.

The Serial Number and Product Key will only work with the version and Edition listed on your License Certificate. If you have lost your License Certificate, please contact us to request another copy.

BB_SERIALNUMBER Enter the Revu Serial Number. Enter TRIAL to install as a 30-day trial.
BB_PRODUCTKEY Enter the Revu Product Key. All upper-case characters.
BB_EDITION Standard = 0 CAD = 1 eXtreme = 2 (default)

Supported Optional Properties

BB_DISABLEANALYTICS Enable or disable sending application usage info to Bluebeam. Send (default) = 0, don’t send = 1. (See notes)
BB_DEFAULTVIEWER Set as the default application (default) = 1, Do not change the default = 0 (See notes)
BB_DESKSHORTCUT Bluebeam Revu desktop shortcut (default) = 1, No shortcut = 0
BB_DESKSTAPLER Bluebeam Stapler desktop shortcut = 1, No shortcut (default) = 0
BB_FEATURES Disables various Revu features. All Features Enabled = 65535 (default). See Enabling and Disabling Revu Features with BB_FEATURES for more information.
BB_IE_PLUGIN Install and enable = 1, Disable (default) = 0
BB_JOBOPTIONS Enter the UNC or fully-qualified path to your custom. jobOptions file.
BB_NETCONFIG Enter the UNC or fully-qualified path to your managed NetConfig folder.
BB_NEW_INSTALL_PATH Enter the fully-qualified path.
BB_PAGESIZE Enter "A4" to override default page size for the Bluebeam PDF printer.
DISABLE_WELCOME Disables the Revu HTML Welcome page and Workflow Training Videos page. Enable (Default) = 0, Disable = 1

Creates a registry entry Computer\HKEY_CURRENT_USER\Software\Bluebeam Software\2018\Revu and DWORD named "WorkflowsInitialized".

BB_REVUPREFERENCES Enter the UNC or fully-qualified path to your RevuPreferences.xml file.
DA Delayed Authorization = 1, Standard Authorization (default) = 0
IGNORE_RBT Disable Check for Pending Reboot = 1, Check for Pending Reboot = 0. (See notes below.)
MBCODE Determines which of the Bluebeam plugins are enabled. The default value of 1023 enables all of them. See Enabling the Bluebeam Plugins with MBCODE for more information
The BB_DISABLEANALYTICS Property

By default, Revu sends usage data to us in order help improve the application. This information is anonymous and not shared with third parties. Bluebeam will not collect personal information about you. If you want to disable this, deploy your installations with the BB_DISABLEANALYTICS property set to One (BB_DISABLEANALYTICS=1) in your MSI command line script or MST file.

Setting the Default PDF Program with BB_DEFAULTVIEWER

Microsoft has changed how default applications are selected in Windows 8 and above, which result in the BB_DEFAULTVIEWER setting being overridden. This means that your users will have to follow the steps in Changing the Default PDF Viewer. Further information can be found on the Microsoft website.

Enabling and Disabling Revu Features with BB_FEATURES

Each Revu feature has an assigned numerical value as shown in the table below. To disable a feature, subtract its numerical value from the default value of the BB_FEATURES property (65535) shown in the table of Supported Optional Properties above, and enter the answer as the new value for the BB_FEATURES property.

For example, to disable the Redaction feature in a Revu eXtreme deployment, you would subtract the value of that feature (2) from 65535, and then enter the balance (65533) as the new value for BB_FEATURES.

Revu Features and Their Numeric Values:
Administrator Button (Revu menu) = 128 Product Updates Button (Help menu) = 16
AllFeatures = 255 Redaction in eXtreme (Includes Cut Content & Erase Content in all Editions) = 2
DigitalSignatures = 4 Registration Button (Revu menu) = 256
EditText = 1 SelfSignCertificates = 8
ExportToOffice = 64 TranslateMarkups = 32

Disabling “Check for Pending Reboot”

For Revu to function correctly, the pending reboot must occur at some point after the installation has completed.

Enabling the Bluebeam Plugins with MBCODE

Each of the Bluebeam plugins for supported third-party software has an assigned numerical value, as shown in the table below. If you only want to enable a single plugin – for example, the plugin for AutoCAD— you would replace the default MBCODE value of 1023 (all plugins enabled) with the number 2. In cases where you need to enable more than one plugin, you would add up their numerical values and enter the total as the new MBCODE value. Changing the value to 0 disables all of the plugins.

Bluebeam plugins are only enabled if the third-party application is installed. Refer to the Revu Compatibility Chart to ensure that your third-party applications are supported.

Revu Plugins and Their Numeric Values

All Plugins Disabled = 0 Microsoft Outlook = 128
AutoCAD = 2 ProjectWise = 64
AutoCAD LT (32 & 64-bit) = 4 Revit & Navisworks = 16
Internet Explorer = 32 SketchUp Pro = 256
Microsoft Office = 1 SolidWorks = 8

Markup & View Modes

Revu 2018.x offers two modes of operation: Markup Mode and View Mode. By default, the software is installed in Markup mode, and can be switched between the two from within the Revu menu. In Revu 2018.1 and above, this is also achieved by pushing out the Windows Registry edit described below via Group Policy.

Restricting Users to View Mode Only

To set any or all of your Revu installations View Mode (Revu 2018.1 and above):

  1. Create a new DWORD registry key called ViewModeOnly in "HKEY_CURRENT_USER\Software\Bluebeam Software\2018."
  2. Set the value to 1.

When Revu launches in this state, the Markup Mode and Register/Unregister options in the Revu menu will be hidden.

Setting the key Value to 0 or deleting it all together switches the Revu installation back to Markup Mode.

Language Transforms

You can deploy installations in a different language from what Windows uses by setting the TRANSFORMS property to one of the language codes listed below. Otherwise, Revu is installed in the language used by the host operating system by default.

Command line examples for MST and MSI installations can be found later in this guide.

Revu Language Transform Codes:
Danish = 1030 Italian = 1040
Dutch = 1043 Japanese = 1041
English = 1033 Korean = 1042
Finnish = 1035 Norwegian = 1044
French Standard = 1036 Spanish = 1034
German = 1031 Swedish = 1053

Uninstalling Revu

You may need to uninstall the previous version of Revu before proceeding with the installation.

Full MSI

If you are pushing the full 2018.x MSI, the previous version of Revu must be uninstalled first. Use the “Uninstall Previous Version” script provided in the MSI package. The MSI will not uninstall previous versions.

An Important Note about Revu Upgrades
If you’re upgrading from 2015.x to Revu 2018, you should not run the “Uninstall Previous Versions” script included in the MSI Deployment Package. In this instance, the Revu 2018 installer will detect, unregister and uninstall the older software.

MSP Patch

If you are pushing the 2018.x MSP patch, do not uninstall the previous version. The patch must be applied to an existing installation of the same major version.

Revu 2016.5.1 introduced the MSP patch installer. The MSP patch uses the same GUID as the major version that’s already installed.

Optional Pre-Installation Check

If you’re unsure about which Revu editions or versions are already installed in your user community, it may be a good idea to consider writing a script which queries the following Windows Registry keys. This information is useful if you have to deploy multiple editions or versions of Revu:

“RevuVersion” or “RevuBuildNo” – Key Data values show the current release version of Revu installed:

“Edition” – Key Data value shows the current Revu Edition:

HKLM\SOFTWARE\Bluebeam Software\RevuVersion#

“InstalledVer” – Key Data value shows the current release version of Revu installed:

HKEY_LOCAL_MACHINE\SOFTWARE\Bluebeam Software\RevuVersion#\BBProduct\Revu

"Registered" – Key Data value displays the Revu Serial Number:

HKLM\SOFTWARE\Bluebeam Software\RevuVersion#\Licenses

Deployment Methods

This section covers topics such as Windows Installer Switches, how to write scripts for either full installations using the MSI or patch updates using the MSP, as well as how to deploy multiple Revu Editions – or in different languages within your environment.

A Note about Windows Installer Switches

Please refer to the Microsoft website for information about important Windows Installer switches to be aware of when writing a script for MST, MSI, or MSP installations:

Writing an Installation Script

Let’s take a look at the different methods for deploying your Revu software, each of which utilize the command line in slightly different ways.

Writing a Command Line Script that Uses Your MST File

Here are a couple of installation script examples that call up an MST file:

msiexec.exe /i "Bluebeam Revu x64 18.msi" TRANSFORMS=YourMSTFile.mst /qn
A silent German Language Installation:
msiexec.exe /i "Bluebeam Revu x64 18.msi" TRANSFORMS=:1031;MyTransforms.mst /qn
It’s very important that you test your script in an elevated command prompt on a test machine, before deploying the installation to ensure that it runs correctly.
Do not double-click the MSI file. Doing so will install Revu without the required elevated privileges, or any customizations you may have set in the MSI Properties.
Passing Properties from the Command Line (Without an MST File)

Another method of building your deployment is to write a complete installation script which calls up the Revu MSI file and lists all relevant mandatory and optional property changes.

Do not double-click the MSI file. Doing so will install Revu without the required elevated privileges, or any customizations you may have set in the MSI Properties.

To get an idea of how this is done, look at the following example of a basic installation script written so that Revu Standard installs silently, with Delayed Authorization:

The Revu Serial Number, Product Key and Edition must be included in all MSI installation scripts, and the quotation marks must be included in the MSI filename.
Values for an MSI switch (signified by a forward slash) must be enclosed on quotation marks as shown below. For Bluebeam specific properties, spaces must be replaced by question marks.
Before deploying Revu, we recommend writing and proofreading your script in a text editor, and running it on a test machine in an elevated command prompt.
msiexec.exe /i "Bluebeam Revu x64 18.msi" BB_SERIALNUMBER=YourRevuSerialNumber BB_PRODUCTKEY=YourRevuProdKey BB_EDITION=0 DA=1 /qn
Additional MSI Script Examples

To help give you a better idea of how command line scripts can be written for various installation requirements and configurations please refer to the following examples:

Basic silent installation of CAD Edition:
msiexec.exe /i "Bluebeam Revu x64 18.msi" BB_SERIALNUMBER=YourRevuSerialNumber BB_PRODUCTKEY=YourRevuProdKey BB_EDITION=1 /qn
Basic silent installation that also deploys a specific RevuPreferences.xml file:
msiexec.exe /i "\\MyServer\Bluebeam?Deployment\Bluebeam Revu x64 18.msi" BB_SERIALNUMBER=YourRevuSerialNumber BB_PRODUCTKEY=YourRevuProdKey BB_EDITION=YourRevuEdition BB_REVUPREFERENCES=\\MyServer\Bluebeam?Deployment\RevuPreferences.xml /qn

Deploying Multiple Editions of Revu

As the MSI installer includes Revu Standard, CAD, and eXtreme, a single MSI can deploy multiple Editions within your end-user community by staging a single MSI file in a shared location, which can be called up by any of the three installation scripts (one for each Revu Edition) that you’ll need to write. Each script must include the corresponding values for the BB_SERIALNUMBER, BB_PRODUCTKEY, and BB_EDITION Properties.

Once you’ve written and checked your scripts in an elevated command prompt on a test machine, you can use Group Policy or a task sequence in your deployment vehicle to determine the Revu Edition they should be running, and then automatically run the correct deployment script.

An alternative method of confirming the Edition and Serial Number of an existing Revu installation is to write a script which queries the following Windows Registry keys:

HKLM\SOFTWARE\Bluebeam Software\<RevuVersion#>
“Edition” – Key Data value shows the current Revu Edition.
HKLM\SOFTWARE\Bluebeam Software\<RevuVersion#>\Licenses

“Registered” – Key Data value displays the Revu Serial Number.

Updating Existing Installations with an MSP File

When writing your command line script, it’s important to note that REINSTALLMODE=omus and REINSTALL=ALL are both required parameters, and are case-sensitive. Additional information about Msiexec.exe command line options can be found on the Microsoft website.

We recommend writing and proofreading your script in a text editor, and then running it in an elevated command prompt on a test machine, before deploying the update to your end-users.

To deploy a basic patch update you’ll need to use the following format:

msiexec.exe /p <path to .msp> REINSTALLMODE=omus REINSTALL=ALL
Additional MSP Script Examples Basic silent update:
Msiexec.exe /p <path to .msp> REINSTALLMODE=omus REINSTALL=ALL /qn
Basic silent update with a suppressed reboot:
Msiexec.exe /p <path to .msp> REINSTALLMODE=omus REINSTALL=ALL REBOOT=ReallySuppress /qn
When patching an installation that was originally deployed with modified Properties, you’ll need to include them in your MSP script. Not doing so will reset them to their default values.

Running and Troubleshooting a Deployment

Assuming you have written your script and tried it out in an elevated command prompt on a test machine, you can now run it in a deployment vehicle of your choice, such as SCCM, Dell KACE, or Group Policy.

If the installations do not go as intended, or otherwise fail, you’ll need to go back and check your work. If your script is calling up an MST file, reopen it with MSI editor and make sure you’ve correctly set the Properties. After that, confirm that you’ve used the correct syntax in the script you have written which calls up the MST file, and test again in an elevated command prompt on a test machine.

In the case of an MSI or MSP script, check the syntax again to make sure it’s formatted correctly, and that you’ve included the relevant Properties with the correct settings. Once you’ve done that, you should run it on your test machine as described earlier.

The MSI installer creates a verbose log file in %TEMP% directory on the local drive of the machine on which Revu is installed. The naming convention is "MSIxxxxx.log" where "xxxxx" are random characters, like "MSIjfb1d6.log." Review this log for common Windows installation errors.
If you’re using SCCM the log file can be found in C:\windows\temp when installed via the SYSTEM account. A list of Windows Installer error codes and their definitions on the Microsoft website.

Bluebeam, Revu, and Bluebeam Studio are trademarks or registered trademarks of Bluebeam, Inc. Microsoft, SharePoint, and Windows are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.

AutoCAD is a registered trademark of Autodesk in the United States and/or other countries.

© 2018 Bluebeam, Inc. All Rights Reserved.

All other trademarks or registered trademarks are the property of their respective owners.

Related Articles