Organization settings
The organization settings allow you to override user settings or set specific behavior. The organization settings apply to different zones - to general ModPlus settings or to plugin settings.
The organization settings are an xml file with a specific structure:
Where:
- ModPlus - the root node of the xml file.
- Node - the configuration zone node. In most cases, the node is named by the unique name of the plugin. Only the zones described later in the help are allowed.
- Property - the property node. Only the properties described later in the help are allowed.
- Value - the value of the property. Values must be within the allowable values described later in the help.
Only required zones can be added to the settings file. Settings for zones are taken into account only if they are present and filled correctly.
Xml file must be saved as orgConfig.mpcf and located in user settings storage folder %appdata%\ModPlus Data\UserData (full path is %appdata%\ModPlus Data\UserData\orgConfig.mpcf). The settings file can be copied and updated by the organization's system administrators.
Organization settings file is used by the program only for reading.
Data from the organization settings file is read when it is directly accessed (for example, when the plugin is run), which allows it to be updated without closing the supported product (AutoCAD, Revit, etc.).
Allowable zone options and settings for their behavior are added on request!
The actual template of the organization settings file - open.
Allowed nodes of the settings file
For organization settings that override the configuration storage file (in which only one property ConfigurationFile is specified), there is a locking system that works according to the following scheme:
1. A user who initially has access to edit a configuration file launches the plugin
2. The configuration file is locked, i.e. no other users are allowed to make changes to it
3. Next to the configuration file is a text file (if it isn't created) created or updated with a name like PluginName.lock.txt, in which the system name of the user who locked the configuration file is written
4. When closing the plugin, the configuration file is released and the system name is deleted from the text file.
That is, the configuration file becomes user-occupied until the plugin is closed.
While the configuration file is occupied, other users who originally have access to edit the configuration file will have the name of the user that the configuration file is currently occupied displayed in the plugin.
The organization settings for the menus allow you to override the menus on the ribbon in AutoCAD or Revit, and to interrupt ModPlus loading in AutoCAD, Revit, or Renga.
The node should be named - Menu.
The node can contain AutoCAD and/or Revit properties. Each property specifies the path to an xml file containing the instructions for building the menu.
If you specify the path to a menu file stored on a network drive on your local network, the path must be in UNC format!
To create a menu file, use the Configurator: on the "Adaptation" tab, create a menu and export it to an xml file using the appropriate 
button.
Important! Do not create or edit the menu file manually, it might cause errors when launching AutoCAD, Revit!
If the user has an overridden menu with Organization Settings, the user will not be able to edit the corresponding menu in the Configurator.
A node can contain the following properties to interrupt ModPlus loading:
| Свойство | Описание | Допустимые значения | Значение по умолчанию |
| LoadInAutoCAD | Manage loading ModPlus into AutoCAD. Important - the commands included in the working libraries will be available for invocation through the command line! | True, False | True |
| LoadInRevit | Manage loading ModPlus into Revit | True, False | True |
| LoadInRenga | Manage loading ModPlus into Renga | True, False | True |
If any of the properties is not specified or is specified incorrectly, but the Menu node exists, the default settings will be used.
Example of settings:
Set all settings for the auto update module.
The node should be named – AutoUpdater.
A node may contain the following properties:
| Property | Description | Allowable values | Default value |
| GetStandardCui | Rebuild the menu when installing new plugins | True, False | True |
| ShowProgressDialog | Show the progress dialog when downloading and installing updates | True, False | True |
| ShowResultDialog | Show the dialog with the results of updates or installation | True, False | True |
| UpdateCheckTime | Update check period | Integer from 0 to 4 0 – 30 minutes 1 – 1 hour 2 – 2 hours 3 – 4 hours 4 – 8 hours |
3 |
| DoubleMouseClick | Double click on the tray icon | 0 or 1 0 – open module settings 1 – open Configurator |
0 |
| NotShowNotificationsForUnimportantUpdates | Don't show notifications for unimportant updates | True, False | True |
| ShowHtmlExceptionMessage | Show html error content | True, False | True |
| AutoInstallNewPlugins | Automatically install new plugins | True, False | False |
| ShowNews | Manage the display of news regardless of notifications settings | True, False | True |
If any of the properties is not specified or is specified incorrectly, but the AutoUpdater node exists, the default settings will be used.
The auto update module has a check for enabling/disabling the organization settings every 30 minutes, which allows you to enable/disable the organization settings without restarting the module.
Example of settings:
Result:
The License Server settings allow you to set the address of the LAN License Server or a unique key of the Web License Server, as well as to specify which server is active.
The zone node must be named – LicenseServer.
The settings for the LAN License Server consist of three properties:
| Property | Description | Valid values |
| IsLocalLicenseServerEnable | Whether this license server is active | True, False |
| LocalLicenseServerIpAddress | IP address of the license server | Not checked |
| LocalLicenseServerPort | License server port | Integer from 0 to 65535 |
The settings for the Web License Server consist of two properties:
| Property | Description | Valid values |
| IsWebLicenseServerEnable | Whether this license server is active | True, False |
| WebLicenseServerGuid | Unique license server key | String convertible to GUID |
It is sufficient to add to the node the settings of only the license server which is used in the organization.
In the case of the Web License Server, the email for user identification is not specified by the organization settings!
Example of LAN License Server settings:
Result:
Example of the Web License Server settings:
Result:
The organization settings for the Base level plugin allows to override the path to the configuration storage file. By default, user configuration settings are stored in %appdata%\ModPlus Data\UserData\mprBaseLevel.xml file.
The node should be named - mprBaseLevel.
The settings consist of one property - ConfigurationFile - in the value of which the path to the configuration storage file is specified. The path must point to the existing configuration storage file, which can even be empty (you can create an empty text file and change the extension from .txt to .xml).
If specifying the path to a configuration file stored on a network drive on the local network, the path must be in UNC format!
Example of settings:
An example of plugin window with these settings:
It is possible to differentiate access to the configuration file using Active Directory service. If a user has no access to edit a configuration file, he will be notified accordingly in the plugin window, and all configuration editing functionality will be disabled. That is, the configuration file will be read-only.
The organization settings for the Copy values plugin allows to override the path to the configuration storage directory. By default, user configuration settings are stored in %appdata%\ModPlus Data\UserData\CopyParameterConfigurations file.
The node should be named - mprCopyParameterValues.
The settings consist of one property - ConfigurationDirectory - in the value of which the path to the configuration storage directory is specified. The path must point to the existing configuration storage directory.
If specifying the path to the configuration storage directory located on a network drive on the local network, the path must be in UNC format!
Example of settings:
An example of plugin window with these settings:
It is possible to differentiate access to the configuration files using Active Directory service. If a user has no access to edit a configuration files, he will be notified accordingly in the plugin window, and all configuration editing functionality will be disabled. That is, the configurations will be read-only.
The organization settings for the Elements join plugin allows to override the path to the configuration storage file. By default, user configuration settings are stored in %appdata%\ModPlus Data\UserData\mprJoin.xml file.
The node should be named - mprJoin.
The settings consist of one property - ConfigurationFile - in the value of which the path to the configuration storage file is specified. The path must point to the existing configuration storage file, which can even be empty (you can create an empty text file and change the extension from .txt to .xml).
If specifying the path to a configuration file stored on a network drive on the local network, the path must be in UNC format!
Example of settings:
An example of plugin window with these settings:
Organization settings apply only to the "Join" and "Cut" tabs!
It is possible to differentiate access to the configuration file using Active Directory service. If a user has no access to edit a configuration file, he will be notified accordingly in the plugin window, and all configuration editing functionality will be disabled. That is, the configuration file will be read-only.
The organization settings for the Floor by Room plugin allows to override the path to the configuration storage file. By default, user configuration settings are stored in %appdata%\ModPlus Data\UserData\mprFloorByRoom.xml file.
The node should be named - mprFloorByRoom.
The settings consist of one property - ConfigurationFile - in the value of which the path to the configuration storage file is specified. The path must point to the existing configuration storage file, which can even be empty (you can create an empty text file and change the extension from .txt to .xml).
If specifying the path to a configuration file stored on a network drive on the local network, the path must be in UNC format!
Example of settings:
An example of plugin window with these settings:
It is possible to differentiate access to the configuration file using Active Directory service. If a user has no access to edit a configuration file, he will be notified accordingly in the plugin window, and all configuration editing functionality will be disabled. That is, the configuration file will be read-only.
The organization settings for the Parametrization plugin allows to override the path to the configuration storage file. By default, user configuration settings are stored in %appdata%\ModPlus Data\UserData\mprParametrization.xml file.
The node should be named - mprParametrization.
The node can contain the following properties:
| Property | Description | Valid values |
| ConfigurationFile | Path to the configuration storage file. Can be omitted when using the ConfigurationsFolder property | File path in UNC format |
| ConfigurationsFolder | Path to the folder containing several configuration storage files | Folder path in UNC format |
| CanUseUserConfigurationFile | Allows users to use a user configuration storage file | True, False |
If specifying the path to a file or folder stored on a network drive on the local network, the path must be in UNC format!
Properties can be combined. If using the properties (ConfigurationsFolder or ConfigurationsFolder + ConfigurationFile or ConfigurationFile + CanUseUserConfigurationFile or ConfigurationFile + ConfigurationsFolder + CanUseUserConfigurationFile) results in multiple configuration files, a drop-down list with configuration file selection appears in the information box. If the CanUseUserConfigurationFile property is set to True, the "User configuration file" position will be added to the list of configuration files.
The files located in the folder specified in the ConfigurationsFolder property must contain valid data for the plugin. Files are not checked for content! Incorrect xml files can lead to errors!
Example of settings:
An example of plugin window with these settings:
It is possible to differentiate access to the configuration files using Active Directory service. If a user has no access to edit a configuration file, he will be notified accordingly in the plugin window, and all configuration editing functionality will be disabled. That is, the configuration file will be read-only.
The organization settings for the Section annotation plugin allows to override the path to the configuration storage file. By default, user configuration settings are stored in %appdata%\ModPlus Data\UserData\mprSectionAnnotation.xml file.
The node should be named - mprSectionAnnotation.
The settings consist of one property - ConfigurationFile - in the value of which the path to the configuration storage file is specified. The path must point to the existing configuration storage file, which can even be empty (you can create an empty text file and change the extension from .txt to .xml).
If specifying the path to a configuration file stored on a network drive on the local network, the path must be in UNC format!
Example of settings:
An example of plugin window with these settings:
It is possible to differentiate access to the configuration file using Active Directory service. If a user has no access to edit a configuration file, he will be notified accordingly in the plugin window, and all configuration editing functionality will be disabled. That is, the configuration file will be read-only.
Organization settings for the Sheet export plugin allow you to set the rules for watermarking when exporting to PDF.
The node should be named – mprSheetExport.
The settings consist of 4 obligatory properties:
| Property | Description | Valid values |
| Watermark | Whether or not to add watermarks | True, False |
| WatermarkText | Contents of the watermark | Any |
| WatermarkExclude | Path to text file (.txt) containing document exclusions | The path to the file. If the path points to a file on the local network, the path must be in UNC format |
| WatermarkRules | Path to the text file (.txt) that contains the rules of watermark placement depending on the Title Block | The path to the file. If the path points to a file on the local network, the path must be in UNC format |
Example of settings:
The exclusions file (WatermarkExclude property) specifies the names of documents that do not require a watermark to be added, even if watermarking is enabled (Watermark = True). Each value must be specified on a new line in the file. Only part of the name can be specified in the file. For example, if a document in Revit is named RAC_basic_sample_project and the file has the value RAC_ or the value _sample_, the document will not add a watermark when exported to PDF.
In the rules file (WatermarkRules property) you add watermark rules. Each rule must be placed on a new line. If a line in the file starts with a # character, the line will not be processed by the plugin. Each rule consists of 7 properties, separated by a comma. The start and end spaces of each property are ignored by the plugin. Properties in a string must be arranged in the following order:
| Property | Description | Valid values |
| The value contained in the name of the Title Block | If the full name of the Title Block contains the value specified in the property, this rule will be used | You can specify an asterisk (*) as the value. The rule with the asterisk will be used for all sheets for which no match is found for the Title Block name |
| Right indent | Indent of the left bottom point of the watermark from the right edge of the sheet in millimeters | Integers |
| Bottom indent | Indent of the left bottom point of the watermark from the bottom edge of the sheet in millimeters | Integers |
| Rotation angle | Angle of rotation relative to the lower left point of the watermark | Integer from 0 to 359 |
| Color | Watermark color | Valid values (case-sensitive): WHITE LIGHT_GRAY GRAY DARK_GRAY BLACK RED ORANGE YELLOW GREEN MAGENTA CYAN BLUE |
| Text size | Watermark text size in millimeters | Integer numbers greater than 0 |
| Font file name | File name of the watermark font. Not case sensitive | The names of font files available on the user's computer in the Windows/Fonts folder. If the specified font file is not found, arial.ttf will be used |
If no rule from the file matches the name of the Title Block (or there are no rules in the file), the plugin will use a rule with the values ",185,65,0,RED,5,isocpeur.ttf".
Example of filling out a rules file:
The organization settings for the Worksets plugin allows to override the path to the configuration storage file. By default, user configuration settings are stored in %appdata%\ModPlus Data\UserData\Worksets.xml file.
The node should be named - mprWorksets.
The settings consist of one property - ConfigurationFile - in the value of which the path to the configuration storage file is specified. The path must point to the existing configuration storage file, which can even be empty (you can create an empty text file and change the extension from .txt to .xml).
If specifying the path to a configuration file stored on a network drive on the local network, the path must be in UNC format!
Example of settings:
An example of plugin window with these settings:
It is possible to differentiate access to the configuration file using Active Directory service. If a user has no access to edit a configuration file, he will be notified accordingly in the plugin window, and all configuration editing functionality will be disabled. That is, the configuration file will be read-only.