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

License server settings

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:

2

Result:

3

Example of the Web License Server settings:

4

Result:

5

Revit. Base level

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:

18

An example of plugin window with these settings:

19

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.

Revit. Copy values

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:

14

An example of plugin window with these settings:

15

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.

Revit. Elements join

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:

16

An example of plugin window with these settings:

17

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.

Revit. Floor by Room

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:

8

An example of plugin window with these settings:

9

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.

Revit. Parametrization

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 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:

10

An example of plugin window with these settings:

11

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.

Revit. Section annotation

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:

12

An example of plugin window with these settings:

13

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.

Revit. Sheet export

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:

20

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:

21

Revit. Worksets

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:

6

An example of plugin window with these settings:

7

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.


ModPlus 2015-2023