Installing Guardian

Knowledge BaseGetting Started
Installing Guardian

In this article


Deployment Install

Guardian is easily deployed to the firm’s Revit user machines by following the recommended workflow. The same .msi file that is used for manual installations will be used for the deployed installation and can be found here.

Prepare a Deployment Transform File (.mst)

A free Microsoft tool called "Orca", available from the Microsoft SDK, provides a graphical user interface for generating Microsoft transform files (.mst). The .mst file will tell the deployment how to install the .msi file.

Windows SDK Components for Windows Installer Developers - Win32 apps | Microsoft Docs

1. After installing Orca, load the .msi file.

Load the MSI file

2. On the main menu, click New Transform.

New Transform on main menu

3. On Property change the following options:

a. USEROPTION = 2 (This will make sure that files will be deployed at “ProgramData”)

b. EulaForm_Property = Yes (This will default the License Agreement to “I Agree”)

Property dialog

4. On CustomAction, insert the Company ID provided to your firm into the Target column adjacent to COMPANYID. This will automatically deploy the company key file on the correct folder during installation.

CustomAction dialog

5. Click on Transform then Generate Transform and save it on the same folder as the .msi that will be deployed.

Generate Transform dialog

Perform a Test Deployment

The tools for deploying Revit addins are quite diverse. Here is a sample command line that can be used in a deployment tool of choice, such as PDQ:

Sample command line:

msiexec /i "<path>\<filename>.msi" /qn TRANSFORMS="<path>\filename.mst"

Verify the Installation

Open any version of Revit and navigate to Add-Ins > Guardian > Settings > Licensing. The company name should be visible on the License Information dialog as shown below.

Guardian License Information dialog

If assistance is needed, please reach out to our team at support@iconicbim.com.

Perform Full Deployment

Once the test deployment is verified, continue to deploy to all necessary machines.

Please note that Guardian licenses are only activated once a registered project is opened on the end user’s machine. Guardian can be deployed to all machines without having to worry about using licenses.

Manual Install

Once a new account is created, an email will be sent providing a link to download the Guardian installer as well as the Company ID.

Once the installer is downloaded, open it to run, the setup wizard will appear. Click Next to continue.

Guardian Setup Wizard dialog
Guardian Setup Wizard

Read through the license agreement and click I Agree. Click Next to continue.

Guardian License Agreement dialog
License Agreement

Select who to install Guardian for. It is recommended that you select All Windows Users. Click Next to continue.

Guardian Install dialog
Install For:

Select the desired Revit versions to install Guardian for. There are two pages for the different versions; one for the currently supported versions of Revit and the second for the unsupported versions. Click Next to continue.

Guardian install dialog for supported Revit versions
Supported Revit Versions
Guardian install dialog for unsupported Revit versions
Unsupported Revit Versions

Guardian will prompt for the Company ID. The Company ID is used to make sure all users within a company are connected. If set incorrectly, users will not be able to utilize the full capability of Guardian.

If the Company ID is set incorrectly, it can be replaced in the Guardian.key file located in one of these two locations:

  • Program Data > Guardian
  • App Data > Local > Guardian

Click Next to continue.

Guardian Company ID dialog
Company ID

Click Close to finish installation.

Guardian Installation Complete dialog
Installation Complete

Guardian is now ready to be utilized! To take advantage of the Project/Company Administrator features, login through Licensing > Admin Login.

Guardian License Admin Login Dialog

For end users (non-administrator users) of Guardian, their accounts will be authenticated automatically through the Company ID and will be able to use Guardian immediately when opening a registered project! No user management required!

Have questions?

Reach out to learn more, ask any questions, or meet the team! We'd love to learn more about your challenges and explore the more proactive solution.

Get in Touch