Network Deployment and Automatic Activation
Introduction
Installing Egan BIM Resources apps on a few computers is easy, and we have provided settings pages for all the apps to make it easy to customize them as you see fit. Also, when you purchase an app, you receive a License ID and Password that can be easily entered on the "Manage License" page. However, if you are deploying the apps to a large number of computers, you will want a way to minimize individual attention on each computer, and a way to standardize your customization across your network.
Special Note on 2025 Configuration
Beginning in 2025, Egan BIM Resources apps use a dll.json (JavaScript Object Notation) file for configuration instead of a .dll.config file. This was necessary to accommodate the Revit change from .NET Framework 4.8 to .NET 8.0. The dll.json file contains the same variables as the dll.config file and is treated the same as the dll.config file by the apps and the app installers.
Installation
When you run the installer you downloaded from the Egan BIM Resources website, it will look for two files, a license file (Egan_AppName.lic) or a config file (Egan_Appname_202x.dll.config or Egan_Appname_202x.dll.json (2025+)) in the same folder as the installer executable.
If it finds either file in the folder, it will copy the file to the appropriate folder on the target computer, overwriting the default file. For additional information on including these files in an Autodesk Network Deployment, see “Including Egan Apps in an Autodesk Network Deployment” below.
This way, you can easily customize your installation.
If it finds either file in the folder, it will copy the file to the appropriate folder on the target computer, overwriting the default file. For additional information on including these files in an Autodesk Network Deployment, see “Including Egan Apps in an Autodesk Network Deployment” below.
This way, you can easily customize your installation.
To Set Up a Network Deployment
To get started, install the app on a computer, and determine your preferred settings. Once you are familiar with your choices, have made your decisions and have all settings the way you want them, you are ready to create the network deployment.
For the Sheet Matrix app, if you want to include a network version of the Start Presets File in your deployment, see the Sheet Matrix help file and establish this setting before continuing.
For the Project Startup app, skip the following paragraph.
For all other apps, use the menu to navigate to the Settings > Network tab. Identify a network location to store your application license files and browse to the location in the “Network License File Location” box. Now go to the “Export Auto-License file to this location” box. Click the check box “Use network license location folder.” Enter your License ID and Password in the boxes provided and click “Export” to export the license file to this location.
Project Startup app people rejoin here. In the “Export current settings to this folder” box, enter the location where the app installation executable will be located. Click “Export.”
You are now ready to include the app in your network deployment process or as an additional program in the Revit installation process. The app installation executable uses the /s switch to run in silent mode.
For the Sheet Matrix app, if you want to include a network version of the Start Presets File in your deployment, see the Sheet Matrix help file and establish this setting before continuing.
For the Project Startup app, skip the following paragraph.
For all other apps, use the menu to navigate to the Settings > Network tab. Identify a network location to store your application license files and browse to the location in the “Network License File Location” box. Now go to the “Export Auto-License file to this location” box. Click the check box “Use network license location folder.” Enter your License ID and Password in the boxes provided and click “Export” to export the license file to this location.
Project Startup app people rejoin here. In the “Export current settings to this folder” box, enter the location where the app installation executable will be located. Click “Export.”
You are now ready to include the app in your network deployment process or as an additional program in the Revit installation process. The app installation executable uses the /s switch to run in silent mode.
Notes
To minimize user interaction, you may elect to suppress the display of the End User License Agreement as part of the network deployment process. Please note that this means that your office is agreeing to the provisions of the End User License Agreement in place of the end user.
For a truly network solution, it is recommended that you point to a network location for the Auto-License file and not place a License file in the installation executable folder location, so if a change needs to be made, it can be made once in the network location.
Likewise, for the Sheet Matrix app, it is recommended that you point to a network location for the Started Value Presets file and not place a copy in the installation executable folder location, so if a change needs to be made, it can be made once in the network location.
The network deployment process described above is the most centralized and expedient method, though many other configurations are possible, depending on your company needs. Please feel free to contact Egan BIM Resources for assistance with other setups.
For a truly network solution, it is recommended that you point to a network location for the Auto-License file and not place a License file in the installation executable folder location, so if a change needs to be made, it can be made once in the network location.
Likewise, for the Sheet Matrix app, it is recommended that you point to a network location for the Started Value Presets file and not place a copy in the installation executable folder location, so if a change needs to be made, it can be made once in the network location.
The network deployment process described above is the most centralized and expedient method, though many other configurations are possible, depending on your company needs. Please feel free to contact Egan BIM Resources for assistance with other setups.
Caution:
The dll.config and license files use XML, and reserved XML characters are <, >, & and %. If you need to use these characters, contact Egan BIM Resources support for help.
For more information about the network deployment configuration, a more complete explanation is included below.
Network Deployment, Detailed
File Locations
For reference, the apps are installed in the Program Data folder, typically located at:
C:\ProgramData\Autodesk\REVIT\Addins\202x
The config file is located at:
C:\ProgramData\Autodesk\REVIT\Addins\202x\Egan_AppName_202x.bundle\Contents\Egan_Appname_202x.dll.config
or
C:\ProgramData\Autodesk\REVIT\Addins\202x\Egan_AppName_202x.bundle\Contents\Egan_Appname_202x.dll.json (2025+)
The license file is located at:
C:\ProgramData\Autodesk\REVIT\Addins\202x\Egan_AppName_202x.bundle\Contents\Resources\Egan_AppName.lic.
Note that since all yearly versions of the apps run on the same license, there is no yearly designation on the license file.
Also, for reference, you can download a Zip file containing license and config files for all Egan BIM Resources apps above.
The license and config files can be edited with any text editor, like "Notepad."
C:\ProgramData\Autodesk\REVIT\Addins\202x
The config file is located at:
C:\ProgramData\Autodesk\REVIT\Addins\202x\Egan_AppName_202x.bundle\Contents\Egan_Appname_202x.dll.config
or
C:\ProgramData\Autodesk\REVIT\Addins\202x\Egan_AppName_202x.bundle\Contents\Egan_Appname_202x.dll.json (2025+)
The license file is located at:
C:\ProgramData\Autodesk\REVIT\Addins\202x\Egan_AppName_202x.bundle\Contents\Resources\Egan_AppName.lic.
Note that since all yearly versions of the apps run on the same license, there is no yearly designation on the license file.
Also, for reference, you can download a Zip file containing license and config files for all Egan BIM Resources apps above.
The license and config files can be edited with any text editor, like "Notepad."
Configuration
To get started, install the app on a computer, and determine your preferred settings. Once you are familiar with your choices, and have made your decisions, you can find the appropriate Egan_Appname_202x.dll.config or Egan_Appname_202x.dll.json (2025+) file and modify the settings as required. For example, if you don't want your users to view the End User License Agreement, you would set the "AcceptEULA" setting to "True." To set up a network location to store your license information, you would fill in the "NetworkLicensePath" setting.
Some samples:
<setting name="AcceptEULA" serializeAs="String">
<value>False</value>
</setting>
<setting name="NetworkLicensePath" serializeAs="String">
<value>M:\MyLicensingFolder</value>
</setting>
<setting name="NameSeparator" serializeAs="String">
<value>_</value>
</setting>
Some dll.json samples:
"AcceptEULA": "True",
"NetworkLicensePath": "M:\MyLicensingFolder",
"TitleblockHeight": "30",
Once you have made your edits, you can copy the file to the folder where the installer executable is located. Now, when you run the installer, it will copy your preferred settings as the app default settings for all future installations.
Warning: Do not copy unedited files to the installer executable folder. This will result in all Egan BIM Resources default settings for your apps.
After you have deployed the apps, and discover you need to make a change to the settings, you can copy the newly revised config file over the original one in the apps folder. (See location above.) You may need elevated permissions to write to this folder - check with your IT staff. To make this even easier, you may use a Windows Logon script to copy the file.
Some samples:
<setting name="AcceptEULA" serializeAs="String">
<value>False</value>
</setting>
<setting name="NetworkLicensePath" serializeAs="String">
<value>M:\MyLicensingFolder</value>
</setting>
<setting name="NameSeparator" serializeAs="String">
<value>_</value>
</setting>
Some dll.json samples:
"AcceptEULA": "True",
"NetworkLicensePath": "M:\MyLicensingFolder",
"TitleblockHeight": "30",
Once you have made your edits, you can copy the file to the folder where the installer executable is located. Now, when you run the installer, it will copy your preferred settings as the app default settings for all future installations.
Warning: Do not copy unedited files to the installer executable folder. This will result in all Egan BIM Resources default settings for your apps.
After you have deployed the apps, and discover you need to make a change to the settings, you can copy the newly revised config file over the original one in the apps folder. (See location above.) You may need elevated permissions to write to this folder - check with your IT staff. To make this even easier, you may use a Windows Logon script to copy the file.
Licensing
When you purchase a license for an app, you are provided with a License ID and Password. Typically, each company is provided one License ID and Password for the app, with the number of activations corresponding to the number of licenses purchased. Therefore, you will typically use the same License ID and Password for each computer in your company.
To run the app beyond the trial period, the app needs to be activated.
When Revit is started, if an app is not yet activated, each app is programmed to look in two locations for the license file. If it finds a valid License file, will attempt to activate the app online. If a valid license file is not found, the app will not be activated and will continue its trial period, or expire.
The locations that the app looks for the license file are:
The "NetworkLicensePath" location as established in the config file.
The "Resources" folder as shown above under "Locations."
If the app finds a valid license file and activates the app, it will ignore any other license files. Once the app is activated, it will no longer look for license files on startup.
To run the app beyond the trial period, the app needs to be activated.
When Revit is started, if an app is not yet activated, each app is programmed to look in two locations for the license file. If it finds a valid License file, will attempt to activate the app online. If a valid license file is not found, the app will not be activated and will continue its trial period, or expire.
The locations that the app looks for the license file are:
The "NetworkLicensePath" location as established in the config file.
The "Resources" folder as shown above under "Locations."
If the app finds a valid license file and activates the app, it will ignore any other license files. Once the app is activated, it will no longer look for license files on startup.
Editing the license file
When you purchase an app, you will receive a License ID and Password. The License ID is an 8-digit integer and the password is the one entered when you set up the account.
To add them to the license file, you would simply change the original contents of the file:
<?xml version="1.0" encoding="utf-8" ?>
<License>
<LicenseID></LicenseID>
<Password></Password>
</License>
to:
<?xml version="1.0" encoding="utf-8" ?>
<License>
<LicenseID>12345678</LicenseID>
<Password>MyPassword</Password>
</License>
Then save the file. Warning: Make sure you have selected the correct file name- the contents of the all the license files are the same for all apps.
To add them to the license file, you would simply change the original contents of the file:
<?xml version="1.0" encoding="utf-8" ?>
<License>
<LicenseID></LicenseID>
<Password></Password>
</License>
to:
<?xml version="1.0" encoding="utf-8" ?>
<License>
<LicenseID>12345678</LicenseID>
<Password>MyPassword</Password>
</License>
Then save the file. Warning: Make sure you have selected the correct file name- the contents of the all the license files are the same for all apps.
Locate the license file
Place the edited license file in one of the two locations identified above.
If you place it in the folder established as the Network License Path in the config file, you don't need to place in the same folder as the installer executable. This location will allow you to deploy the app to all computers first, run them on a trial basis and then purchase a license and place it in the Netowrk License Path location. It will then activate the app on all future Revit startups.
If you place it in the same folder as the installer executable, it will be copied to the correct location for all future installations, but you will have to wait until you have purchased the license before you begin the installations.
As a third alternative, you could copy the license file to its proper location in the app "Resources" folder at any time after installation. As with the config file, you may need elevated permissions to write to this folder - check with your IT staff. To make this even easier, you may use a Windows Logon script to copy the file.
If you place it in the folder established as the Network License Path in the config file, you don't need to place in the same folder as the installer executable. This location will allow you to deploy the app to all computers first, run them on a trial basis and then purchase a license and place it in the Netowrk License Path location. It will then activate the app on all future Revit startups.
If you place it in the same folder as the installer executable, it will be copied to the correct location for all future installations, but you will have to wait until you have purchased the license before you begin the installations.
As a third alternative, you could copy the license file to its proper location in the app "Resources" folder at any time after installation. As with the config file, you may need elevated permissions to write to this folder - check with your IT staff. To make this even easier, you may use a Windows Logon script to copy the file.
Including Egan Apps in an Autodesk Network Deployment
The apps can be deployed with an Autodesk Network (Revit, BDSP, BDSU) Deployment under the grouping "Include additional software."
When creating a deployment, open the "Include additional software" group. Click "Add." The dialog will allow you to browse to and select the Egan app install executable as desired. (Note that each app will require its own individual entry.) The deployment wizard will create a new entry in the list.
The "Name" column will be populated with "New Add-on." If desired, change this to correspond to the name of the app you are installing. This name will display on the progress dialog during the installation.
The "Path" column will display the location of the file you just selected, and will be adjusted during the creation of the deployment.
Enter "/S" (without the quotes, the deployment will add them) in the "Command Line Parameters" column. The installer will run in "Silent" mode.
Add another addon as desired or complete the deployment.
When you click "Create" to finish it, the deployment will make a folder under "Img" called "Addons" which will contain a folder corresponding to the name of the executable file which, in turn, will contain a copy of the installer executable. For example, for the "Egan_SheetMatrix_2017" app, the deployment will create the folder:
"server\deployment_loc\deployment_name\Img\Addons\Addon_Egan_SheetMatrix_2017_0"
that contains the installer.
If you have created any custom dll.config, dll.json or .lic files, place them in this folder and they will be copied to the appropriate folder on the target computer, overwriting the default file.
When creating a deployment, open the "Include additional software" group. Click "Add." The dialog will allow you to browse to and select the Egan app install executable as desired. (Note that each app will require its own individual entry.) The deployment wizard will create a new entry in the list.
The "Name" column will be populated with "New Add-on." If desired, change this to correspond to the name of the app you are installing. This name will display on the progress dialog during the installation.
The "Path" column will display the location of the file you just selected, and will be adjusted during the creation of the deployment.
Enter "/S" (without the quotes, the deployment will add them) in the "Command Line Parameters" column. The installer will run in "Silent" mode.
Add another addon as desired or complete the deployment.
When you click "Create" to finish it, the deployment will make a folder under "Img" called "Addons" which will contain a folder corresponding to the name of the executable file which, in turn, will contain a copy of the installer executable. For example, for the "Egan_SheetMatrix_2017" app, the deployment will create the folder:
"server\deployment_loc\deployment_name\Img\Addons\Addon_Egan_SheetMatrix_2017_0"
that contains the installer.
If you have created any custom dll.config, dll.json or .lic files, place them in this folder and they will be copied to the appropriate folder on the target computer, overwriting the default file.