How it Works

Bluebeam REVU Integration

• A group needs Upload, Download and Create/View Markups permissions in order to be able to use Bluebeam with PDox.

• The Bluebeam integration installer doesn’t check whether the client machine has Bluebeam REVU installed.

• The user must download and install Bluebeam REVU on the client machine. The order of the installation (Bluebeam REVU first or Bluebeam integration first) is not important .

• During the ProjectDox file checkout process, Bluebeam integration will try to open PDF document in Bluebeam REVU. If there is no Bluebeam REVU installed the user will be notified with a message box in ProjectDox .

• When the ProjectDox Bluebeam Integration is uninstalled, the Bluebeam REVU software will not be affected.

Optional Configuration

• The Bluebeam integration is installed with settings that allow the user to use the application right away. However, the user is free to overwrite settings in the configuration file. The use case would be for someone who wants to change where the ProjectDox files are downloaded to edit in Bluebeam or if they reinstall Bluebeam Revu to a different directory.

• The configuration file BluebeamIntegration.exe.config exists in the folder where the ProjectDox Integration was installed.

• Settings in the configuration file:

BluebeamFilesPath - full path to the directory where downloaded files are stored. User that runs application should have read/write permission to that folder. By default, the path points to directory where application was installed.

Example:

<add key ="BluebeamFilesPath" value ="c:\Program Files (x86)\Avolve\Bluebeam Integration\BBFiles\"/>

BluebeamRevuExeFullPath- full path to Bluebeam Revu executable.

Example:

<add key ="BluebeamRevuExeFullPath" value ="c:\Program Files (x86)\Bluebeam Software\Bluebeam Revu\2016\Revu\Revu32.exe" />

• Once the application starts the user will see the console box briefly open when the integration is invoked from ProjectDox or from Bluebeam.

Bluebeam Integration Execution

• After installation, the Bluebeam Integration is not running. The program is started automatically after the first ProjectDox protocol command is issued.

• There is always a single instance of the program running, per machine, per user.

• Once the application is running, there will be an icon in the system tray.

• To exit application – mouse right click on system tray icon -> Exit.

Protocol Commands

• Bluebeam Integration supports ProjectDox protocol:

BluebeamDownloadCheckout– downloads pdf document to the directory specified in configuration file (see BluebeamFilesPath).

Example: pdox://BluebeamDownloadCheckout/?fileid=71&sessionid=6110eda8-c08a-411e-a2f2-43e2c80eee50&webApiBaseUrl=http%3a%2f%2flocalhost%2fProjectDox.Web.API.Dev

BluebeamUploadCheckin – uploads pdf file from directory specified in configuration file (see BluebeamFilesPath) to server, checks file in and triggers publishing process.

Example:

pdox://BluebeamUploadCheckin?fileid=12&sessionid=bbe1337f-37b4-4fba-a6f2-67e985e5a98e&webApiBaseUrl=http%3a%2f%2flocalhost%2fProjectDox.Web.API.Dev

• The application communicates with web API methods, target base URL is specified in configuration file (see PdoxWebAPIBaseUrl).

List of web API methods that application relies on:

-       [POST] File/CheckInOutFiles/json

-      [GET] File/DownloadFiles/json

-    [POST] File/UploadFileVersion/json