Deployment

Revolution Design software has been created to be easy for BIM managers to deploy to a large groups of users. Follow the instructions below to set up a deployment.

This page describes the process for an initial deployment and install to a new machine. If you are trying to deploy new settings to users that already have the program the process is very similar but can be found on the settings management page.

Important = Important Note

Settings XML file

Creating the Settings File

In order to deploy settings and licensing you need to start by creating the XML settings file that you will deploy. The best way to begin is to install the software on a single machine, start it, and use the UI to modify the settings until they match what you would like to deploy.

Once you have the settings how you want them you will need to locate the settings file on the setup machine. Settings files can be found in a sub folder of C:\Users\{username}\AppData\Roaming\Revolution Design Important Note. Software specific sub folders are as follows:

  • Keynote Manager – Keynote Manager\{version}\Keynote Manager_Settings.xmlImportant Note
  • Revit workFlow – Workflow\{version}\workFlow_Settings.xmlImportant Note
  • Selection Master – Selection Master\{version}\Selection Master_Settings.xmlImportant Note

 

Modifying Settings

All settings should be present in this file and all UI visible settings should already be set correctly. However there are a few other settings available that you may need or want to set:

  • Licensing – Both standalone and portable licenses can be deployed and silently activated thought he settings file. Simply enter your activation key in the ‘Stored Activation Key’ setting and the software will automatically attempt to activate your license on first startup.
  • Proxy Information – If you connect to the internet through a proxy server you will need to enter the proxy server information in order for connection to occur and for licenses to be properly checked out. Fill in the ‘Proxy Server Data’ section if necessary.

The settings file can also be modified as follows:

  • Environment Variables – Some settings contain user specific paths, creating different text on each users machine. In this case, environment variables can be entered in the deployment file. These environment variables will be expanded when the software first starts and the correct path will be inserted.
  • Partial Files – The settings file may also be deployed partially complete. To deploy only license data to users and leave the remaining settings as default, simply delete all other settings from the file before deployment. The software will read the deployed values present and fill in default values for the remaining items.

Creating the Deployment

Deploying Installation

If you are creating a silent install via Microsoft SCCM or similar, you can do so with the main exe installer. The exe file will honor any passive switches available to the embedded msi package (including all standard msi switches like /passive). If you would like to extract the msi to look at the parameters directly you can do so by running the following command line:

“<Path to Exe>” /extract:”<Directory to Extract To>”

Note that the directory you are trying to extract to must exist already, the extraction will not create it. Note also that this msi is intended to read parameters from and should not be used for installation purposes; installs should be run from the exe directly through a command line instead of from an msi through msiexec.

The exe recognizes the following parameters in addition to the standard parameters:

  • Revit version – You can select which Revit versions to install by typing the revit version and setting it to 0 (not installed) or 1 (installed). So to turn off Revit 2014 you would use REVIT2014=0 in the command line.
  • Install Directory – Use APPDIR to set the installation directory for the program (this is an msi standard but it’s worth noting.
  • Keynote Manager also recognizes the following properties (turn on and off with the 0/1 switch):
    • CLOUDMANAGER – The cloud console interface.
    • STANDALONE – The standalone application.
    • INTEGRATED – The Revit Integrated application.

All unspecified parameters will be set to the default value shown when you run the exe installer directly, you are only required to set the parameters that you would like to change from the default.

If you are not creating a silent install or are trying to script the installer in some other form, you may simply use the downloaded exe installer.

Deploying Settings

Once the settings file is ready to deploy, it must be deployed to end user machines; this can be done via manual copy, through the deployment utility, or through a script or other deployment system that copies the file to the target machine. The settings file can be copied to several locations with slightly different results:

  • User Folder – The settings file can be copied directly into the location shown above for each user on the machine that will use the software. This is the location that the program will read and write settings to, so deploying to this location will overwrite any settings that the user may have already created or set and will override them with the deployed settings.
  • Execution Folder – The settings file can be copied into the executing directory of the program. This location will cause the settings file to become a machine default for all new users or users that have not used the software previously. When the software starts it will first attempt to load the settings from the user specific location above; if no file exists at this location it will look in the execution folder. If settings exist in the execution folder, the program will copy those settings to the user specific directory and use them from there. Execution directories for programs are as follows:
    • Keynote Manager – C:\Program Files (x86)\Revolution Design\Keynote Manager
    • Revit workFlow – C:\Program Files (x86)\Revolution Design\Workflow
    • Selection Master – C:\Program Files (x86)\Revolution Design\Selection Master
  • All Users Folder – The settings file can be deployed to the all users folder with the same results as deploying to the execution folder. Program specific folders for all users are the same as the user folder location, but they are based in C:\ProgramData instead of C:\Users\{username}\AppData\Roaming.

Deployment Utility

Utility Download

The Revolution Design deployment utility is a simple and free utility created to assist users with deploying Revolution Design software. The deployment utility can be downloaded from the utility page.

Using the Deployment Utility

The deployment utility can be run from any location, but is designed to sit on a network drive and be accessed from all local users machines and run from the network. Opening the utility will automatically detect what RD software is installed on the current machine and will show a tab for each one.

Simply fill in the license key and/or settings file fields and press ‘Deploy’ to deploy the values to the current machine. Note that if you have placed your license key inside your settings file you do not need to enter it into the license key field as well, it will deploy with the settings.

The license utility also allows some automation so that you do not have to browse on each machine to your settings file. You may place settings and license key files in the same directory as the utility exe file and it will automatically fill out the values when it loads, so you just need to open the utility and press deploy and you are done! The files must follow the following rules:

  • The settings file must be a valid settings file created using the method in the ‘Settings XML’ section above.
  • The settings file must be named in the format *software name*_Settings.xml. For example, Keynote Manager would be ‘Keynote Manager_Settings.xml’. This should be the way they are named already if you create them from an existing settings file.
  • The license file should be a plain text file and contain only the license key.
  • The license file should be named in the format *software name*_License.txt. For example, Keynote Manager would be ‘Keynote Manager_License.txt’.